Table of Contents

Class XenDesktopHypervisorConnection

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

Represents an individual XenDesktop hypervisor connection.

public class XenDesktopHypervisorConnection : GlobalSerializableClassicBase, IComparable<XenDesktopHypervisorConnection>
Inheritance
XenDesktopHypervisorConnection
Implements

Constructors

XenDesktopHypervisorConnection()

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

public XenDesktopHypervisorConnection()

Properties

Administrators

Gets or sets the administrators who have permissions to manage this connection.

public XenDesktopAdministratorAssignmentCollection Administrators { get; set; }

Property Value

XenDesktopAdministratorAssignmentCollection

ConnectionOptions

Gets or sets the connection options used by this connection.

public string ConnectionOptions { get; set; }

Property Value

string

ConnectionType

Gets or sets the hypervisor connection type - for example "XenServer".

public XenDesktopHypervisorConnectionType ConnectionType { get; set; }

Property Value

XenDesktopHypervisorConnectionType

ConnectionTypeString

Gets the connection type as a human readable string.

public string ConnectionTypeString { get; set; }

Property Value

string

HostingUnits

Gets or sets the hosting units (resources and storage) configured for this hypervisor connection.

public XenDesktopHypervisorHostingUnits HostingUnits { get; set; }

Property Value

XenDesktopHypervisorHostingUnits

HypervisorAddresses

Gets or sets an array of addresses for the hypervisor – for example “https://corp-xen01.demonstration.int”.

public SerializableStringCollection HypervisorAddresses { get; set; }

Property Value

SerializableStringCollection

IsReady

Gets or sets whether the hypervisor connection was ready at the time of the scan. This is only available on XenDesktop 7.5 and above.

public BooleanOption IsReady { get; set; }

Property Value

BooleanOption

MachineCount

Gets or sets the number of machines associated with this connection.

public int MachineCount { get; set; }

Property Value

int

MaxAbsoluteActiveActions

Gets or sets the maximum simultaneous actions (all types).

public int MaxAbsoluteActiveActions { get; set; }

Property Value

int

MaxAbsoluteNewActionsPerMinute

Gets or sets maximum new actions per minute.

public int MaxAbsoluteNewActionsPerMinute { get; set; }

Property Value

int

MaxAbsolutePvdPowerActions

Gets or sets the maximum simultaneous personal vDisk inventory updates.

public int MaxAbsolutePvdPowerActions { get; set; }

Property Value

int

MaxPercentageActiveActions

Gets or sets the maximum percentage of simultaneous actions (all types).

public int MaxPercentageActiveActions { get; set; }

Property Value

int

MaxPvdPowerActionsPercentageOfDesktops

Gets or sets the maximum percentage simultaneous personal vDisk inventory updates.

public int MaxPvdPowerActionsPercentageOfDesktops { get; set; }

Property Value

int

MetadataItems

Gets or sets the metadata associated with this hypervisor connection.

public XenDesktopMetadataItemCollection MetadataItems { get; set; }

Property Value

XenDesktopMetadataItemCollection

Name

Gets or sets the name of the connection - for example "XenServer Connection". This must be unique within the site.

public string Name { get; set; }

Property Value

string

Persistent

Gets or sets whether this is a persistent connection.

public BooleanOption Persistent { get; set; }

Property Value

BooleanOption

PluginId

Gets or sets the plugin identifier for this connection - for example "XenFactory".

public string PluginId { get; set; }

Property Value

string

PreferredController

Gets or sets the name of the delivery controller which is the preferred controller to perform all communication with the hypervisor.

public string PreferredController { get; set; }

Property Value

string

Revision

Gets or sets the revision for this connection in GUID format - for example "581067c9-6e81-44f9-8d63-53c1897546e2".

public string Revision { get; set; }

Property Value

string

Scopes

Gets or sets the scopes referenced by this hypervisor connection.

public XenDesktopScopeReferenceCollection Scopes { get; set; }

Property Value

XenDesktopScopeReferenceCollection

State

Gets or sets the state of the hypervisor connection at the time of the scan.

public XenDesktopHypervisorConnectionState State { get; set; }

Property Value

XenDesktopHypervisorConnectionState

StateString

Gets the state of the hypervisor connection at the time of the scan as a human readable string.

public string StateString { get; set; }

Property Value

string

SupportsLocalStorageCaching

Gets or sets whether the hypervisor connection supports local storage caching.

public BooleanOption SupportsLocalStorageCaching { get; set; }

Property Value

BooleanOption

SupportsPvsVMs

Gets or sets determines whether the hypervisor connection supports Citrix Provisioning Services.

public BooleanOption SupportsPvsVMs { get; set; }

Property Value

BooleanOption

Uid

Gets or sets the unique identifier of the connection.

public int Uid { get; set; }

Property Value

int

UserName

Gets or sets the username used for the connection.

public string UserName { get; set; }

Property Value

string

UsesCloudInfrastructure

Gets or sets whether this hypervisor connection uses cloud infrastructure.

public BooleanOption UsesCloudInfrastructure { get; set; }

Property Value

BooleanOption

Uuid

Gets or sets the universally unique identifier of the connection in GUID format.

public string Uuid { get; set; }

Property Value

string

ZoneName

Gets or sets the name of the zone to which this hypervisor connection belongs. This applies to XenDesktop 7.7 and above only.

public string ZoneName { get; set; }

Property Value

string

ZoneUid

Gets or sets the unique identifier of the zone to which this hypervisor connection belongs in GUID format - for example "f438d60c-d8ce-4b12-a6d4-d9190e0330ee". This applies to XenDesktop 7.7 and above only.

public string ZoneUid { get; set; }

Property Value

string

Methods

CompareTo(XenDesktopHypervisorConnection)

Compares two CENTREL.XIA.Configuration.Types.XenDesktopHypervisorConnection to allow sorting alphabetically by name.

public int CompareTo(XenDesktopHypervisorConnection other)

Parameters

other XenDesktopHypervisorConnection

The CENTREL.XIA.Configuration.Types.XenDesktopHypervisorConnection to compare to.

Returns

int

The sort order of the two items.

FromXml(string)

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

public static XenDesktopHypervisorConnection FromXml(string Xml)

Parameters

Xml string

The XML representation of the object.

Returns

XenDesktopHypervisorConnection

A CENTREL.XIA.Configuration.Types.XenDesktopHypervisorConnection class.

ToString()

Returns the name of the connection - for example "XenServer Connection".

public override string ToString()

Returns

string

The name of the connection - for example "XenServer Connection".