GlobalSessionInfo

GlobalSessionInfo
GlobalSessionInfo

Information related to Global Session.

JSON Example
{
    "agent_version": "8.3.0",
    "application_names": [
        "Calculator",
        "Paint"
    ],
    "broker_user_id": "S-1-5-21-1111111111-2222222222-3333333333-500",
    "brokered_remotely": true,
    "brokering_pod_id": "399eecf2-66ab-4a8f-94d9-b290fda35e4f",
    "client_data": {
        "address": "127.0.0.1",
        "location_id": "ac9be3c194f62043b274058102d3ce39048ec9c26d0e2c8b8ea475909d497f79",
        "name": "Client1",
        "type": "WINDOWS",
        "version": "5.4.0"
    },
    "desktop_pool_id": "53c4de7c-ae7c-471d-a8d0-3489cb9741d7",
    "desktop_pool_or_farm_name": "Farm-Name",
    "desktop_pool_or_farm_source": "VIRTUAL_CENTER",
    "desktop_pool_or_farm_type": "AUTOMATED",
    "disconnected_time": 1621512686000,
    "farm_id": "250f68e8-9e7e-4578-b8fa-25864c63f168",
    "federated_access_group_ids": [
        "310927ee-1195-44c3-b877-5b194b4b4ea8",
        "78669598-45b6-44a3-aa0d-11b16d45ab73"
    ],
    "forever_session": false,
    "global_application_entitlement_ids": [
        "0d23a254-b873-4534-ad9a-ce8d25c5b40e",
        "89036a3a-5f6f-4dcd-bc78-e2febdc9dc8a"
    ],
    "global_desktop_entitlement_id": "adcfdefc-c853-4413-8ac7-b299535a509d",
    "id": "ac6fc134-d197-3bbc-a6bf-24dc63123ae6",
    "idle_duration": 30,
    "last_session_duration_ms": 120290,
    "local_access_group_id": "95061b82-92fa-4285-b90d-a5e1d8e38c3d",
    "machine_id": "3205f64e-1d3d-43c0-942b-0bb6707c481d",
    "machine_or_rds_server_dns_name": "machine1.example.com",
    "pod_id": "b7ade226-ca2a-4805-b7be-c4bc8cec5188",
    "rds_server_id": "a6cddaeb-4477-468d-90ea-593c716790b8",
    "resourced_remotely": false,
    "security_gateway_data": {
        "address": "127.0.0.1",
        "domain_name": "SECURE-GW.example.com",
        "location": "EXTERNAL"
    },
    "session_protocol": "BLAST",
    "session_state": "CONNECTED",
    "session_type": "DESKTOP",
    "site_id": "037e6be2-9aa3-4676-93d3-25a519efedf4",
    "start_time": 1621512606000,
    "unauthenticated": false,
    "user_id": "S-1-5-21-1111111111-2222222222-3333333333-500"
}
string
agent_version
Optional

Version of the agent for the session. Supported Filters: 'Equals'. This property can be used for sorting.

array of string
application_names
Optional

Names of the applications launched in the session.
It will only be set when session_type is APPLICATION. Supported Filters: 'Contains'.

string
broker_user_id
Optional

SID for the broker user associated with the session. It will be unset for non-broker sessions. Supported Filters: 'Equals'.

boolean
brokered_remotely
Optional

Indicates whether the session is brokered from a remote pod.
This will be set only if the Horizon View agent where the session resides is version 6.0 or later. Supported Filters: 'Equals'. This property can be used for sorting.

string
brokering_pod_id
Optional

ID of the pod that brokered the session.

client_data
Optional

client_data

string
desktop_pool_id
Optional

ID of the desktop pool for the desktop session. This will be unset if the session is not brokered through a desktop pool, such as for direct console access. This will be unset if the session is hosted by remote pod. Supported Filters: 'Equals'.

string
desktop_pool_or_farm_name
Optional

Display name of the desktop pool or name of the farm for the session. This will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. Supported Filters: 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.

string
desktop_pool_or_farm_source
Optional

Source of the desktop pool or farm for the session. This will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. This property can be used for sorting.

  • INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
  • LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
  • RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
  • UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.
  • VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.
Possible values are : INSTANT_CLONE, LINKED_CLONE, RDS, UNMANAGED, VIRTUAL_CENTER,
string
desktop_pool_or_farm_type
Optional

Type of the desktop pool or farm for the session. This will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. This property can be used for sorting.

  • AUTOMATED: Automated Desktop Pool.
  • MANUAL: Manual Desktop Pool.
  • RDS: RDS Desktop Pool.
Possible values are : AUTOMATED, MANUAL, RDS,
integer As int64 As int64
disconnected_time
Optional

Epoch time in milliseconds, when the session was last disconnected. This will be unset if the machine on which the session resides has an error state, or if the session has never been disconnected. Supported Filters: 'Equals'. This property can be used for sorting.

string
farm_id
Optional

ID of the farm for the RDS desktop or application session. This will be unset if the session is not brokered through a farm, such as for direct console access. This will be unset if the session is hosted by remote pod. Supported Filters: 'Equals'.

array of string
federated_access_group_ids
Optional

IDs of the federated access groups associated with the session.
This represents the federated access groups associated with the global desktop entitlement or global application entitlements used to launch the session. Supported Filters : 'Contains'.

boolean
forever_session
Optional

Indicates whether the application session will continue to run indefinitely on reaching global idle timeout or max session timeout. This property can be used for sorting.

array of string
global_application_entitlement_ids
Optional

IDs of the global application entitlements used to launch applications in the session. Either this or global_desktop_entitlement_id may be set, but not both. Supported Filters : 'Contains'.

string
global_desktop_entitlement_id
Optional

ID of the global desktop entitlement used to launch the session. Either this or global_application_entitlement_ids may be set, but not both. Supported Filters : 'Equals'.

string
id
Optional

Unique ID representing a session. Supported Filters: 'Equals'.

integer As int64 As int64
idle_duration
Optional

Idle time duration in minutes, indicating how long the end user of the session has been idle for. Supported Filters: 'Equals'. This property can be used for sorting.

integer As int64 As int64
last_session_duration_ms
Optional

Duration of the last connection period of the session in milliseconds. If the session is currently connected, this is the duration that the session has been in connected state. If the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error. Supported Filters: 'Equals'. This property can be used for sorting.

string
local_access_group_id
Optional

ID of the local access group associated with the session. For a non-RDS desktop session, this is the access group ID of the desktop pool. For an RDS desktop session, this is access group ID of the farm of the RDS desktop pool. For an application session, this is the access group ID of the farm of the application pool. This will be unset if the session is hosted by remote pod. Supported Filters: 'Equals'.

string
machine_id
Optional

ID of the machine for the session. This will be unset for RDS desktop or application sessions. If desktop_pool_id is unset, it is the id of registered unmanaged physical machine. This will be unset if the session is hosted by remote pod. Supported Filters: 'Equals'.

string
machine_or_rds_server_dns_name
Optional

DNS name of the machine or RDS server for the session. This property can be used for sorting.

string
pod_id
Optional

ID of the pod that provided the resource for the session.

string
rds_server_id
Optional

ID of the RDS server for the RDS desktop or application session.
This will be unset if the session is hosted by remote pod. Supported Filters: 'Equals'.

boolean
resourced_remotely
Optional

Indicates whether the session is running on a remote pod resource. Supported Filters: 'Equals'. This property can be used for sorting.

security_gateway_data
Optional

security_gateway_data

string
session_protocol
Optional

Protocol for session. This will be unset for disconnected sessions. Supported Filters: 'Equals'. This property can be used for sorting.

  • PCOIP: Display protocol is PCoIP.
  • RDP: Display protocol is RDP.
  • BLAST: Display protocol is BLAST.
  • CONSOLE: Display protocol is console.
  • UNKNOWN: Display protocol is unknown.
Possible values are : PCOIP, RDP, BLAST, CONSOLE, UNKNOWN,
string
session_state
Optional

State of session. Supported Filters: 'Equals', 'NotEquals'. This property can be used for sorting.

  • CONNECTED: Session is connected
  • DISCONNECTED: Session is disconnected
  • PENDING: Session is pending
Possible values are : CONNECTED, DISCONNECTED, PENDING,
string
session_type
Optional

Type of session. Supported Filters: 'Equals'. This property can be used for sorting.

  • DESKTOP: Desktop or RDS desktop session.
  • APPLICATION: Application session.
Possible values are : DESKTOP, APPLICATION,
string
site_id
Optional

ID of the site where the pod that resourced the session belongs.

integer As int64 As int64
start_time
Optional

Epoch time in milliseconds when this session was originally logged in. The lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences between. The first connection time will be shortly after this time. Supported Filters: 'Equals'. This property can be used for sorting.

boolean
unauthenticated
Optional

Indicates whether the session belongs to unauthenticated access user. Supported Filters: 'Equals'. This property can be used for sorting.

string
user_id
Optional

SID of the user logged into the session. It may not match the broker user id for non-SSO scenarios.