From 5162d21ea374b33250a226a02a97fd8a3263f356 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Tue, 4 Jun 2019 00:22:31 +0530 Subject: [PATCH] VMware: vSphere Automation SDK installation docs (#57280) * VMware: adds instructions for installing vSphere Automation SDK to the dynamic inventory scenario --- .../57224-vmware_vm_inventory-vsphere_sdk.yml | 2 ++ .../vmware_scenarios/vmware_inventory.rst | 19 ++++++++++++++++++- 2 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 changelogs/fragments/57224-vmware_vm_inventory-vsphere_sdk.yml diff --git a/changelogs/fragments/57224-vmware_vm_inventory-vsphere_sdk.yml b/changelogs/fragments/57224-vmware_vm_inventory-vsphere_sdk.yml new file mode 100644 index 00000000000..b8a3cbbb1fa --- /dev/null +++ b/changelogs/fragments/57224-vmware_vm_inventory-vsphere_sdk.yml @@ -0,0 +1,2 @@ +minor_changes: +- Add installation documentation for vSphere Automation SDK for Python in vmware inventory plugin docs (https://github.com/ansible/ansible/issues/57224). diff --git a/docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory.rst b/docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory.rst index fbd6136483a..f942dd00ffd 100644 --- a/docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory.rst +++ b/docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory.rst @@ -13,7 +13,20 @@ VMware Dynamic Inventory Plugin The best way to interact with your hosts is to use the VMware dynamic inventory plugin, which dynamically queries VMware APIs and tells Ansible what nodes can be managed. -To be able to use this VMware dynamic inventory plugin, you need to enable it first by specifying the following in the ``ansible.cfg`` file: +Requirements +------------ + +To use the VMware dynamic inventory plugins, you must install `pyVmomi `_ +on your control node (the host running Ansible). + +To include tag-related information for the virtual machines in your dynamic inventory, you also need the `vSphere Automation SDK `_, which supports REST API features like tagging and content libraries, on your control node. +You can install the ``vSphere Automation SDK`` following `these instructions `_. + +.. code-block:: bash + + $ pip install pyvmomi + +To use this VMware dynamic inventory plugin, you need to enable it first by specifying the following in the ``ansible.cfg`` file: .. code-block:: ini @@ -67,6 +80,10 @@ And you can use this vaulted inventory configuration file using: The GitHub Page of pyVmomi `pyVmomi Issue Tracker `_ The issue tracker for the pyVmomi project + `vSphere Automation SDK GitHub Page `_ + The GitHub Page of vSphere Automation SDK for Python + `vSphere Automation SDK Issue Tracker `_ + The issue tracker for vSphere Automation SDK for Python :ref:`working_with_playbooks` An introduction to playbooks :ref:`playbooks_vault`