openstack/oslo.vmware
Code Issues Proposed changes

Make usage doc easier to understand for library consumers

Browse Source 
This change makes a few modifications to make the usage doc easier
to understand and consume for users of the oslo.vmware library.
Among the changes are explanations for parameters, extra helpful
comments, removing references to default arguments to simplify the
example.

Change-Id: Iccbe40f6bda0c65c3de87d708634ae6bbdcaa959
This commit is contained in:
Ryan Hsu 2015-07-24 11:28:48 -07:00
parent d83f03fb01
commit 9df58d2d6a
1 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/source/usage.rst
View File

@ -2,13 +2,24 @@
Usage
========
To use in a project::
Example usage of getting a handle to a vSphere session and retrieving all the
ESX hosts in a server::
from oslo_vmware import api
from oslo_vmware import vim_util
from oslo_vmware import api
from oslo_vmware import vim_util
api_session = api.VMwareAPISession('10.1.2.3', 'administrator',
'password', 10, 0.1,
create_session=False, port=443)
result = api_session.invoke_api(vim_util, 'get_objects',
api_session.vim, 'HostSystem', 100)
# Get a handle to a vSphere API session
session = api.VMwareAPISession(
'10.1.2.3', # vSphere host endpoint
'administrator', # vSphere username
'password', # vSphere password
10, # Number of retries for connection failures in tasks
0.1 # Poll interval for async tasks (in seconds)
)
# Example call to get all the managed objects of type "HostSystem"
# on the server.
result = session.invoke_api(
vim_util, # Handle to VIM utility module
'get_objects', # API method name to invoke
session.vim, 'HostSystem', 100) # Params to API method (*args)