Table of Contents

Class VMwareSystem

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents a VMware managed system, either a vCenter or standalone ESX host.

[SupportsClientScan]
[SupportsSupportProvisions]
public class VMwareSystem : BaseConfigurationType
Inheritance
VMwareSystem
Inherited Members

Constructors

VMwareSystem()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.VMwareSystem class.

public VMwareSystem()

Properties

Clusters

Gets or sets the clusters found within this VMware system.

public VMwareClusters Clusters { get; set; }

Property Value

VMwareClusters

DataCenters

Gets or sets the data centers configured within this VMware system.

public VMwareDataCenters DataCenters { get; set; }

Property Value

VMwareDataCenters

DatastoreClusters

Gets or sets the datastore clusters configured on the system.

public VMwareDatastoreClusters DatastoreClusters { get; set; }

Property Value

VMwareDatastoreClusters

Datastores

Gets or sets the datastores configured on the system.

public VMwareDatastores Datastores { get; set; }

Property Value

VMwareDatastores

DistributedSwitches

Gets or sets the distributed virtual switches configured on the system.

public VMwareDistributedSwitches DistributedSwitches { get; set; }

Property Value

VMwareDistributedSwitches

Hosts

Gets or sets the hosts found within this VMware system.

public VMwareHosts Hosts { get; set; }

Property Value

VMwareHosts

Information

Gets or sets the information about this VMware system.

public VMwareSystemInformation Information { get; set; }

Property Value

VMwareSystemInformation

IsHost

Gets whether this item is a host or vCenter server.

public bool IsHost { get; }

Property Value

bool

ResourcePools

Gets or sets the resource pools found within this vCenter system or ESX standalone host.

public VMwareResourcePools ResourcePools { get; set; }

Property Value

VMwareResourcePools

Security

Gets or sets the security configuration of this VMware system.

public VMwareSecurity Security { get; set; }

Property Value

VMwareSecurity

SystemTypeString

Gets the type of system as a human readable string - for example "Host" or "vCenter Server".

public string SystemTypeString { get; set; }

Property Value

string

VirtualMachines

Gets or sets the virtual machines found within this vCenter system or ESX standalone host.

public VMwareVirtualMachines VirtualMachines { get; set; }

Property Value

VMwareVirtualMachines

Methods

Clone()

Creates a clone of this CENTREL.XIA.Configuration.Types.VMwareSystem.

public VMwareSystem Clone()

Returns

VMwareSystem

A clone of this CENTREL.XIA.Configuration.Types.VMwareSystem.

FindByManagedObjectID(string)

Returns the VMware managed object with the specified managed object ID or null if no managed object with the specified ID is found.

public VMwareManagedObject FindByManagedObjectID(string managedObjectID)

Parameters

managedObjectID string

The unique ID of the object to resolve - for example "datacenter-21".

Returns

VMwareManagedObject

A CENTREL.XIA.Configuration.Types.VMwareManagedObject with the specified ID.

FindHostByVirtualSwitch(VMwareVirtualSwitch)

Returns the CENTREL.XIA.Configuration.Types.VMwareHost that owns the specified virtual switch.

public VMwareHost FindHostByVirtualSwitch(VMwareVirtualSwitch virtualSwitch)

Parameters

virtualSwitch VMwareVirtualSwitch

The virtual switch for which the host should be located.

Returns

VMwareHost

The CENTREL.XIA.Configuration.Types.VMwareHost that owns the specified virtual switch.

FindHosts(VMwareManagedObject)

Finds the hosts that are a member of the specified parent object.

public VMwareHostCollection FindHosts(VMwareManagedObject parent)

Parameters

parent VMwareManagedObject

The parent object - typically a cluster for which hosts should be found.

Returns

VMwareHostCollection

A collection of the hosts that are a member of the specified parent object.

FindResourcePools(VMwareManagedObject)

Finds the resource pools assigned to the specified parent object.

public VMwareResourcePoolCollection FindResourcePools(VMwareManagedObject parent)

Parameters

parent VMwareManagedObject

The parent object - for example a cluster or host, for which the resource pools should be found.

Returns

VMwareResourcePoolCollection

A collection of the resource pools that are assigned to the specified parent object.

FindVirtualMachines(VMwareManagedObject)

Finds the virtual machines assigned to the specified parent object.

public VMwareVirtualMachineCollection FindVirtualMachines(VMwareManagedObject parent)

Parameters

parent VMwareManagedObject

The parent object - for example a cluster or host, for which the virtual machines should be found.

Returns

VMwareVirtualMachineCollection

A collection of the virtual machines that are assigned to the specified parent object.

FindVirtualMachines(VMwareManagedObject, bool)

Finds the virtual machines assigned to the specified parent object.

public VMwareVirtualMachineCollection FindVirtualMachines(VMwareManagedObject parent, bool includeTemplates)

Parameters

parent VMwareManagedObject

The parent object - for example a cluster or host, for which the virtual machines should be found.

includeTemplates bool

Determines whether to include templates.

Returns

VMwareVirtualMachineCollection

A collection of the virtual machines that are assigned to the specified parent object.

FindVirtualSwitch(Guid)

Returns the CENTREL.XIA.Configuration.Types.VMwareVirtualSwitch with the specified identifier regardless of the host in which the CENTREL.XIA.Configuration.Types.VMwareVirtualSwitch resides.

public VMwareVirtualSwitch FindVirtualSwitch(Guid identifier)

Parameters

identifier Guid

The unique identifier of the virtual switch to locate.

Returns

VMwareVirtualSwitch

The CENTREL.XIA.Configuration.Types.VMwareVirtualSwitch with the specified identifier.

FindVirtualSwitches()

Returns a CENTREL.XIA.Configuration.Types.VMwareVirtualSwitchCollection that contains all virtual switches from all hosts.

public VMwareVirtualSwitchCollection FindVirtualSwitches()

Returns

VMwareVirtualSwitchCollection

A CENTREL.XIA.Configuration.Types.VMwareVirtualSwitchCollection that contains all virtual switches from all hosts.

FromXml(string)

Returns a CENTREL.XIA.Configuration.Types.VMwareSystem object from the specified XML data

public static VMwareSystem FromXml(string Xml)

Parameters

Xml string

The XML representation of the object.

Returns

VMwareSystem

A CENTREL.XIA.Configuration.Types.VMwareSystem object.

LoadXml(string)

Returns the CENTREL.XIA.Configuration.Types.VMwareSystem from the specified XML file.

public static VMwareSystem LoadXml(string filePath)

Parameters

filePath string

The absolute path of the XML file to load.

Returns

VMwareSystem

A CENTREL.XIA.Configuration.Types.VMwareSystem from the specified XML.

ResolveObjectNames(SerializableStringCollection)

Resolves a list of managed object IDs to the names of those objects.

public SerializableStringCollection ResolveObjectNames(SerializableStringCollection ObjectIDs)

Parameters

ObjectIDs SerializableStringCollection

A collection of object IDs to resolve.

Returns

SerializableStringCollection

A collection of the names of the managed objects.