1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
.. -*- rst -*-
==================================================
XenServer VNC Proxy (XVP) consoles (os-consoles)
==================================================
Manages server XVP consoles.
.. warning::
These APIs are only applicable when using the XenServer virt driver.
They were removed in the 21.0.0 (Ussuri) release.
Lists Consoles
==============
.. rest_method:: GET /servers/{server_id}/consoles
Lists all consoles for a server.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), gone(410)
Request
-------
.. rest_parameters:: parameters.yaml
- server_id: server_id_path
Response
--------
.. rest_parameters:: parameters.yaml
- consoles: consoles
- console: console
- console_type: console_type
- id: console_id_in_body
|
**Example List Consoles**
.. literalinclude:: ../../doc/api_samples/consoles/consoles-list-get-resp.json
:language: javascript
Create Console
==============
.. rest_method:: POST /servers/{server_id}/consoles
Creates a console for a server.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
Request
-------
.. rest_parameters:: parameters.yaml
- server_id: server_id_path
Response
--------
If successful, this method does not return a response body.
Show Console Details
====================
.. rest_method:: GET /servers/{server_id}/consoles/{console_id}
Shows console details for a server.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
Request
-------
.. rest_parameters:: parameters.yaml
- server_id: server_id_path
- console_id: console_id
Response
--------
.. rest_parameters:: parameters.yaml
- console: console
- console_type: console_type
- host: console_host
- id: console_id_in_body
- instance_name: instance_name
- password: console_password
- port: port_number
|
**Example Show Console Details**
.. literalinclude:: ../../doc/api_samples/consoles/consoles-get-resp.json
:language: javascript
Delete Console
==============
.. rest_method:: DELETE /servers/{server_id}/consoles/{console_id}
Deletes a console for a server.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
Request
-------
.. rest_parameters:: parameters.yaml
- server_id: server_id_path
- console_id: console_id
Response
--------
If successful, this method does not return a response body.
|
