1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
.. _str: https://docs.python.org/2/library/stdtypes.html
.. _vim.Task: ../vim/Task.rst
.. _VI API 2.5: ../vim/version.rst#vimversionversion2
.. _vim.Extension: ../vim/Extension.rst
.. _IpPoolManager: ../vim/IpPoolManager.rst
.. _vSphere API 4.0: ../vim/version.rst#vimversionversion5
.. _vSphere API 5.1: ../vim/version.rst#vimversionversion8
.. _vSphere API 5.0: ../vim/version.rst#vimversionversion7
.. _vim.ManagedEntity: ../vim/ManagedEntity.rst
.. _vim.fault.NotFound: ../vim/fault/NotFound.rst
.. _LoginExtensionByCertificate: ../vim/SessionManager.rst#loginExtensionByCertificate
.. _vmodl.fault.InvalidArgument: ../vmodl/fault/InvalidArgument.rst
.. _vim.fault.NoClientCertificate: ../vim/fault/NoClientCertificate.rst
.. _vim.ExtensionManager.IpAllocationUsage: ../vim/ExtensionManager/IpAllocationUsage.rst
vim.ExtensionManager
====================
This managed object type provides directory and basic management services for all registered extensions.Clients use the ExtensionManager, available in `ServiceInstance`_ , to access extension objects.While several authentication methods are available for extension servers to use (see `SessionManager`_ ), only one authentication method is valid for an extension at any given time.
:since: `VI API 2.5`_
Attributes
----------
extensionList ([`vim.Extension`_]):
privilege: System.View
The list of currently registered extensions.
Methods
-------
UnregisterExtension(extensionKey):
Unregisters the specified extension if it exists.
Privilege:
Extension.Unregister
Args:
extensionKey (`str`_):
Unique name of extension to unregister.
Returns:
None
Raises:
`vim.fault.NotFound`_:
if the specified extension is not registered.
FindExtension(extensionKey):
Returns extension with the given key, if any.
Privilege:
System.View
Args:
extensionKey (`str`_):
Key to search for.
Returns:
`vim.Extension`_:
Extension that matches given key, if any.
RegisterExtension(extension):
Registers extension.
Privilege:
Extension.Register
Args:
extension (`vim.Extension`_):
Extension description to register.
Returns:
None
Raises:
`vmodl.fault.InvalidArgument`_:
if the Extension description is incomplete or an extension is already registered with the given unique key, or if the extension is an OVF extension and its section types overlap with other registered OVF extensions.
UpdateExtension(extension):
If the key specified in the extension exists, the existing record is updated.If thesubjectNameproperty of the Extension object has a value, and it is different from the existing value, this method will unset any public key or certificate associated with the extension.
Privilege:
Extension.Update
Args:
extension (`vim.Extension`_):
Updated extension description.
Returns:
None
Raises:
`vim.fault.NotFound`_:
if the specified extension key is not registered.
`vmodl.fault.InvalidArgument`_:
if the Extension description is incomplete or invalid, or if the extension is an OVF extension and its section types overlap with other registered OVF extensions.
GetPublicKey():
Returns VirtualCenter Server public key.
Privilege:
System.View
Args:
Returns:
`str`_:
Public key of VirtualCenter Server, encoded in PEM (privacy-enhanced mail) format.
SetPublicKey(extensionKey, publicKey):
Sets extension's public key.This method will unset any subject name or certificate associated with the extension.
Privilege:
Extension.Update
Args:
extensionKey (`str`_):
Key of extension to update.
publicKey (`str`_):
Public key of extension, encoded in PEM (privacy-enhanced mail) format.
Returns:
None
Raises:
`vmodl.fault.InvalidArgument`_:
if the public key is invalid.
SetExtensionCertificate(extensionKey, certificatePem):
Update the stored authentication certificate for a specified extension. Updates the registration of the specified extension with the thumbprint of the X.509 client certificate provided over SSL handshake, or by thecertificatePemargument. The thumbprint will be used to authenticate the extension during invocations of `LoginExtensionByCertificate`_ .NOTE: No verification is performed on the received certificate, such as expiry or revocation.This method will unset any public key or subject name associated with the extension.
since: `vSphere API 4.0`_
Privilege:
Extension.Update
Args:
extensionKey (`str`_):
Key of extension to update.
certificatePem (`str`_, optional):
PEM encoded certificate. If not specified, the certificate passed over SSL handshake is used.
Returns:
None
Raises:
`vim.fault.NotFound`_:
if an extension specified byextensionKeyis not registered.
`vim.fault.NoClientCertificate`_:
if certificatePem is not specified, and no certificate was passed over SSL handshake.
`vmodl.fault.InvalidArgument`_:
if the certificate described bycertificatePemis not in PEM format, or could not be decoded to an X.509 certificate.
QueryManagedBy(extensionKey):
Find entities managed by an extension. These can be either virtual machines or vApps.
since: `vSphere API 5.0`_
Privilege:
System.View
Args:
extensionKey (`str`_):
Key of the extension to find managed entities for.
Returns:
[`vim.ManagedEntity`_]:
List of entities managed by the extension.
QueryExtensionIpAllocationUsage(extensionKeys):
Query statistics about IP allocation usage, either system wide or for specified extensions.Refer to `IpPoolManager`_ for details.
since: `vSphere API 5.1`_
Privilege:
System.View
Args:
extensionKeys (`str`_, optional):
List of extensions whose IP allocation is being queried. If no extension keys are specified then allocation data for all registered extensions are returned.
Returns:
[`vim.ExtensionManager.IpAllocationUsage`_]:
List of IP allocation usage.
|
