Managed Object - Network

Property of
ComputeResource, Datacenter, HostSystem, NetworkSummary, VirtualEthernetCardNetworkBackingInfo, VirtualMachine
Extends
ExtensibleManagedObject
See also
HostSystem, NetworkSummary, VirtualMachine


Managed Object Description

Represents a network accessible by either hosts or virtual machines. This can be a physical network or a logical network, such as a VLAN.

Networks are created:

Properties

Name Type Description
host*ManagedObjectReference[]
to a HostSystem[]

Hosts attached to this network.
namexsd:string

Name of this network.
summaryNetworkSummary

Properties of a network.
vm*ManagedObjectReference[]
to a VirtualMachine[]

Virtual machines using this network.
Properties inherited from ExtensibleManagedObject
availableField, value
*May not be present

Methods

Methods defined in this Managed Object
DestroyNetwork
Methods inherited from ExtensibleManagedObject
setCustomValue

DestroyNetwork

Deprecated. As of VI API 2.5 do not use this method. This method throws ResourceInUse. Networks are automatically removed when no longer in use, so this method is unnecessary.

Removes a network. A network can be removed only if it is not used by any host or virtual machine.
Required Privileges
Network.Delete

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Network used to make the method call.

Return Value

Type Description
None

Faults

Type Description
ResourceInUseThrown if one or more hosts or virtual machines are configured to use the network.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition