ISO/IEC 19831:2015

Cloud Infrastructure Management Interface (CIMI) Model and RESTful HTTP-based Protocol — An Interface for Managing Cloud Infrastructure

ISO/IEC 19831:2015 describes the model and protocol for management interactions between a cloud Infrastructure as a Service (IaaS) Provider and the Consumers of an IaaS service. The basic resources of IaaS (machines, storage, and networks) are modeled with the goal of providing Consumer management access to an implementation of IaaS and facilitating portability between cloud implementations that support the specification. This document specifies a Representational State Transfer (REST)-style protocol using HTTP. However, the underlying model is not specific to HTTP, and it is possible to map it to other protocols as well. CIMI addresses the management of the lifecycle of infrastructure provided by a Provider. CIMI does not extend beyond infrastructure management to the control of the applications and services that the Consumer chooses to run on the infrastructure provided as a service by the Provider. Although CIMI may be to some extent applicable to other cloud service models, such as Platform as a Service ("PaaS") or Storage as a Service ("SaaS"), these uses are outside the design goals of CIMI.

Model d'interface de management de l'infrastructure du nuage informatique (CIMI) et protocole RESTful basé HTTP — Une interface pour le management de l'infrastructure du nuage informatique

General Information

• Status: Published
• Publication Date: 21-Apr-2015
• ICS: 35.100.05 - Multilayer applications
• Technical Committee: ISO/IEC JTC 1 - Information technology
• Drafting Committee: ISO/IEC JTC 1 - Information technology
• Current Stage: 9093 - International Standard confirmed
• Completion Date: 10-Mar-2021

Standards Content (Sample)

INTERNATIONAL ISO/IEC
STANDARD 19831
First edition
2015-05-01

Cloud Infrastructure Management
Interface (CIMI) Model and RESTful
HTTP-based Protocol — An Interface for
Managing Cloud Infrastructure
Model d'interface de management de l'infrastructure du nuage
informatique (CIMI) et protocole RESTful basé HTTP — Une interface
pour le management de l'infrastructure du nuage informatique




Reference number
ISO/IEC 19831:2015(E)
©
ISO/IEC 2015

---------------------- Page: 1 ----------------------
ISO/IEC 19831:2015(E)

COPYRIGHT PROTECTED DOCUMENT


©  ISO/IEC 2015
All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized otherwise in any form or by any
means, electronic or mechanical, including photocopying, or posting on the internet or an intranet, without prior written permission.
Permission can be requested from either ISO at the address below or ISO’s member body in the country of the requester.
ISO copyright office
Case postale 56  CH-1211 Geneva 20
Tel. + 41 22 749 01 11
Fax + 41 22 749 09 47
E-mail [e-mail]
Web www.iso.org
Published in Switzerland

ii © ISO/IEC 2015 – All rights reserved

---------------------- Page: 2 ----------------------
ISO/IEC 19831:2015 (E)
33 CONTENTS
34 Foreword . 7
35 1 Scope . 9
36 1.1 Document structure . 9
37 1.2 Document versioning scheme . 9
38 1.3 Typographical conventions . 9
39 2 Normative references . 10
40 3 Terms and definitions . 11
41 4 HTTP-based protocol . 14
42 4.1 Introduction . 14
43 4.1.1 Protocol evolution and client expectations . 14
44 4.1.2 XML namespaces . 14
45 4.1.3 URI space . 14
46 4.1.4 Media types . 15
47 4.1.5 Request headers. 15
48 4.1.6 Request query parameters . 15
49 4.2 Protocol operations . 21
50 4.2.1 Common CRUD operations . 22
51 4.3 OVF support . 29
52 5 Model . 30
53 5.1 Resource wrappers . 30
54 5.2 Extensibility . 31
55 5.3 Identifiers . 31
56 5.4 Attribute constraints . 32
57 5.5 Data types and their serialization . 33
58 5.5.1 boolean . 33
59 5.5.2 dateTime . 33
60 5.5.3 duration . 33
61 5.5.4 integer . 34
62 5.5.5 string . 34
63 5.5.6 ref . 34
64 5.5.7 map . 35
65 5.5.8 structure . 35
66 5.5.9 byte[ ] . 36
67 5.5.10 URI . 36
68 5.5.11 Arrays . 36
69 5.5.12 Collections . 37
70 5.5.13 "Any" type . 41
71 5.5.14 Empty attribute values . 41
72 5.6 Units . 41
73 5.7 Relationship semantics . 42
74 5.8 Operations . 42
75 5.9 Alternative model formats . 43
76 5.10 Resources . 43
77 5.10.1 Common attributes. 43
78 5.11 Resource metadata . 45
79 5.11.1 Serialization of attribute value constraints . 49
80 5.11.2 Capabilities . 51
81 5.11.3 ResourceMetadataCollection Resource . 54
82 5.12 Cloud Entry Point . 55
83 5.12.1 Operations . 61
84 5.13 System Resources and relationships . 61
85 5.13.1 System . 62
© ISO/IEC 2015 — All rights reserved 3

---------------------- Page: 3 ----------------------
ISO/IEC 19831:2015 (E)
86 5.13.2 SystemCollection Resource . 80
87 5.13.3 SystemTemplate Resource . 81
88 5.13.4 SystemTemplateCollection Resource. 87
89 5.14 Machine Resources and relationships . 88
90 5.14.1 Machine . 89
91 5.14.2 MachineCollection. 107
92 5.14.3 MachineTemplate . 109
93 5.14.4 MachineTemplateCollection Resource . 116
94 5.14.5 MachineConfiguration Resource . 117
95 5.14.6 MachineConfigurationCollection Resource . 119
96 5.14.7 MachineImage Resource . 120
97 5.14.8 MachineImageCollection Resource . 124
98 5.14.9 Credential Resource . 125
99 5.14.10 CredentialCollection Resource . 126
100 5.14.11 CredentialTemplate Resource . 127
101 5.14.12 CredentialTemplateCollection Resource . 128
102 5.15 Volume Resources and relationships . 130
103 5.15.1 Volume . 131
104 5.15.2 VolumeCollection Resource . 135
105 5.15.3 VolumeTemplate Resource . 136
106 5.15.4 VolumeTemplateCollection Resource . 138
107 5.15.5 VolumeConfiguration Resource . 139
108 5.15.6 VolumeConfigurationCollection Resource . 141
109 5.15.7 VolumeImage Resource . 142
110 5.15.8 VolumeImageCollection Resource . 144
111 5.16 Network Resources and relationships . 145
112 5.16.1 Network . 145
113 5.16.2 NetworkCollection Resource . 153
114 5.16.3 NetworkTemplate Resource . 154
115 5.16.4 NetworkTemplateCollection Resource . 156
116 5.16.5 NetworkConfiguration Resource . 157
117 5.16.6 NetworkConfigurationCollection Resource . 158
118 5.16.7 NetworkPort . 160
119 5.16.8 NetworkPortCollection Resource . 164
120 5.16.9 NetworkPortTemplate Resource . 165
121 5.16.10 NetworkPortTemplateCollection Resource . 168
122 5.16.11 NetworkPortConfiguration Resource . 169
123 5.16.12 NetworkPortConfigurationCollection Resource . 170
124 5.16.13 Address Resource . 171
125 5.16.14 AddressCollection Resource . 173
126 5.16.15 AddressTemplate Resource . 174
127 5.16.16 AddressTemplateCollection Resource . 176
128 5.16.17 ForwardingGroup Resource . 177
129 5.16.18 ForwardingGroupCollection Resource. 180
130 5.16.19 ForwardingGroupTemplate Resource . 181
131 5.16.20 ForwardingGroupTemplateCollection Resource . 182
132 5.17 Monitoring Resources and relationships. 183
133 5.17.1 Job Resource . 184
134 5.17.2 JobCollection Resource . 188
135 5.17.3 Meter Resource . 189
136 5.17.4 MeterCollection Resource . 195
137 5.17.5 MeterTemplate Resource . 196
138 5.17.6 MeterTemplateCollection Resource . 197
139 5.17.7 MeterConfiguration Resource . 198
140 5.17.8 MeterConfigurationCollection Resource . 201
141 5.17.9 EventLog Resource . 202
4 © ISO/IEC 2015 — All rights reserved

---------------------- Page: 4 ----------------------
ISO/IEC 19831:2015 (E)
142 5.17.10 EventLogCollection Resource . 205
143 5.17.11 EventLogTemplate Resource . 206
144 5.17.12 EventLogTemplateCollection Resource . 207
145 5.17.13 Event Resource . 208
146 6 Security considerations . 216
147 ANNEX A (normative)  OVF support in CIMI . 217
148 ANNEX B (informative)  XML Schema . 219
149 ANNEX C (informative)  Change log . 220
150
151 Figures
152 Figure 1 - Cloud Entry Point . 56
153 Figure 2 - System Resources. 62
154 Figure 3 - Machine Resources . 89
155 Figure 4 - Volume Resources . 130
156 Figure 5 - Network Resources . 145
157 Figure 6 - Monitoring Resources . 184
158
159 Tables
160 Table 1 – XML namespaces . 14
161 Table 2 – Named structure. 35
162 Table 3 – Converting a relative URI to an absolute URI . 36
163 Table 4 – Numerical equivalents for attributes . 42
164 Table 5 – Common attributes . 43
165 Table 7 – Capability URIs . 51
166 Table 8 – CloudEntryPoint attributes . 56
167 Table 9 – System attributes . 63
168 Table 10 – SystemSystem attributes . 67
169 Table 11 – SystemMachine attributes . 68
170 Table 12 – SystemCredential attributes . 70
171 Table 13 – SystemVolume attributes . 71
Table 14 – SystemNetwork attributes . 72
172
173 Table 15 – SystemNetworkPort attributes . 74
174 Table 16 – SystemAddress attributes . 75
175 Table 17 – SystemForwardingGroup attributes . 76
176 Table 18 – SystemTemplate attributes . 82
177 Table 19 – Machine attributes . 89
178 Table 20 – Disk attributes . 93
179 Table 21 – MachineVolume attributes . 94
180 Table 22 – MachineNetworkInterface attributes . 96
181 Table 23 – MachineNetworkInterfaceAddress attributes . 98
182 Table 24 – MachineSnapshot attributes . 100
183 Table 25 – MachineTemplate attributes . 109
184 Table 26 – MachineConfiguration attributes . 117
185 Table 27 – MachineImage attributes . 120
© ISO/IEC 2015 — All rights reserved 5

---------------------- Page: 5 ----------------------
ISO/IEC 19831:2015 (E)
186 Table 28 – Credential attributes . 125
187 Table 29 – UserName/Password attributes . 125
188 Table 30 – Public key attributes . 125
189 Table 31 – CredentialTemplate attributes . 127
190 Table 32 – Volume attributes . 131
191 Table 33 – VolumeVolumeImage attributes . 133
192 Table 34 – VolumeTemplate attributes . 136
193 Table 35 – VolumeConfiguration attributes. 140
194 Table 36 – VolumeImage attributes . 142
195 Table 37 – Network attributes . 145
196 Table 38 – NetworkTemplate attributes . 154
197 Table 39 – NetworkConfiguration attributes . 157
198 Table 40 – NetworkPort attributes . 160
199 Table 41 – NetworkPortTemplate attributes . 165
200 Table 42 – NetworkPortConfiguration attributes . 169
201 Table 43 – Address attributes . 171
202 Table 44 – AddressTemplate attributes . 174
203 Table 45 – ForwardingGroup attributes . 178
204 Table 46 – ForwardingGroupNetwork attributes . 179
205 Table 47 – ForwardingGroupTemplate attributes . 181
206 Table 48 – Job attributes . 185
207 Table 49 – Meter attributes . 189
208 Table 50 – Sample attributes . 192
209 Table 51 – MeterTemplate attributes . 196
210 Table 52 – MeterConfiguration attributes . 198
211 Table 53 – aspect URIs . 200
212 Table 54 – EventLog attributes . 202
213 Table 55 – EventLogTemplate attributes . 206
214 Table 56 – Event attributes . 208
215 Table 57 – type URIs . 211
216
217
6 © ISO/IEC 2015 — All rights reserved

---------------------- Page: 6 ----------------------
ISO/IEC 19831:2015 (E)
218 Foreword
219 The Cloud Infrastructure Management Interface (CIMI) Model and RESTful HTTP-based Protocol
220 specification (DSP0263) was prepared by the DMTF Cloud Management Working Group. It defines a
221 logical model for the management of resources within the Infrastructure as a Service domain.
222 DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems
223 management and interoperability.
224 Acknowledgments
225 The DMTF acknowledges the following individuals for their contributions to this document:
226 Editors (past and present):
227 x Marios Andreou – Red Hat
228 x Doug Davis – IBM
229 x Jacques Durand – Fujitsu
230 x Gilbert Pilz – Oracle
231 Contributors:
232 x Ghazanfar Ali – ZTE Corporation
233 x Marios Andreou – Red Hat
234 x Keith Bankston – Microsoft Corporation
235 x Winston Bumpus – VMware Inc.
236 x Nathan Burkhart – Microsoft Corporation
237 x Mark Carlson – Oracle
238 x Steve Carter – Novell
239 x Junsheng Chu – ZTE Corporation
240 x Josh Cohen – Microsoft Corporation
241 x Derek Coleman – Hewlett-Packard Company
242 x John Crandall – Brocade Communications Systems
243 x Doug Davis – IBM
244 x Jim Davis – WBEM Solutions
245 x Fernando de la Iglesia – Telefónica
246 x Hiroshi Dempo – NEC Corporation
247 x Jacques Durand – Fujitsu
248 x Yigal Edery – Microsoft Corporation
249 x George Ericson – EMC
250 x Colleen Evans – Microsoft Corporation
251 x Norbert Floeren – Ericsson AB
252 x Robert Freund – Hitachi, Ltd.
253 x Fermín Galán – Telefónica
254 x Krishnan Gopalan – Microsoft Corporation
255 x Kazunori Iwasa – Fujitsu
256 x Mark Johnson – IBM
257 x Bhumip Khasnabish – ZTE Corporation
258 x Dies Köper – Fujitsu
259 x Vincent Kowalski – BMC Software
260 x Ruby Krishnaswamy – France Telecom Group
261 x Lawrence Lamers – VMware Inc.
262 x Paul Lipton – CA Technologies
263 x James Livingston – NEC Corporation
264 x Vince Lubsey – Virtustream Inc.
© ISO/IEC 2015 — All rights reserved 7

---------------------- Page: 7 ----------------------
ISO/IEC 19831:2015 (E)
265 x David Lutterkort – Red Hat
266 x Fred Maciel – Hitachi, Ltd.
267 x Andreas Maier – IBM
268 x Ashok Malhotra – Oracle
269 x Jeff Mischkinsky – Oracle
270 x Jesus Molina – Fujitsu
271 x Efraim Moscovich – CA Technologies
272 x Bryan Murray – Hewlett-Packard Company
273 x Steven Neely – Cisco
274 x Ryuichi Ogawa – NEC Corporation
275 x John Parchem– Microsoft Corporation
276 x Shishir Pardikar – Citrix Systems Inc.
277 x Miguel Peñalvo – Telefónica
278 x Gilbert Pilz – Oracle
279 x Alvaro Polo – Telefónica
280 x Enrico Ronco – Telecom Italia
281 x Federico Rossini – Telecom Italia
282 x Matthew Rutkowski – IBM
283 x Tom Rutt – Fujitsu
284 x Hemal Shah – Broadcom
285 x Nihar Shah – Microsoft Corporation
286 x Alan Sill – Texas Tech University
287 x Zhexuan Song – Huawei
288 x Marvin Waschke – CA Technologies
289 x Eric Wells – Hitachi, Ltd.
290 x Jeff Wheeler – Huawe
...