Table of Contents

Class XenDesktopDeliveryGroup

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

Represents an individual XenDesktop delivery group.

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

Constructors

XenDesktopDeliveryGroup()

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

public XenDesktopDeliveryGroup()

Properties

AccessPolicy

Gets or sets the access policy for this delivery group.

public XenDesktopDeliveryGroupAccessPolicy AccessPolicy { get; set; }

Property Value

XenDesktopDeliveryGroupAccessPolicy

Administrators

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

public XenDesktopAdministratorAssignmentCollection Administrators { get; set; }

Property Value

XenDesktopAdministratorAssignmentCollection

AppDiskIdentifiers

Gets or sets the unique identifiers of the AppDisks associated with this delivery group. This setting applies to XenDesktop 7.8 and above only.

public SerializableStringCollection AppDiskIdentifiers { get; set; }

Property Value

SerializableStringCollection

AutomaticPowerOnForAssigned

Gets or sets whether assigned desktops in the delivery group are automatically started at the start of peak time periods. This only applies to private machines.

public BooleanOption AutomaticPowerOnForAssigned { get; set; }

Property Value

BooleanOption

AutomaticPowerOnForAssignedDuringPeak

Gets or sets whether assigned desktops in the desktop are automatically started throughout peak time periods. This only applies to private machines.

public BooleanOption AutomaticPowerOnForAssignedDuringPeak { get; set; }

Property Value

BooleanOption

ColorDepth

Gets or sets the color depth setting configured for this machine.

public XenDesktopMachineColorDepth ColorDepth { get; set; }

Property Value

XenDesktopMachineColorDepth

ColorDepthString

Gets the color depth setting configured for this machine.

public string ColorDepthString { get; set; }

Property Value

string

ConfigurationSlotUids

Gets or sets the unique identifiers of any configuration slots which hold machine configurations associated with the delivery group.

public SerializableIntegerCollection ConfigurationSlotUids { get; set; }

Property Value

SerializableIntegerCollection

DeliveryType

Gets or sets the delivery type for this machine.

public XenDesktopMachineDeliveryType DeliveryType { get; set; }

Property Value

XenDesktopMachineDeliveryType

DeliveryTypeString

Gets the delivery type for this machine.

public string DeliveryTypeString { get; set; }

Property Value

string

Description

Gets or sets the description of the delivery group.

public string Description { get; set; }

Property Value

string

DesktopKind

Gets or sets the desktop kind for this delivery group - either "Private" or "Shared".

public XenDesktopDeliveryGroupDesktopKind DesktopKind { get; set; }

Property Value

XenDesktopDeliveryGroupDesktopKind

DesktopKindString

Gets the desktop kind for this delivery group - either "Private" or "Shared".

public string DesktopKindString { get; set; }

Property Value

string

Enabled

Gets or sets whether this delivery group is enabled.

public BooleanOption Enabled { get; set; }

Property Value

BooleanOption

FunctionalLevel

Gets or sets the functional level of this delivery group.

public XenDesktopFunctionalLevel FunctionalLevel { get; set; }

Property Value

XenDesktopFunctionalLevel

FunctionalLevelString

Gets the functional level of this delivery group as a human readable string.

public string FunctionalLevelString { get; set; }

Property Value

string

IconUid

Gets or sets the unique identifier of the icon to use for this delivery group.

public int IconUid { get; set; }

Property Value

int

InMaintenanceMode

Gets or sets whether the delivery group was in maintenance mode at the time of the scan.

public BooleanOption InMaintenanceMode { get; set; }

Property Value

BooleanOption

IsRemotePC

Gets or sets whether the delivery group is a Remote PC desktop group.

public BooleanOption IsRemotePC { get; set; }

Property Value

BooleanOption

Lingering

Gets or sets the application session lingering settings for the delivery group.

public XenDesktopDeliveryGroupLingeringSettings Lingering { get; set; }

Property Value

XenDesktopDeliveryGroupLingeringSettings

MachineConfigurationNames

Gets or sets the machine configuration names associated with the delivery group 0 for example "RS\demo-xa76-sf01.demoxenapp.int", "AppV\1".

public SerializableStringCollection MachineConfigurationNames { get; set; }

Property Value

SerializableStringCollection

MachineConfigurationUids

Gets or sets the machine configuration UIDs associated with the delivery group.

public SerializableIntegerCollection MachineConfigurationUids { get; set; }

Property Value

SerializableIntegerCollection

MaxDesktops

Gets or sets the maximum number of desktops allowed per user in this delivery group.

public int MaxDesktops { get; set; }

Property Value

int

Name

Gets or sets the name of the delivery group - for example "Finance Applications".

public string Name { get; set; }

Property Value

string

PowerManagement

Gets or sets the power management settings for this delivery group.

public XenDesktopDeliveryGroupPowerManagementSettings PowerManagement { get; set; }

Property Value

XenDesktopDeliveryGroupPowerManagementSettings

PrelaunchSettings

Gets or sets the session prelaunch settings for this delivery group.

public XenDesktopDeliveryGroupPrelaunchSettings PrelaunchSettings { get; set; }

Property Value

XenDesktopDeliveryGroupPrelaunchSettings

Protocols

Gets or sets the list of protocol names in the order in which they are attempted for use during connection.

public SerializableStringCollection Protocols { get; set; }

Property Value

SerializableStringCollection

PublishedName

Gets or sets the name of the delivery group as it is to appear to the user in StoreFront.

public string PublishedName { get; set; }

Property Value

string

RebootSchedule

Gets or sets the restart schedule for this delivery group.

public XenDesktopDeliveryGroupRebootSchedule RebootSchedule { get; set; }

Property Value

XenDesktopDeliveryGroupRebootSchedule

Scopes

Gets or sets the scopes referenced by this delivery group.

public XenDesktopScopeReferenceCollection Scopes { get; set; }

Property Value

XenDesktopScopeReferenceCollection

SecureIcaRequired

Gets or sets whether the SecureICA encryption of the HDX protocol is required for sessions of desktops in the delivery group.

public BooleanOption SecureIcaRequired { get; set; }

Property Value

BooleanOption

SessionSupport

Gets or sets the session support for this delivery group.

public XenDesktopSessionSupport SessionSupport { get; set; }

Property Value

XenDesktopSessionSupport

SessionSupportString

Gets the session support for this delivery group as a human readable string.

public string SessionSupportString { get; set; }

Property Value

string

SettlementPeriodBeforeAutoShutdown

Gets or sets the time after a session ends during which automatic shutdown requests are deferred. This setting applies to XenDesktop 7.6 and above only.

public TimeSpan SettlementPeriodBeforeAutoShutdown { get; set; }

Property Value

TimeSpan

SettlementPeriodBeforeAutoShutdownString

Gets or sets the time after a session ends during which automatic shutdown requests are deferred. This setting applies to XenDesktop 7.6 and above only. This is required as the TimeSpan class does not support XML serialization.

[Browsable(false)]
public string SettlementPeriodBeforeAutoShutdownString { get; set; }

Property Value

string

ShutdownDesktopsAfterUse

Gets or sets whether desktops will shut down after they have been used and there are no sessions running on the machine.

public BooleanOption ShutdownDesktopsAfterUse { get; set; }

Property Value

BooleanOption

StoreFronts

Gets or sets the StoreFront connections used by this delivery group.

public XenDesktopStoreFrontServerConnectionCollection StoreFronts { get; set; }

Property Value

XenDesktopStoreFrontServerConnectionCollection

Tags

Gets or sets the tags assigned to this delivery group.

public SerializableStringCollection Tags { get; set; }

Property Value

SerializableStringCollection

TimeZone

Gets or sets the timezone in which the desktops in the desktop group reside - for example "GMT Standard Time".

public string TimeZone { get; set; }

Property Value

string

TurnOnAddedMachine

Gets or sets whether power-managed machines should be turned on when they are added to the delivery group.

public BooleanOption TurnOnAddedMachine { get; set; }

Property Value

BooleanOption

Uid

Gets or sets the unique identifier for the delivery group - for example "5".

public int Uid { get; set; }

Property Value

int

Uuid

Gets or sets the universally unique identifier for the delivery group in GUID format - for example "ad2c7a58-a0f5-48d9-8bf8-2f73a6941456".

public string Uuid { get; set; }

Property Value

string

Methods

CompareTo(XenDesktopDeliveryGroup)

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

public int CompareTo(XenDesktopDeliveryGroup other)

Parameters

other XenDesktopDeliveryGroup

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

Returns

int

The sort order of the two items.

FromXml(string)

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

public static XenDesktopDeliveryGroup FromXml(string Xml)

Parameters

Xml string

The XML representation of the object.

Returns

XenDesktopDeliveryGroup

A CENTREL.XIA.Configuration.Types.XenDesktopDeliveryGroup class.

ToString()

Returns the name of the delivery group - for example "Finance Applications".

public override string ToString()

Returns

string

The name of the delivery group - for example "Finance Applications".