1408
The CLP specifies the following named, selectable formats for output data: "text", "keyword", and 1409
"clpxml". These data formats are defined in the following clauses. 1410
5.2.4.1 General 1411
Implementations shall support "text" format and shall provide "text" format output as the default output 1412
setting. When other output data formats are supported, implementations shall allow the user to override 1413
the format on a per-command basis using the command option output. Implementations shall also 1414
provide an environment setting to control output format for all commands, unless overridden by the user. 1415
If an implementation supports at least one output format other than "text", the implementation shall 1416
support the "clpxml" output format. 1417
5.2.4.2 Text Format 1418
The output format "text" is the default format for output. Output in "text" format is not recommended to be 1419
parsed by an automated agent. This format is suitable only to be read by a person. Text output format will 1420
vary from implementation to implementation. 1421
When "text" output format is selected, implementations may use any output text wording that is deemed 1422
appropriate to convey the Command Response data elements to the user. When the Command 1423
Response is presented in "text" format, the implementation may provide execution status data as part of 1424
the text description of the Command Results or, if the command is successful, the implementation may 1425
not include an explicit statement of execution status in the Command Response. 1426
5.2.4.3 Structured Outputs 1427
This clause details requirements related to structured output. 1428
5.2.4.3.1 General 1429
The CLP specification defines two structured output formats: "keyword" and "clpxml". When returning a 1430
Command Response formatted according to a structured output, the implementation shall use the specific 1431
keywords and values identified in 222H5.2.3.1 and 223H5.2.3.2 for each data element included in the Command 1432
Status data element. 1433
For information about the rules governing the use of the output option to select an output format, see 1434
Error! Reference source not found.. 1435
5.2.4.3.2 Keyword=Value Format 1436
The "keyword" output format requests the command to format the output in a "keyword=value" format. To 1437
select "keyword" format explicitly, the implementations shall accept "keyword" as the argument value for 1438
the format argument to the output option. 1439
In "keyword" output format, output data element items appear in sequence as "<keyword>=<value>" 1440
items separated by the end-of-line character sequence. Implementations shall use double quotes around 1441
any value that contains the end-of-line sequence. 1442
Implementations shall specify a group of "keyword" items that are to be interpreted as a single item or 1443
collection by using the "begingroup" keyword and a value identifying the type of data. Implementations 1444
shall terminate a group by using the "endgroup" keyword. When a "begingroup" keyword appears in the 1445
output, all keywords that follow are interpreted as part of a group until the next "endgroup" keyword. 1446
Implementations shall indicate the end of the Command Response by using the "endoutput" keyword. 1447
Implementations may include blank lines or lines that have an # character (octothorp) in the first character 1448
position in the output. If an implementation includes blank lines or lines that have an # character 1449
(octothorp) in the first character position in the output, the implementation shall not impart a meaning to 1450
the blank lines. 1451
The general form of the "keyword" output format is as follows: 1452
commandline=the commandline that was processed
1453
status=Integer job status code
1454
status_tag=String job status
1455
error=integer processing error code, if there is one
1456
error_tag=string description of processing error
1457
begingroup=message
1458
owningentity=organization owning a message
1459
message_id=string identifier for the message, unique with the value of owningentity
1460
message=message text
1461
message_arg=Insertion value 1 for the message
1462 . 1463 . 1464 . 1465
message_arg=Insertion value n for the message
1466
endgroup
1467
job_id=Identifier for the job created to execute the command
1468
errtype=Integer code for the high level category of execution error
1469
errtype_desc=string description of the execution error
1470
cimstat=integer code for the CIM error
1471
cimstat_desc=string description of the CIM error
1472
severity=integer code indicating the severity of the error
1473
severity_desc=description corresponding to the severity code
1474
probcause=integer code indicating the probable cause of the execution error
1475
probcause_desc=description corresponding to the probable cause code
1476
errsource=Target Address of error source
1477
errsourceform=SMA Target Address
1478
errsourceform_desc=SM Target Address
1479
recmdaction=Free-form string describing action to take to resolve the error
1480
begingroup=message
1481
owningentity=organization owning a message
1482
message_id=string identifier for the message, unique with the value of owningentity
1483
message=message text
1484
message_arg=Insertion value 1 for the message
1485 . 1486 . 1487 . 1488
message_arg=Insertion value n for the message
1489
endgroup
. 1491 . 1492 . 1493 command=<verbname> 1494 . 1495 . 1496 . 1497
Verb and target-specific keywords
1498 . 1499 . 1500 . 1501 endoutput 1502
If an implementation includes OEM output for a command issued with a CLP verb, the implementation 1503
shall return the OEM output after the standard output for the command and before the final "endoutput" 1504
keyword. If an implementation includes OEM defined keywords for inclusion in the output, the 1505
implementation shall define each keyword using the convention for OEM name extensions defined in 1506
224H
5.2.6.2. 1507
If an implementation is returning "keyword" output for an OEM Command Form command, the 1508
implementation shall return the Command Status using the standard keyword structure and shall 1509
substitute the "command" keyword and subsequent output with the keyword "oemcommand" followed by 1510
the vendor-defined output. 1511
5.2.4.3.3 XML Format 1512
The output format "clpxml" requests the command to format the output in an XML document format. To 1513
select "clpxml" format explicitly, implementations shall accept "clpxml" as the value for the format 1514
argument to the option option. 1515
In "clpxml" output format, the output data is a well-formed XML document. The XML document schema 1516
(tags and so on) is defined per command. An outline of the XML document specific to each CLP verb is 1517
located in the "XML Output" subclause for that verb in Clause 225H6. 1518
The XML schema defining the Command Response data element is defined using XSD in Server 1519
Management Command Line Protocol (SM CLP) Command Response XML Schema v1.0 (226H6HDSP0224). 1520
The XML schema is intended to address the requirements of users of the CLP for a simple, parsable 1521
schema to represent CLP output. It is not intended as a data exchange format to fully represent a CIM 1522
instance or class. If an implementation returns Command Response data as an XML document, the 1523
implementation shall ensure that the document default namespace is: 1524
"http://schemas.dmtf.org/smash/commandresponse/1.0.0/dsp0224.xsd" 1525
OEM vendors may extend the Command Response schema. If OEM vendors extend the Command 1526
Response schema, the implementation shall place the OEM extensions into a distinct namespace and 1527
shall define a namespace prefix that follows the convention for OEM name extensions defined in 227H5.2.6.2. 1528