mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-26 19:29:58 -05:00
remove doc folder
This commit is contained in:
Tianhao He
parent
72a5072887
commit
082f7b2e6b
BIN
docs/.DS_Store
vendored
BIN
docs/.DS_Store
vendored
Binary file not shown.
BIN
docs/client/.DS_Store
vendored
BIN
docs/client/.DS_Store
vendored
Binary file not shown.
@ -1,394 +0,0 @@
|
|||||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/tr/1999/REC-html401-19991224/loose.dtd">
|
|
||||||
<html><head>
|
|
||||||
<title>VMware vSphere Automation Python SDK: client samples README</title>
|
|
||||||
|
|
||||||
<meta content="VMware, Inc. All rights reserved." name="copyright"></meta>
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../docs/resources/template.css"></link>
|
|
||||||
<script src="../../docs/resources/version.js" type="text/javascript"></script>
|
|
||||||
<style type="text/css">
|
|
||||||
|
|
||||||
h4 {
|
|
||||||
padding: 0;
|
|
||||||
font-size: 12px;
|
|
||||||
font-weight: bold;
|
|
||||||
border-top: 1px solid #dedede;
|
|
||||||
background-color:#E6EDF6;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
.Parameter {
|
|
||||||
margin: 0 0 7px 0;
|
|
||||||
width: 100%;
|
|
||||||
font-size: 11px;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.Code
|
|
||||||
{
|
|
||||||
font-size: 11px; font-family:
|
|
||||||
"Courier New", Courier, monospace;
|
|
||||||
}
|
|
||||||
|
|
||||||
.Console
|
|
||||||
{
|
|
||||||
font-size: 11px; font-family:
|
|
||||||
"Courier New", Courier, monospace;
|
|
||||||
color: #ffffff;
|
|
||||||
font-weight: bold;
|
|
||||||
background: #000000;
|
|
||||||
}
|
|
||||||
.Caption {
|
|
||||||
font-size:11px; line-height:12px; text-transform: uppercase; FONT-WEIGHT: bold; COLOR: #000000; TEXT-DECORATION: none
|
|
||||||
}
|
|
||||||
.Exp {
|
|
||||||
font-size:11px; text-transform: uppercase; FONT-WEIGHT: bold; COLOR: #3366AA;
|
|
||||||
}
|
|
||||||
.Large { font-size: 16px; FONT-WEIGHT: bold; }
|
|
||||||
|
|
||||||
.TableText {
|
|
||||||
FONT-SIZE: 11px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.TableHead {
|
|
||||||
FONT-SIZE: 10px; font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.BoldRedText {
|
|
||||||
FONT-WEIGHT: bold; COLOR: #CC0000; TEXT-DECORATION: none
|
|
||||||
}
|
|
||||||
.BoldBlue {
|
|
||||||
FONT-WEIGHT: bold; COLOR: #3366AA; TEXT-DECORATION: none
|
|
||||||
}
|
|
||||||
.Miniscule {font-size: 9px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.Nav {font-size: 11px; COLOR: #3366AA;
|
|
||||||
}
|
|
||||||
.Large { font-size: 16px; FONT-WEIGHT: bold; }
|
|
||||||
</style>
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
|
|
||||||
<table cellpadding="0" cellspacing="5" id="main-table">
|
|
||||||
<tr><td id="main-body" align="left">
|
|
||||||
<!-- ///*** start of content area ***/// -->
|
|
||||||
|
|
||||||
|
|
||||||
<table width="100%" cellpadding="5">
|
|
||||||
<tr>
|
|
||||||
<td><h1>VMware vSphere Automation Python SDK: client samples README</h1></td>
|
|
||||||
<td align="right">
|
|
||||||
<img src="../../docs/resources/vmware.gif" alt="VMware logo" width="187" height="72" border="0"></img>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<p class="Nav">
|
|
||||||
<img src="../../docs/resources/page.gif" alt="vSphere Automation Python SDK client README" width="13" height="16" border="0"></img>
|
|
||||||
<a href="../vSphere-Automation-Client-SDK-Python-README.html" title="vSphere Automation Python SDK client README...">VMware vSphere Automation Python SDK: client README</a><br />
|
|
||||||
</p>
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
<script type="text/javascript">
|
|
||||||
document.write('This document describes the vSphere Automation Python SDK samples that use the vSphere Automation python client library.')
|
|
||||||
document.write(' (vapi_common_client-' + gVersions.vapiversion + ') ')
|
|
||||||
document.write('and vAPI runtime library')
|
|
||||||
document.write(' (vapi_runtime-' + gVersions.vapiversion + ').')
|
|
||||||
</script>
|
|
||||||
Additionally, some of the samples demonstrate the combined use of the
|
|
||||||
vSphere Automation and vSphere APIs. To support this combined use, the vSphere
|
|
||||||
Automation Python SDK samples require the vSphere Management SDK packages
|
|
||||||
(<a href="https://github.com/vmware/pyvmomi">pyVmomi</a>)
|
|
||||||
to be installed on the client.
|
|
||||||
The examples have been developed to work with python <strong>2.7</strong>,
|
|
||||||
<strong>3.3</strong>, <strong>3.4</strong> and <strong>3.5</strong>.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
The following sections provide information about using the samples..
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><a href="#dependencies">Python SDK and 3rd party Library Dependencies</a></li>
|
|
||||||
<li><a href="#packaging">Feature Samples</a></li>
|
|
||||||
<li><a href="#vcentersample">vAPI Samples for Managing vSphere Infrastructure and Virtual Machines</a></li>
|
|
||||||
<li><a href="#cltaggingsample">Content Library and Tagging Samples</a></li>
|
|
||||||
<li><a href="#connectionsample">Connection Workflow Samples</a></li>
|
|
||||||
<li><a href="#runningsample">Running the Samples</a></li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<a name="dependencies"></a>
|
|
||||||
<h2>Python SDK and 3rd party Dependencies</h2>
|
|
||||||
<p>
|
|
||||||
Please see the instructions for
|
|
||||||
<a href="../vSphere-Automation-Client-SDK-Python-README.html#installingsdklibs">
|
|
||||||
installing the SDK and 3rd party libraries</a>.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<a name="packaging"></a>
|
|
||||||
<h2>Feature Samples</h2>
|
|
||||||
|
|
||||||
<p> The vSphere Automation Python SDK samples are located in the client sample
|
|
||||||
directory:
|
|
||||||
<strong>samples</strong><br/><br/>
|
|
||||||
The following table shows the sample sub-directories and their contents.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<table border="1" cellpadding="5">
|
|
||||||
<tr><th>Directory</th><th>Description</th></tr>
|
|
||||||
<tr><td>samples.vsphere.common</td><td>Samples common classes and abstractions; This package does NOT contain any sample</td></tr>
|
|
||||||
<tr><td>samples.vsphere.vim.helpers</td><td>Samples and utilities for accessing and manipulating VC objects using pyVmomi</td></tr>
|
|
||||||
<tr><td>samples.vsphere.lookupservice</td><td>Service discovery sample using lookup service APIs</td></tr>
|
|
||||||
<tr><td>samples.vsphere.vcenter</td><td>vAPI samples for managing vSphere infrastructure and virtual machines</td></tr>
|
|
||||||
<tr><td>samples.vsphere.workflow</td><td>Various vAPI work flow samples</td></tr>
|
|
||||||
<tr><td>samples.vsphere.inventory</td><td>Samples for inventory APIs for retrieving information about vCenter datastore and network objects.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<a name="vcentersample"></a>
|
|
||||||
<h2>vAPI Samples for Managing vSphere Infrastructure and Virtual Machines</h2>
|
|
||||||
<p>
|
|
||||||
The directory samples.vsphere.vcenter contains samples for the vSphere infrastructure and virtual machine APIs.
|
|
||||||
|
|
||||||
You have two options to run samples inside this package:
|
|
||||||
<ol>
|
|
||||||
<li>
|
|
||||||
Run the whole sample suite which contains all vCenter samples using main.py in samples.vsphere.vcenter.setup package. Please see the README in the setup package for detailed steps.
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
Run an individual sample in an existing environment. You can either pass the environment parameters through command line arguments or specify them in setup.py in the setup package.
|
|
||||||
<br/>
|
|
||||||
For example, to run the create_default_vm sample in the samples.vsphere.vcenter.vm.create package:
|
|
||||||
<ul>
|
|
||||||
<li><code>$ cd /path/to/VMware-vSphere-Automation-SDK-Python-<version>/client/bin</code></li>
|
|
||||||
<li>Run the sample with the testbed settings specified in setup.py in a Linux machine:<br/>
|
|
||||||
<code>$ ./run_sample.sh ../samples/src/samples/vsphere/vcenter/vm/create/create_default_vm.py -v</code>
|
|
||||||
</li>
|
|
||||||
<li>Or specify the credentials using command line parameters:<br/>
|
|
||||||
<code>$ ./run_sample.sh ../samples/src/samples/vsphere/vcenter/vm/create/create_default_vm.py -s <server> -u <username> -p <password> -v</code>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ol>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<a name="cltaggingsample"></a>
|
|
||||||
<h2>Sample Program Structure for the Content Library and Tagging Samples</h2>
|
|
||||||
<p>
|
|
||||||
The Content Library and Tagging samples use a framework to facilitate different
|
|
||||||
aspects of using the samples. Some of the framework capabilities are:
|
|
||||||
<ul>
|
|
||||||
<li>Command line argument parsing.</li>
|
|
||||||
<li>Specifying mandatory and optional arguments for a sample.</li>
|
|
||||||
<li>Sample setup, execution and post-execution cleanup.</li>
|
|
||||||
<li>Information about samples.</li>
|
|
||||||
</ul>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
Each sample extends the class <code>samples_base</code>.
|
|
||||||
This class uses <code>service_manager_factory</code> to create and manage the
|
|
||||||
vAPI service endpoint and vSphere service port. Every sample implements the
|
|
||||||
following methods from the class <code>samples_base</code>:
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><code>_options()</code> - Called by <code>samples_base</code> during <code>parse_args</code> phase. This occurs during initialization.</li>
|
|
||||||
<li><code>_setup()</code> - Called by <code>samples_base</code> during <code>before</code> phase. This occurs after authentication and vAPI and vSphere service initialization.</li>
|
|
||||||
<li><code>_execute()</code> - Called by <code>samples_base</code> during <code>run</code> phase. At this point all the connections and services are initialized.</li>
|
|
||||||
<li><code>_cleanup()</code> - Called by <code>samples_base</code> during <code>after</code> phase. This occurs before disconnecting the services.</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Samples configuration</h3>
|
|
||||||
You can specify server, username and password in the configuration file
|
|
||||||
(sample.cfg). If you use a configuration file, you can run samples without
|
|
||||||
specifying these options on the command line.
|
|
||||||
When you run a sample, you can override the configuration file values by
|
|
||||||
specifying command line options.
|
|
||||||
|
|
||||||
<pre style="border: 2px solid #A9A9A9; width: 60em; max-width: 60em; background-color:#DCDCDC;">
|
|
||||||
[connection]
|
|
||||||
server=vCenter server IP
|
|
||||||
username=username
|
|
||||||
password=password
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
The sample.cfg file can be found under <code>VMware-vSphere-Automation-SDK-Python-<version>/client/samples/src</code>
|
|
||||||
</br>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<a name="connectionsample"></a>
|
|
||||||
<h2>
|
|
||||||
Connection Workflow Samples:
|
|
||||||
</h2>
|
|
||||||
<p>
|
|
||||||
To work with the VMWare-supported deployment configurations of
|
|
||||||
Platform Services Controllers (Single Sign-On) and vCenter Servers,
|
|
||||||
applications need to dynamically discover service URLs to make service requests.
|
|
||||||
Before making service requests, applications need to authenticate.
|
|
||||||
They can authenticate using a username and password or with a token obtained
|
|
||||||
from the Single Sign-On service.
|
|
||||||
<br/>
|
|
||||||
vApi connection workflow sample performs the following basic steps to connect
|
|
||||||
to the vAPI service endpoint (on a management node).
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li>Step 1: Retrieve the vAPI service endpoint URL from the lookup service.</li>
|
|
||||||
<li>Step 2: Connect to the vAPI service endpoint.</li>
|
|
||||||
<li>Step 3: Use the username/password to login to the vAPI service endpoint.</li>
|
|
||||||
<li>Step 4: Create a vAPI session.</li>
|
|
||||||
<li>Step 5: Validate some of the vAPI services.</li>
|
|
||||||
<li>Step 6: Delete the vAPI session.</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
The call sequence shown above is implemented in the samples framework through the following modules:</br>
|
|
||||||
<ul>
|
|
||||||
<li><code>src/samples/vsphere/common/lookup_service_helper</code> provides methods for discovering management nodes and service endpoint URLs on management nodes from lookup service.</li>
|
|
||||||
<li><code>src/samples/vsphere/common/platform_service_controller</code> uses lookup_service_helper to discover the Single Sign-On URL (on any of the Platform Service Controller node) and then retrieves the SAML token from the Single Sign-On server by authenticating the given user.</li>
|
|
||||||
<li><code>src/samples/vsphere/common/service_manager</code> login to the vAPI and vim service endpoints (on a management node).</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>Running the Connection Workflow Samples:</h3>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
The following parameters are needed for running the samples:
|
|
||||||
</p>
|
|
||||||
<ul>
|
|
||||||
<li><code>lswsdlurl</code> -lookup service WSDL file URL. See <a href="#using_wsdl"> Using WSDL</a></li>
|
|
||||||
<li><code>lssoapurl</code> - Platform Service controller's/node's (any, since data is replicated) lookupservice soap URL. Ex: https://psc/lookupservice/sdk</li>
|
|
||||||
<li><code>mgmtinstancename</code> - Instance name of the vCenter Server management node. When only one node is registered, it is selected by default; otherwise, omit the parameter to get a list of available nodes.</li>
|
|
||||||
<li><code>username</code> - username for authentication with the SSO server</li>
|
|
||||||
<li><code>password</code> - password for the SSO user</li>
|
|
||||||
<li><code>skipverification</code> - Do not verify server certificate</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
You can also specify these parameters in the configuration file (sample.cfg).
|
|
||||||
If you use a configuration file, you can run samples without specifying these
|
|
||||||
options on the command line.
|
|
||||||
|
|
||||||
<a name="using_wsdl"></a>
|
|
||||||
<h3>Working with lookup service WSDL</h3>
|
|
||||||
The vSphere Automation SDK for Python samples use the vSphere Automation Lookup Service to obtain the URLs for other vSphere Automation services (SSO, vAPI, VIM, SPBM, etc.).
|
|
||||||
The SDK contains the Lookup Service WSDL files. The samples use the python SUDS client for accessing the lookup service.
|
|
||||||
<br/>
|
|
||||||
The Lookup Service WSDL files are located in the following SDK directory:
|
|
||||||
<br/>
|
|
||||||
<code>VMware-vSphere-Automation-SDK-Python-<version>/client/wsdl</code>.
|
|
||||||
<br/>
|
|
||||||
You must specify the WSDL file location in the <code>client/samples/src/sample.cfg</code> file and in the lookupservice.wsdl file (located in the WSDL directory).
|
|
||||||
|
|
||||||
<ol>
|
|
||||||
<li>In sample.cfg, set 'lswsdlurl' to the lokkupservice WSDL file location. Use a local file URL specification:
|
|
||||||
e.g. lswsdlurl=file:///path/to/the/VMware-vSphere-Automation-SDK-Python-6.5.0/client/wsdl/lookupservice.wsdl</br>
|
|
||||||
(Note: You can also specify the lookup service WSDL path to the sample as a command line option)</li>
|
|
||||||
<li>In lookupservice.wsdl, set 'import location' to the local lookup WSDL file. Use a local file URL specification.
|
|
||||||
<pre>
|
|
||||||
<import location="file:///path/to/the/VMware-vSphere-Automation-SDK-Python-6.5.0/client/wsdl/lookup.wsdl" namespace="urn:lookup" />
|
|
||||||
<service name="LsService">
|
|
||||||
<port binding="interface:LsBinding" name="LsPort">
|
|
||||||
<soap:address location="http://localhost:8080/lookupservice/sdk" />
|
|
||||||
</port>
|
|
||||||
</service>
|
|
||||||
</pre>
|
|
||||||
</li>
|
|
||||||
</ol>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<a name="runningsample"></a>
|
|
||||||
<h2>Running the samples from the command line</h2>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
You can run the samples from command line using the scripts supplied in <code>VMware-vSphere-Automation-SDK-Python-<version>/client/bin</code> directory:
|
|
||||||
</p>
|
|
||||||
Before running the samples:
|
|
||||||
<ol>
|
|
||||||
<li>You must set the <code>PYTHON_HOME</code> environment variable to the base directory for the python 2.7</li>
|
|
||||||
<li>You must install all the dependencies required by the samples on client. See <a href="#dependencies"> Sample Dependencies</a></li>
|
|
||||||
</ol>
|
|
||||||
<p>
|
|
||||||
<strong>Examples:</strong>
|
|
||||||
</p>
|
|
||||||
<pre>
|
|
||||||
$cd /path/to/VMware-vSphere-Automation-SDK-Python-<version>/client/bin
|
|
||||||
$run_sample.sh ../samples/src/samples/vsphere/workflow/connection_workflow.py \
|
|
||||||
-vapiurl https://203.0.113.0/api \
|
|
||||||
-stsurl https://203.0.113.0:443/sts/STSService/vsphere.local \
|
|
||||||
-username administrator@vsphere.local \
|
|
||||||
-password AdminPassword
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
</br>
|
|
||||||
Use the -h option to print information about a sample.
|
|
||||||
The following example shows the help for the vAPI connection workflow sample.
|
|
||||||
<pre>
|
|
||||||
$ ./run_sample.sh ../samples/src/samples/vsphere/workflow/vapi_connection_workflow.py -h
|
|
||||||
usage: vapi_connection_workflow.py [-h] [-w LSWSDLURL] [-s LSSOAPURL]
|
|
||||||
[-m MGMTINSTANCENAME] [-u USERNAME]
|
|
||||||
[-p PASSWORD] [-v]
|
|
||||||
|
|
||||||
Demonstrates vAPI connection and service initialization call flow using the
|
|
||||||
username and password.
|
|
||||||
Step 1: Retrieve the vAPI service endpoint URL from lookup service.
|
|
||||||
Step 2: Connect to the vAPI service endpoint.
|
|
||||||
Step 3: Use the username/password to login to the vAPI service endpoint.
|
|
||||||
Step 4: Create a vAPI session.
|
|
||||||
Step 5: Validate some of the vAPI services.
|
|
||||||
Step 6: Delete the vAPI session.
|
|
||||||
|
|
||||||
optional arguments:
|
|
||||||
-h, --help show this help message and exit
|
|
||||||
-w LSWSDLURL, --lswsdlurl LSWSDLURL
|
|
||||||
Lookup service WSDL URL
|
|
||||||
-s LSSOAPURL, --lssoapurl LSSOAPURL
|
|
||||||
Lookup service SOAP URL
|
|
||||||
-m MGMTINSTANCENAME, --mgmtinstancename MGMTINSTANCENAME
|
|
||||||
Instance name of the vCenter Server management node.
|
|
||||||
When only one node is registered, it is selected by
|
|
||||||
default; otherwise, omit the parameter to get a list
|
|
||||||
of available nodes.
|
|
||||||
-u USERNAME, --username USERNAME
|
|
||||||
SSO user name
|
|
||||||
-p PASSWORD, --password PASSWORD
|
|
||||||
SSO user password
|
|
||||||
-v, --skipverification
|
|
||||||
Do not verify server certificate
|
|
||||||
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
Note: In the above example <b>mgmtinstancename</b> is optional and can be omitted if there's a single vCenter Server management node in the deployment.
|
|
||||||
When there is more than one management node, the user MUST specify the management node instance name against which the sample needs
|
|
||||||
to run, else the sample throws <b>MultipleManagementNodeException</b>.
|
|
||||||
Example of a multiple management node exception:
|
|
||||||
<pre>
|
|
||||||
raise MultipleManagementNodeException(MultipleManagementNodeException.format(result))
|
|
||||||
samples.vsphere.common.lookup_service_helper.MultipleManagementNodeException: Multiple Management Node Found on server
|
|
||||||
Node name: vcenter-1.example.com uuid: de2afd86-790e-11e4-9c20-0200087f55c6
|
|
||||||
Node name: vcenter-2.example.com uuid: 545da868-7910-11e4-81e1-020008e89d83
|
|
||||||
</pre>
|
|
||||||
Example exception when an invalid management instance name is specified by the user:
|
|
||||||
<pre>
|
|
||||||
ValueError: abc is not a valid management node instance name
|
|
||||||
Available management nodes:
|
|
||||||
Node name: vcenter-2.example.com uuid: 545da868-7910-11e4-81e1-020008e89d83
|
|
||||||
Node name: vcenter-1.example.com uuid: de2afd86-790e-11e4-9c20-0200087f55c6
|
|
||||||
</pre>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
|
|
||||||
<hr />
|
|
||||||
<table border="0" width="100%">
|
|
||||||
<tr>
|
|
||||||
<td>
|
|
||||||
<p class="Miniscule">Copyright © 2015, 2016 VMware, Inc. All rights not expressly granted herein are reserved.</p>
|
|
||||||
</td>
|
|
||||||
<td align="right"><p class="Miniscule">Last updated: 20 Oct 2016 | VMware vSphere Automation SDK for Python</p></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
</td></tr></table>
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,299 +0,0 @@
|
|||||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/tr/1999/REC-html401-19991224/loose.dtd">
|
|
||||||
<html><head>
|
|
||||||
<title>VMware vSphere Automation Python SDK: client README</title>
|
|
||||||
|
|
||||||
<meta content="VMware, Inc. All rights reserved." name="copyright"></meta>
|
|
||||||
<link rel="stylesheet" type="text/css" href="../docs/resources/template.css"></link>
|
|
||||||
<script src="../docs/resources/version.js" type="text/javascript"></script>
|
|
||||||
<style type="text/css">
|
|
||||||
|
|
||||||
h4 {
|
|
||||||
padding: 0;
|
|
||||||
font-size: 12px;
|
|
||||||
font-weight: bold;
|
|
||||||
border-top: 1px solid #dedede;
|
|
||||||
background-color:#E6EDF6;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
.Parameter {
|
|
||||||
margin: 0 0 7px 0;
|
|
||||||
width: 100%;
|
|
||||||
font-size: 11px;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.Code
|
|
||||||
{
|
|
||||||
font-size: 11px; font-family:
|
|
||||||
"Courier New", Courier, monospace;
|
|
||||||
}
|
|
||||||
|
|
||||||
.Console
|
|
||||||
{
|
|
||||||
font-size: 11px; font-family:
|
|
||||||
"Courier New", Courier, monospace;
|
|
||||||
color: #ffffff;
|
|
||||||
font-weight: bold;
|
|
||||||
background: #000000;
|
|
||||||
}
|
|
||||||
.Caption {
|
|
||||||
font-size:11px; line-height:12px; text-transform: uppercase; FONT-WEIGHT: bold; COLOR: #000000; TEXT-DECORATION: none
|
|
||||||
}
|
|
||||||
.Exp {
|
|
||||||
font-size:11px; text-transform: uppercase; FONT-WEIGHT: bold; COLOR: #3366AA;
|
|
||||||
}
|
|
||||||
.Large { font-size: 16px; FONT-WEIGHT: bold; }
|
|
||||||
|
|
||||||
.TableText {
|
|
||||||
FONT-SIZE: 11px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.TableHead {
|
|
||||||
FONT-SIZE: 10px; font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.BoldRedText {
|
|
||||||
FONT-WEIGHT: bold; COLOR: #CC0000; TEXT-DECORATION: none
|
|
||||||
}
|
|
||||||
.BoldBlue {
|
|
||||||
FONT-WEIGHT: bold; COLOR: #3366AA; TEXT-DECORATION: none
|
|
||||||
}
|
|
||||||
.Miniscule {font-size: 9px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.Nav {font-size: 11px; COLOR: #3366AA;
|
|
||||||
}
|
|
||||||
.Large { font-size: 16px; FONT-WEIGHT: bold; }
|
|
||||||
</style>
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
|
|
||||||
<table cellpadding="0" cellspacing="5" id="main-table">
|
|
||||||
<tr><td id="main-body" align="left">
|
|
||||||
<!-- ///*** start of content area ***/// -->
|
|
||||||
|
|
||||||
|
|
||||||
<table width="100%" cellpadding="5">
|
|
||||||
<tr>
|
|
||||||
<td><h1>VMware vSphere Automation Python SDK: client README</h1></td>
|
|
||||||
<td align="right">
|
|
||||||
<img src="../docs/resources/vmware.gif" alt="VMware logo" width="187" height="72" border="0"></img>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<p class="Nav">
|
|
||||||
<img src="../docs/resources/page.gif" alt="Python SDK client samples README" width="13" height="16" border="0"></img>
|
|
||||||
<a href="samples/vSphere-Automation-Client-SDK-Python-Samples-README.html" title="README for the Python SDK samples...">README for Python SDK samples</a><br />
|
|
||||||
<img src="../docs/resources/page.gif" alt="vSphere Automation Python SDK README" width="13" height="16" border="0"></img>
|
|
||||||
<a href="../vSphere-Automation-SDK-Python-README.html" title="vSphere Automation Python SDK README...">vSphere Automation Python SDK README</a><br />
|
|
||||||
</p>
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
|
|
||||||
The following section describes the current directory contents:
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><a href="#packagecontents">Directory structure</a></li>
|
|
||||||
<li><a href="#apidocs">Python SDK API Docs</a></li>
|
|
||||||
<li><a href="#lib">SDK libraries</a></li>
|
|
||||||
<li><a href="#installingsdklibs">Installing SDK and 3rd party libraries</a></li>
|
|
||||||
<li><a href="#runningsample">Running a sample</a></li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="packagecontents"></a>
|
|
||||||
<h2>Directory structure</h2>
|
|
||||||
<p>The vSphere Automation Client SDK for Python provides client bindings, documentation, samples, and WSDL files. The following table shows the client directories and their contents.</p>
|
|
||||||
<table cellpadding="5" cellspacing="0" border="1" width="100%" class="TableText">
|
|
||||||
<tr><th width="15%">Directory</th><th width="35%">Description</th><th width="60%">Contents</th></tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td>bin</td>
|
|
||||||
<td>Command scripts for sample execution</td>
|
|
||||||
<td>run_sample.bat</br>run_sample.sh</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td>lib</td>
|
|
||||||
<td>VMware python libraries for accessing vSphere Automation services</td>
|
|
||||||
<script type="text/javascript">
|
|
||||||
document.write('<td>')
|
|
||||||
document.write('vapi_runtime-' + gVersions.vapiversion + '.zip' + '</br>')
|
|
||||||
document.write('vapi_common_client-' + gVersions.vapiversion + '.zip' + '</br>')
|
|
||||||
document.write('vapi_client_bindings-' + gVersions.bindingsversion + '.zip' + '</br>')
|
|
||||||
document.write('</td>')
|
|
||||||
</script>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td>samples</td>
|
|
||||||
<td>Python samples that demonstrate the use of the vSphere Automation API</td>
|
|
||||||
<td>See the <a href="samples/vSphere-Automation-Client-SDK-Python-Samples-README.html">Python samples README</a><br />
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td>wsdl</td>
|
|
||||||
<td>Lookup Service WSDL files.</td>
|
|
||||||
<td>lookup.wsdl<br/>lookupservice.wsdl</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
</table>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
<a name="apidocs"></a>
|
|
||||||
<h2>Python SDK API Docs</h2>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
<strong>apidocs</strong> directory contains the generated python API reference documentation for vSphere Automation features like Content Library and Tagging.
|
|
||||||
The README page also includes a hyperlink to pyVmomi API reference documentation for convenience.
|
|
||||||
Please Refer to <a href="../docs/apidocs/vSphere-Automation-SDK-Python-APIRef-README.html"> vSphere Automation SDK Pythondoc</a> for details.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<a name="lib"></a>
|
|
||||||
<h2>SDK libraries</h2>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
For python developers, client libraries are supplied for testing and development purposes.
|
|
||||||
All the supplied libraries are located under <strong>lib</strong> directory.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<table border="1" cellpadding="5">
|
|
||||||
|
|
||||||
<table cellpadding="5" cellspacing="0" border="1" width="100%" class="TableText">
|
|
||||||
<tr><th width="40%">Name</th><th width="60%">Description</th></tr>
|
|
||||||
<script type="text/javascript">
|
|
||||||
document.write('<tr><td>vapi_runtime-' + gVersions.vapiversion + '</td><td>vAPI runtime responsible for serialization/de-serialization of objects and wire protocol</td></tr>')
|
|
||||||
document.write('<tr><td>vapi_common_client-' + gVersions.vapiversion + '</td><td>vAPI common client code</td></tr>')
|
|
||||||
document.write('<tr><td>vapi_client_bindings-' + gVersions.bindingsversion + '</td><td>client stubs for vSphere Automation APIs</td></tr>')
|
|
||||||
</script>
|
|
||||||
</table>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
<a name="installingsdklibs"></a>
|
|
||||||
<h2>Installing SDK and 3rd party libraries</h2>
|
|
||||||
|
|
||||||
The supplied python libs can be installed using <strong>pip install</strong>;
|
|
||||||
For details on how to install python packages using pip please refer to
|
|
||||||
<a href="http://pip.readthedocs.io/en/latest/user_guide/">pip user guide</a>.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h3>vapi_runtime</h3>
|
|
||||||
<p>
|
|
||||||
This library is needed for accessing features like Content Library and Tagging.
|
|
||||||
</p>
|
|
||||||
<pre>> pip install /path/to/VMware-vSphere-Automation-SDK-Python/client/lib/vapi_runtime-2.5.0.zip</pre>
|
|
||||||
</br>
|
|
||||||
<strong>pyOpenSSL</strong> is required by vapi_runtime. Please see the <a href="#pyopenssl">pyOpenSSL installation</a> steps for details.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h3>vapi_common_client</h3>
|
|
||||||
<p>
|
|
||||||
This library is needed for accessing features like Content Library and Tagging.
|
|
||||||
</p>
|
|
||||||
<pre>> pip install /path/to/VMware-vSphere-Automation-SDK-Python/client/lib/vapi_common_client-2.5.0.zip</pre>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h3>vapi_client_bindings</h3>
|
|
||||||
<p>
|
|
||||||
This library is needed for accessing features like Content Library and Tagging.
|
|
||||||
</p>
|
|
||||||
<pre>> pip install /path/to/VMware-vSphere-Automation-SDK-Python/client/lib/vapi_client_bindings-2.5.0.zip</pre>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h3>pyVmomi</h3>
|
|
||||||
<p>
|
|
||||||
This library is needed for accessing/manipulating vCenter Server managed objects using vSphere APIs;
|
|
||||||
For more information please refer to <a href="https://github.com/vmware/pyvmomi">vmware pyVmomi</a>
|
|
||||||
</p>
|
|
||||||
<pre>> pip install pyvmomi</pre>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<strong>The following 3rd party python libraries are required to be installed for running the sample.</strong>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li>pyOpenSSL</li>
|
|
||||||
<li>lxml</li>
|
|
||||||
<li>suds (suds-jurko for python 3.x)</li>
|
|
||||||
</ul>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<a name="pyopenssl"></a>
|
|
||||||
<h3>pyOpenSSL</h3>
|
|
||||||
<p>
|
|
||||||
This requires python <strong>cryptography</strong> package to be installed as a pre-requisite.</br>
|
|
||||||
Please follow the detailed instruction from <a href="https://cryptography.io/en/latest/installation/">installing cryptography dev documentation</a></br>
|
|
||||||
VMware strongly recommends using openssl version <strong>1.0.1j</strong> or, higher. SDK and samples are tested against openssl version >= 1.0.1j.</br>
|
|
||||||
</br>
|
|
||||||
pyOpenSSL version 0.14 is needed for the SDK (vapi_runtime) and samples. For details on how to install the package please go to
|
|
||||||
<a href="https://pypi.python.org/pypi/pyOpenSSL/0.14">pypi.python.org/pypi/pyOpenSSL/0.14</a>.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h3>lxml</h3>
|
|
||||||
<p>
|
|
||||||
Please follow detailed instructions from <a href="http://lxml.de/installation.html">Installing lxml</a>
|
|
||||||
<pre>> pip install lxml</pre>
|
|
||||||
</p>
|
|
||||||
<h4>Notes for the Windows client</h4>
|
|
||||||
<strong>How to use MinGW's gcc compiler when installing python package using pip?</strong>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li>install MinGW with gcc Compiler option checked</li>
|
|
||||||
<li>add C:\MinGW\bin to your PATH</li>
|
|
||||||
<li><span style="line-height: 1.5em;">In </span><strong>PYTHONPATH\Lib\distutils</strong><span style="line-height: 1.5em;">, create a file </span><strong>distutils.cfg</strong><span style="line-height: 1.5em;"> and add these lines:</span></li>
|
|
||||||
<pre>[build]
|
|
||||||
compiler=mingw32
|
|
||||||
</pre>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
Here's an <strong>alternative</strong> method:
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li>Download Libxml-python (Libxml-python are bindings for the libxml2 and libxslt libraries). Windows 64-bit installer for python 2.7 can be found <a href="http://www.lfd.uci.edu/~gohlke/pythonlibs/">here</a></li>
|
|
||||||
<li>Run the installer to install libxml2 and libxslt</li>
|
|
||||||
<li>Download lxml 3.3.1 windows 64-bit installer for python 2.7. <a href="https://pypi.python.org/packages/2.7/l/lxml/lxml-3.3.1.win-amd64-py2.7.exe#md5=6233aa58eebaa857e1f2a6b2ea71a85c">link</a></li>
|
|
||||||
<li>Run the installer to install lxml</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>suds(suds-jurko)</h3>
|
|
||||||
<p>
|
|
||||||
This library is needed for lookup service queries; For more information please refer to <a href="https://fedorahosted.org/suds/wiki/Documentation">suds Documentation</a>
|
|
||||||
</p>
|
|
||||||
<pre>> pip install suds</pre>
|
|
||||||
Use suds-jurko for python 3.x
|
|
||||||
<pre>> pip install suds-jurko</pre>
|
|
||||||
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<a name="runningsample"></a>
|
|
||||||
<h2>Running a sample</h2>
|
|
||||||
|
|
||||||
Please refer to <a href="samples/vSphere-Automation-Client-SDK-Python-Samples-README.html#vcentersample">running a vcenter sample</a> for detailed steps to run a vCenter sample. <br/>
|
|
||||||
Please refer to <a href="samples/vSphere-Automation-Client-SDK-Python-Samples-README.html#runningsample">running a workflow sample</a> for detailed steps to run a vCenter Single Sign-On, Content Library or Tagging sample.
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><strong>run_sample.sh</strong> is needed for running the samples in UNIX/mac OS X environment</li>
|
|
||||||
<li><strong>run_sample.bat</strong> is a windows bat file needed for running the samples in windows</li>
|
|
||||||
</ul>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<hr />
|
|
||||||
<table border="0" width="100%">
|
|
||||||
<tr>
|
|
||||||
<td>
|
|
||||||
<p class="Miniscule">Copyright © 2015 VMware, Inc. All rights not expressly granted herein are reserved.</p>
|
|
||||||
</td>
|
|
||||||
<td align="right"><p class="Miniscule">Last updated: 23rd January 2015 | VMware vSphere Automation Python SDK</p></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
</td></tr></table>
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,117 +0,0 @@
|
|||||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/tr/1999/REC-html401-19991224/loose.dtd">
|
|
||||||
<html><head>
|
|
||||||
<title>VMware vSphere Automation Python SDK: Client API References</title>
|
|
||||||
|
|
||||||
<meta content="VMware, Inc. All rights reserved." name="copyright"></meta>
|
|
||||||
<link rel="stylesheet" type="text/css" href="../resources/template.css"></link>
|
|
||||||
<style type="text/css">
|
|
||||||
|
|
||||||
h4 {
|
|
||||||
padding: 0;
|
|
||||||
font-size: 12px;
|
|
||||||
font-weight: bold;
|
|
||||||
border-top: 1px solid #dedede;
|
|
||||||
background-color:#E6EDF6;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
.Parameter {
|
|
||||||
margin: 0 0 7px 0;
|
|
||||||
width: 100%;
|
|
||||||
font-size: 11px;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.Code
|
|
||||||
{
|
|
||||||
font-size: 11px; font-family:
|
|
||||||
"Courier New", Courier, monospace;
|
|
||||||
}
|
|
||||||
|
|
||||||
.Console
|
|
||||||
{
|
|
||||||
font-size: 11px; font-family:
|
|
||||||
"Courier New", Courier, monospace;
|
|
||||||
color: #ffffff;
|
|
||||||
font-weight: bold;
|
|
||||||
background: #000000;
|
|
||||||
}
|
|
||||||
.Caption {
|
|
||||||
font-size:11px; line-height:12px; text-transform: uppercase; FONT-WEIGHT: bold; COLOR: #000000; TEXT-DECORATION: none
|
|
||||||
}
|
|
||||||
.Exp {
|
|
||||||
font-size:11px; text-transform: uppercase; FONT-WEIGHT: bold; COLOR: #3366AA;
|
|
||||||
}
|
|
||||||
.Large { font-size: 16px; FONT-WEIGHT: bold; }
|
|
||||||
|
|
||||||
.TableText {
|
|
||||||
FONT-SIZE: 11px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.TableHead {
|
|
||||||
FONT-SIZE: 10px; font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.BoldRedText {
|
|
||||||
FONT-WEIGHT: bold; COLOR: #CC0000; TEXT-DECORATION: none
|
|
||||||
}
|
|
||||||
.BoldBlue {
|
|
||||||
FONT-WEIGHT: bold; COLOR: #3366AA; TEXT-DECORATION: none
|
|
||||||
}
|
|
||||||
.Miniscule {font-size: 9px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.Nav {font-size: 11px; COLOR: #3366AA;
|
|
||||||
}
|
|
||||||
.Large { font-size: 16px; FONT-WEIGHT: bold; }
|
|
||||||
</style>
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
|
|
||||||
<table cellpadding="0" cellspacing="5" id="main-table">
|
|
||||||
<tr><td id="main-body" align="left">
|
|
||||||
<!-- ///*** start of content area ***/// -->
|
|
||||||
|
|
||||||
|
|
||||||
<table width="100%" cellpadding="5">
|
|
||||||
<tr>
|
|
||||||
<td><h1>VMware vSphere Automation Python SDK: Client API References</h1></td>
|
|
||||||
<td align="right">
|
|
||||||
<img src="../resources/vmware.gif" alt="VMware logo" width="187" height="72" border="0"></img>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
<p class="Nav">
|
|
||||||
<img src="../resources/page.gif" alt="vSphere Automation SDK for Python Readme" width="13" height="16" border="0"></img>
|
|
||||||
<a href="../../vSphere-Automation-SDK-Python-README.html">README for vSphere Automation SDK for Python</a>.
|
|
||||||
</p>
|
|
||||||
<hr />
|
|
||||||
|
|
||||||
<h2>Python SDK API Docs</h2>
|
|
||||||
<p>
|
|
||||||
<ul>
|
|
||||||
<li><a href="client/py-modindex.html#cap-c">API reference documentation</a> for tagging and content library</li>
|
|
||||||
<li><a href="https://github.com/vmware/pyvmomi/tree/master/docs">pyVmomi API reference documentation</a> for vSpehere API</li>
|
|
||||||
</ul>
|
|
||||||
</p>
|
|
||||||
<hr />
|
|
||||||
<table border="0" width="100%">
|
|
||||||
<tr>
|
|
||||||
<td>
|
|
||||||
<p class="Miniscule">Copyright © 2015 VMware, Inc. All rights not expressly granted herein are reserved.</p>
|
|
||||||
</td>
|
|
||||||
<td align="right"><p class="Miniscule">Last updated: 23rd January 2015 | VMware vSphere Automation SDK for Python</p></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 91 B |
Binary file not shown.
|
Before Width: | Height: | Size: 109 B |
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 2.7 KiB |
@ -1,206 +0,0 @@
|
|||||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/tr/1999/REC-html401-19991224/loose.dtd">
|
|
||||||
<html><head>
|
|
||||||
<title>VMware vSphere Automation Python SDK README</title>
|
|
||||||
|
|
||||||
<meta content="VMware, Inc. All rights reserved." name="copyright"></meta>
|
|
||||||
<link rel="stylesheet" type="text/css" href="docs/resources/template.css"></link>
|
|
||||||
<style type="text/css">
|
|
||||||
|
|
||||||
h4 {
|
|
||||||
padding: 0;
|
|
||||||
font-size: 12px;
|
|
||||||
font-weight: bold;
|
|
||||||
border-top: 1px solid #dedede;
|
|
||||||
background-color:#E6EDF6;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
.Parameter {
|
|
||||||
margin: 0 0 7px 0;
|
|
||||||
width: 100%;
|
|
||||||
font-size: 11px;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.Code
|
|
||||||
{
|
|
||||||
font-size: 11px; font-family:
|
|
||||||
"Courier New", Courier, monospace;
|
|
||||||
}
|
|
||||||
|
|
||||||
.Console
|
|
||||||
{
|
|
||||||
font-size: 11px; font-family:
|
|
||||||
"Courier New", Courier, monospace;
|
|
||||||
color: #ffffff;
|
|
||||||
font-weight: bold;
|
|
||||||
background: #000000;
|
|
||||||
}
|
|
||||||
.Caption {
|
|
||||||
font-size:11px; line-height:12px; text-transform: uppercase; FONT-WEIGHT: bold; COLOR: #000000; TEXT-DECORATION: none
|
|
||||||
}
|
|
||||||
.Exp {
|
|
||||||
font-size:11px; text-transform: uppercase; FONT-WEIGHT: bold; COLOR: #3366AA;
|
|
||||||
}
|
|
||||||
.Large { font-size: 16px; FONT-WEIGHT: bold; }
|
|
||||||
|
|
||||||
.TableText {
|
|
||||||
FONT-SIZE: 11px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.TableHead {
|
|
||||||
FONT-SIZE: 10px; font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.BoldRedText {
|
|
||||||
FONT-WEIGHT: bold; COLOR: #CC0000; TEXT-DECORATION: none
|
|
||||||
}
|
|
||||||
.BoldBlue {
|
|
||||||
FONT-WEIGHT: bold; COLOR: #3366AA; TEXT-DECORATION: none
|
|
||||||
}
|
|
||||||
.Miniscule {font-size: 9px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.Nav {font-size: 11px; COLOR: #3366AA;
|
|
||||||
}
|
|
||||||
.Large { font-size: 16px; FONT-WEIGHT: bold; }
|
|
||||||
</style>
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
|
|
||||||
<table cellpadding="0" cellspacing="5" id="main-table">
|
|
||||||
<tr><td id="main-body" align="left">
|
|
||||||
<!-- ///*** start of content area ***/// -->
|
|
||||||
|
|
||||||
|
|
||||||
<table width="100%" cellpadding="5">
|
|
||||||
<tr>
|
|
||||||
<td><h1>VMware vSphere Automation Python SDK README</h1></td>
|
|
||||||
<td align="right">
|
|
||||||
<img src="docs/resources/vmware.gif" alt="VMware logo" width="187" height="72" border="0"></img>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<p class="Nav">
|
|
||||||
<img src="docs/resources/page.gif" alt="README for client SDK" width="13" height="16" border="0"></img>
|
|
||||||
<a href="client/vSphere-Automation-Client-SDK-Python-README.html" title="README for client SDK...">README for client SDK</a><br />
|
|
||||||
</p>
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<table cellpadding="0" cellspacing="0" width="100%">
|
|
||||||
<tr><td width="50%" vAlign="top">
|
|
||||||
|
|
||||||
|
|
||||||
<p>The <strong>VMware vSphere Automation SDK for Python</strong> enables programmatic access to vSphere.
|
|
||||||
Access to capabilities exposed through the vSphere Web Services API is done using the open-source
|
|
||||||
<a href="https://github.com/vmware/pyvmomi">pyVmomi</a> project. The SDK includes python libraries
|
|
||||||
for accessing new features like Content Library and existing features like Tagging which did not
|
|
||||||
support a public API prior to vSphere 6.5.
|
|
||||||
<br/>
|
|
||||||
The SDK contains samples for the features mentioned above as well as samples to demonstrate how to interoperate with vSphere APIs.
|
|
||||||
If you want to look at the vSphere API samples, please refer to <a href="https://github.com/vmware/pyvmomi-community-samples">pyVmomi community samples</a>.
|
|
||||||
</br>
|
|
||||||
This README contains the following topics:</p>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><a href="#audience" target="_top">Intended Audience</a></li>
|
|
||||||
<li><a href="#prerequisites" target="_top">Prerequisites</a></li>
|
|
||||||
<li><a href="#systemrequirements" target="_top">System Requirements</a></li>
|
|
||||||
<li><a href="#packagecontents" target="_top">What’s in the SDK Package?</a></li>
|
|
||||||
<li><a href="#resources" target="_top">VMware Resources</a></li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
</td><td vAlign="top" align="right">
|
|
||||||
|
|
||||||
</td></tr></table>
|
|
||||||
|
|
||||||
<a name="audience"></a>
|
|
||||||
<h2><strong>Intended Audience</strong></h2>
|
|
||||||
<p>The VMware vSphere Automation SDK for Python is intended for the following audiences:</p>
|
|
||||||
<ul>
|
|
||||||
<li>Developers who want to write new application(s) for vSphere 6.5.</li>
|
|
||||||
<li>Developers migrating an existing vSphere application to use new features.</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<a name="prerequisites"></a>
|
|
||||||
<h2><strong>Prerequisites</strong></h2>
|
|
||||||
<p>For exercising the samples included in this SDK, you need a vSphere 6.5 deployment.
|
|
||||||
Refer to <a href="https://www.vmware.com/support/pubs/vsphere-esxi-vcenter-server-pubs.html">vSphere product documentation</a>
|
|
||||||
for more information and specific installation and deployment options.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<a name="systemrequirements"></a>
|
|
||||||
<h2><strong>System Requirements</strong></h2>
|
|
||||||
vSphere Automation SDK for Python 6.5 supports python 2.7, 3.3, 3.4 and 3.5</br>
|
|
||||||
Note: VMware strongly recommends using <a href="https://www.openssl.org/">openssl</a> version <strong>1.0.1j or, higher</strong> because of some critical security fixes.</br>
|
|
||||||
Currently we test the SDK and samples on python 2.7, 3.3, 3.4 and 3.5 on these operating systems:</br>
|
|
||||||
<ul>
|
|
||||||
<li>x86-64 RHEL 7</li>
|
|
||||||
<li>64 bit Windows 10</li>
|
|
||||||
<li>OS X 10.11.6 El Capitan</li>
|
|
||||||
</ul>
|
|
||||||
</p>
|
|
||||||
Please see the instructions for <a href="client/vSphere-Automation-Client-SDK-Python-README.html#installingsdklibs">installing the SDK and 3rd party libraries</a>.
|
|
||||||
|
|
||||||
</p>
|
|
||||||
<a name="packagecontents"></a>
|
|
||||||
<h2><strong>What’s in the SDK Package?</strong></h2>
|
|
||||||
<p>The vSphere Automation SDK for Python contains:
|
|
||||||
<ul>
|
|
||||||
<li>Python libraries, API reference documentation for features like Content Library and Tagging.</li>
|
|
||||||
<li>WSDL for lookup service API (required for Service Registration and Discovery).</li>
|
|
||||||
<li>Samples for new features and services which also demonstrate how to interoperate new APIs with vSphere APIs.</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
The following table contains a brief description of the contents of the vSphere Automation SDK for Python.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h3>Directory structure (under VMware-vSphereAutomation-Python-SDK): </h3>
|
|
||||||
|
|
||||||
<table cellpadding="5" cellspacing="0" border="1" width="100%" class="TableText">
|
|
||||||
<tr><th width="15%">Directory</th><th width="60%">Contents</th><th width="35%">Documentation</th></tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td>client</td>
|
|
||||||
<td>Client libraries, API documentation and samples</td>
|
|
||||||
<td>
|
|
||||||
<a href="client/vSphere-Automation-Client-SDK-Python-README.html">Client SDK README</a><br />
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td>docs</td>
|
|
||||||
<td>API reference documentation and documentation resource files</td>
|
|
||||||
<td>
|
|
||||||
<a href="docs/apidocs/vSphere-Automation-SDK-Python-APIRef-README.html">Client SDK API Reference Index</a><br />
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
</table>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<a name="resources"></a>
|
|
||||||
<h2><strong>VMware Resources</strong></h2>
|
|
||||||
<ul>
|
|
||||||
<li><a href="https://developercenter.vmware.com/home">Developer Center</a></li>
|
|
||||||
<li><a href="https://communities.vmware.com/community/vmtn/developer">VMware Developer Community</a> </li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<hr />
|
|
||||||
<table border="0" width="100%">
|
|
||||||
<tr>
|
|
||||||
<td>
|
|
||||||
<p class="Miniscule">Copyright © 2015-2016 VMware, Inc. All rights not expressly granted herein are reserved.</p>
|
|
||||||
</td>
|
|
||||||
<td align="right"><p class="Miniscule">Last updated: 26 Oct 2016 | VMware vSphere Automation Python SDK</p></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
</td></tr></table>
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
Loading…
Reference in New Issue
Block a user