《ANSI-INCITS-411-2007.pdf》由会员分享，可在线阅读，更多相关《ANSI-INCITS-411-2007.pdf（271页珍藏版）》请在三一文库上搜索。
1、American National Standard Developed by for Information Technology iSCSI Management API ANSI INCITS 411-2007 ANSI INCITS 411-2007 Copyright American National Standards Institute Provided by IHS under license with ANSI Licensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02
2、:26:32 MDTNo reproduction or networking permitted without license from IHS -,-,- Copyright American National Standards Institute Provided by IHS under license with ANSI Licensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:26:32 MDTNo reproduction or networking permitted
3、 without license from IHS -,-,- ANSI INCITS 411-2007 American National Standard for Information Technology iSCSI Management API Secretariat Information Technology Industry Council Approved August 17, 2007 American National Standards Institute, Inc. Copyright American National Standards Institute Pro
4、vided by IHS under license with ANSI Licensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:26:32 MDTNo reproduction or networking permitted without license from IHS -,-,- Approval of an American National Standard requires review by ANSI that the requirements for due proc
5、ess, consensus, and other criteria for approval have been met by the standards developer. Consensus is established when, in the judgement of the ANSI Board of Standards Review, substantial agreement has been reached by directly and materially affected interests. Substantial agreement means much more
6、 than a simple majority, but not necessarily unanimity. Consensus requires that all views and objections be considered, and that a concerted effort be made towards their resolution. The use of American National Standards is completely voluntary; their existence does not in any respect preclude anyon
7、e, whether he has approved the standards or not, from manufacturing, marketing, purchasing, or using products, processes, or procedures not conforming to the standards. The American National Standards Institute does not develop standards and will in no circumstances give an interpretation of any Ame
8、rican National Standard. Moreover, no person shall have the right or authority to issue an interpretation of an American National Standard in the name of the American National Standards Institute. Requests for interpretations should be addressed to the secretariat or sponsor whose name appears on th
9、e title page of this standard. CAUTION NOTICE: This American National Standard may be revised or withdrawn at any time. The procedures of the American National Standards Institute require that action be taken periodically to reaffirm, revise, or withdraw this standard. Purchasers of American Nationa
10、l Standards may receive current information on all standards by calling or writing the American National Standards Institute. American National Standard Published by American National Standards Institute, Inc. 25 West 43rd Street, New York, NY 10036 Copyright 2006 by Information Technology Industry
11、Council (ITI) All rights reserved. No part of this publication may be reproduced in any form, in an electronic retrieval system or otherwise, without prior written permission of ITI, 1250 Eye Street NW, Washington, DC 20005. Printed in the United States of America CAUTION: The developers of this sta
12、ndard have requested that holders of patents that may be required for the implementation of the standard disclose such patents to the publisher. However, neither the developers nor the publisher have undertaken a patent search in order to identify which, if any, patents may apply to this standard. A
13、s of the date of publication of this standard and following calls for the identification of patents that may be required for the implementation of the 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 processe
14、s. No representation is made or implied that licenses are not required to avoid infringement in the use of this standard. Copyright American National Standards Institute Provided by IHS under license with ANSI Licensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:26:32 M
15、DTNo reproduction or networking permitted without license from IHS -,-,- i Contents Page Foreword.vi Introduction .ix 1Scope. 1 2References. 2 3Document Conventions 3 3.1API Description Format 3 4Background Technical Information 4 4.1Terms. 4 4.2Concepts 7 5Constants and Types. 15 5.1IMA_WCHAR. 15 5
16、.2IMA_BYTE. 15 5.3IMA_BOOL. 15 5.4IMA_XBOOL 15 5.5IMA_UINT 15 5.6IMA_UINT16 15 5.7IMA_UINT32 15 5.8IMA_UINT64 15 5.9IMA_DATETIME 16 5.10IMA_OBJECT_VISIBILITY_FN 17 5.11IMA_OBJECT_PROPERTY_FN 18 5.12IMA_OBJECT_TYPE. 19 5.13IMA_STATUS 21 5.14IMA_OID 25 5.15IMA_OID_LIST. 26 5.16IMA_NODE_NAME 27 5.17IMA
17、_NODE_ALIAS 28 5.18IMA_IP_ADDRESS 29 5.19IMA_HOST_NAME 30 5.20IMA_HOST_ID. 31 5.21IMA_TARGET_ADDRESS. 32 5.22IMA_ADDRESS_KEY 33 5.23IMA_ADDRESS_KEYS 34 5.24IMA_STATIC_DISCOVERY_TARGET 35 Copyright American National Standards Institute Provided by IHS under license with ANSI Licensee=IHS Employees/11
18、11111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:26:32 MDTNo reproduction or networking permitted without license from IHS -,-,- ii Page 5.25IMA_DISCOVERY_ADDRESS_PROPERTIES. 36 5.26IMA_STATIC_DISCOVERY_TARGET_PROPERTIES. 37 5.27IMA_IP_PROPERTIES 38 5.28IMA_LIBRARY_PROPERTIES 41 5.29IMA_PLU
19、GIN_PROPERTIES 42 5.30IMA_NODE_PROPERTIES. 43 5.31IMA_LHBA_PROPERTIES 45 5.32Upper Level Protocol (ULP) Flags. 47 5.33IMA_PHBA_PROPERTIES . 48 5.34IMA_DISCOVERY_PROPERTIES 51 5.35IMA_PHBA_DOWNLOAD_IMAGE_TYPE 53 5.36IMA_PHBA_DOWNLOAD_IMAGE_PROPERTIES. 54 5.37IMA_ISNS_DISCOVERY_METHOD . 55 5.38IMA_PHB
20、A_DOWNLOAD_PROPERTIES 56 5.39IMA_IPSEC_PROPERTIES 57 5.40IMA_MIN_MAX_VALUE 58 5.41IMA_BOOL_VALUE. 60 5.42IMA_MAC_ADDRESS. 61 5.43IMA_LNP_PROPERTIES 62 5.44IMA_PNP_PROPERTIES 63 5.45IMA_PNP_STATISTICS 65 5.46IMA_NETWORK_PORTAL_PROPERTIES 66 5.47IMA_PHBA_STATUS 67 5.48IMA_ NETWORK_PORT_STATUS. 68 5.49
21、IMA_TARGET_DISCOVERY_METHOD. 70 5.50IMA_TARGET_PROPERTIES. 71 5.51IMA_TARGET_ERROR_STATISTICS 73 5.52IMA_LU_PROPERTIES. 75 5.53IMA_DEVICE_STATISTICS 77 5.54IMA_STATISTICS_PROPERTIES 78 5.55IMA_AUTHMETHOD. 79 5.56IMA_CHAP_INITIATOR_AUTHPARMS 80 5.57IMA_SRP_INITIATOR_AUTHPARMS. 82 5.58IMA_KRB5_INITIAT
22、OR_AUTHPARMS. 83 5.59IMA_SPKM_INITIATOR_AUTHPARMS 84 Copyright American National Standards Institute Provided by IHS under license with ANSI Licensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:26:32 MDTNo reproduction or networking permitted without license from IHS -,
23、-,- iii Page 5.60IMA_INITIATOR_AUTHPARMS 85 6APIs86 6.1APIs by Category.87 6.1.1Library and Plugin APIs87 6.1.2Node APIs87 6.1.3Logical HBA APIs.87 6.1.4Physical HBA APIs.89 6.1.5Network Portal APIs.89 6.1.6Logical Network Port (LNP) APIs.89 6.1.7Physical Network Port (PNP) APIs.90 6.1.8Target APIs9
24、0 6.1.9Logical Unit (LU) APIs91 6.1.10Miscellaneous APIs91 6.2APIs by Name93 6.2.1IMA_AddDiscoveryAddress .95 6.2.2IMA_AddStaticDiscoveryTarget .97 6.2.3IMA_DeregisterForObjectPropertyChanges 99 6.2.4IMA_DeregisterForObjectVisibilityChanges.100 6.2.5IMA_ExposeLu.101 6.2.6IMA_FreeMemory 103 6.2.7IMA_
25、GenerateNodeName104 6.2.8IMA_GetAddressKeys105 6.2.9IMA_GetAssociatedPluginOid106 6.2.10IMA_GetDataPduInOrderProperties 107 6.2.11IMA_GetDataSequenceInOrderProperties.108 6.2.12IMA_GetDefaultTime2RetainProperties.109 6.2.13IMA_GetDefaultTime2WaitProperties110 6.2.14IMA_GetDeviceStatistics111 6.2.15I
26、MA_GetDiscoveryAddressOidList.113 6.2.16IMA_GetDiscoveryAddressProperties115 6.2.17IMA_GetDiscoveryProperties.116 6.2.18IMA_GetErrorRecoveryLevelProperties.118 6.2.19IMA_GetFirstBurstLengthProperties119 6.2.20IMA_GetImmediateDataProperties120 6.2.21IMA_GetInitialR2TProperties .121 6.2.22IMA_GetIniti
27、atorAuthParms .122 6.2.23IMA_GetInUseInitiatorAuthMethods.124 6.2.24IMA_GetIpProperties126 6.2.25IMA_GetIpsecProperties127 6.2.26IMA_GetLhbaOidList128 6.2.27IMA_GetLhbaProperties.129 6.2.28IMA_GetLibraryProperties130 6.2.29IMA_GetLnpOidList131 6.2.30IMA_GetLnpProperties.132 6.2.31IMA_GetLuOid .133 6
28、.2.32IMA_GetLuOidList135 6.2.33IMA_GetLuProperties.137 6.2.34IMA_GetMaxBurstLengthProperties 138 6.2.35IMA_GetMaxConnectionsProperties139 6.2.36IMA_GetMaxOutstandingR2TProperties140 Copyright American National Standards Institute Provided by IHS under license with ANSI Licensee=IHS Employees/1111111
29、001, User=Wing, Bernie Not for Resale, 10/05/2007 02:26:32 MDTNo reproduction or networking permitted without license from IHS -,-,- iv Page 6.2.37IMA_GetMaxRecvDataSegmentLengthProperties 141 6.2.38IMA_GetNetworkPortalOidList. 142 6.2.39IMA_GetNetworkPortalProperties 143 6.2.40IMA_GetNetworkPortSta
30、tus. 144 6.2.41IMA_GetNodeProperties 145 6.2.42IMA_GetNonSharedNodeOidList. 146 6.2.43IMA_GetObjectType 147 6.2.44IMA_GetPhbaDownloadProperties 148 6.2.45IMA_GetPhbaOidList. 149 6.2.46IMA_GetPhbaProperties 150 6.2.47IMA_GetPhbaStatus 151 6.2.48IMA_GetPluginOidList . 152 6.2.49IMA_GetPluginProperties
31、 153 6.2.50IMA_GetPnpOidList. 154 6.2.51IMA_GetPnpProperties 155 6.2.52IMA_GetPnpStatistics 156 6.2.53IMA_GetSharedNodeOid. 158 6.2.54IMA_GetStaticDiscoveryTargetOidList 159 6.2.55IMA_GetStaticDiscoveryTargetProperties. 161 6.2.56IMA_GetStatisticsProperties 162 6.2.57IMA_GetSupportedAuthMethods. 163
32、 6.2.58IMA_GetTargetErrorStatistics 165 6.2.59IMA_GetTargetOidList. 167 6.2.60IMA_GetTargetProperties 169 6.2.61IMA_IsPhbaDownloadFile . 170 6.2.62IMA_LuInquiry 171 6.2.63IMA_LuReadCapacity 174 6.2.64IMA_LuReportLuns 176 6.2.65IMA_PhbaDownload 179 6.2.66IMA_PluginIOCtl 181 6.2.67IMA_RegisterForObjec
33、tPropertyChanges . 183 6.2.68IMA_RegisterForObjectVisibilityChanges 184 6.2.69IMA_RemoveDiscoveryAddress 185 6.2.70IMA_RemoveStaleData . 186 6.2.71IMA_RemoveStaticDiscoveryTarget 187 6.2.72IMA_SetDataPduInOrder. 188 6.2.73IMA_SetDataSequenceInOrder. 190 6.2.74IMA_SetDefaultGateway . 192 6.2.75IMA_Se
34、tDefaultTime2Retain . 193 6.2.76IMA_SetDefaultTime2Wait 195 6.2.77IMA_SetDnsServerAddress. 197 6.2.78IMA_SetErrorRecoveryLevel . 199 6.2.79IMA_SetFirstBurstLength. 201 6.2.80IMA_SetImmediateData. 203 6.2.81IMA_SetInitialR2T 205 6.2.82IMA_SetInitiatorAuthMethods 206 6.2.83IMA_SetInitiatorAuthParms .
35、208 6.2.84IMA_SetIpConfigMethod 210 6.2.85IMA_SetIsnsDiscovery. 212 6.2.86IMA_SetMaxBurstLength. 214 6.2.87IMA_SetMaxConnections 216 6.2.88IMA_SetMaxRecvDataSegmentLength. 218 Copyright American National Standards Institute Provided by IHS under license with ANSI Licensee=IHS Employees/1111111001, U
36、ser=Wing, Bernie Not for Resale, 10/05/2007 02:26:32 MDTNo reproduction or networking permitted without license from IHS -,-,- v Page 6.2.89IMA_SetMaxOutstandingR2T 220 6.2.90IMA_SetNetworkPortalIpAddress.222 6.2.91IMA_SetNodeAlias.224 6.2.92IMA_SetNodeName.226 6.2.93IMA_SetSendTargetsDiscovery.228
37、6.2.94IMA_SetSlpDiscovery 230 6.2.95IMA_SetStaticDiscovery.232 6.2.96IMA_SetStatisticsCollection .234 6.2.97IMA_SetSubnetMask .236 6.2.98IMA_UnexposeLu.237 7Implementation Compliance.239 8Notes240 8.1Client Usage Notes240 8.2Library Implementation Notes241 8.3Plugin Implementation Notes.241 Annexes
38、A Device Names244 A.1 osDeviceName Field of the IMA_LHBA_PROPERTIES Structure 244 A.2 osDeviceName Field of the IMA_LU_PROPERTIES Structure .244 B Coding Examples.245 B.1 Example of Getting Library Properties.246 B.2 Example of Getting Plugin Properties247 B.3 Example of Getting an Associated Plugin
39、 ID .248 B.4 Example of Getting Node Properties249 B.5 Example of Setting a Node Name250 B.6 Example of Getting LHBA Properties.251 B.7 Example of Getting PHBA Properties 252 B.8 Example of Getting PHBA Discovery Properties253 B.9 Example of Getting/Setting LHBA Max Burst Length.254 B.10Example of G
40、etting all LUs of all Targets Visible to a System .255 Copyright American National Standards Institute Provided by IHS under license with ANSI Licensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:26:32 MDTNo reproduction or networking permitted without license from IHS
41、-,-,- vi Foreword (This foreword is not part of American National Standard ANSI INCITS 411-2007.) This standard documents an API that allows a management application to discover and manage the iSCSI resources on a system. The API uses an architecture that al- lows multiple iSCSI HBAs, sometimes refe
42、rred to as hardware initiators, and/or multi- ple iSCSI software initiators installed on a system to provide a common interface to clients of the library. This API can be used by host-based management applications. A client of the API should be able to move between platforms by simply recompiling. T
43、his standard includes two informative annexes, which are not considered part of the standard Requests for interpretation, suggestions for improvement and addenda, or defect re- ports are welcome. They should be sent to the INCITS Secretariat, National Commit- tee for Information Technology Standards
44、, Information Technology Institute, 1250 Eye Street, NW, Suite 200, Washington, DC 20005-3922. This standard was processed and approved for submittal to ANSI by the InterNation- al Committee for Information Technology Standards (INCITS). Committee approval of the standard does not necessarily imply
45、that all committee members voted for its approval. At the time it approved this standard, INCITS had the following members: Karen Higginbottom, Chair Jennifer Garner, Secretary Organization Represented Name of Representative AIM GlobalDan Mullen Charles Biss (Alt.) Apple Computer, Inc.David Michael
46、Electronic Industries AllianceEdward Mikoski, Jr. David Thompson (Alt.) EMC CorporationGary Robinson Farance, IncFrank Farance Timothy Schoechle (Alt.) GS1 US Frank Sharkey James Chronowski (Alt.) Mary Wilson (Alt.) Hewlett-Packard Company.Karen Higginbottom Steve Mills (Alt.) Scott Jameson (Alt.) I
47、BM Corporation .Ronald F. Silletti Peter Schirling (Alt.) IEEE .Judith Gorman Terry DeCourcelle (Alt.) Bill Ash (Alt.) Jodi Haasz (Alt.) Bob Labelle (Alt.) Intel.Philip Wennblom Dave Thewlis (Alt.) Jesse Walker (Alt.) Grace Wei (Alt.) Lexmark International.Don Wright Dwight Lewis (Alt.) Paul Menard
48、(Alt.) Microsoft Corporation .Jim Hughes Don Stanwyck (Alt.) Isabelle Valet-Harper (Alt.) National Institute of Standards some implementations will have the ability to combine connections in a 5 Copyright American National Standards Institute Provided by IHS under license with ANSI Licensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:26:32 MDTNo reproduction or networking permitted without license from IHS -,-,- ANSI