Files
deb-python-pyvmomi/docs/vim/host/IscsiManager/IscsiPortInfo.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

2.9 KiB

vim.host.IscsiManager.IscsiPortInfo

The IscsiPortInfo data object describes the Virtual NIC that are bound to an iSCSI adapter and also it describes the candidate Virtual NICs that can be bound to a given iSCSI adapter.

extends

vmodl.DynamicData

since

vSphere API 5.0

Attributes:

vnicDevice (str, optional):

Virtual NIC Name. Contains the name of the Virtual NIC device. This may be unset in case where the bound Virtual NIC doesn't have the system object or where a candidate Physical NIC isn't associated with any Virtual NIC.

vnic (vim.host.VirtualNic, optional):

Virtual NIC Object corresponding to the vnicDevice. May be unset if Virtual NIC object corresponding to vnicDevice doesn't exist in the system.

pnicDevice (str, optional):

Physical NIC Name.

pnic (vim.host.PhysicalNic, optional):

Physical NIC Object corresponding to the pnicDevice. May be unset if Physical NIC object corresponding to pnicDevice doesn't exist in the system or the vnicDevice doesn't have any Physical NIC associated with it.

switchName (str, optional):

Name of the virtual switch this Physical/Virtual NIC belongs. May be unset if the vnicDevice and/or pnicDevice do not have a virtual switch associated with them.

switchUuid (str, optional):

UUID of the virtual switch this Physical/Virtual NIC belongs. May be unset if the vnicDevice and/or pnicDevice do not have a virtual switch associated with them or the associated switch is not VDS.

portgroupName (str, optional):

Name of the portgroup to which this Virtual NIC belongs. May be unset if the vnicDevice and/or pnicDevice do not have a Portgroup associated with them.

portgroupKey (str, optional):

Portgroup key to which this Virtual NIC belongs. May be unset if the vnicDevice and/or pnicDevice do not have a Portgroup associated with them or the associated portgroup does is not of VDS type.

portKey (str, optional):

portkey to which this Virtual NIC belongs. May be unset if the vnicDevice is not assigned to a specific port or the switch is not VDS.

complianceStatus (vim.host.IscsiManager.IscsiStatus, optional):

Status indicating whether the Virtual NIC is compliant with the network policy that is required by iSCSI port binding. May be unset in the candidate NIC list.

pathStatus (str, optional):

A status, as defined in PathStatus, indicating the existing storage paths dependency level on a given Virtual NIC. May be unset in the candidate NIC list.