Server Management Command Line Protocol Specification - DMTF

More documents

Recommendations

Info

Server Management Command Line Protocol (SM CLP) Specification 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 5.1.3.4 Target Managed Element Object Model and Semantics The CLP is designed for administrators and scripts that manage systems. At the same time, the CLP conforms to the object model described by the 132H4HCommon Information Model (CIM) Schema, version 2.12. The CLP defines a set of general command verbs used to manipulate Managed Elements. In many cases, CLP verbs relate directly to typical object interactions, such as "set property value", "read property value", "put into a particular state", and so on. In other cases, CLP verbs are interpreted in the context of the Managed Element and map to particular methods of that Managed Element’s class. The CLP verb definitions in Clause 133H6 describe each CLP command verb in detail. 134H32HDSP0216 describes the full mapping of the CLP to the CIM. For each CIM class, 135H32HDSP0216 describes the behavior of commands applied to a target instance of the class. The specification also describes the property names of those targets that are referenced or manipulated by the command. In the CLP, Managed Elements have the following aspects: • Properties These are properties of the Managed Element itself and are described in more detail in 136H5.1.4. • Contained Targets This is the set of Managed Elements immediately contained in the Managed Element according to the rules of instance containment described in 137H5.1.3.5. • Associations This is the set of associations that reference the Managed Element. They are described in more detail in 138H5.1.5. • Verbs This is the set of commands that are applicable to the Managed Element. The SM CLP verbs are described in Clause 139H6. 5.1.3.5 Target Addressing CLP target addressing is defined by 140H5HDSP0215. CLP implementations shall operate only on command target terms that adhere to 141H5HDSP0215 or to the rules for identifying OEM targets described in 142H5.2.6. The specific arrangements of Managed Elements that a MAP may expose are documented in 143H5HDSP0215 and SMASH Implementation Requirements (144H33HDSP0217). The SM CLP separates Managed Elements into two categories of targets: CLP Targets and OEM Targets. CLP Targets are Managed Elements whose properties, behavior, UFcT, and so on are wholly defined by the profiles approved for use with the CLP. OEM Targets are Managed Elements whose properties, behavior, UFcT, and so on are outside the scope of the profiles approved for use with the CLP and are vendor dependent. 5.1.3.6 Aggregated Targets Command targets may be an aggregation of underlying components. These underlying components may be visible in the address space of the MAP. When the command target is composed of aggregated parts, the Command Processor shall interpret the command for the aggregated target as a single job and return a Command Response accordingly. The implementation may rely on the target Managed Element to implement the aggregated command function. One example of an aggregated target is an operating system. When a user issues a stop to an operating system instance, a single job is spawned. The operating system may attempt to shut down applications running within it. This action taken by the operating system is not modeled with jobs, and the results for individual applications are not displayed in the Command Results. 20 Version 1.0.2
Server Management Command Line Protocol (SM CLP) Specification 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 5.1.3.7 Target Grouping by Class "Grouping" describes the ability of a user to explicitly select more than one target for a command at the time the command is issued. The only method defined by the CLP for addressing multiple targets with a single command is Target Class Addressing. If the final term of the command target term is a UFsT, in general the Command Processor interprets the command target term as a selector for all Managed Elements of the class specified that are in the immediate container. Implementations shall support Target Class Addressing for the show command. Implementations may support Target Class Addressing for the create and delete commands. Implementations shall not support Target Class Addressing for CLP commands other than the show, create, and delete commands. When Target Class Addressing is utilized for a command, the implementation shall select the instances to be the target of the command by using the Rules for Selecting Instances by UFcT defined in 145H5HDSP0215, where the Selection UFcT is the UFcT identified by the UFsT specified in the command target term. EXAMPLE The command target term "/system3/disk*" instructs the Command Processor to issue the command for all targets with an UFcT of "disk" in the container "/system3". 5.1.4 Command Target Properties Target properties are identifying and descriptive information related to and defined by the target. Target properties are identified by property names. Each class of target defines a set of valid property names. Valid property names are found in the CIM Schema Managed Object Files (MOFs). Vendors may support vendor-specific property names according to the rules defined in 146H5.2.6 of this specification. The SM CLP recognizes three categories of properties: • Required Properties are properties that the profile defining the class of the target deems required for compliance with the profile. These properties will be present for the instance across implementations. • Core Properties are properties that are defined for the class of the target in the CIM schema. The profile that defines the class does not require these properties; however, they may be used because they are defined in the MOF. Note that this includes any deprecated properties which are still defined in the MOF. They may be present across implementations. • OEM Properties are properties defined by an OEM vendor for a target. These properties will not be consistent across different vendors’ implementations. 5.1.5 Associations 147H5HDSP0215 specifies the Association Classes that may be used to construct paths to address any Managed Element appearing within the scope of the MAP. 148H5HDSP0215 identifies these as Addressing Associations. Additional associations that are not used for addressing may exist and express relationships between Managed Elements. 149H5HDSP0215 identifies these as Non-addressing Associations. Associations represent a special type of target. Association instances are not assigned UFiTs. For a given association class, instances are uniquely identified by the Managed Element instances they reference. They can be addressed using an extension of the target addressing syntax. 150H5.2.1.3.5 describes how to use the association separator "=>" to address association instances. 151H6.10 and 152H6.11 illustrate the use of the set and show commands, respectively. Associations have properties which follow the rules for Command Target Properties as identified in 153H5.1.4. 5.1.6 Command Processing This clause states the requirements for the processing of a CLP Command Line. Version 1.0.2 21
Page 1 and 2: 1 2 3 4 Document Number: DSP0214 Da
Page 3 and 4: Server Management Command Line Prot
Page 19: Server Management Command Line Prot
Page 71 and 72:
Server Management Command Line Prot
Page 73 and 74:
Page 75 and 76:
Page 77 and 78:
Page 79 and 80:
Page 81 and 82:
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?