summaryrefslogtreecommitdiffstats
path: root/docs/docsite/rst/scenario_guides/vmware_rest_scenarios/authentication.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:04:21 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:04:21 +0000
commit8a754e0858d922e955e71b253c139e071ecec432 (patch)
tree527d16e74bfd1840c85efd675fdecad056c54107 /docs/docsite/rst/scenario_guides/vmware_rest_scenarios/authentication.rst
parentInitial commit. (diff)
downloadansible-core-8a754e0858d922e955e71b253c139e071ecec432.tar.xz
ansible-core-8a754e0858d922e955e71b253c139e071ecec432.zip
Adding upstream version 2.14.3.upstream/2.14.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/docsite/rst/scenario_guides/vmware_rest_scenarios/authentication.rst')
-rw-r--r--docs/docsite/rst/scenario_guides/vmware_rest_scenarios/authentication.rst47
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/docsite/rst/scenario_guides/vmware_rest_scenarios/authentication.rst b/docs/docsite/rst/scenario_guides/vmware_rest_scenarios/authentication.rst
new file mode 100644
index 0000000..4f09cbe
--- /dev/null
+++ b/docs/docsite/rst/scenario_guides/vmware_rest_scenarios/authentication.rst
@@ -0,0 +1,47 @@
+.. _vmware_rest_authentication:
+
+*******************************************
+How to configure the vmware_rest collection
+*******************************************
+
+.. contents::
+ :local:
+
+
+Introduction
+============
+
+The vcenter_rest modules need to be authenticated. There are two different
+
+Environment variables
+=====================
+
+.. note::
+ This solution requires that you call the modules from the local machine.
+
+You need to export some environment variables in your shell before you call the modules.
+
+.. code-block:: shell
+
+ $ export VMWARE_HOST=vcenter.test
+ $ export VMWARE_USER=myvcenter-user
+ $ export VMWARE_password=mypassword
+ $ ansible-playbook my-playbook.yaml
+
+Module parameters
+=================
+
+All the vcenter_rest modules accept the following arguments:
+
+- ``vcenter_hostname``
+- ``vcenter_username``
+- ``vcenter_password``
+
+
+Ignore SSL certificate error
+============================
+
+It's common to run a test environment without a proper SSL certificate configuration.
+
+To ignore the SSL error, you can use the ``vcenter_validate_certs: no`` argument or
+``export VMWARE_VALIDATE_CERTS=no`` to set the environment variable.