Class: console

Last published : Oct 01, 2026
A console
Related information
XenServer 8.4 Management API

Fields for class: console

Field Type Qualifier Description
location string RO/runtime URI for the console service
other_config (string -> string) map RW additional configuration
protocol console_protocol RO/runtime the protocol used by this console
uuid string RO/runtime Unique identifier/object reference
VM VM ref RO/runtime VM to which this console is attached

RPCs associated with class: console

RPC name: addtootherconfig

Overview:
Add the given keyvalue pair to the otherconfig field of the given console.
Signature:
void add_to_other_config (session ref session_ref, console ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
console ref self reference to the object
string key Key to add
string value Value to add
Minimum Role: vm-admin
Return Type: void

RPC name: create

Overview:
Create a new console instance, and return its handle.
Signature:
console ref create (session ref session_ref, console record args)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
console record args All constructor arguments
Minimum Role: vm-admin
Return Type: console ref
reference to the newly created object

RPC name: destroy

Overview:
Destroy the specified console instance.
Signature:
void destroy (session ref session_ref, console ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
console ref self reference to the object
Minimum Role: vm-admin
Return Type: void

RPC name: getall

Overview:
Return a list of all the consoles known to the system.
Signature:
console ref set get_all (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: console ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of console references to console records for all consoles known to the system.
Signature:
(console ref -> console record) map get_all_records (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: (console ref -> console record) map
records of all objects

RPC name: getbyuuid

Overview:
Get a reference to the console instance with the specified UUID.
Signature:
console ref get_by_uuid (session ref session_ref, string uuid)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string uuid UUID of object to return
Minimum Role: read-only
Return Type: console ref
reference to the object

RPC name: getlocation

Overview:
Get the location field of the given console.
Signature:
string get_location (session ref session_ref, console ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
console ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getotherconfig

Overview:
Get the otherconfig field of the given console.
Signature:
(string -> string) map get_other_config (session ref session_ref, console ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
console ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getprotocol

Overview:
Get the protocol field of the given console.
Signature:
console_protocol get_protocol (session ref session_ref, console ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
console ref self reference to the object
Minimum Role: read-only
Return Type: console_protocol
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given console.
Signature:
console record get_record (session ref session_ref, console ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
console ref self reference to the object
Minimum Role: read-only
Return Type: console record
all fields from the object

RPC name: getuuid

Overview:
Get the uuid field of the given console.
Signature:
string get_uuid (session ref session_ref, console ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
console ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getVM

Overview:
Get the VM field of the given console.
Signature:
VM ref get_VM (session ref session_ref, console ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
console ref self reference to the object
Minimum Role: read-only
Return Type: VM ref
value of the field

RPC name: removefromotherconfig

Overview:
Remove the given key and its corresponding value from the otherconfig field of the given console. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, console ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
console ref self reference to the object
string key Key to remove
Minimum Role: vm-admin
Return Type: void

RPC name: setotherconfig

Overview:
Set the otherconfig field of the given console.
Signature:
void set_other_config (session ref session_ref, console ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
console ref self reference to the object
(string -> string) map value New value to set
Minimum Role: vm-admin
Return Type: void