Local Properties	Local Methods
Managed Object Types	Data Object Types	All Properties	All Methods

Managed Object - Network(vim.Network)

Property of

CannotAccessNetwork, CannotUseNetwork, ClusterNetworkConfigSpec, ComputeResource, Datacenter, HostConfigSummary, HostEsxAgentHostManagerConfigInfo, HostSystem, IpPoolAssociation, NetworkEventArgument, NetworkSummary, NoAvailableIp, NodeDeploymentSpec, OvfNetworkMapping, VAppCloneSpecNetworkMappingPair, VirtualApp, VirtualEthernetCardNetworkBackingInfo, VirtualMachine

Extended by

DistributedVirtualPortgroup, OpaqueNetwork

Extends

ManagedEntity

See also

HostSystem, NetworkSummary, VirtualMachine

Since

2.0

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:

• explicitly when configuring a host.
• automatically when adding a host to VirtualCenter.
• automatically when adding a new virtual machine to a host or to VirtualCenter.

To configure network access for hosts and virtual machines, use DistributedVirtualSwitch and DistributedVirtualPortgroup managed objects.

Properties

Name	Type	Description
host*	ManagedObjectReference[] to a HostSystem[]	Hosts attached to this network.
name	xsd:string	Name of this network.
summary	NetworkSummary	Properties of a network.
vm*	ManagedObjectReference[] to a VirtualMachine[]	Virtual machines using this network.
Properties inherited from ManagedEntity
alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState
Properties inherited from ExtensibleManagedObject
availableField, value

*May not be present

Methods

Methods defined in this Managed Object
DestroyNetwork
Methods inherited from ManagedEntity
Destroy_Task, Reload, Rename_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

DestroyNetwork(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

Name	Type	Description
_this	ManagedObjectReference	A reference to the Network used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
ResourceInUse	Thrown if one or more hosts or virtual machines are configured to use the network.
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