Bug 1388807

Summary: Documentation of RESTAPI support for VM "Enable VirtIO serial console"
Product: Red Hat Enterprise Virtualization Manager Reporter: Rainer Beyel <rbeyel>
Component: DocumentationAssignee: rhev-docs <rhev-docs>
Status: CLOSED CURRENTRELEASE QA Contact: rhev-docs <rhev-docs>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 3.6.9CC: lbopf, lsurette, mavital, rbalakri, srevivo, thildred, ykaul, ylavi
Target Milestone: ovirt-4.0.7   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-05-24 14:54: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: 1321582    
Bug Blocks: 1148393    

Description Rainer Beyel 2016-10-26 08:34:00 UTC
Description of problem:
The REST-API Guide [1] is missing documentation on how to enable/disable the "serial console" of a VM.

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

How reproducible:
always

Steps to Reproduce:
Missing documentation in REST-API Guide [1]

Actual results:
Feature not documented in REST-API Guide [1]

Expected results:
Feature documented in REST-API Guide [1]

  Example:
  <vm>
    <console enabled="true" />
  </vm>

  The "All-Content: true" header has to be set.

  See bugzilla [2] Comment 12 for details,

Additional info:
- this downstream bugzilla refers to RHEV-M 3.6
- upstream bugzilla [2]

Links:
1) https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.6/html-single/REST_API_Guide/index.html
2) https://bugzilla.redhat.com/show_bug.cgi?id=1321582

Comment 1 Yaniv Lavi 2017-05-24 14:54:27 UTC
Will be reviewed by docs directly on the code.