Console Service
Overview
The Platform Management feature of ZStack Cloud displays the current console proxy information, that is, the information about the proxy you use when you open the console of your VM instance.
- You need to modify the console proxy address only in the management node.
- The default proxy address is the IP address of the management node.
- The displayed type is ManagementServerConsoleProxy.
- You can open the console of a VM instance only when the state of the console proxy is Enabled and the status is Connected.
You can perform the following operations on a console proxy:
- Reconnect: You can reconnect the console proxy if the console of a VM instance fails to be opened. After reconnection, you can open the console again when the proxy state is Enabled and the proxy status is Connected.
- Set the console proxy address:
ZStack Cloud allows you to set the console proxy address
on the UI.
- The console proxy address can either be the public IP address, the NAT address, or the domain name of a management node. Port settings are not supported.
- The setting takes effect immediately without a need to restart the management node.
Inventory
Properties
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 0.6 | ||
| description | The detailed description of the resource. | Yes | 0.6 | |
| state | The state. |
|
0.6 | |
| status | The status, including Connected and Disconnected. | 0.6 | ||
| type | The type. | 0.6 | ||
| managementIp | The IP address of the management node. | 0.6 | ||
| consoleProxyOverriddenIp | 0.6 | |||
| createDate | The creation date. For more information, see Resource Property. | 0.6 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 0.6 |
Sample
{
"inventories": [
{
"consoleProxyOverriddenIp": "",
"createDate": "Mar 10, 2018 3:40:42 PM",
"description": "Console proxy agent running on the management node[uuid:c6696896a2a34f1782781e42f85d89a4]",
"lastOpDate": "Mar 10, 2018 3:40:56 PM",
"managementIp": "10.0.210.4",
"state": "Enabled",
"status": "Connected",
"type": "ManagementServerConsoleProxy",
"uuid": "c6696896a2a34f1782781e42f85d89a4"
}
],
"success": true
}Operations
RequestConsoleAccess
Sends a request to obtain the access address of a console. For
example,
RequestConsoleAccess vmInstanceUuid=43ff23ed457544e285597ad8d8edad68Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vmInstanceUuid | The VM instance UUID. | 0.6 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 0.6 | |
| timeout | Yes |
QueryConsoleProxyAgent
Queries a console proxy. For
example,
QueryConsoleProxyAgent consoleProxyOverriddenIp=172.20.16.176Primitive Fields of Query
See Console Proxy Agent Inventory.
ReconnectConsoleProxyAgent
Reconnects a console proxy. For
example,
ReconnectConsoleProxyAgent agentUuids=f3537a0d957e49fc971acd4198ca1729Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| agentUuids | The console proxy UUID. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 0.6 | |
| timeout | Yes |
UpdateConsoleProxyAgent
Updates a console proxy. For
example,
UpdateConsoleProxyAgent uuid=dccc2549a6b7402cbf5de9551b6c06e9 consoleProxyOverriddenIp=172.20.16.255Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| consoleProxyOverriddenIp | The IP address of the console proxy. | 0.6 | ||
| uuid | 0.6 | |||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 0.6 | |
| timeout | Yes |
Tags
You can create a user tag on a console proxy by using CreateUserTag
resourceType=ConsoleProxyAgentVO. For
example,
CreateUserTag resourceType=ConsoleProxyAgentVO tag=Test1 \
resourceUuid=3214e0dcd01d4e2aa8407968e1ccreatee51d58