Apache CloudStack 4.21.0.0 Root Admin API Reference

listConsoleSessions

Lists console sessions.

Request parameters

Parameter Name	Description	Required
accountid	The ID of the account that created the console endpoint.	false
acquired	Lists acquired console sessions, defaults to false. Acquired console sessions are the ones that have been accessed. The 'activeonly' parameter has precedence over the 'acquired' parameter, i.e., when the 'activeonly' parameter is 'true', the 'acquired' parameter value will be ignored.	false
activeonly	Lists only active console sessions, defaults to true. Active sessions are the ones that have been acquired and have not been removed.	false
clientaddress	IP address of the client that accessed the console session.	false
consoleendpointcreatoraddress	IP address of the creator of the console endpoint.	false
domainid	The domain ID of the account that created the console endpoint.	false
enddate	Lists console sessions generated up until this date. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone.	false
hostid	Lists console sessions from the specified host.	false
id	The ID of the console session.	false
isrecursive	Lists console sessions recursively per domain. If an account ID is informed, only the account's console sessions will be listed. Defaults to false.	false
keyword	List by keyword	false
page		false
pagesize		false
startdate	Lists console sessions generated from this date onwards. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "00:00:00"). If the recommended format is not used, the date will be considered in the server timezone.	false
userid	The ID of the user that created the console endpoint.	false
virtualmachineid	The ID of the virtual machine.	false

Response Tags

Response Name	Description
id	ID of the console session.
account	Account that created the console endpoint.
accountid	ID of the account that created the console endpoint.
acquired	Date when the console session was acquired.
clientaddress	IP address of the client that created the console session.
consoleendpointcreatoraddress	IP address of the creator of the console endpoint.
created	Date when the console session's endpoint was created.
domain	Domain of the account that created the console endpoint.
domainid	Domain ID of the account that created the console endpoint.
domainpath	Domain path of the account that created the console endpoint.
hostid	ID of the host.
hostname	Name of the host.
removed	Date when the console session was removed.
user	User that created the console endpoint.
userid	ID of the user that created the console endpoint.
virtualmachineid	ID of the virtual machine.
virtualmachinename	Name of the virtual machine.

Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.