Service - NetworkLabel

Class: VMware.Hv.NetworkLabel
See also: HostOrClusterId, NetworkLabelInfo, NetworkLabelSpec
Since: Horizon View 6.0

Service Description

The service for fetching network labels from VirtualCenter.
Each port group is identified by a network label, which is unique to the current host. Network labels are used to make virtual machine configuration portable across hosts. All port groups in a datacenter that are physically connected to the same network (in the sense that each can receive broadcasts from the others) are given the same label. Conversely, if two port groups cannot receive broadcasts from each other, they have distinct labels.
Each network interface card on a virtual machine can be assigned a network label to specify its port group. Network labels may serve as shorthand for settings like VLAN tag and DHCP IP address range information.

Methods

Methods defined in this Service
NetworkLabel_ListByHostOrCluster, NetworkLabel_ListByNetworkLabelSpec

NetworkLabel_ListByHostOrCluster

Returns all network labels on the given host or cluster that may be suitable for configuration with a desktop's network interface card. This includes both standard and distributed virtual switch network label types. Requires at least one of the listed privileges.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	privilege is required to get the NetworkLabelInfos.
VC_CONFIG_VIEW	privilege is required to get the NetworkLabelInfos.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the NetworkLabel used to make the method call.
cluster	HostOrClusterId	The cluster id

Return Value

Type	Description
NetworkLabelInfo[]	An array of NetworkLabelInfos

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="NetworkLabel_ListByHostOrCluster" type="vdi:NetworkLabel_ListByHostOrClusterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="NetworkLabel_ListByHostOrClusterResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:NetworkLabelInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

NetworkLabel_ListByNetworkLabelSpec

Returns all the network labels on the given host or cluster by filtering on the network type that may be suitable for configuration with a desktop's network interface card. Requires at least one of the listed privileges.

Privileges

Privilege	Description
VC_CONFIG_VIEW	privilege is required to get the NetworkLabelInfos.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the NetworkLabel used to make the method call.
spec	NetworkLabelSpec	NetworkLabelSpec

Return Value

Type	Description
NetworkLabelInfo[]	An array of NetworkLabelInfos

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="NetworkLabel_ListByNetworkLabelSpec" type="vdi:NetworkLabel_ListByNetworkLabelSpecRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="NetworkLabel_ListByNetworkLabelSpecResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:NetworkLabelInfo" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>