Class XenDesktopMachine
- Namespace
- CENTREL.XIA.Configuration.Types
- Assembly
- CENTREL.XIA.Configuration.Types.dll
Represents an individual XenDesktop machine.
public class XenDesktopMachine : GlobalSerializableClassicBase, IComparable<XenDesktopMachine>- Inheritance
-
XenDesktopMachine
- Implements
Constructors
XenDesktopMachine()
Initializes a new instance of the CENTREL.XIA.Configuration.Types.XenDesktopMachine class.
public XenDesktopMachine()Properties
AgentVersion
Gets or sets the version of the VDA agent installed on the machine - for example "7.6.0.5026".
public string AgentVersion { get; set; }Property Value
AllocationType
Gets or sets the allocation type for this machine.
public XenDesktopMachineCatalogAllocationType AllocationType { get; set; }Property Value
AllocationTypeString
Gets the machine allocation type for the machine catalog.
public string AllocationTypeString { get; set; }Property Value
ApplicationsInUse
Gets or sets the applications in use on the machine in browser name format.
public SerializableStringCollection ApplicationsInUse { get; set; }Property Value
- SerializableStringCollection
AssignedClientName
Gets or sets the name of the endpoint client device that the machine has been assigned to.
public string AssignedClientName { get; set; }Property Value
AssignedIPAddress
Gets or sets the IP address of the endpoint client device that the machine has been assigned to.
public string AssignedIPAddress { get; set; }Property Value
AssociatedUserNames
Gets or sets the users associated with this machine, these are the current user(s) for shared machines and the assigned users for private machines.
public SerializableStringCollection AssociatedUserNames { get; set; }Property Value
- SerializableStringCollection
BrowserName
Gets or sets the internal name of the machine – for example "Windows 7 VDI Deli $A2-1-7CE9651A-0001". This is only availabile in XenDesktop 7.6 and above.
public string BrowserName { get; set; }Property Value
CatalogName
Gets or sets the name of the machine catalog to which this machine belongs - for example "Windows 7 VDI machines".
public string CatalogName { get; set; }Property Value
CatalogUid
Gets or sets the unique identifier (UID) of the machine catalog to which this machine belongs.
public int CatalogUid { get; set; }Property Value
CatalogUuid
Gets or sets the universally unique identifier (UUID) of the machine catalog to which this machine belongs in GUID format - for example "b6f4e527-6005-4c50-ac4b-7c3235ef77ae".
public string CatalogUuid { get; set; }Property Value
ColorDepth
Gets or sets the color depth setting configured for this machine.
public XenDesktopMachineColorDepth ColorDepth { get; set; }Property Value
ColorDepthString
Gets the color depth setting configured for this machine.
public string ColorDepthString { get; set; }Property Value
ControllerDnsName
Gets or sets the fully qualified domain name of the delivery controller that the machine is registered to.
public string ControllerDnsName { get; set; }Property Value
DeliveryGroupName
Gets or sets the name of the delivery group of which this machine is a member.
public string DeliveryGroupName { get; set; }Property Value
DeliveryGroupUid
Gets or sets the unique identifier (UID) of the delivery group that this machine is a member of. This value may be set to zero if no delivery group is assigned to the machine.
public int DeliveryGroupUid { get; set; }Property Value
DeliveryGroupUuid
Gets or sets the universally unique identifier of the delivery group that this machine is a member of - for example "b6f4e527-6005-4c50-ac4b-7c3235ef77ae".
public string DeliveryGroupUuid { get; set; }Property Value
DeliveryType
Gets or sets the delivery type for this machine.
public XenDesktopMachineDeliveryType DeliveryType { get; set; }Property Value
DeliveryTypeString
Gets the delivery type for this machine.
public string DeliveryTypeString { get; set; }Property Value
Description
Gets or sets the description of this machine.
public string Description { get; set; }Property Value
DesktopConditions
Gets or sets the list of outstanding desktop conditions for the machine.
public SerializableStringCollection DesktopConditions { get; set; }Property Value
- SerializableStringCollection
DnsName
Gets or sets the fully qualified domain name of the machine - for example "demo-ctx01.demonstration.int".
public string DnsName { get; set; }Property Value
FaultState
Gets or sets the fault state of the machine at the time of the scan. This value may not be set if no delivery group is assigned to the machine.
public XenDesktopMachineFaultState FaultState { get; set; }Property Value
FunctionalLevel
Gets or sets the functional level of the machine.
public XenDesktopFunctionalLevel FunctionalLevel { get; set; }Property Value
FunctionalLevelString
Gets the functional level of this machine catalog as a human readable string.
public string FunctionalLevelString { get; set; }Property Value
HostedMachineId
Gets or sets the unique identifier assigned by the hypervisor to the machine.
public string HostedMachineId { get; set; }Property Value
HostedMachineName
Gets or sets the friendly name of a hosted machine as used by its hypervisor. This is not necessarily the DNS name of the machine.
public string HostedMachineName { get; set; }Property Value
HostingServerName
Gets or sets the DNS name of the hypervisor that is hosting the machine if managed.
public string HostingServerName { get; set; }Property Value
HypervisorConnectionName
Gets or sets the name of the hypervisor connection that the machine's hosting server is accessed through.
public string HypervisorConnectionName { get; set; }Property Value
HypervisorConnectionUid
Gets or sets the unique identifier (UID) of the hypervisor connection that the machine's hosting server is accessed through - for example "5".
public int HypervisorConnectionUid { get; set; }Property Value
HypervisorConnectionUuid
Gets or sets the universally unique identifier (UUID) of the hypervisor connection that the machine's hosting server is accessed through – for example “72d29912-45e0-4603-b75c-dbb7237fec5a”.
public string HypervisorConnectionUuid { get; set; }Property Value
IPAddress
Gets or sets the IP address of the machine.
public string IPAddress { get; set; }Property Value
IconUid
Gets or sets the unique identifier of the icon to use for this machine.
public int IconUid { get; set; }Property Value
InMaintenanceMode
Gets or sets whether the machine was in maintenance mode at the time of the scan.
public BooleanOption InMaintenanceMode { get; set; }Property Value
IsAssigned
Gets or sets determines whether a private desktop has been assigned to a user or users.
public BooleanOption IsAssigned { get; set; }Property Value
IsPhysical
Gets or sets whether the machine is a physical machine and therefore not power managed by the Citrix Broker service.
public BooleanOption IsPhysical { get; set; }Property Value
LastConnectionUser
Gets or sets the name of the user that last attempted a connection with the machine in the format "DOMAIN\username".
public string LastConnectionUser { get; set; }Property Value
LastErrorReason
Gets or sets the reason for the last error detected in the machine.
public string LastErrorReason { get; set; }Property Value
LastErrorTime
Gets or sets the date and time of the last error message.
public DateTime LastErrorTime { get; set; }Property Value
MachineName
Gets or sets the full NetBIOS name of the machine - for example "DEMONSTRATION\DEMO-PC01".
public string MachineName { get; set; }Property Value
MetadataItems
Gets or sets the metadata associated with this desktop machine.
public XenDesktopMetadataItemCollection MetadataItems { get; set; }Property Value
NetBiosName
Gets or sets the NetBIOS name of the machine - for example "DEMO-PC01".
public string NetBiosName { get; set; }Property Value
OSType
Gets or sets the operating system type of the machine - for example "Windows 7 Service Pack 1".
public string OSType { get; set; }Property Value
OSVersion
Gets or sets the operating system version of the machine - for example "Microsoft Windows NT 6.1.7601 Service Pack 1".
public string OSVersion { get; set; }Property Value
PersistUserChanges
Gets or sets how user changes are persisted.
public XenDesktopPersistUserChanges PersistUserChanges { get; set; }Property Value
PersistUserChangesString
Gets how user changes are persisted.
public string PersistUserChangesString { get; set; }Property Value
PowerState
Gets or sets the power state of the machine at the time of the scan.
public XenDesktopMachinePowerState PowerState { get; set; }Property Value
PowerStateString
Gets the power state of the machine at the time of the scan as a human readable string.
public string PowerStateString { get; set; }Property Value
ProvisioningType
Gets or sets the provisioning type used for this machine catalog.
public XenDesktopProvisioningType ProvisioningType { get; set; }Property Value
ProvisioningTypeString
Gets the provisioning type as a human readable string.
public string ProvisioningTypeString { get; set; }Property Value
PublishedApplications
Gets or sets the browser names of the applications published by the machine.
public SerializableStringCollection PublishedApplications { get; set; }Property Value
- SerializableStringCollection
PublishedName
Gets or sets the name of the machine that is displayed in StoreFront, if the machine has been published.
public string PublishedName { get; set; }Property Value
PvdStage
Gets or sets the personal vDisk stage of a machine at the time of the scan.
public XenDesktopMachinePvdStage PvdStage { get; set; }Property Value
PvdStageString
Gets the personal vDisk stage of a machine at the time of the scan as a human readable string.
public string PvdStageString { get; set; }Property Value
RegistrationState
Gets or sets the registration state of the machine at the time of the scan.
public XenDesktopMachineRegistrationState RegistrationState { get; set; }Property Value
RegistrationStateString
Gets the registration state of the machine at the time of the scan as a human readable string.
public string RegistrationStateString { get; set; }Property Value
SID
Gets or sets the security identifier (SID) of the machine in SDDL format - for example "S-1-5-21-1119390013-2107715993-1139858522-1128".
public string SID { get; set; }Property Value
SecureIcaRequired
Gets or sets whether secure ICA is required when starting a session on the machine.
public BooleanOption SecureIcaRequired { get; set; }Property Value
SessionSupport
Gets or sets the session support for this machine catalog.
public XenDesktopSessionSupport SessionSupport { get; set; }Property Value
SessionSupportString
Gets the session support for this machine catalog as a human readable string.
public string SessionSupportString { get; set; }Property Value
SupportedPowerActions
Gets or sets the list of power actions supported by this machine for example "Reset" and "Restart". This is available on XenDesktop 7.1 and above only.
public SerializableStringCollection SupportedPowerActions { get; set; }Property Value
- SerializableStringCollection
Tags
Gets or sets the tags assigned to this machine.
public SerializableStringCollection Tags { get; set; }Property Value
- SerializableStringCollection
ToolsState
Gets or sets the state of the hypervisor tools present on the VM (if any) at the time of the scan.
public XenDesktopMachineVMToolsState ToolsState { get; set; }Property Value
ToolsStateString
Gets the state of the hypervisor tools present on the VM (if any) at the time of the scan as a human readable string.
public string ToolsStateString { get; set; }Property Value
Uid
Gets or sets the unique identifier for this machine - for example "5".
public int Uid { get; set; }Property Value
Uuid
Gets or sets the universally unique identifier for this machine in GUID format - for example "ad2c7a58-a0f5-48d9-8bf8-2f73a6941456".
public string Uuid { get; set; }Property Value
WillShutdownAfterUse
Gets or sets whether this machine is tainted and will be shut down after all sessions on the machine have ended.
public BooleanOption WillShutdownAfterUse { get; set; }Property Value
WindowsConnectionSetting
Gets or sets the logon mode reported by Windows on multi-session machines.
public XenDesktopMachineWindowsConnectionSetting WindowsConnectionSetting { get; set; }Property Value
WindowsConnectionSettingString
Gets the logon mode reported by Windows on multi-session machines as a human readable string.
public string WindowsConnectionSettingString { get; set; }Property Value
Methods
CompareTo(XenDesktopMachine)
Compares two CENTREL.XIA.Configuration.Types.XenDesktopMachine to allow sorting alphabetically by NetBIOS name.
public int CompareTo(XenDesktopMachine other)Parameters
otherXenDesktopMachineThe CENTREL.XIA.Configuration.Types.XenDesktopMachine to compare to.
Returns
- int
The sort order of the two items.
FromXml(string)
Returns a CENTREL.XIA.Configuration.Types.XenDesktopMachine class from the specified XML.
public static XenDesktopMachine FromXml(string Xml)Parameters
XmlstringThe XML representation of the object.
Returns
- XenDesktopMachine
A CENTREL.XIA.Configuration.Types.XenDesktopMachine class.
ToString()
Returns the NetBIOS name of the machine - for example "DEMONSTRATION\DEMO-PC01".
public override string ToString()Returns
- string
The NetBIOS name of the machine - for example "DEMONSTRATION\DEMO-PC01".