Console params for Compute API are outdated and inaccurate

Bug #1446660 reported by Anne Gentle
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-api-site
Fix Released
Medium
Alex Xu

Bug Description

Based on the cli there are four commands:
nova get-rdp-console
nova get-serial-console
nova get-spice-console
nova get-vnc-console

When using --debug to see the actual API call I see there are undocumented request params, and I'm not sure the os-console is the only extension that gives you a console. What about os-getVNCConsole, that needs to be documented.

There are also undocumented console types.

rdp-html5
serial
spice-html5
"novnc" or "xvpvnc"

Tags: nova
Revision history for this message
Diane Fleming (diane-fleming) wrote :

Anne, can you clarify what's need with this bug?

From what I gather, this is what needs to happen:

- This call is missing request parameters: http://developer.openstack.org/api-ref-compute-v2-ext.html#getConsole
- There are other console types that need to be documented in addition to os-getVNCConsole (that one is documented - see my frist bullt)

Changed in openstack-api-site:
status: Confirmed → Incomplete
Changed in openstack-api-site:
status: Incomplete → Confirmed
assignee: nobody → Alex Xu (xuhj)
milestone: none → liberty
Atsushi SAKAI (sakaia)
tags: added: nova
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/235064
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=cd14d8cc0ee2b1c67f06a42c7e5472216859bd6c
Submitter: Jenkins
Branch: master

commit cd14d8cc0ee2b1c67f06a42c7e5472216859bd6c
Author: He Jie Xu <email address hidden>
Date: Thu Oct 15 11:08:01 2015 +0800

    The servers remote console section is missing RDP and Serial console

    There are four consoles in the Compute API, but the doc is missing RDP
    and Serial console. This patch adds them.

    (df) Updated the descriptions and also added in the missing
    "get console log output" call.
    (df) Consolidated all server actions and ensured that the
    actions match what's in the generated code samples.

    Closes-Bug: #1446660

    Change-Id: Ibfe994a3be38da2cb53e3edb0df41511a29368cc

Changed in openstack-api-site:
status: Confirmed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.