9df58d2d6a
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
26 lines
917 B
ReStructuredText
26 lines
917 B
ReStructuredText
========
|
|
Usage
|
|
========
|
|
|
|
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
|
|
|
|
# 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)
|