ISO/IEC 11989:2010

Information technology — iSCSI Management API

ISO/IEC 11989:2010(E) specifies an Application Programming Interface (API) that provides interfaces to discover and manage iSCSI resources on a system. This International Standard is applicable to vendors who deliver drivers that provide iSCSI resources to a system.

Technologies de l'information — Interface de programmation de gestion iSCSI

General Information

• Status: Published
• Publication Date: 12-Apr-2010
• ICS: 35.200 - Interface and interconnection equipment
• Technical Committee: ISO/IEC JTC 1/SC 25 - Interconnection of information technology equipment
• Drafting Committee: ISO/IEC JTC 1/SC 25 - Interconnection of information technology equipment
• Current Stage: 9093 - International Standard confirmed
• Completion Date: 13-Jul-2018

Standards Content (Sample)

ISO/IEC 11989
Edition 1.0 2010-03
INTERNATIONAL
STANDARD

colour
inside

Information technology – iSCSI management API


ISO/IEC 11989:2010(E)

---------------------- Page: 1 ----------------------
THIS PUBLICATION IS COPYRIGHT PROTECTED
Copyright © 2010 ISO/IEC, Geneva, Switzerland

All rights reserved. Unless otherwise 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 IEC's member National Committee in the country of the requester.
If you have any questions 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: [e-mail]
Web: www.iec.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 constant 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,…).
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.electropedia.org
The world's 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: www.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: [e-mail]
Tel.: [phone]
Fax: [phone]

---------------------- Page: 2 ----------------------
ISO/IEC 11989
Edition 1.0 2010-03
INTERNATIONAL
STANDARD

colour
inside

Information technology – iSCSI management API



INTERNATIONAL
ELECTROTECHNICAL
COMMISSION
PRICE CODE
XD
ICS 35.200 ISBN 2-8318-1082-5

---------------------- Page: 3 ----------------------
– 2 – 11989 © ISO/IEC:2010(E)
CONTENTS
FOREWORD.10
1 Scope.12
2 Normative references .12
3 Document conventions .12
4 Background technical information .14
4.1 Terms, definitions and abbreviations .14
4.2 Concepts.17
4.2.1 Library and plugins .17
4.2.2 Object ID .18
4.2.3 Object ID list.19
4.2.4 The Shared Node versus Non-shared Nodes .19
4.2.5 Logical HBA .20
4.2.6 Target OIDs and Logical Unit OIDs.20
4.2.7 Software Initiators versus Hardware Initiators.21
4.2.8 iSCSI session and connection parameters.22
4.2.9 Class relationship diagram .23
5 Constants and types.24
5.1 IMA_WCHAR.24
5.2 IMA_BYTE .24
5.3 IMA_BOOL .24
5.4 IMA_XBOOL.24
5.5 IMA_UINT .24
5.6 IMA_UINT16.24
5.7 IMA_UINT32.24
5.8 IMA_UINT64.24
5.9 IMA_DATETIME .24
5.10 IMA_OBJECT_VISIBILITY_FN .24
5.11 IMA_OBJECT_PROPERTY_FN .25
5.12 IMA_OBJECT_TYPE .25
5.12.1 Format.25
5.12.2 Fields .26
5.13 IMA_STATUS .27
5.13.1 Macros .27
5.13.2 Non-error statuses.27
5.13.3 Error statuses.28
5.14 IMA_OID .31
5.14.1 Format.31
5.14.2 Fields .31
5.14.3 Remarks.31
5.15 IMA_OID_LIST .32
5.15.1 Format.32
5.15.2 Fields .32
5.15.3 Remarks.32
5.16 IMA_NODE_NAME.32
5.16.1 Format.32
5.16.2 Remarks.32

---------------------- Page: 4 ----------------------
11989 © ISO/IEC:2010(E) – 3 –
5.17 IMA_NODE_ALIAS .32
5.17.1 Format.32
5.17.2 Remarks.32
5.18 IMA_IP_ADDRESS.33
5.18.1 Format.33
5.18.2 Fields .33
5.19 IMA_HOST_NAME .33
5.19.1 Format.33
5.19.2 Remarks.33
5.20 IMA_HOST_ID.33
5.20.1 Format.33
5.20.2 Fields .34
5.20.3 Remarks.34
5.21 IMA_TARGET_ADDRESS .34
5.21.1 Format.34
5.21.2 Fields .34
5.21.3 Remarks.34
5.22 IMA_ADDRESS_KEY .34
5.22.1 Format.34
5.22.2 Fields .35
5.22.3 Remarks.35
5.23 IMA_ADDRESS_KEYS .35
5.23.1 Format.35
5.23.2 Fields .35
5.23.3 Remarks.35
5.24 IMA_STATIC_DISCOVERY_TARGET.36
5.24.1 Format.36
5.24.2 Fields .36
5.24.3 Remarks.36
5.25 IMA_DISCOVERY_ADDRESS_PROPERTIES .36
5.25.1 Format.36
5.25.2 Fields .36
5.25.3 Remarks.37
5.26 IMA_STATIC_DISCOVERY_TARGET_PROPERTIES.37
5.26.1 Format.37
5.26.2 Fields .37
5.26.3 Remarks.37
5.27 IMA_IP_PROPERTIES .37
5.27.1 Format.37
5.27.2 Fields .38
5.27.3 Remarks.39
5.28 IMA_LIBRARY_PROPERTIES.39
5.28.1 Format.39
5.28.2 Fields .39
5.28.3 Remarks.40
5.29 IMA_PLUGIN_PROPERTIES.40
5.29.1 Format.40
5.29.2 Fields .40
5.29.3 Remarks.41

---------------------- Page: 5 ----------------------
– 4 – 11989 © ISO/IEC:2010(E)
5.30 IMA_NODE_PROPERTIES.41
5.30.1 Format.41
5.30.2 Fields .41
5.30.3 Remarks.42
5.31 IMA_LHBA_PROPERTIES.42
5.31.1 Format.42
5.31.2 Fields .43
5.31.3 Remarks.43
5.32 Upper Level Protocol (ULP) flags .43
5.33 IMA_PHBA_PROPERTIES .44
5.33.1 Format.44
5.33.2 Fields .44
5.33.3 Remarks.46
5.34 IMA_DISCOVERY_PROPERTIES .47
5.34.1 Format.47
5.34.2 Fields .47
5.34.3 Remarks.48
5.35 IMA_PHBA_DOWNLOAD_IMAGE_TYPE.48
5.35.1 Format.48
5.35.2 Fields .48
5.35.3 Remarks.49
5.36 IMA_PHBA_DOWNLOAD_IMAGE_PROPERTIES.49
5.36.1 Format.49
5.36.2 Fields .49
5.36.3 Remarks.49
5.37 IMA_ISNS_DISCOVERY_METHOD.49
5.37.1 Format.49
5.37.2 Fields .50
5.37.3 Remarks.50
5.38 IMA_PHBA_DOWNLOAD_PROPERTIES .50
5.38.1 Format.50
5.38.2 Fields .50
5.38.3 Remarks.51
5.39 IMA_IPSEC_PROPERTIES .51
5.39.1 Format.51
5.39.2 Fields .51
5.39.3 Remarks.51
5.40 IMA_MIN_MAX_VALUE.51
5.40.1 Format.51
5.40.2 Fields .52
5.40.3 Remarks.52
5.41 IMA_BOOL_VALUE.53
5.41.1 Format.53
5.41.2 Fields .53
5.42 IMA_MAC_ADDRESS.53
5.42.1 Format.53
5.42.2 Remarks.53
5.43 IMA_LNP_PROPERTIES.53
5.43.1 Format.53

---------------------- Page: 6 ----------------------
11989 © ISO/IEC:2010(E) – 5 –
5.43.2 Fields .54
5.43.3 Remarks.54
5.44 IMA_PNP_PROPERTIES.54
5.44.1 Format.54
5.44.2 Fields .54
5.44.3 Remarks.55
5.45 IMA_PNP_STATISTICS.55
5.45.1 Format.55
5.45.2 Fields .55
5.45.3 Remarks.56
5.46 IMA_NETWORK_PORTAL_PROPERTIES.56
5.46.1 Format.56
5.46.2 Fields .56
5.46.3 Remarks.56
5.47 IMA_PHBA_STATUS.56
5.47.1 Format.56
5.47.2 Values .56
5.47.3 Remarks.56
5.48 IMA_ NETWORK_PORT_STATUS .57
5.48.1 Format.57
5.48.2 Fields .57
5.48.3 Remarks.58
5.49 IMA_TARGET_DISCOVERY_METHOD .58
5.49.1 Format.58
5.49.2 Fields .58
5.50 IMA_TARGET_PROPERTIES.58
5.50.1 Format.58
5.50.2 Fields .59
5.50.3 Remarks.59
5.51 IMA_TARGET_ERROR_STATISTICS.60
5.51.1 Format.60
5.51.2 Fields .60
5.51.3 Remarks.61
5.52 IMA_LU_PROPERTIES .62
5.52.1 Format.62
5.52.2 Fields .62
5.52.3 Remarks.63
5.53 IMA_DEVICE_STATISTICS .63
5.53.1 Format.63
5.53.2 Fields .64
5.53.3 Remarks.64
5.54 IMA_STATISTICS_PROPERTIES.64
5.54.1 Format.64
5.54.2 Fields .64
5.54.3 Remarks.65
5.55 IMA_AUTHMETHOD .65
5.55.1 Format.65
5.55.2 Fields .65
5.56 IMA_CHAP_INITIATOR_AUTHPARMS.66

---------------------- Page: 7 ----------------------
– 6 – 11989 © ISO/IEC:2010(E)
5.56.1 Format.66
5.56.2 Fields .66
5.56.3 Remarks.67
5.57 IMA_SRP_INITIATOR_AUTHPARMS .67
5.57.1 Format.67
5.57.2 Fields .67
5.57.3 Remarks.68
5.58 IMA_KRB5_INITIATOR_AUTHPARMS .68
5.58.1 Format.68
5.58.2 Fields .68
5.58.3 Remarks.68
5.59 IMA_SPKM_INITIATOR_AUTHPARMS.68
5.59.1 Format.68
5.59.2 Fields .69
5.59.3 Remarks.69
5.60 IMA_INITIATOR_AUTHPARMS .69
5.60.1 Format.69
5.60.2 Fields .70
5.60.3 Remarks.70
6 APIs .70
6.1 APIs by Category .70
6.1.1 Library and Plugin APIs .70
6.1.2 Node APIs .71
6.1.3 Logical HBA APIs .71
6.1.4 Physical HBA APIs .72
6.1.5 Network Portal APIs .73
6.1.6 Logical Network Port (LNP) APIs .73
6.1.7 Physical Network Port (PNP) APIs.73
6.1.8 Target APIs .73
6.1.9 Logical Unit (LU) APIs .74
6.1.10 Miscellaneous APIs .75
6.2 APIs by Name .76
6.2.1 IMA_AddDiscoveryAddress.78
6.2.2 IMA_AddStaticDiscoveryTarget .79
6.2.3 IMA_DeregisterForObjectPropertyChanges .81
6.2.4 IMA_DeregisterForObjectVisibilityChanges.
...