Retrieves sessions matching all the specified criteria. If no parameters are specified this cmdlet enumerates all sessions.
-------------------------- BrokerSession Object
The session object returned represents a session on a machine in the site. The session could be for a desktop or application
-- AgentVersion (System.String)
Version of the Citrix Virtual Delivery Agent (VDA) installed on the machine.
-- ApplicationsInUse (System.String)
List of SDK Name property of applications in use in the session.
-- AutonomouslyBrokered (System.Boolean)
Session property indicating if the session was started without the use of the broker.
-- BrokeringDuration (System.Int32?)
Time taken to broker the session.
-- BrokeringTime (System.DateTime?)
Time at which the session was brokered.
-- BrokeringUserName (System.String)
The user name of the brokering user.
-- BrokeringUserSID (System.String)
The SID of the brokering user.
-- CatalogName (System.String)
The name of the catalog that the machine hosting the session is assigned to.
-- ClientAddress (System.String)
The IP address of the client connected to the desktop.
-- ClientName (System.String)
The host name of the client connected to the session.
-- ClientVersion (System.String)
The version of the Citrix Receiver running on the client connected to the session.
-- ConnectedViaHostName (System.String)
The host name of the incoming connection. This is usually a gateway, router or client.
-- ConnectedViaIP (System.String)
The IP address of the incoming connection This is usually a gateway, router or client.
-- ControllerDNSName (System.String)
The DNS host name of the controller that the session's hosting machine is registered with.
-- DesktopGroupName (System.String)
Name of the desktop group of the machine the session is on.
-- DesktopGroupUid (System.Int32)
UID of the desktop group of the machine the session is on.
-- DesktopKind (Citrix.Broker.Admin.SDK.DesktopKind)
Indicates if the session is shared or private.
-- DesktopSID (System.String)
The Windows SID of the machine the session is on.
-- DesktopUid (System.Int32)
For a desktop session, the unique identifier of the desktop.
-- DeviceId (System.String)
Unique identifier for the client device that has most recently been associated with the session.
-- DNSName (System.String)
The DNS host name of the machine hosting the session.
-- EstablishmentDuration (System.Int32?)
Duration that it took to establish the session.
-- EstablishmentTime (System.DateTime?)
Time at which the session was established.
-- HardwareId (System.String)
Unique identifier for the client hardware that has been most recently associated with the session.
-- Hidden (System.Boolean)
Flag to indicate if the session is currently hidden from the user and not to be reconnected to.
-- HostedMachineName (System.String)
The friendly name of a hosted machine running the session, as used by its hypervisor. This does not necessarily match either the DNS or AD name of the machine.
-- HostingServerName (System.String)
DNS name of the hypervisor that is hosting the machine hosting the session.
-- HypervisorConnectionName (System.String)
The name of the hypervisor connection that the machine hosting the session has been assigned to.
-- ImageOutOfDate (System.Boolean?)
Denotes whether the VM image for a hosted machine is out of date and due to be updated to a new master image when the machine next reboots.
-- InMaintenanceMode (System.Boolean)
Denotes whether the machine hosting the session is in maintentance mode.
-- IPAddress (System.String)
The IP address of the machine hosting the session.
-- IsPhysical (System.Boolean)
This value is false if the machine hosting the session can be power managed, and true otherwise
-- LaunchedViaHostName (System.String)
The host name of the StoreFront server used to launch the session.
-- LaunchedViaIP (System.String)
The IP address of the StoreFront server used to launch the session.
-- MachineName (System.String)
DNS host name of the machine hosting the session.
-- MachineSummaryState (Citrix.Broker.Admin.SDK.DesktopSummaryState)
The summary state of the machine (will be Unregistered, Disconnected, or InUse)
-- MachineUid (System.Int32)
UID of the machine hosting the session.
-- MetadataMap (System.Collections.Generic.Dictionary<string, string>)
Map of metadata for this session.
-- OSType (System.String)
A string that can be used to identify the operating system that is running on the machine hosting the session.
-- PersistUserChanges (Citrix.Broker.Admin.SDK.PersistUserChanges)
Describes whether/how the user changes are persisted. Possible values are:
o OnLocal - Persist the user changes locally.
o Discard - Discard user changes.
o OnPvd - Persist user changes on the Citrix Personal vDisk.
-- PowerState (Citrix.Broker.Admin.SDK.PowerState)
The current power state of the machine hosting the session. Possible values are: Unmanaged, Unknown, Unavailable, On, Suspended, TurningOn, TurningOff, Suspending and Resuming.
-- Protocol (System.String)
The protocol that the session is using, can be either "HDX" or "RDP".
-- ProvisioningType (Citrix.Broker.Admin.SDK.ProvisioningType)
Describes how the machine hosting the session was provisioned, possible values are:
o Manual: No provisioning.
o PVS: Machine provisioned by PVS (may be physical, blade, VM,...)
o MCS: Machine provisioned by MCS (machine must be VM)
-- SecureIcaActive (System.Boolean?)
Indicates whether SecureICA is active on the session.
-- SessionId (System.Int32)
Deprecated. A unique identifier that Remote Desktop Services uses to track the session but it is only unique on that machine.
-- SessionKey (System.Guid)
GUID that provides a unique identifier for this session.
-- SessionState (Citrix.Broker.Admin.SDK.SessionState)
The state of the session. Valid values are PreparingNewSession, Connected, Active, Disconnected, Reconnecting, NonBrokeredSession, Other, and Unknown.
-- SessionStateChangeTime (System.DateTime)
The time of the most recent state change for the session.
-- SessionSupport (Citrix.Broker.Admin.SDK.SessionSupport)
Indicates if the machine hosting the session supports multiple or single sessions.
-- SessionType (Citrix.Broker.Admin.SDK.SessionType)
Indicates if this is an Application or Desktop session.
-- SmartAccessTags (System.String)
The Smart Access tags for this session.
-- StartTime (System.DateTime?)
Indicates when the session was started.
-- Uid (System.Int64)
Unique identifier of this session.
-- UserFullName (System.String)
The full name of the user.
-- UserName (System.String)
The name of the user.
-- UserSID (System.String)
The user's Windows SID.
-- UserUPN (System.String)
The user's User Principal Name