ISO IEC 13187-2011 Information technology - Server management command line protocol (SM CLP) specification《信息技术 服务器管理命令行协议(SM CLP)规范》.pdf

1、 ISO/IEC 13187 Edition 1.0 2011-07 INTERNATIONAL STANDARD Information technology Server management command line protocol (SM CLP) specification ISO/IEC 13187:2011(E) colour inside THIS PUBLICATION IS COPYRIGHT PROTECTED Copyright 2011 ISO/IEC, Geneva, Switzerland All rights reserved. Unless otherwis

2、e specified, no part of this publication may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying and microfilm, without permission in writing from either IEC or IECs member National Committee in the country of the requester. If you have any questio

3、ns about ISO/IEC copyright or have an enquiry about obtaining additional rights to this publication, please contact the address below or your local IEC member National Committee for further information. IEC Central Office 3, rue de Varemb CH-1211 Geneva 20 Switzerland Email: inmailiec.ch Web: www.ie

4、c.ch About the IEC The International Electrotechnical Commission (IEC) is the leading global organization that prepares and publishes International Standards for all electrical, electronic and related technologies. About IEC publications The technical content of IEC publications is kept under consta

5、nt review by the IEC. Please make sure that you have the latest edition, a corrigenda or an amendment might have been published. Catalogue of IEC publications: www.iec.ch/searchpub The IEC on-line Catalogue enables you to search by a variety of criteria (reference number, text, technical committee,)

6、. It also gives information on projects, withdrawn and replaced publications. IEC Just Published: www.iec.ch/online_news/justpub Stay up to date on all new IEC publications. Just Published details twice a month all new publications released. Available on-line and also by email. Electropedia: www.ele

7、ctropedia.org The worlds leading online dictionary of electronic and electrical terms containing more than 20 000 terms and definitions in English and French, with equivalent terms in additional languages. Also known as the International Electrotechnical Vocabulary online. Customer Service Centre: w

8、ww.iec.ch/webstore/custserv If you wish to give us your feedback on this publication or need further assistance, please visit the Customer Service Centre FAQ or contact us: Email: csciec.ch Tel.: +41 22 919 02 11 Fax: +41 22 919 03 00 ISO/IEC 13187 Edition 1.0 2011-07 INTERNATIONAL STANDARD Informat

9、ion technology Server management command line protocol (SM CLP) specification INTERNATIONAL ELECTROTECHNICAL COMMISSION XC ICS 35.200 PRICE CODE ISBN 978-2-88912-577-7 colour inside 2 13187 ISO/IEC:2011(E) CONTENTS FOREWORD . 7 1 Scope . 9 2 Normative references . 9 3 Terms and definitions . 10 4 Ab

10、breviations . 14 5 Server Management Command Line Protocol (SM CLP) Specification 15 5.1 Semantics . 15 5.1.1 General . 15 5.1.2 Command verb 15 5.1.3 Command options 15 5.1.4 Command target 15 5.1.5 Command target properties . 18 5.1.6 Associations 19 5.1.7 Command processing 19 5.1.8 SESSION reser

11、ved target 21 5.1.9 Input data 21 5.1.10 Output data . 21 5.1.11 Session prompt . 25 5.1.12 Extending the command line protocol 26 5.2 Syntax . 26 5.2.1 General . 26 5.2.2 Basic command syntax 26 5.2.3 Output data schema 34 5.2.4 Command Status data elements 35 5.2.5 Output data formats . 44 5.2.6 I

12、nternationalization/Localization . 46 5.2.7 OEM extensions 47 6 SM CLP verbs 50 6.1 General . 50 6.2 Verb support requirements 50 6.3 cd 51 6.3.1 General . 51 6.3.2 Valid targets 52 6.3.3 Options 52 6.3.4 Output . 52 6.3.5 Examples 53 6.4 create 55 6.4.1 General . 55 6.4.2 Valid targets 56 6.4.3 Opt

13、ions 56 6.4.4 Output . 56 6.4.5 Examples 57 6.5 delete 59 6.5.1 General . 59 6.5.2 Valid targets 60 6.5.3 Options 60 13187 ISO/IEC:2011(E) 3 6.5.4 Output . 60 6.5.5 Examples 61 6.6 dump . 65 6.6.1 General . 65 6.6.2 Valid targets 65 6.6.3 Options 65 6.6.4 Output . 66 6.6.5 Examples 67 6.7 exit 70 6.

14、7.1 General . 70 6.7.2 Valid targets 71 6.7.3 Options 71 6.7.4 Output . 71 6.7.5 Examples 71 6.8 help . 72 6.8.1 General . 72 6.8.2 Valid targets 72 6.8.3 Options 72 6.8.4 Output . 73 6.8.5 Examples 73 6.9 load . 74 6.9.1 General . 74 6.9.2 Valid targets 75 6.9.3 Options 75 6.9.4 Output . 75 6.9.5 E

15、xamples 76 6.10 reset 78 6.10.1 General . 78 6.10.2 Valid targets 78 6.10.3 Options 78 6.10.4 Output . 78 6.10.5 Examples 79 6.11 set . 80 6.11.1 General . 80 6.11.2 Valid targets 81 6.11.3 Options 81 6.11.4 Output . 81 6.11.5 Examples 82 6.12 show . 88 6.12.1 General . 88 6.12.2 Valid targets 90 6.

16、12.3 Options 90 6.12.4 Output . 91 6.12.5 Examples 93 6.13 start 114 6.13.1 General . 114 6.13.2 Valid targets 115 6.13.3 Options 115 6.13.4 Output . 115 4 13187 ISO/IEC:2011(E) 6.13.5 Examples 116 6.14 stop . 117 6.14.1 General . 117 6.14.2 Valid targets 117 6.14.3 Options 118 6.14.4 General . 118

17、6.14.5 Output . 118 6.14.6 Examples 119 6.15 version 121 6.15.1 General . 121 6.15.2 Valid targets 121 6.15.3 Options 121 6.15.4 Output . 121 6.15.5 Examples 122 7 Standard command options 123 7.1 General . 123 7.2 all 126 7.2.1 General . 126 7.2.2 Forms 126 7.2.3 Example use 126 7.2.4 Behavior 126

18、7.3 destination 126 7.3.1 General . 126 7.3.2 Forms 126 7.3.3 Example Use . 126 7.3.4 Behavior 126 7.4 display 126 7.4.1 Forms 127 7.4.2 Example use 127 7.4.3 Behavior 127 7.5 examine 129 7.5.1 General . 129 7.5.2 Forms 129 7.5.3 Example use 129 7.5.4 Behavior 129 7.6 force 130 7.6.1 General . 130 7

19、.6.2 Forms 130 7.6.3 Example Use . 130 7.6.4 Behavior 130 7.7 help . 130 7.7.1 General . 130 7.7.2 Forms 130 7.7.3 Example use 130 7.7.4 Behavior 130 7.8 keep 131 7.8.1 General . 131 7.8.2 Forms 131 7.8.3 Example use 131 13187 ISO/IEC:2011(E) 5 7.8.4 Behavior 131 7.9 level 131 7.9.1 General . 131 7.

20、9.2 Forms 131 7.9.3 Example use 131 7.9.4 Behavior 132 7.10 output 132 7.10.1 General . 132 7.10.2 Forms 132 7.10.3 Example Use . 133 7.10.4 Behavior 133 7.11 source . 137 7.11.1 General . 137 7.11.2 Forms 137 7.11.3 Example Use . 137 7.11.4 Behavior 137 7.12 version 137 7.12.1 General . 137 7.12.2

21、Forms 138 7.12.3 Example use 138 7.12.4 Behavior 138 7.13 wait . 138 7.13.1 General . 138 7.13.2 Forms 138 7.13.3 Example use 138 7.13.4 Behavior 138 8 SM CLP session . 138 8.1 General . 138 8.2 Authentication, authorization, and audit . 138 8.3 CLP session 139 8.3.1 General . 139 8.3.2 Session envi

22、ronment . 140 8.3.3 CLP service . 140 8.3.4 Initial prompt . 140 8.3.5 CLP interaction model . 140 8.4 Transport 145 8.4.1 General . 145 8.4.2 Telnet 145 8.4.3 Secure Shell (SSH) Version 2 146 Annex A (normative) SM CLP command grammar in ABNF notation ( RFC2234) . 147 Annex B (informative) W3C Univ

23、ersal Resource Identifiers (URI) . 153 Annex C (informative) W3C Extensible Markup Language (XML) . 154 Annex D (informative) POSIX Utility Conventions . 155 Annex E (informative) Conventions 157 Annex F (informative) Notation 158 Bibliography 159 6 13187 ISO/IEC:2011(E) Figure 1 Session establishme

24、nt sequence . 141 Figure 2 Command interaction sequences . 142 Figure 3 Session switching sequences . 143 Figure 4 Session termination sequences 144 Table 1 CLP reserved characters and character sequences . 27 Table 2 Common output keywords . 35 Table 3 Command Status keywords . 35 Table 4 Command S

25、tatus values and tags . 36 Table 5 Message keywords 36 Table 6 Processing error values and tags 37 Table 7 Job Error keywords . 38 Table 8 Error Type values and descriptions . 38 Table 9 CIM Status code values and descriptions 39 Table 10 Severity values and descriptions . 40 Table 11 Probable cause

26、 values and descriptions 41 Table 12 Verb support requirements 51 Table 13 Data element types and all option . 91 Table 14 Standard command options . 124 Table 15 Verb and option support 125 Table 16 Output option arguments . 132 Table 17 Output options for controlling command status output . 137 Ta

27、ble 18 Command authorizations for CLP groups 139 Table 19 Telnet Transport Support Requirements 145 13187 ISO/IEC:2011(E) 7 INTERNATIONAL ELECTROTECHNICAL COMMISSION _ INFORMATION TECHNOLOGY Server management command line protocol (SM CLP) specification FOREWORD 1) ISO (International Organization fo

28、r Standardization) and IEC (International Electrotechnical Commission) form the specialized system for worldwide standardization. National bodies that are members of ISO or IEC participate in the development of International Standards. Their preparation is entrusted to technical committees; any ISO

29、and IEC member body interested in the subject dealt with may participate in this preparatory work. International governmental and non-governmental organizations liaising with ISO and IEC also participate in this preparation. 2) In the field of information technology, ISO and IEC have established a j

30、oint technical committee, ISO/IEC JTC 1. Draft International Standards adopted by the joint technical committee are circulated to national bodies for voting. Publication as an International Standard requires approval by at least 75 % of the national bodies casting a vote. 3) The formal decisions or

31、agreements of IEC and ISO on technical matters express, as nearly as possible, an international consensus of opinion on the relevant subjects since each technical committee has representation from all interested IEC and ISO member bodies. 4) IEC, ISO and ISO/IEC publications have the form of recomme

32、ndations for international use and are accepted by IEC and ISO member bodies in that sense. While all reasonable efforts are made to ensure that the technical content of IEC, ISO and ISO/IEC publications is accurate, IEC or ISO cannot be held responsible for the way in which they are used or for any

33、 misinterpretation by any end user. 5) In order to promote international uniformity, IEC and ISO member bodies undertake to apply IEC, ISO and ISO/IEC publications transparently to the maximum extent possible in their national and regional publications. Any divergence between any ISO/IEC publication

34、 and the corresponding national or regional publication should be clearly indicated in the latter. 6) ISO and IEC provide no marking procedure to indicate their approval and cannot be rendered responsible for any equipment declared to be in conformity with an ISO/IEC publication. 7) All users should

35、 ensure that they have the latest edition of this publication. 8) No liability shall attach to IEC or ISO or its directors, employees, servants or agents including individual experts and members of their technical committees and IEC or ISO member bodies for any personal injury, property damage or ot

36、her damage of any nature whatsoever, whether direct or indirect, or for costs (including legal fees) and expenses arising out of the publication of, use of, or reliance upon, this ISO/IEC publication or any other IEC, ISO or ISO/IEC publications. 9) Attention is drawn to the normative references cit

37、ed in this publication. Use of the referenced publications is indispensable for the correct application of this publication. 10) Attention is drawn to the possibility that some of the elements of this International Standard may be the subject of patent rights. ISO and IEC shall not be held responsib

38、le for identifying any or all such patent rights. International Standard ISO/IEC 13187 was prepared by SNIA (Storage Networking Industry Association 1 ), was adopted, under the fast track procedure, by subcommittee 25: Interconnection of information technology equipment, of ISO/IEC joint technical c

39、ommittee 1: Information technology. _ 1Storage Networking Industry Association, 425 Market Street, Suite 1020, San Francisco, CA 92105, U.S.A. 8 13187 ISO/IEC:2011(E) This International Standard has been approved by vote of the member bodies, and the voting results may be obtained from the address g

40、iven on the second title page. This publication has been drafted in accordance with the ISO/IEC Directives, Part 2. IMPORTANT The colour inside logo on the cover page of this publication indicates that it contains colours which are considered to be useful for the correct understanding of its content

41、s. Users should therefore print this document using a colour printer. 13187 ISO/IEC:2011(E) 9 INFORMATION TECHNOLOGY Server management command line protocol (SM CLP) specification 1 Scope This International Standard lays out the general framework for the Server Management Command Line Protocol (SM C

42、LP). This standard is intended to guide developers of implementations of the SM CLP and may also 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

43、format 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: contro

44、l 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 Normative references

45、 The following referenced documents are indispensable for the application of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies. ISO 639-2, Codes for the Representation of Names

46、 of Languages Part 2: Alpha-3 Code, March 2002 DMTF, Common Information Model (CIM) Schema, version 2.12, April 20, 2006 DMTF, DSP0215, Server Management Managed Element (SM ME) Addressing Specification v1.0, November 10, 2006 DMTF, DSP0216, Command Line Protocol (CLP)-to-Common Information Model (C

47、IM) Mapping Specification, version 1.0, 2005 10 13187 ISO/IEC:2011(E) DMTF, DSP0224, Server Management Command Line Protocol (SM CLP) Command Response XML Schema, v1.0, 2006 DMTF, DSP1005, Command Line Protocol (CLP) Service Profile, v1.0, October 10, 2006 IETF, RFC2234, Augmented BNF for Syntax Spe

48、cifications: ABNF, November 1997 IETF, RFC2396, Uniform Resource Identifiers (URI): Generic Syntax, August 1998 3 Terms and definitions For the purposes of this document, the following terms and definitions apply. 3.1 Absolute Target Address designation of target address that begins at the root of t

49、he containment hierarchy 3.2 Addressing Associations association instance that is used by the MAP to construct the UFiP to an instance referenced by the association instance 3.3 Admin Domain set of Managed Elements, Logical Devices, and Services for which the MAP has management responsibilities 3.4 Association relationship between two Managed Elements, which is itself a manageable entity within the Admin Domain 3.5 Ass