Bug 1388636

Summary: [RFE] The documentation of the API is missing some of the new/updated changes/features, as only a few details are documented in the SDK manual
Product: Red Hat Enterprise Virtualization Manager Reporter: Bimal Chollera <bcholler>
Component: DocumentationAssignee: rhev-docs <rhev-docs>
Status: CLOSED DUPLICATE QA Contact: rhev-docs <rhev-docs>
Severity: high Docs Contact:
Priority: unspecified    
Version: 3.6.9CC: gklein, lsurette, rbalakri, sfroemer, srevivo, ykaul, ylavi
Target Milestone: ---Keywords: FutureFeature
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: 2016-11-01 13:33:41 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:

Description Bimal Chollera 2016-10-25 19:36:11 UTC
Description of problem:

The documentation of the API is missing some of the new/updated changes/features, as only a few details are documented in the SDK manual (https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.6/html/Python_SDK_Guide/index.html).

For example, the following worked in RHEV-3.5, but not anymore in RHEV-3.6 as the behavior has completely changed per https://bugzilla.redhat.com/show_bug.cgi?id=1172629.


## RHEV-3.5

~~~
pm = params.PowerManagement()
pm.set_type('ipmilan')
pm.set_enabled(True)
pm.set_address(PM_ADDRESS)
pm.set_username('fence_user')
pm.set_password('XXXXXXXXXX')
pm.set_kdump_detection(True)
         
if api.hosts.add(params.Host(name=HOST_NAME,
                 address=HOST_ADDRESS,
                 cluster=api.clusters.get(CLUSTER_NAME),
                 root_password=ROOT_PASSWORD,
                 power_management=pm)):

~~~

## RHEV-3.6

~~~
# Add the fencing agent:
agent = params.Agent()
agent.set_options(params.Options())
agent.set_type("ilo3")
agent.set_username("admin")
agent.set_password("XXXXXXXXX")
agent.set_address("PM_ADDRESS")
agent.set_order(1);

# enable PM and set fenceagent to a new host instance
pm = params.PowerManagement()
pm.set_enabled(True)
pm.set_agents(agent)

# Creating Host instance
host = params.Host()
host.set_power_management(pm)
~~~

Another is adding a serial console using API.

There is an older BZ https://bugzilla.redhat.com/show_bug.cgi?id=1148393 on this subject but was comment https://bugzilla.redhat.com/show_bug.cgi?id=1148393#c11 redirect to upstream BZ https://bugzilla.redhat.com/show_bug.cgi?id=1201197.



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

RHEV-M 3.6.9

How reproducible:


Steps to Reproduce:
1. 
2.
3.

Actual results:

No new API documentation is available for any new/update changed/features.

Expected results:

It would be have the documentation updated with any new/updated changed/feature that have been changed.

Additional info:

Comment 1 Ondra Machacek 2016-10-26 06:23:37 UTC
This is Documentation RFE, so I am changing the bugzilla component accordingly.

FYI, we have some examples located in the git repository of the Python SDK(version 4), you can see it here:

  https://github.com/oVirt/ovirt-engine-sdk/tree/master/sdk/examples

Comment 2 Yaniv Lavi 2016-11-01 13:33:41 UTC

*** This bug has been marked as a duplicate of bug 1148393 ***