vCenter Storage Monitoring Service API
|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - HostNetworkSystem(vim.host.NetworkSystem)
- Property of
- HostConfigManager
- Extends
- ExtensibleManagedObject
- See also
- HostDnsConfig, HostIpRouteConfig, HostIpRouteTableConfig, HostNetCapabilities, HostNetOffloadCapabilities, HostNetworkConfig, HostNetworkConfigResult, HostNetworkInfo, HostPortGroupSpec, HostVirtualNicSpec, HostVirtualSwitchSpec, PhysicalNicHintInfo, PhysicalNicLinkInfo
- Since
- 2.0
Managed Object Description
This managed object type describes networking host configuration and serves as the top level container for relevant networking data objects.Properties
| Name | Type | Description |
|---|---|---|
| capabilities* | HostNetCapabilities |
Capability vector indicating the available product features.
|
| consoleIpRouteConfig* | HostIpRouteConfig |
IP route configuration for the service console. The IP route
configuration is global to the entire host. This property is
set only if
IP routing can be configured for the service console.
|
| dnsConfig* | HostDnsConfig |
Deprecated.
As of vSphere API 5.5, which is moved to
each NetStackInstance. This only works on the default NetStackInstance.
Client-side DNS configuration.
|
| ipRouteConfig* | HostIpRouteConfig |
Deprecated.
As of vSphere API 5.5, which is moved to
each NetStackInstance. This only works on the default NetStackInstance.
The IP route configuration.
|
| networkConfig* | HostNetworkConfig |
Network configuration information. This information can be applied
using the UpdateNetworkConfig method. The
information is a strict subset of the information available in NetworkInfo. See HostNetworkInfo |
| networkInfo* | HostNetworkInfo |
The network configuration and runtime information.
|
| offloadCapabilities* | HostNetOffloadCapabilities |
Deprecated.
As of VI API 4.0, the system defaults will be used.
The offload capabilities available on this server.
|
| Properties inherited from ExtensibleManagedObject | ||
| availableField, value | ||
Methods
AddPortGroup(addPortGroup)
Adds a port group to the virtual switch.- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| portgrp | HostPortGroupSpec |
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| AlreadyExists | Thrown if the port group already exists. |
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the virtual switch does not exist. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
AddServiceConsoleVirtualNic(addServiceConsoleVirtualNic)
Adds a virtual service console network adapter. Returns the device of the VirtualNic.
IP configuration is required although it does not have to be enabled
if the host is an ESX Server system.
The dynamic privilege check will ensure that users have Host.Config.Network
privilege on the host, and Network.Assign privilege on the connecting
DVPortGroup, or DVS if connecting to a standalone DVPort.
Network.Assign privilege is not required for operations on standard network
or for operations performed directly on the host
See usesServiceConsoleNic
- Required Privileges
- None
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| portgroup | xsd:string |
See usesServiceConsoleNic Since 2.0 |
| nic | HostVirtualNicSpec |
See usesServiceConsoleNic Since 2.0 |
Return Value
| Type | Description |
|---|---|
| xsd:string |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. See usesServiceConsoleNic |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
AddVirtualNic(addVirtualNic)
Adds a virtual host/VMkernel network adapter. Returns the device of the virtual network adapter.IP configuration is required although it does not have to be enabled if the host is an ESX Server system. The dynamic privilege check will ensure that users have Host.Config.Network privilege on the host, and Network.Assign privilege on the connecting DVPortGroup, or DVS if connecting to a standalone DVPort. Network.Assign privilege is not required for operations on standard network or for operations performed directly on the host.
- Required Privileges
- None
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| portgroup | xsd:string |
Note: Must be the empty string in case nic.distributedVirtualPort
is set.
Since 2.0 |
| nic | HostVirtualNicSpec |
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| xsd:string |
Faults
| Type | Description |
|---|---|
| AlreadyExists | Thrown if the portgroup already has a virtual network adapter. |
| HostConfigFault | Thrown for all other configuration failures. |
| InvalidState | Thrown if the an ipv6 address is specified in an ipv4 only system |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
AddVirtualSwitch(addVirtualSwitch)
Adds a new virtual switch to the system with the given name. The name must be unique with respect to other virtual switches on the host and is limited to 32 characters.See UpdateVirtualSwitch
- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| vswitchName | xsd:string |
See UpdateVirtualSwitch Since 2.0 |
| spec* | HostVirtualSwitchSpec |
See UpdateVirtualSwitch Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| AlreadyExists | Thrown if the virtual switch already exists. See UpdateVirtualSwitch |
| HostConfigFault | Thrown for all other configuration failures. See UpdateVirtualSwitch |
| ResourceInUse | Thrown if the physical network adapter being bridged is already in use. See UpdateVirtualSwitch |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
QueryNetworkHint(queryNetworkHint)
Requests network hint information for a physical network adapter. A network hint is some information about the network to which the physical network adapter is attached. The method receives in a list of physical network adapter devices and returns an equal number of hints if some devices are provided. If the list of devices is empty, then the method accesses hints for all physical network adapters.See supportsNetworkHints
See device
- Required Privileges
- System.Read
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| device* | xsd:string[] |
See supportsNetworkHints See device Since 2.0 |
Return Value
| Type | Description |
|---|---|
| PhysicalNicHintInfo[] |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. See supportsNetworkHints See device |
| NotFound | Thrown if a specified physical network adapter does not exist. See supportsNetworkHints See device |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
RefreshNetworkSystem(refresh)
Refresh the network information and settings to pick up any changes that might have occurred.- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
RemovePortGroup(removePortGroup)
Removes port group from the virtual switch.- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| pgName | xsd:string |
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the port group or virtual switch does not exist. |
| ResourceInUse | Thrown if the port group can not be removed because there are virtual network adapters associated with it. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
RemoveServiceConsoleVirtualNic(removeServiceConsoleVirtualNic)
Removes a virtual service console network adapter.See usesServiceConsoleNic
- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| device | xsd:string |
See usesServiceConsoleNic Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. See usesServiceConsoleNic |
| NotFound | Thrown if the virtual network adapter cannot be found. See usesServiceConsoleNic |
| ResourceInUse | Thrown if the network adapter is currently used by DHCP DNS. See usesServiceConsoleNic |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
RemoveVirtualNic(removeVirtualNic)
Removes a virtual host/VMkernel network adapter.- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| device | xsd:string |
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the virtual network adapter cannot be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
RemoveVirtualSwitch(removeVirtualSwitch)
Removes an existing virtual switch from the system.- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| vswitchName | xsd:string |
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the virtual switch does not exist. |
| ResourceInUse | Thrown if there are virtual network adapters associated with the virtual switch. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
RestartServiceConsoleVirtualNic(restartServiceConsoleVirtualNic)
Restart the service console virtual network adapter interface. If the service console virtual network adapter uses DHCP, restarting the interface may result it with a different IP configuration, or even fail to be brought up depending on the host system network configuration.See usesServiceConsoleNic
- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| device | xsd:string |
See usesServiceConsoleNic Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. See usesServiceConsoleNic |
| NotFound | Thrown if the virtual network adapter cannot be found. See usesServiceConsoleNic |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
startDpuFailover
Launch DPU(Data Processing Unit) failover for a given distributed virtual switch.- Required Privileges
- Host.Config.Network
- Since
- vSphere API Release 8.0.3.0
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| dvsName | xsd:string |
The name of the distributed virtual switch.
Since vSphere API Release 8.0.3.0 |
| targetDpuAlias* | xsd:string |
The alias of the DPU to failover to.
If not set, it will be determined by the system.
At least one vmnic backed by the DPU needs to be associated to the
standby uplink of the distributed virtual switch.
Since vSphere API Release 8.0.3.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| InvalidArgument | Thrown if the given distributed virtual switch is not configured in network offloading mode or the standby DPU is not available. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
UpdateConsoleIpRouteConfig(updateConsoleIpRouteConfig)
Applies the IP route configuration for the service console.- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| config | HostIpRouteConfig |
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
UpdateDnsConfig(updateDnsConfig)
Deprecated. As of vSphere API 5.5, which is moved to each NetStackInstance. This API only works on the default NetStackInstance. Applies the client-side DNS configuration.- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| config | HostDnsConfig |
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| HostInDomain | Thrown if an attempt is made to change the host or domain name while the host is part of a Windows domain. |
| NotFound | when the DHCP virtual network adapter specified does not exist. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
UpdateIpRouteConfig(updateIpRouteConfig)
Deprecated. As of vSphere API 5.5, which is moved to each NetStackInstance. This API only works on the default NetStackInstance. Applies the IP route configuration.- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| config | HostIpRouteConfig |
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| InvalidState | Thrown if the an ipv6 address is specified in an ipv4 only system |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
UpdateIpRouteTableConfig(updateIpRouteTableConfig)
Deprecated. As of vSphere API 5.5, which is moved to each NetStackInstance. This API only works on the default NetStackInstance. Applies the IP route table configuration.- Required Privileges
- Host.Config.Network
- Since
- vSphere API Release 4.0
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| config | HostIpRouteTableConfig |
Since vSphere API Release 4.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
UpdateNetworkConfig(updateNetworkConfig)
Applies the network configuration. This method operates primarily in two modes: replace or modify mode.
replace
When called in replace mode, this method applies the fully
specified networking configuration to the networking system.
Upon successful completion of the call, the state of networking will match the configuration specified in config. In general, objects are created or destroyed to match the elements in the array of configurations. The identifier field in each element in an array of configurations is used to match an existing network entity. The state of existing network entities is patched to match that of the configuration.
An exception to this approach applies to the array of PhysicalNic.Config objects. The cardinality of physical network adapters cannot be changed through this operation. Thus, the identifier of every element in the array must match an existing PhysicalNic. If there are fewer elements in the array than there are existing PhysicalNics, then no change is made on the unreferenced PhysicalNic objects.
If the call fails, the networking error is returned as an exception and the state of networking reverts to the state prior to the start of the call.
modify When called in modify mode, only changes that are specified are made. For singleton entities like DnsConfig, the state is changed only if the data object is set. For array elements, there is an Operation field that indicates if the element should be added, removed, or edited. In the case of editing or removal, the entity must exist or an exception is thrown. In the case of adding, a specification needs to be provided.
It returns device names of vmkernel and service console virtual network adapter added to the system.
Currently, the only mode that is implemented is incremental mode.
Only add operations are supported for instances. Singleton
configuration is not supported.
The dynamic privilege check will ensure that users have Host.Config.Network
privilege on the host, and Network.Assign privilege on the connecting
DVPortGroup, or DVS if connecting to a standalone DVPort.
Network.Assign privilege is not required for operations on standard network
or for operations performed directly on the host
See HostConfigChangeMode
- Required Privileges
- None
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| config | HostNetworkConfig |
See HostConfigChangeMode Since 2.0 |
| changeMode | xsd:string |
See HostConfigChangeMode Since 2.0 |
Return Value
| Type | Description |
|---|---|
| HostNetworkConfigResult |
Faults
| Type | Description |
|---|---|
| AlreadyExists | when a network entity specified in the configuration already exists. See HostConfigChangeMode |
| HostConfigFault | Thrown for all other configuration failures. See HostConfigChangeMode |
| NotFound | when a network entity specified in the configuration already exists. See HostConfigChangeMode |
| ResourceInUse | See HostConfigChangeMode |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
UpdatePhysicalNicLinkSpeed(updatePhysicalNicLinkSpeed)
Configures link speed and duplexity. If linkSpeed is not specified, physical network adapter will be set to autonegotiate.See canSetPhysicalNicLinkSpeed
- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| device | xsd:string |
See canSetPhysicalNicLinkSpeed Since 2.0 |
| linkSpeed* | PhysicalNicLinkInfo |
See canSetPhysicalNicLinkSpeed Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. See canSetPhysicalNicLinkSpeed |
| NotFound | Thrown if the physical network adapter does not exist. See canSetPhysicalNicLinkSpeed |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
UpdatePortGroup(updatePortGroup)
Reconfigures a port group on the virtual switch.- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| pgName | xsd:string |
Since 2.0 |
| portgrp | HostPortGroupSpec |
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| AlreadyExists | Thrown if the update causes the port group to conflict with an existing port group. |
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the port group or virtual switch does not exist. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
UpdateServiceConsoleVirtualNic(updateServiceConsoleVirtualNic)
Configures the IP configuration for a virtual service console network adapter.
IP configuration is required although it does not have to be enabled
if the host is an ESX Server system.
The dynamic privilege check will check that the users
have Network.Assign privilege on the DVPortGroup
or the DVS if the port resides on a DVPortGroup or is a stand-alone DVS port.
See usesServiceConsoleNic
- Required Privileges
- None
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| device | xsd:string |
See usesServiceConsoleNic Since 2.0 |
| nic | HostVirtualNicSpec |
See usesServiceConsoleNic Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. See usesServiceConsoleNic |
| NotFound | Thrown if the virtual network adapter cannot be found. See usesServiceConsoleNic |
| ResourceInUse | Thrown if tries to turn of DHCP while the network adapter is currently used by DHCP DNS. See usesServiceConsoleNic |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
UpdateVirtualNic(updateVirtualNic)
Configures virtual host/VMkernel network adapter.IP configuration is required although it does not have to be enabled if the host is an ESX Server system. The dynamic privilege check will ensure that users have Host.Config.Network privilege on the host, and Network.Assign privilege on the connecting DVPortGroup, or DVS if connecting to a standalone DVPort. Network.Assign privilege is not required for operations on standard network or for operations performed directly on the host.
- Required Privileges
- None
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| device | xsd:string |
Since 2.0 |
| nic | HostVirtualNicSpec |
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| InvalidState | Thrown if the an ipv6 address is specified in an ipv4 only system |
| NotFound | Thrown if the virtual network adapter cannot be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
UpdateVirtualSwitch(updateVirtualSwitch)
Updates the properties of the virtual switch.If the bridge is NULL, the configuration will be unset.
If a network adapter is listed in the active or standby list, then changing the set of network adapters to which the physical network adapter is associated may have a side effect of changing the network adapter order policy. If a network adapter is removed from the bridge configuration, then the network adapter is removed from the network adapter teaming order.
The BondBridge configuration is the only valid bridge configuration for
an ESX Server system.
See HostNicOrderPolicy
- Required Privileges
- Host.Config.Network
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostNetworkSystem used to make the method call. |
| vswitchName | xsd:string |
See HostNicOrderPolicy Since 2.0 |
| spec | HostVirtualSwitchSpec |
See HostNicOrderPolicy Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. See HostNicOrderPolicy |
| NotFound | Thrown if the virtual switch does not exist. See HostNicOrderPolicy |
| ResourceInUse | Thrown if the physical network adapter being bridged is already in use. See HostNicOrderPolicy |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |