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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
.. _str: https://docs.python.org/2/library/stdtypes.html
.. _bool: https://docs.python.org/2/library/stdtypes.html
.. _vim.Task: ../../vim/Task.rst
.. _vSphere API 5.0: ../../vim/version.rst#vimversionversion7
.. _vim.fault.NotFound: ../../vim/fault/NotFound.rst
.. _vim.fault.IscsiFault: ../../vim/fault/IscsiFault.rst
.. _vim.fault.PlatformConfigFault: ../../vim/fault/PlatformConfigFault.rst
.. _vim.fault.IscsiFaultInvalidVnic: ../../vim/fault/IscsiFaultInvalidVnic.rst
.. _vim.fault.IscsiFaultVnicNotFound: ../../vim/fault/IscsiFaultVnicNotFound.rst
.. _vim.fault.IscsiFaultVnicNotBound: ../../vim/fault/IscsiFaultVnicNotBound.rst
.. _vim.host.IscsiManager.IscsiStatus: ../../vim/host/IscsiManager/IscsiStatus.rst
.. _vim.fault.IscsiFaultVnicIsLastPath: ../../vim/fault/IscsiFaultVnicIsLastPath.rst
.. _vim.host.IscsiManager.IscsiPortInfo: ../../vim/host/IscsiManager/IscsiPortInfo.rst
.. _vim.fault.IscsiFaultVnicHasNoUplinks: ../../vim/fault/IscsiFaultVnicHasNoUplinks.rst
.. _vim.fault.IscsiFaultVnicAlreadyBound: ../../vim/fault/IscsiFaultVnicAlreadyBound.rst
.. _vim.fault.IscsiFaultVnicHasWrongUplink: ../../vim/fault/IscsiFaultVnicHasWrongUplink.rst
.. _vim.fault.IscsiFaultVnicHasActivePaths: ../../vim/fault/IscsiFaultVnicHasActivePaths.rst
.. _vim.fault.IscsiFaultVnicHasMultipleUplinks: ../../vim/fault/IscsiFaultVnicHasMultipleUplinks.rst
.. _vim.host.IscsiManager.IscsiMigrationDependency: ../../vim/host/IscsiManager/IscsiMigrationDependency.rst
vim.host.IscsiManager
=====================
This managed object provides interfaces for mapping VMkernel NIC to iSCSI Host Bus Adapter.
:since: `vSphere API 5.0`_
Attributes
----------
Methods
-------
QueryVnicStatus(vnicDevice):
Query the status of Virtual NIC association with the iSCSI.
Privilege:
Host.Config.Storage
Args:
vnicDevice (`str`_):
Virtual NIC device to check the status for
Returns:
`vim.host.IscsiManager.IscsiStatus`_:
A status object IscsiStatus, containing list of the fault codes, providing the user with information as to whether Virtual NIC is used by iSCSI and list of compliance check failure codes if any. The returned IscsiStatus object will have an array of MethodFault objects providing following information:
* Empty IscsiStatus (i.e reason unset) if Virtual NIC device is not used.
* Fault code IscsiFaultVnicInUse if Virtual NIC is being used by iSCSI.
* This will be followed with list of fault codes corresponding to the compliance check failures.
Raises:
`vim.fault.IscsiFault`_:
For any problem that is not handled with a more specific fault.
QueryPnicStatus(pnicDevice):
Query if Physical NIC device is used for iSCSI.
Privilege:
Host.Config.Storage
Args:
pnicDevice (`str`_):
Physical NIC device name to check the status for
Returns:
`vim.host.IscsiManager.IscsiStatus`_:
A status object, IscsiStatus, indicating whether Physical NIC is used by iSCSI or not.
* Empty IscsiStatus (i.e reason unset) if Physical NIC device is not used.
* Fault code IscsiFaultPnicInUse if Physical NIC is being used.
Raises:
`vim.fault.IscsiFault`_:
For any problem that is not handled with a more specific fault.
QueryBoundVnics(iScsiHbaName):
Query the list of Virtual NICs that are bound to a given iSCSI HBA.
Privilege:
Host.Config.Storage
Args:
iScsiHbaName (`str`_):
iSCSI adapter name for which the method to be applied.
Returns:
[`vim.host.IscsiManager.IscsiPortInfo`_]:
An array of IscsiPortInfo containing detailed information on the list of Virtual NICs bound to the adapter
Raises:
`vim.fault.IscsiFault`_:
For any problem that is not handled with a more specific fault.
`vim.fault.NotFound`_:
If the given HBA is not found
QueryCandidateNics(iScsiHbaName):
Query the candidate Virtual NICs and Physical NICs that can be used for Port-Binding. For dependent offload adapters, the Virtual NIC should be attached to the physical NIC associated with the hardware function.
Privilege:
Host.Config.Storage
Args:
iScsiHbaName (`str`_):
iSCSI Adapter name for which the method to be applied.
Returns:
[`vim.host.IscsiManager.IscsiPortInfo`_]:
Array of IscsiPortInfo containing detailed information on list of eligible Virtual NICs that can be bound to the adapter. This list will also include details on the eligible Physical NICs that are not associated with any Virtual NICs.
Raises:
`vim.fault.IscsiFault`_:
For any problem that is not handled with a more specific fault.
`vim.fault.NotFound`_:
If the given HBA is not found
BindVnic(iScsiHbaName, vnicDevice):
Bind a Virtual NIC to be used for an iSCSI adapter
Privilege:
Host.Config.Storage
Args:
iScsiHbaName (`str`_):
iSCSI adapter name for which the Virtual NIC to be added.
vnicDevice (`str`_):
Virtual NIC that is to be bound to the iSCSI HBA
Returns:
None
Raises:
`vim.fault.IscsiFaultVnicAlreadyBound`_:
The given Virtual NIC is already bound to the HBA.
`vim.fault.IscsiFaultVnicHasNoUplinks`_:
The given Virtual NIC has no physical uplinks.
`vim.fault.IscsiFaultVnicHasMultipleUplinks`_:
The given Virtual NIC has multiple uplinks.
`vim.fault.IscsiFaultVnicHasWrongUplink`_:
The given Virtual NIC has the wrong uplink and it can't be used for iSCSI multi-pathing.
`vim.fault.IscsiFaultVnicNotFound`_:
The given Virtual NIC is not present on the system.
`vim.fault.IscsiFaultInvalidVnic`_:
The given Virtual NIC is not valid for the HBA.
`vim.fault.PlatformConfigFault`_:
For platform error that occurs during the operation.
`vim.fault.IscsiFault`_:
For any problem that is not handled with a more specific fault.
`vim.fault.NotFound`_:
If the given HBA is not found
UnbindVnic(iScsiHbaName, vnicDevice, force):
Unbind Virtual NIC binding from an iSCSI adapter.
Privilege:
Host.Config.Storage
Args:
iScsiHbaName (`str`_):
iSCSI adapter name for which the Virtual NIC to be removed.
vnicDevice (`str`_):
Virtual NIC that is to be removed from the iSCSI HBA
force (`bool`_):
Returns:
None
Raises:
`vim.fault.IscsiFaultVnicNotBound`_:
The given Virtual NIC is not bound to the adapter
`vim.fault.IscsiFaultVnicHasActivePaths`_:
The given Virtual NIC is associated with "active" paths to the storage.
`vim.fault.IscsiFaultVnicIsLastPath`_:
The given Virtual NIC is associated with "only" paths to the storage.
`vim.fault.PlatformConfigFault`_:
For platform error that occurs during the operation.
`vim.fault.IscsiFault`_:
For any problem that is not handled with a more specific fault.
`vim.fault.NotFound`_:
If the given HBA is not found
QueryMigrationDependencies(pnicDevice):
Query the dependency table for a migration operation of a given Physical NIC.
Privilege:
Host.Config.Storage
Args:
pnicDevice (`str`_):
List of Physical NICs to be migrated
Returns:
`vim.host.IscsiManager.IscsiMigrationDependency`_:
Dependency table, as described in IscsiMigrationDependency, providing the user of all the Virtual NIC and iSCSI resources affected.
|
