Revision b82d4c5e doc/rapi.rst
b/doc/rapi.rst | ||
---|---|---|
984 | 984 |
Whether to force an unknown variant. |
985 | 985 |
|
986 | 986 |
|
987 |
``/2/instances/[instance_name]/console`` |
|
988 |
++++++++++++++++++++++++++++++++++++++++ |
|
989 |
|
|
990 |
Request information for connecting to instance's console. |
|
991 |
|
|
992 |
Supports the following commands: ``GET``. |
|
993 |
|
|
994 |
``GET`` |
|
995 |
~~~~~~~ |
|
996 |
|
|
997 |
Returns a dictionary containing information about the instance's |
|
998 |
console. Contained keys: |
|
999 |
|
|
1000 |
``instance`` |
|
1001 |
Instance name. |
|
1002 |
``kind`` |
|
1003 |
Console type, one of ``ssh``, ``vnc`` or ``msg``. |
|
1004 |
``message`` |
|
1005 |
Message to display (``msg`` type only). |
|
1006 |
``host`` |
|
1007 |
Host to connect to (``ssh`` and ``vnc`` only). |
|
1008 |
``port`` |
|
1009 |
TCP port to connect to (``vnc`` only). |
|
1010 |
``user`` |
|
1011 |
Username to use (``ssh`` only). |
|
1012 |
``command`` |
|
1013 |
Command to execute on machine (``ssh`` only) |
|
1014 |
``display`` |
|
1015 |
VNC display number (``vnc`` only). |
|
1016 |
|
|
1017 |
|
|
987 | 1018 |
``/2/instances/[instance_name]/tags`` |
988 | 1019 |
+++++++++++++++++++++++++++++++++++++ |
989 | 1020 |
|
Also available in: Unified diff