Table of Contents

Class VMwareVirtualMachines

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

Represents a collection of VMware virtual machines.

public class VMwareVirtualMachines : BaseTypeSection
Inheritance
VMwareVirtualMachines

Constructors

VMwareVirtualMachines()

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

public VMwareVirtualMachines()

Properties

Items

Gets or sets the items in the collection.

public VMwareVirtualMachineCollection Items { get; set; }

Property Value

VMwareVirtualMachineCollection

Methods

Exists(string)

Determines if the virtual machine with the specified managed object ID exists.

public bool Exists(string managedObjectID)

Parameters

managedObjectID string

The unique ID of the virtual machine to locate - for example "vm-35".

Returns

bool

A System.Boolean value that indicates whether the virtual machine with the specfied managed object ID exists within the collection.

FindByManagedObjectID(string)

Returns the virtual machine with the specified managed object ID, or null if no virtual machine with the specified ID exists within the collection.

public VMwareVirtualMachine FindByManagedObjectID(string managedObjectID)

Parameters

managedObjectID string

The unique ID of the virtual machine to locate - for example "vm-35".

Returns

VMwareVirtualMachine

The CENTREL.XIA.Configuration.Types.VMwareVirtualMachine with the specified managed object ID.

FindByName(string)

Returns the virtual machine with the specified name, or null if no virtual machine with the specified name exists within the collection.

public VMwareVirtualMachine FindByName(string name)

Parameters

name string

The unique name of the virtual machine to locate - for example "DEMO-SRV01".

Returns

VMwareVirtualMachine

The CENTREL.XIA.Configuration.Types.VMwareVirtualMachine with the specified name.

FromXml(string)

Returns a CENTREL.XIA.Configuration.Types.VMwareVirtualMachines class from the specified XML.

public static VMwareVirtualMachines FromXml(string Xml)

Parameters

Xml string

The XML representation of the object.

Returns

VMwareVirtualMachines

A CENTREL.XIA.Configuration.Types.VMwareVirtualMachines class.

GetOperatingSystemBreakdown()

Returns breakdown of the number of each operating system found to be running on the virtual machines in the collection.

public CountBreakdown GetOperatingSystemBreakdown()

Returns

CountBreakdown

A CENTREL.XIA.Configuration.Types.CountBreakdown object.

Remarks

Empty guest names are replaced with the string "{Unknown}.

GetOperatingSystemBreakdown(bool)

Returns breakdown of the number of each operating system found to be running on the virtual machines in the collection.

public CountBreakdown GetOperatingSystemBreakdown(bool includeTemplates)

Parameters

includeTemplates bool

Determines whether templates should be included when generating the breakdown.

Returns

CountBreakdown

A CENTREL.XIA.Configuration.Types.CountBreakdown object.

ToString()

Returns the virtual machines as a human readable string - for example "20 Virtual Machines".

public override string ToString()

Returns

string

The virtual machines as a human readable string.