Server Management Command Line Protocol Specification - DMTF

More documents

Recommendations

Info

Server Management Command Line Protocol (SM CLP) Specification 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 5.2.1.3 Command Line Terms This clause details the requirements for Command Line Terms. 5.2.1.3.1 General A CLP Command Line consists of four types of terms: verbs, options and option argument terms, command target terms, and target property terms. Each term on the Command Line is separated from other terms by the CLP command term separator character, " " (space). (See 176H5.2.1.1 for the list of CLP special and reserved characters.) Implementations shall recognize the CLP command term separator character, beginning of line, and end of line as delimiting terms on the Command Line. Implementations shall recognize the end-of-line character as terminating a single Command Line unless it is preceded by the CLP escape character. A single Command Line may be continued across end-of-line by using the CLP escape character immediately before the end-of-line character. The implementation shall not initiate command processing until after the complete command has been received by the CLP. If an implementation receives a Command Line that contains zero characters or consists entirely of the command term separator character, implementations shall return a Command Response that contains exactly zero characters. The effect of this requirement is such that a blank line is not reported as an error and instead results in a CLP prompt being returned. 5.2.1.3.2 Verb The implementation shall expect the command verb to be the first term in a command. The implementation will expect the command verb to be one of the specified CLP command verbs listed in Clause 177H6 or an OEM command line extended form as defined in 178H5.2.6.3.3. Implementations shall not support any verbs other than the CLP verbs defined in this specification and any command verbs identified as OEM verbs according to 179H5.2.6.3.3. When the first term in a Command Line is not a CLP verb and is not identified as an OEM verb according to the rules in 180H5.2.6.3.3, the implementation shall not execute the command and shall return a Command Status of COMMAND PROCESSING FAILED and a Processing Error of COMMAND NOT RECOGNIZED. 5.2.1.3.3 Options and Option Arguments Command options may be included immediately after the command verb. Command options are recognized by the option indicator character, "-" (single hyphen). If options are specified in a command, the options and their arguments shall occur immediately after the command verb and before the optional command target term and target properties. Command options either require an argument or require no argument. Options that require no argument are separated from the subsequent options, command target term, or target property names by the command term separator character. Options that require arguments are separated from their option argument term by the command term separator character. An option argument will be one or more argument names or argument/value pairs. The comma is used to delimit arguments and argument/value pairs within the option argument term. The comma is also used to delimit values within an argument value. Using the comma for two types of tokenization within the option argument term could result in ambiguity when parsing an option argument term. To eliminate the potential for ambiguity, parentheses are used to enclose argument values which can be comma-delimited lists. When processing an option argument term, implementations will tokenize the option argument term using the comma as a delimiter unless the comma is enclosed in parentheses, in which case the implementation will ignore it. Implementations shall interpret a "," (comma) as delimiting arguments in the option argument term unless the comma is preceded by a left parenthesis "(", in which case the implementation shall ignore any commas that occur prior to a matching right parenthesis ")". If while parsing a Command Line an implementation encounters an option it does not recognize, the implementation shall not execute the command and shall return a Command Status of COMMAND PROCESSING FAILED and a Processing Error of INVALID OPTION. 30 Version 1.0.2
Server Management Command Line Protocol (SM CLP) Specification 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 5.2.1.3.4 Target Address A Target Address is a string that follows the Target Address Syntax and is used to identify the target of a command. The SM CLP supports several types of target addressing. It supports individual instance addressing as defined in 181H5HDSP0215. Instance addressing is extended to include support for Relative Target Addresses. It adds support for addressing instances of a particular class and support for addressing an instance or instances of an association relative to target instances that the association references. Implementations shall require that if the command target term is included in the Command Line, the command target term is the first term that is not an option after the command verb. Implementations shall require that when the command target term is included in the command, the command target term appears before any target property names. The implementation shall observe the following ordered rules for determining if the first non-option or option argument term after the verb is treated as a command target term: • If the first non-option or option argument term after the verb contains one of the following CLP reserved addressing terms ("." [dot], ".." [dot dot], address term separator, "=>" [association separator], or SESSION) and the term is unescaped, the implementation shall interpret the term as a command target term. • If the first non-option or option argument term after the verb ends in an integer or an "*" (asterisk) and does not contain an unescaped assignment operator or equivalence operator, the implementation shall interpret the term as a command target term. • When the Command Processor discovers that the first non-option or option argument term after the verb is not a command target term, the Command Processor shall assume that the term, and any subsequent terms, are target property terms. These rules enable a Client wishing to ensure consistent results when specifying a command target term to do so through the inclusion of one of the CLP reserved addressing terms. When the implementation determines that a command target term has been specified, the implementation shall validate the command target term against the all-legal-targets production of the grammar specified in 182HAnnex A. If the command target term is invalid, the implementation shall return a Command Status of COMMAND PROCESSING FAILED and a Processing Error of INVALID TARGET. The order of precedence for determining the Resultant Target of a command is defined in 183H5.1.3. 5.2.1.3.5 Target Address Syntax Target addresses in the SM CLP are composed of the following parts: • UFiT—A UFcT concatenated with an integer suffix. Selects a specific Managed Element in a given container. • UFsT—A UFcT concatenated with an asterisk. Selects all instances of the type specified by the UFcT within a given container. • address term separator (/ or \)—When located at the beginning of a command target term, represents the root of the address space. When used to separate two UFiTs in an address, represents an Addressing Association between them. • association separator (=>)—Delimits an Association Class within a target address. The portion of the target address preceding, and optionally following, the Association Class identifies one, or both, Managed Elements referenced by the target Association instance. • dot (.)—Reserved term meaning "this target" • dot dot (..)—Reserved term meaning "the container of this target" Version 1.0.2 31
Page 1 and 2: 1 2 3 4 Document Number: DSP0214 Da
Page 3 and 4: Server Management Command Line Prot
Page 29: Server Management Command Line Prot
Page 81 and 82:
Server Management Command Line Prot
Page 83 and 84:
Page 85 and 86:
Page 87 and 88:
Page 89 and 90:
Page 91 and 92:
Page 93 and 94:
Page 95 and 96:
Page 97 and 98:
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?