Bug 1327252

Summary: Missing documentation for REST API commands for guest serial console feature
Product: Red Hat Enterprise Virtualization Manager Reporter: Ilanit Stein <istein>
Component: DocumentationAssignee: rhev-docs <rhev-docs>
Status: CLOSED CURRENTRELEASE QA Contact: meital avital <mavital>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 3.6.5CC: fromani, juan.hernandez, lsurette, mavital, rbalakri, srevivo, ylavi
Target Milestone: ovirt-4.0.7   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-05-23 07:55:27 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: Docs RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1148393    

Description Ilanit Stein 2016-04-14 15:03:56 UTC 
Description of problem:
For serial console, rhevm 3.6 feature (For RFE see [1]),
REST API documentation for how to configure it is missing.
[2] and [3] configuration steps should be documented.

[1] Bug 1223671 - [RFE] Provide interface to access guest serial console 
[2] Bug 1254445 - REST API: missing support for ssh keys handling 
[3] Bug 1321582 - [RESTAPI] Add support for VM "Enable VirtIO serial console"

Version-Release number of selected component (if applicable):
3.6.5-4

Additional info:

Example for [2], above:
======================
 /post/get/put/delete over REST API for the serial-console key management.
In order to create a new key, use this syntax:
Method: PUT      URL:  https://<engine fqdn>/ovirt-engine/api/users/00000018-0018-0018-0018-0000000001dc/sshpublickeys/KEY_ID_HERE 


Request Header: 
Name                    	Header Value
Content-type	application/xml
Accept	application/xml

Body:

<ssh_public_key>
<content>ssh-dsa  
. . . 
</content>
</ssh_public_key>
Comment 1 Yaniv Lavi 2016-05-09 11:06:20 UTC 
oVirt 4.0 Alpha has been released, moving to oVirt 4.0 Beta target.
Comment 5 Juan Hernández 2016-11-08 13:58:20 UTC 
As far as I know this hasn't been addressed in the specification of the API for 4.0.5, so I am re-targeting to 4.0.6.
Comment 6 Yaniv Lavi 2017-05-23 07:55:27 UTC 
The review will be done directly on code. Closing.