console
Class: console
A console
| Published in: | XenServer 4.0 (rio) | A console |
Enums
console_protocol
| Values: | vt100 | VT100 terminal |
| rfb | Remote FrameBuffer protocol (as used in VNC) |
| rdp | Remote Desktop Protocol |
Fields
string
location
[RO/runtime]
URI for the console service
| Published in: | XenServer 4.0 (rio) | URI for the console service |
(string → string) map
other_config
[RW]
additional configuration
| Published in: | XenServer 4.0 (rio) | additional configuration |
enum console_protocol
protocol
[RO/runtime]
the protocol used by this console
| Published in: | XenServer 4.0 (rio) | the protocol used by this console |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
VM ref
VM
[RO/runtime]
VM to which this console is attached
| Published in: | XenServer 4.0 (rio) | VM to which this console is attached |
Messages
void
add_to_other_config
(session ref, console ref, string, string)
Add the given key-value pair to the other_config field of the given console.
| Parameters: | session ref session_id | 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 |
| Published in: | XenServer 4.0 (rio) | additional configuration |
console ref
create
(session ref, console record)
Create a new console instance, and return its handle.
The constructor args are: other_config* (* = non-optional).
| Parameters: | session ref session_id | Reference to a valid session |
| console record args | All constructor arguments |
| Minimum role: | vm-admin |
| Result: | reference to the newly created object |
| Published in: | XenServer 4.0 (rio) | A console |
void
destroy
(session ref, console ref)
Destroy the specified console instance.
| Parameters: | session ref session_id | Reference to a valid session |
| console ref self | reference to the object |
| Minimum role: | vm-admin |
| Published in: | XenServer 4.0 (rio) | A console |
console ref set
get_all
(session ref)
Return a list of all the consoles known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | references to all objects |
| Published in: | XenServer 4.0 (rio) | A console |
(console ref → console record) map
get_all_records
(session ref)
Return a map of console references to console records for all consoles known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | records of all objects |
| Published in: | XenServer 4.0 (rio) | A console |
console ref
get_by_uuid
(session ref, string)
Get a reference to the console instance with the specified UUID.
| Parameters: | session ref session_id | Reference to a valid session |
| string uuid | UUID of object to return |
| Minimum role: | read-only |
| Result: | reference to the object |
| Published in: | XenServer 4.0 (rio) | A console |
string
get_location
(session ref, console ref)
Get the location field of the given console.
| Parameters: | session ref session_id | Reference to a valid session |
| console ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | URI for the console service |
(string → string) map
get_other_config
(session ref, console ref)
Get the other_config field of the given console.
| Parameters: | session ref session_id | Reference to a valid session |
| console ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | additional configuration |
enum console_protocol
get_protocol
(session ref, console ref)
Get the protocol field of the given console.
| Parameters: | session ref session_id | Reference to a valid session |
| console ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the protocol used by this console |
console record
get_record
(session ref, console ref)
Get a record containing the current state of the given console.
| Parameters: | session ref session_id | Reference to a valid session |
| console ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 4.0 (rio) | A console |
string
get_uuid
(session ref, console ref)
Get the uuid field of the given console.
| Parameters: | session ref session_id | Reference to a valid session |
| console ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
VM ref
get_VM
(session ref, console ref)
Get the VM field of the given console.
| Parameters: | session ref session_id | Reference to a valid session |
| console ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | VM to which this console is attached |
void
remove_from_other_config
(session ref, console ref, string)
Remove the given key and its corresponding value from the other_config field of the given console. If the key is not in that Map, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| console ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | vm-admin |
| Published in: | XenServer 4.0 (rio) | additional configuration |
void
set_other_config
(session ref, console ref, (string → string) map)
Set the other_config field of the given console.
| Parameters: | session ref session_id | Reference to a valid session |
| console ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | vm-admin |
| Published in: | XenServer 4.0 (rio) | additional configuration |