Commit 6f4a2e9d authored by Andrea Spadaccini's avatar Andrea Spadaccini

Fix RAPI documentation for gnt-instance console

Fix a failing pyassert in the RAPI docs and update it to reflect the
addition of SPICE to gnt-instance console.
Signed-off-by: default avatarAndrea Spadaccini <spadaccio@google.com>
Reviewed-by: default avatarMichael Hanselmann <hansmi@google.com>
parent ea064d24
......@@ -977,20 +977,23 @@ console. Contained keys:
constants.CONS_MESSAGE,
constants.CONS_SSH,
constants.CONS_VNC,
constants.CONS_SPICE,
])
``instance``
Instance name.
``kind``
Console type, one of :pyeval:`constants.CONS_SSH`,
:pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_MESSAGE`.
:pyeval:`constants.CONS_VNC`, :pyeval:`constants.CONS_SPICE`
or :pyeval:`constants.CONS_MESSAGE`.
``message``
Message to display (:pyeval:`constants.CONS_MESSAGE` type only).
``host``
Host to connect to (:pyeval:`constants.CONS_SSH` and
:pyeval:`constants.CONS_VNC` only).
Host to connect to (:pyeval:`constants.CONS_SSH`,
:pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_SPICE` only).
``port``
TCP port to connect to (:pyeval:`constants.CONS_VNC` only).
TCP port to connect to (:pyeval:`constants.CONS_VNC` or
:pyeval:`constants.CONS_SPICE` only).
``user``
Username to use (:pyeval:`constants.CONS_SSH` only).
``command``
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment