ANSI INCITS 438-2008 Information Technology C Server Management Command Line Protocol (SM CLP) Specification.pdf

1、American National StandardDeveloped byfor Information Technology Server ManagementCommand Line Protocol(SM CLP) SpecificationANSI INCITS 438-2008ANSIINCITS438-2008ANSIINCITS 438-2008American National Standardfor Information Technology Server ManagementCommand Line Protocol(SM CLP) SpecificationSecre

2、tariatInformation Technology Industry CouncilApproved January 9, 2008American National Standards Institute, Inc.Approval of an American National Standard requires review by ANSI that therequirements for due process, consensus, and other criteria for approval havebeen met by the standards developer.C

3、onsensus is established when, in the judgement of the ANSI Board ofStandards Review, substantial agreement has been reached by directly andmaterially affected interests. Substantial agreement means much more thana simple majority, but not necessarily unanimity. Consensus requires that allviews and o

4、bjections be considered, and that a concerted effort be madetowards their resolution.The use of American National Standards is completely voluntary; theirexistence does not in any respect preclude anyone, whether he has approvedthe standards or not, from manufacturing, marketing, purchasing, or usin

5、gproducts, processes, or procedures not conforming to the standards.The American National Standards Institute does not develop standards andwill in no circumstances give an interpretation of any American NationalStandard. Moreover, no person shall have the right or authority to issue aninterpretatio

6、n of an American National Standard in the name of the AmericanNational Standards Institute. Requests for interpretations should beaddressed to the secretariat or sponsor whose name appears on the titlepage of this standard.CAUTION NOTICE: This American National Standard may be revised orwithdrawn at

7、 any time. The procedures of the American National StandardsInstitute require that action be taken periodically to reaffirm, revise, orwithdraw this standard. Purchasers of American National Standards mayreceive current information on all standards by calling or writing the AmericanNational Standard

8、s Institute.American National StandardPublished byAmerican National Standards Institute, Inc.25 West 43rd Street, New York, NY 10036Copyright 2008 by Information Technology Industry Council (ITI)All rights reserved.No part of this publication may be reproduced in anyform, in an electronic retrieval

9、system or otherwise,without prior written permission of ITI, 1250 Eye Street NW, Washington, DC 20005. Printed in the United States of AmericaCAUTION: The developers of this standard have requested that holders of patents that may berequired for the implementation of the standard disclose such paten

10、ts to the publisher. However,neither the developers nor the publisher have undertaken a patent search in order to identifywhich, if any, patents may apply to this standard. As of the date of publication of this standardand following calls for the identification of patents that may be required for th

11、e implementation ofthe standard, no such claims have been made. No further patent search is conducted by the de-veloper or publisher in respect to any standard it processes. No representation is made or impliedthat licenses are not required to avoid infringement in the use of this standard.iContents

12、PageForeword . iiiIntroduction .vi1 Scope. 12 Normative References . 13 Terms and Definitions 24 Symbols and Abbreviated Terms. 75 Server Management Command Line Protocol (SM CLP) Specification. 85.1 Semantics 85.2 Syntax 186 SM CLP Verbs . 416.1 Verb Support Requirements 426.2 cd . 436.3 create. 47

13、6.4 delete . 516.5 dump 576.6 exit . 636.7 help 656.8 load 676.9 reset. 716.10 set 746.11 show. 826.12 start 1106.13 stop 1136.14 version . 1177 Standard Command Options . 1197.1 General 1197.2 all . 1227.3 destination 1227.4 display 1227.5 examine . 1257.6 force. 1267.7 help 1267.8 keep . 126iiPage

14、7.9 level . 1277.10 output. 1287.11 source 1337.12 version . 1337.13 wait 1348 SM CLP Session 1348.1 Authentication, Authorization, and Audit 1348.2 CLP Session 1358.3 Transport . 141AnnexesA SM CLP Command Grammar in ABNF Notation (RFC2234) 143B W3C Universal Resource Identifiers (URI) 149C W3C Ext

15、ensible Markup Language (XML) 150D POSIX Utility Conventions . 151E Conventions. 153F Notation . 154G Bibliography . 155Tables1 CLP Reserved Characters and Character Sequences 192 Common Output Keywords 273 Command Status Keywords 274 Command Status Values and Tags . 285 Message Keywords . 286 Proce

16、ssing Error Values and Tags 297 Job Error Keywords . 308 Error Type Values and Descriptions 309 CIM Status Code Values and Descriptions 3110 Severity Values and Descriptions 3211 Probable Cause Values and Descriptions . 3312 Verb Support Requirements 4213 Data Element Types and all Option . 8414 Sta

17、ndard Command Options . 12015 Verb and Option Support . 12116 Output Option Arguments 12817 Output Options for Controlling Command Status Output. 133iiiPage18 Command Authorizations for CLP Groups. 13519 Telnet Transport Support Requirements 141Figures1 Session Establishment Sequence 1372 Command In

18、teraction Sequences 1383 Session Switching Sequences. 1394 Session Termination Sequences . 140ivForeword (This foreword is not part of American National Standard ANSI INCITS 438-2008.)The Server Management Command Line Protocol (SM CLP) Specification(DSP0214) was prepared by the Server Management Wo

19、rking Group. This docu-ment was prepared in accordance with ISO/IEC Directives, Part 2: Rules for thestructure and drafting of International Standards.The Server Management Command Line Protocol (SM CLP) Specification specifies acommon command line syntax and message protocol semantics for managing

20、com-puter resources in Internet, enterprise, and service provider environments.DMTF is a not-for-profit association of industry members dedicated to promoting en-terprise and systems management and interoperability. This standard contains seven annexes. Annex A is normative and is considered partof

21、this standard. The other annexes are informative and are not considered part ofthis standard.Requests for interpretation, suggestions for improvement or addenda, or defect re-ports are welcome. They should be sent to InterNational Committee for InformationTechnology Standards (INCITS), ITI, 1250 Eye

22、 Street, NW, Suite 200, Washington,DC 20005.This standard was processed and approved for submittal to ANSI by INCITS. Com-mittee approval of this standard does not necessarily imply that all committee mem-bers voted for its approval. At the time it approved this standard, INCITS had thefollowing mem

23、bers:Karen Higginbottom, ChairJennifer Garner, SecretaryOrganization Represented Name of RepresentativeAdobe Systems, Inc. Leslie BixelSteve Ziles (Alt.)AIM Global, Inc. Dan MullenCharles Biss (Alt.)Apple Computer, Inc. David MichaelElectronic Industries Alliance . Edward Mikoski, Jr.David Thompson

24、(Alt.)EMC Corporation Gary RobinsonFarance, Inc. Frank FaranceTimothy Schoechle (Alt.)GS1 US Frank SharkeyJames Chronowski (Alt.)Mary Wilson (Alt.)Hewlett-Packard Company. Karen HigginbottomSteve Mills (Alt.)Scott Jameson (Alt.)IBM Corporation . Ronald F. SillettiRobert Weir (Alt.)Sandy Block (Alt.)

25、Richard Schwerdtfeger (Alt.)IEEE . Judith GormanTerry DeCourcelle (Alt.)Bill Ash (Alt.)Jodi Haasz (Alt.)Bob Labelle (Alt.)Intel. Philip WennblomDave Thewlis (Alt.)Jesse Walker (Alt.)Grace Wei (Alt.)vOrganization Represented Name of RepresentativeLexmark InternationalDon WrightDwight Lewis (Alt.)Paul

26、 Menard (Alt.)Microsoft CorporationJim HughesDon Stanwyck (Alt.)Isabelle Valet-Harper (Alt.)National Institute of Standards the CLP Service implementa-tion is the other. CLP Service implementations manage the transport and the ses-sions that occur over the transport as required by DSP1005. Authentic

27、ation, Authorization, and EncryptionThe CLP Service does not perform any authentication or encryption. It relies entirelyon the transport to perform these functions. Session transport requirements are doc-umented in 8.3.To accommodate a single basis for user authorization, the user account database

28、re-quired by the transport is expected to share the user information with the CLP Ser-vice once the user is logged in. For more information, see 8.3.The CLP Service authorizes commands through the use of authorization groups.Each CLP User shall be a member of at least one CLP Group. For more informa

29、tion,see 8.1.The CLP contains commands for the creation, removal, and modification of user ac-counts, including authorization and access rights. For more information, see Clause6.SessionsSessions between a Client and a CLP Service are established over a transport proto-col. After the session has bee

30、n authenticated, the Client can begin to submit com-mands using the CLP Service. Each session has a unique context within the MAP.Within this context, the CLP Service keeps track of session characteristics. Imple-ixmentations will maintain a session context and session characteristics as required by

31、DSP1005. Examples of these characteristics include the Current Default Target, cur-rently selected output mode, current output language, and the current user and ses-sion identifier. Commands for manipulating the session characteristics are includedin the CLP. For more information, see 8.2.2.Input E

32、ditingThe CLP is a command/response protocol. CLP implementations shall receive andparse an entire Command Line, complete with verb, command target term, options,and properties. The CLP Service shall not allow any interactive input or data editing.This does not preclude a vendor from providing such

33、capability associated with theClient implementation, but any such capability is outside of the scope of this specifi-cation.Command Line Protocol Service The CLP Service is responsible for providing and enforcing the syntax and semanticsof the CLP. Implementations will support being managed as requi

34、red by DSP1005.This includes starting, stopping, and changing the attributes of the service.CLP Service Access PointThe transport session is established to the CLP Service Access Point (SAP). The ac-cess point represents the physical and logical communication mechanism throughwhich the CLP Service r

35、eceives incoming connection requests. The CLP providesthe mechanisms necessary to enable, disable, and configure the SAP. Implementa-tions will support managing the supporting protocol stacks as required by DSP1005.Operation ManagementAll commands submitted through the CLP Service create jobs within

36、 the MAP. Thereis one and only one global job queue within the MAP. Implementations shall track alljobs using this single job queue. Operations follow the CIM_Job schema, as defined in later sections. The CLP sup-ports commands to query jobs, retrieve the interim status of jobs, retrieve the finalst

37、atus of jobs, and delete jobs. Operations are covered further in 5.1.6. Use CasesThis section describes the intended features, functions, and uses of the CLP. Notethat the CLP is not limited to these functions, but these are the specific uses for whichthe CLP was intended.The CLP is designed to appl

38、y to a number of server topologies. This includes, but isnot limited to, stand-alone servers, rack-mounted servers, blades, partitioned serv-ers, and Telco servers. It is also suitable to manage any necessary enterprise com-ponents, enclosures, chassis, racks, and power supplies necessary to utilize

39、 servers.The CLP provides the ability to enumerate and configure server hardware. This in-cludes discovery of the current hardware configuration and properties, system set-tings, and local IO devices. The CLP provides some amount of configuration for localdisk drives, including local arrays. The int

40、ention of providing this support is to allowinitial logical unit creation for installation, provisioning, or both. It is not intended thatthe CLP Service be the primary interface for managing mass storage, because thesestandards and access points exist in the industry.xThe CLP also includes the abil

41、ity to select, control, and initiate the transfer of images.Also provided is the ability to control the boot configuration of any supported server.In addition, support for heartbeat and operating-system-status information is includ-ed.Server state control is included in the CLP. This includes power

42、control, interventioncapability (to halt, reset, or shut down a server), and mechanisms to initiate a dumpof the operating system.Access to some system resources is also included in the CLP. This includes accessand manipulation of any accessible logs; the ability to view and set remote status dis-pl

43、ays, LEDs, and alarms; the ability to configure alert destinations; and the ability toinitiate a session with a remote text-based console device.The CLP also supports normal expected user session functions such as help, versioninformation, and the ability to exit or terminate a session.Known Limitat

44、ionsFirst and foremost, while CLP commands are mapped to CIM methods and opera-tions, the CLP is not intended to be a complete mapping to every CIM method, prop-erty, or operation. The CLP supports a sufficient subset of CIM Server features toenable the CLP to be the primary locus of interaction for

45、 server management, regard-less of server type, physical connection, or operating system state.Another known limitation pertains to the intended Client. The CLP is primarily fo-cused on an interactive experience with a human user or simple script. It is not in-tended to be the primary interface for

46、advanced server management software to useto manage hardware. Consequently, the format of the commands and their respons-es, as well as the CIM methods, properties, and operations supported, are not al-ways sufficient for the CLP Service Access Point to be the primary interface foradvanced server ma

47、nagement software.AMERICAN NATIONAL STANDARD ANSI INCITS 438-2008American National Standard for Information Technology Server Management Command Line Protocol (SM CLP) Specification 1 1 Scope This document lays out the general framework for the Server Management Command Line Protocol (SM CLP). This

48、specification is intended to guide developers of implementations of the SM CLP and optionally be used as a reference by system administrators and other users of SM CLP implementations. The following subjects are within the scope of this document: Command Line Protocol syntax and semantics input form

49、at and output format accessing and traversing the target address space error handling and semantics session management, including mapping to supported transports session characteristics operation processing and reporting The following subjects are outside the scope of this document: control command verbs, such as loop control, conditionals, or prompting regular expressions, such as mathematical or logical expressions command editor environment Clients shell environment physical interconnects complex data, data types, or objects operation error precedence 2 N