Server Management Command Line Protocol Specification - DMTF

More documents

Recommendations

Info

Server Management Command Line Protocol (SM CLP) Specification 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 5.2.4.3.2 Keyword=Value Format The "keyword" output format requests the command to format the output in a "keyword=value" format. To select "keyword" format explicitly, the implementations shall accept "keyword" as the argument value for the format argument to the output option. In "keyword" output format, output data element items appear in sequence as "=" items separated by the end-of-line character sequence. Implementations shall use double quotes around any value that contains the end-of-line sequence. Implementations shall specify a group of "keyword" items that are to be interpreted as a single item or collection by using the "begingroup" keyword and a value identifying the type of data. Implementations shall terminate a group by using the "endgroup" keyword. When a "begingroup" keyword appears in the output, all keywords that follow are interpreted as part of a group until the next "endgroup" keyword. Implementations shall indicate the end of the Command Response by using the "endoutput" keyword. Implementations may include blank lines or lines that have an # character (octothorp) in the first character position in the output. If an implementation includes blank lines or lines that have an # character (octothorp) in the first character position in the output, the implementation shall not impart a meaning to the blank lines. The general form of the "keyword" output format is as follows: commandline=the commandline that was processed status=Integer job status code status_tag=String job status error=integer processing error code, if there is one error_tag=string description of processing error begingroup=message owningentity=organization owning a message message_id=string identifier for the message, unique with the value of owningentity message=message text message_arg=Insertion value 1 for the message . . . message_arg=Insertion value n for the message endgroup job_id=Identifier for the job created to execute the command errtype=Integer code for the high level category of execution error errtype_desc=string description of the execution error cimstat=integer code for the CIM error cimstat_desc=string description of the CIM error severity=integer code indicating the severity of the error severity_desc=description corresponding to the severity code probcause=integer code indicating the probable cause of the execution error probcause_desc=description corresponding to the probable cause code errsource=Target Address of error source errsourceform=SMA Target Address errsourceform_desc=SM Target Address recmdaction=Free-form string describing action to take to resolve the error begingroup=message owningentity=organization owning a message message_id=string identifier for the message, unique with the value of owningentity message=message text message_arg=Insertion value 1 for the message . . . message_arg=Insertion value n for the message endgroup 46 Version 1.0.2
Server Management Command Line Protocol (SM CLP) Specification 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 . . . command= . . . Verb and target-specific keywords . . . endoutput If an implementation includes OEM output for a command issued with a CLP verb, the implementation shall return the OEM output after the standard output for the command and before the final "endoutput" keyword. If an implementation includes OEM defined keywords for inclusion in the output, the implementation shall define each keyword using the convention for OEM name extensions defined in 224H5.2.6.2. If an implementation is returning "keyword" output for an OEM Command Form command, the implementation shall return the Command Status using the standard keyword structure and shall substitute the "command" keyword and subsequent output with the keyword "oemcommand" followed by the vendor-defined output. 5.2.4.3.3 XML Format The output format "clpxml" requests the command to format the output in an XML document format. To select "clpxml" format explicitly, implementations shall accept "clpxml" as the value for the format argument to the option option. In "clpxml" output format, the output data is a well-formed XML document. The XML document schema (tags and so on) is defined per command. An outline of the XML document specific to each CLP verb is located in the "XML Output" subclause for that verb in Clause 225H6. The XML schema defining the Command Response data element is defined using XSD in Server Management Command Line Protocol (SM CLP) Command Response XML Schema v1.0 (226H6HDSP0224). The XML schema is intended to address the requirements of users of the CLP for a simple, parsable schema to represent CLP output. It is not intended as a data exchange format to fully represent a CIM instance or class. If an implementation returns Command Response data as an XML document, the implementation shall ensure that the document default namespace is: "http://schemas.dmtf.org/smash/commandresponse/1.0.0/dsp0224.xsd" OEM vendors may extend the Command Response schema. If OEM vendors extend the Command Response schema, the implementation shall place the OEM extensions into a distinct namespace and shall define a namespace prefix that follows the convention for OEM name extensions defined in 227H5.2.6.2. 5.2.5 Internationalization/Localization This clause outlines the support for internationalization and localization provided for by the CLP specification. For the purposes of the CLP specification, internationalization is interpreted to mean the substitution of strings in one language for strings having equivalent meaning in another language. Localization refers to the formatting of information for conformance with the norms of a particular locale. 5.2.5.1 Command Input CLP implementations shall not provide support for internationalization of Command Line terms. CLP implementations may provide support for localization of input data. Furthermore, a CLP implementation shall not support alternative strings for CLP command verbs, option names, and target property names except as OEM extensions (see 228H5.2.6). Commands written using alternative strings for these Command Line terms will not be portable from implementation to implementation. Version 1.0.2 47
Page 1 and 2: 1 2 3 4 Document Number: DSP0214 Da
Page 3 and 4: Server Management Command Line Prot
Page 45: Server Management Command Line Prot
Page 97 and 98:
Server Management Command Line Prot
Page 99 and 100:
Page 101 and 102:
Page 103 and 104:
Page 105 and 106:
Page 107 and 108:
Page 109 and 110:
Page 111 and 112:
Page 113 and 114:
Page 115 and 116:
Page 117 and 118:
Page 119 and 120:
Page 121 and 122:
Page 123 and 124:
Page 125 and 126:
Page 127 and 128:
Page 129 and 130:
Page 131 and 132:
Page 133 and 134:
Page 135 and 136:
Page 137 and 138:
302H10H Server Management Command L
Page 139 and 140:
Page 141 and 142:
Page 143 and 144:
Page 145 and 146:
Page 147 and 148:
Page 149 and 150:
Page 151 and 152:
Page 153 and 154:
Page 155 and 156:
Page 157 and 158:
Page 159 and 160:
Page 161 and 162:
Page 163 and 164:
show all

Server Management Command Line Protocol Specification - DMTF

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?