diff --git a/changelogs/fragments/524-drop-scenaros.yml b/changelogs/fragments/524-drop-scenaros.yml new file mode 100644 index 000000000..83560bf66 --- /dev/null +++ b/changelogs/fragments/524-drop-scenaros.yml @@ -0,0 +1,4 @@ +--- +minor_changes: + - Removed the scenario guides which are pretty much unmaintained and, therefor, possibly outdated and misleading + (https://github.com/ansible-collections/vmware.vmware_rest/pull/524). diff --git a/docs/docsite/extra-docs.yml b/docs/docsite/extra-docs.yml index 417184915..cc63130a2 100644 --- a/docs/docsite/extra-docs.yml +++ b/docs/docsite/extra-docs.yml @@ -1,8 +1,5 @@ --- sections: - - title: Scenario Guide - toctree: - - guide_vmware_rest - title: Developer Guide toctree: - dev_guide diff --git a/docs/docsite/rst/guide_vmware_rest.rst b/docs/docsite/rst/guide_vmware_rest.rst deleted file mode 100644 index c3df6b781..000000000 --- a/docs/docsite/rst/guide_vmware_rest.rst +++ /dev/null @@ -1,41 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware_rest_ansible: - -******************* -VMware Guide (REST) -******************* - - - -.. toctree:: - :maxdepth: 1 - - vmware_rest_scenarios/vcenter/1_installation - vmware_rest_scenarios/vcenter/1_authentication - -Life cycle of a Virtual Machine -############################### - -These scenarios teach you how to accomplish common VMware tasks using the REST API and the Ansible ``vmware.vmware_rest`` collection. To get started, please select the task you want to accomplish. - -.. toctree:: - :maxdepth: 1 - - vmware_rest_scenarios/vcenter/2_collect_information - vmware_rest_scenarios/vcenter/3_create_vm - vmware_rest_scenarios/vcenter/4_vm_info - vmware_rest_scenarios/vcenter/5_vm_hardware_tuning - vmware_rest_scenarios/vcenter/6_run_a_vm - vmware_rest_scenarios/vcenter/7_vm_tool_information - vmware_rest_scenarios/vcenter/8_vm_tool_configuration - -Manage a vCenter Server Appliance (VCSA) -######################################## - -.. toctree:: - :maxdepth: 1 - - vmware_rest_scenarios/appliance/appliance_access - vmware_rest_scenarios/appliance/health - vmware_rest_scenarios/appliance/network - vmware_rest_scenarios/appliance/services - vmware_rest_scenarios/appliance/system_managment diff --git a/docs/docsite/rst/vmware_rest_scenarios/appliance/appliance_access.rst b/docs/docsite/rst/vmware_rest_scenarios/appliance/appliance_access.rst deleted file mode 100644 index 453d905bd..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/appliance/appliance_access.rst +++ /dev/null @@ -1,138 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-appliance-access: - - -Configure the console and SSH access -************************************ - - -Introduction -============ - -This section show you how to manage the console and SSH access of the -vCenter Server Appliance (VCSA). - - -Scenario requirements -===================== - -You"ve got an up and running vCenter Server Appliance. - - -Manage the shell access ------------------------ - -Detect if the Shell is enabled. - -:: - - - name: Check if the Shell is enabled - vmware.vmware_rest.appliance_access_shell_info: - -response - -:: - - { - "changed": false, - "value": { - "enabled": false, - "timeout": 0 - } - } - -Or turn on the Shell access with a timeout: - -:: - - - name: Disable the Shell - vmware.vmware_rest.appliance_access_shell: - enabled: False - timeout: 600 - -response - -:: - - { - "changed": false, - "value": { - "enabled": false, - "timeout": 0 - } - } - - -Manage the Direct Console User Interface (DCUI) ------------------------------------------------ - -You can use vmware.vmware_rest.appliance_access_dcui_info_module to -get the current state of the configuration: - -:: - - - name: Check if the Direct Console User Interface is enabled - vmware.vmware_rest.appliance_access_dcui_info: - -response - -:: - - { - "changed": false, - "value": false - } - -You can enable or disable the interface with appliance_access_dcui: - -:: - - - name: Disable the Direct Console User Interface - vmware.vmware_rest.appliance_access_dcui: - enabled: False - -response - -:: - - { - "changed": false, - "value": false - } - - -Manage the SSH interface ------------------------- - -You can also get the status of the SSH interface with -appliance_access_ssh_info: - -:: - - - name: Check is the SSH access is enabled - vmware.vmware_rest.appliance_access_ssh_info: - -response - -:: - - { - "changed": false, - "value": true - } - -And to enable the SSH interface: - -:: - - - name: Ensure the SSH access ie enabled - vmware.vmware_rest.appliance_access_ssh: - enabled: true - -response - -:: - - { - "changed": false, - "value": true - } diff --git a/docs/docsite/rst/vmware_rest_scenarios/appliance/health.rst b/docs/docsite/rst/vmware_rest_scenarios/appliance/health.rst deleted file mode 100644 index 003dcfddf..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/appliance/health.rst +++ /dev/null @@ -1,1301 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-appliance-health: - - -Get the health state of the VCSA components -******************************************* - - -Introduction -============ - -The collection provides several modules that you can use to know the -state of the different components of the VCSA. - - -Scenario requirements -===================== - -You"ve got an up and running vCenter Server Appliance. - - -Health state per component --------------------------- - -The database storage: - -:: - - - name: Get the database storage heath status - vmware.vmware_rest.appliance_health_databasestorage_info: - -response - -:: - - { - "changed": false, - "value": "green" - } - -The system load: - -:: - - - name: Get the system load status - vmware.vmware_rest.appliance_health_load_info: - -response - -:: - - { - "changed": false, - "value": "green" - } - -The memory usage: - -:: - - - name: Get the system mem status - vmware.vmware_rest.appliance_health_mem_info: - -response - -:: - - { - "changed": false, - "value": "green" - } - -The system status: - -:: - - - name: Get the system health status - vmware.vmware_rest.appliance_health_system_info: - -response - -:: - - { - "changed": false, - "value": "green" - } - -The package manager: - -:: - - - name: Get the health of the software package manager - vmware.vmware_rest.appliance_health_softwarepackages_info: - -response - -:: - - { - "changed": false, - "value": "green" - } - -The storage system: - -:: - - - name: Get the health of the storage system - vmware.vmware_rest.appliance_health_storage_info: - -response - -:: - - { - "changed": false, - "value": "green" - } - -The swap usage: - -:: - - - name: Get the health of the swap - vmware.vmware_rest.appliance_health_swap_info: - -response - -:: - - { - "changed": false, - "value": "green" - } - - -Monitoring ----------- - -You can also retrieve information from the VCSA monitoring backend. -First you need the name of the item. To get a full list of these -items, run: - -:: - - - name: Get the list of the monitored items - vmware.vmware_rest.appliance_monitoring_info: - register: result - -response - -:: - - { - "changed": false, - "value": [ - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-1", - "id": "disk.read.rate.dm-1", - "instance": "dm-1", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-1", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-10", - "id": "disk.read.rate.dm-10", - "instance": "dm-10", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-10", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-11", - "id": "disk.read.rate.dm-11", - "instance": "dm-11", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-11", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-12", - "id": "disk.read.rate.dm-12", - "instance": "dm-12", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-12", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-13", - "id": "disk.read.rate.dm-13", - "instance": "dm-13", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-13", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-14", - "id": "disk.read.rate.dm-14", - "instance": "dm-14", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-14", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-15", - "id": "disk.read.rate.dm-15", - "instance": "dm-15", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-15", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-2", - "id": "disk.read.rate.dm-2", - "instance": "dm-2", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-2", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-3", - "id": "disk.read.rate.dm-3", - "instance": "dm-3", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-3", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-4", - "id": "disk.read.rate.dm-4", - "instance": "dm-4", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-4", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-5", - "id": "disk.read.rate.dm-5", - "instance": "dm-5", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-5", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-6", - "id": "disk.read.rate.dm-6", - "instance": "dm-6", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-6", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-7", - "id": "disk.read.rate.dm-7", - "instance": "dm-7", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-7", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-8", - "id": "disk.read.rate.dm-8", - "instance": "dm-8", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-8", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-9", - "id": "disk.read.rate.dm-9", - "instance": "dm-9", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-9", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-1", - "id": "disk.write.rate.dm-1", - "instance": "dm-1", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-1", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-10", - "id": "disk.write.rate.dm-10", - "instance": "dm-10", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-10", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-11", - "id": "disk.write.rate.dm-11", - "instance": "dm-11", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-11", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-12", - "id": "disk.write.rate.dm-12", - "instance": "dm-12", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-12", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-13", - "id": "disk.write.rate.dm-13", - "instance": "dm-13", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-13", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-14", - "id": "disk.write.rate.dm-14", - "instance": "dm-14", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-14", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-15", - "id": "disk.write.rate.dm-15", - "instance": "dm-15", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-15", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-2", - "id": "disk.write.rate.dm-2", - "instance": "dm-2", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-2", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-3", - "id": "disk.write.rate.dm-3", - "instance": "dm-3", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-3", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-4", - "id": "disk.write.rate.dm-4", - "instance": "dm-4", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-4", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-5", - "id": "disk.write.rate.dm-5", - "instance": "dm-5", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-5", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-6", - "id": "disk.write.rate.dm-6", - "instance": "dm-6", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-6", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-7", - "id": "disk.write.rate.dm-7", - "instance": "dm-7", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-7", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-8", - "id": "disk.write.rate.dm-8", - "instance": "dm-8", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-8", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-9", - "id": "disk.write.rate.dm-9", - "instance": "dm-9", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-9", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-1", - "id": "disk.latency.rate.dm-1", - "instance": "dm-1", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-1", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-10", - "id": "disk.latency.rate.dm-10", - "instance": "dm-10", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-10", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-11", - "id": "disk.latency.rate.dm-11", - "instance": "dm-11", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-11", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-12", - "id": "disk.latency.rate.dm-12", - "instance": "dm-12", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-12", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-13", - "id": "disk.latency.rate.dm-13", - "instance": "dm-13", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-13", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-14", - "id": "disk.latency.rate.dm-14", - "instance": "dm-14", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-14", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-15", - "id": "disk.latency.rate.dm-15", - "instance": "dm-15", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-15", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-2", - "id": "disk.latency.rate.dm-2", - "instance": "dm-2", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-2", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-3", - "id": "disk.latency.rate.dm-3", - "instance": "dm-3", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-3", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-4", - "id": "disk.latency.rate.dm-4", - "instance": "dm-4", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-4", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-5", - "id": "disk.latency.rate.dm-5", - "instance": "dm-5", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-5", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-6", - "id": "disk.latency.rate.dm-6", - "instance": "dm-6", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-6", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-7", - "id": "disk.latency.rate.dm-7", - "instance": "dm-7", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-7", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-8", - "id": "disk.latency.rate.dm-8", - "instance": "dm-8", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-8", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-9", - "id": "disk.latency.rate.dm-9", - "instance": "dm-9", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-9", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.swap.util", - "id": "swap.util", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.swap.util", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.swap", - "id": "storage.used.filesystem.swap", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.swap", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.swap", - "id": "swap", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.swap", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.swap", - "id": "storage.totalsize.filesystem.swap", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.swap", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.cpu", - "description": "com.vmware.applmgmt.mon.descr.cpu.totalfrequency", - "id": "cpu.totalfrequency", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.cpu.totalfrequency", - "units": "com.vmware.applmgmt.mon.unit.mhz" - }, - { - "category": "com.vmware.applmgmt.mon.cat.cpu", - "description": "com.vmware.applmgmt.mon.descr.cpu.systemload", - "id": "cpu.systemload", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.cpu.systemload", - "units": "com.vmware.applmgmt.mon.unit.load_per_min" - }, - { - "category": "com.vmware.applmgmt.mon.cat.memory", - "description": "com.vmware.applmgmt.mon.descr.mem.util", - "id": "mem.util", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.mem.util", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.memory", - "description": "com.vmware.applmgmt.mon.descr.mem.total", - "id": "mem.total", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.mem.total", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.memory", - "description": "com.vmware.applmgmt.mon.descr.mem.usage", - "id": "mem.usage", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.mem.usage", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.rx.error.eth0", - "id": "net.rx.error.eth0", - "instance": "eth0", - "name": "com.vmware.applmgmt.mon.name.net.rx.error.eth0", - "units": "com.vmware.applmgmt.mon.unit.errors_per_sample" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.rx.error.lo", - "id": "net.rx.error.lo", - "instance": "lo", - "name": "com.vmware.applmgmt.mon.name.net.rx.error.lo", - "units": "com.vmware.applmgmt.mon.unit.errors_per_sample" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.tx.error.eth0", - "id": "net.tx.error.eth0", - "instance": "eth0", - "name": "com.vmware.applmgmt.mon.name.net.tx.error.eth0", - "units": "com.vmware.applmgmt.mon.unit.errors_per_sample" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.tx.error.lo", - "id": "net.tx.error.lo", - "instance": "lo", - "name": "com.vmware.applmgmt.mon.name.net.tx.error.lo", - "units": "com.vmware.applmgmt.mon.unit.errors_per_sample" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_hourly_stats", - "id": "storage.totalsize.directory.vcdb_hourly_stats", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_hourly_stats", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_daily_stats", - "id": "storage.totalsize.directory.vcdb_daily_stats", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_daily_stats", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_monthly_stats", - "id": "storage.totalsize.directory.vcdb_monthly_stats", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_monthly_stats", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_yearly_stats", - "id": "storage.totalsize.directory.vcdb_yearly_stats", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_yearly_stats", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_stats", - "id": "storage.totalsize.directory.vcdb_stats", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_stats", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.seat", - "id": "storage.totalsize.filesystem.seat", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.seat", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.directory.vcdb_stats", - "id": "storage.util.directory.vcdb_stats", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.util.directory.vcdb_stats", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_events", - "id": "storage.totalsize.directory.vcdb_events", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_events", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.directory.vcdb_events", - "id": "storage.util.directory.vcdb_events", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.util.directory.vcdb_events", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_alarms", - "id": "storage.totalsize.directory.vcdb_alarms", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_alarms", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.directory.vcdb_alarms", - "id": "storage.util.directory.vcdb_alarms", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.util.directory.vcdb_alarms", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_tasks", - "id": "storage.totalsize.directory.vcdb_tasks", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_tasks", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.directory.vcdb_tasks", - "id": "storage.util.directory.vcdb_tasks", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.util.directory.vcdb_tasks", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.seat", - "id": "storage.used.filesystem.seat", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.seat", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.seat", - "id": "storage.util.filesystem.seat", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.seat", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.db", - "id": "storage.used.filesystem.db", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.db", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.db", - "id": "storage.totalsize.filesystem.db", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.db", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.db", - "id": "storage.util.filesystem.db", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.db", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.dblog", - "id": "storage.used.filesystem.dblog", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.dblog", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.dblog", - "id": "storage.totalsize.filesystem.dblog", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.dblog", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.dblog", - "id": "storage.util.filesystem.dblog", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.dblog", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.root", - "id": "storage.totalsize.filesystem.root", - "instance": "/", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.root", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.root", - "id": "storage.util.filesystem.root", - "instance": "/", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.root", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.boot", - "id": "storage.totalsize.filesystem.boot", - "instance": "/boot", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.boot", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.boot", - "id": "storage.util.filesystem.boot", - "instance": "/boot", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.boot", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.archive", - "id": "storage.totalsize.filesystem.archive", - "instance": "/storage/archive", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.archive", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.archive", - "id": "storage.util.filesystem.archive", - "instance": "/storage/archive", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.archive", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.autodeploy", - "id": "storage.totalsize.filesystem.autodeploy", - "instance": "/storage/autodeploy", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.autodeploy", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.autodeploy", - "id": "storage.util.filesystem.autodeploy", - "instance": "/storage/autodeploy", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.autodeploy", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.core", - "id": "storage.totalsize.filesystem.core", - "instance": "/storage/core", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.core", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.core", - "id": "storage.util.filesystem.core", - "instance": "/storage/core", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.core", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.imagebuilder", - "id": "storage.totalsize.filesystem.imagebuilder", - "instance": "/storage/imagebuilder", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.imagebuilder", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.imagebuilder", - "id": "storage.util.filesystem.imagebuilder", - "instance": "/storage/imagebuilder", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.imagebuilder", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.lifecycle", - "id": "storage.totalsize.filesystem.lifecycle", - "instance": "/storage/lifecycle", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.lifecycle", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.lifecycle", - "id": "storage.util.filesystem.lifecycle", - "instance": "/storage/lifecycle", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.lifecycle", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.log", - "id": "storage.totalsize.filesystem.log", - "instance": "/storage/log", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.log", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.log", - "id": "storage.util.filesystem.log", - "instance": "/storage/log", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.log", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.lvm_snapshot", - "id": "storage.totalsize.filesystem.lvm_snapshot", - "instance": "/storage/lvm_snapshot", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.lvm_snapshot", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.lvm_snapshot", - "id": "storage.util.filesystem.lvm_snapshot", - "instance": "/storage/lvm_snapshot", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.lvm_snapshot", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.netdump", - "id": "storage.totalsize.filesystem.netdump", - "instance": "/storage/netdump", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.netdump", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.netdump", - "id": "storage.util.filesystem.netdump", - "instance": "/storage/netdump", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.netdump", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.updatemgr", - "id": "storage.totalsize.filesystem.updatemgr", - "instance": "/storage/updatemgr", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.updatemgr", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.updatemgr", - "id": "storage.util.filesystem.updatemgr", - "instance": "/storage/updatemgr", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.updatemgr", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.vtsdb", - "id": "storage.totalsize.filesystem.vtsdb", - "instance": "/storage/vtsdb", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.vtsdb", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.vtsdb", - "id": "storage.util.filesystem.vtsdb", - "instance": "/storage/vtsdb", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.vtsdb", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.vtsdblog", - "id": "storage.totalsize.filesystem.vtsdblog", - "instance": "/storage/vtsdblog", - "name": "com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.vtsdblog", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.vtsdblog", - "id": "storage.util.filesystem.vtsdblog", - "instance": "/storage/vtsdblog", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.vtsdblog", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.root", - "id": "storage.used.filesystem.root", - "instance": "/", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.root", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.boot", - "id": "storage.used.filesystem.boot", - "instance": "/boot", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.boot", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.archive", - "id": "storage.used.filesystem.archive", - "instance": "/storage/archive", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.archive", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.autodeploy", - "id": "storage.used.filesystem.autodeploy", - "instance": "/storage/autodeploy", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.autodeploy", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.core", - "id": "storage.used.filesystem.core", - "instance": "/storage/core", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.core", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.imagebuilder", - "id": "storage.used.filesystem.imagebuilder", - "instance": "/storage/imagebuilder", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.imagebuilder", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.lifecycle", - "id": "storage.used.filesystem.lifecycle", - "instance": "/storage/lifecycle", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.lifecycle", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.log", - "id": "storage.used.filesystem.log", - "instance": "/storage/log", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.log", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.lvm_snapshot", - "id": "storage.used.filesystem.lvm_snapshot", - "instance": "/storage/lvm_snapshot", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.lvm_snapshot", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.netdump", - "id": "storage.used.filesystem.netdump", - "instance": "/storage/netdump", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.netdump", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.updatemgr", - "id": "storage.used.filesystem.updatemgr", - "instance": "/storage/updatemgr", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.updatemgr", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.vtsdb", - "id": "storage.used.filesystem.vtsdb", - "instance": "/storage/vtsdb", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.vtsdb", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.used.filesystem.vtsdblog", - "id": "storage.used.filesystem.vtsdblog", - "instance": "/storage/vtsdblog", - "name": "com.vmware.applmgmt.mon.name.storage.used.filesystem.vtsdblog", - "units": "com.vmware.applmgmt.mon.unit.kb" - }, - { - "category": "com.vmware.applmgmt.mon.cat.cpu", - "description": "com.vmware.applmgmt.mon.descr.cpu.util", - "id": "cpu.util", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.cpu.util", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.cpu", - "description": "com.vmware.applmgmt.mon.descr.cpu.steal", - "id": "cpu.steal", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.cpu.steal", - "units": "com.vmware.applmgmt.mon.unit.percent" - }, - { - "category": "com.vmware.applmgmt.mon.cat.memory", - "description": "com.vmware.applmgmt.mon.descr.swap.pageRate", - "id": "swap.pageRate", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.swap.pageRate", - "units": "com.vmware.applmgmt.mon.unit.pages_per_sec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.read.rate.dm-0", - "id": "disk.read.rate.dm-0", - "instance": "dm-0", - "name": "com.vmware.applmgmt.mon.name.disk.read.rate.dm-0", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.write.rate.dm-0", - "id": "disk.write.rate.dm-0", - "instance": "dm-0", - "name": "com.vmware.applmgmt.mon.name.disk.write.rate.dm-0", - "units": "com.vmware.applmgmt.mon.unit.num_of_io_per_msec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.disk", - "description": "com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-0", - "id": "disk.latency.rate.dm-0", - "instance": "dm-0", - "name": "com.vmware.applmgmt.mon.name.disk.latency.rate.dm-0", - "units": "com.vmware.applmgmt.mon.unit.msec_per_io" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.rx.activity.eth0", - "id": "net.rx.activity.eth0", - "instance": "eth0", - "name": "com.vmware.applmgmt.mon.name.net.rx.activity.eth0", - "units": "com.vmware.applmgmt.mon.unit.kb_per_sec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.rx.activity.lo", - "id": "net.rx.activity.lo", - "instance": "lo", - "name": "com.vmware.applmgmt.mon.name.net.rx.activity.lo", - "units": "com.vmware.applmgmt.mon.unit.kb_per_sec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.rx.packetRate.eth0", - "id": "net.rx.packetRate.eth0", - "instance": "eth0", - "name": "com.vmware.applmgmt.mon.name.net.rx.packetRate.eth0", - "units": "com.vmware.applmgmt.mon.unit.packets_per_sec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.rx.packetRate.lo", - "id": "net.rx.packetRate.lo", - "instance": "lo", - "name": "com.vmware.applmgmt.mon.name.net.rx.packetRate.lo", - "units": "com.vmware.applmgmt.mon.unit.packets_per_sec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.rx.drop.eth0", - "id": "net.rx.drop.eth0", - "instance": "eth0", - "name": "com.vmware.applmgmt.mon.name.net.rx.drop.eth0", - "units": "com.vmware.applmgmt.mon.unit.drops_per_sample" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.rx.drop.lo", - "id": "net.rx.drop.lo", - "instance": "lo", - "name": "com.vmware.applmgmt.mon.name.net.rx.drop.lo", - "units": "com.vmware.applmgmt.mon.unit.drops_per_sample" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.tx.activity.eth0", - "id": "net.tx.activity.eth0", - "instance": "eth0", - "name": "com.vmware.applmgmt.mon.name.net.tx.activity.eth0", - "units": "com.vmware.applmgmt.mon.unit.kb_per_sec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.tx.activity.lo", - "id": "net.tx.activity.lo", - "instance": "lo", - "name": "com.vmware.applmgmt.mon.name.net.tx.activity.lo", - "units": "com.vmware.applmgmt.mon.unit.kb_per_sec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.tx.packetRate.eth0", - "id": "net.tx.packetRate.eth0", - "instance": "eth0", - "name": "com.vmware.applmgmt.mon.name.net.tx.packetRate.eth0", - "units": "com.vmware.applmgmt.mon.unit.packets_per_sec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.tx.packetRate.lo", - "id": "net.tx.packetRate.lo", - "instance": "lo", - "name": "com.vmware.applmgmt.mon.name.net.tx.packetRate.lo", - "units": "com.vmware.applmgmt.mon.unit.packets_per_sec" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.tx.drop.eth0", - "id": "net.tx.drop.eth0", - "instance": "eth0", - "name": "com.vmware.applmgmt.mon.name.net.tx.drop.eth0", - "units": "com.vmware.applmgmt.mon.unit.drops_per_sample" - }, - { - "category": "com.vmware.applmgmt.mon.cat.network", - "description": "com.vmware.applmgmt.mon.descr.net.tx.drop.lo", - "id": "net.tx.drop.lo", - "instance": "lo", - "name": "com.vmware.applmgmt.mon.name.net.tx.drop.lo", - "units": "com.vmware.applmgmt.mon.unit.drops_per_sample" - }, - { - "category": "com.vmware.applmgmt.mon.cat.storage", - "description": "com.vmware.applmgmt.mon.descr.storage.util.filesystem.swap", - "id": "storage.util.filesystem.swap", - "instance": "", - "name": "com.vmware.applmgmt.mon.name.storage.util.filesystem.swap", - "units": "com.vmware.applmgmt.mon.unit.percent" - } - ] - } - -With this information, you can access the information for a given time -frame: - -:: - - - name: Query the monitoring backend - vmware.vmware_rest.appliance_monitoring_query: - end_time: 2021-04-14T09:34:56.000Z - start_time: 2021-04-14T08:34:56.000Z - names: - - mem.total - interval: MINUTES5 - function: AVG - register: result - -response - -:: - - { - "changed": false, - "value": [ - { - "data": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" - ], - "end_time": "2021-04-14T09:34:56.000Z", - "function": "AVG", - "interval": "MINUTES5", - "name": "mem.total", - "start_time": "2021-04-14T08:34:56.000Z" - } - ] - } diff --git a/docs/docsite/rst/vmware_rest_scenarios/appliance/network.rst b/docs/docsite/rst/vmware_rest_scenarios/appliance/network.rst deleted file mode 100644 index 312099d07..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/appliance/network.rst +++ /dev/null @@ -1,523 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-appliance-network: - - -Network managment -***************** - - -IP configuration -================ - -You can also use Ansible to get and configure the network stack of the -VCSA. - - -Global network information --------------------------- - -The appliance_networking_info exposes the state of the global network -configuration: - -:: - - - name: Get network information - vmware.vmware_rest.appliance_networking_info: - -response - -:: - - { - "changed": false, - "value": { - "dns": { - "hostname": "vcenter.test", - "mode": "STATIC", - "servers": [ - "192.168.123.1" - ] - }, - "interfaces": { - "nic0": { - "ipv4": { - "address": "192.168.123.8", - "configurable": true, - "default_gateway": "192.168.123.1", - "mode": "STATIC", - "prefix": 24 - }, - "ipv6": { - "addresses": [ - { - "address": "fe80::5054:ff:fe70:4823", - "origin": "OTHER", - "prefix": 64, - "status": "PREFERRED" - } - ], - "autoconf": true, - "configurable": true, - "default_gateway": "", - "dhcp": false - }, - "mac": "52:54:00:70:48:23", - "name": "nic0", - "status": "up" - } - }, - "vcenter_base_url": "https://vcenter.test:443" - } - } - -And you can adjust the parameters with the appliance_networking -module. - -:: - - - name: Set network information - vmware.vmware_rest.appliance_networking: - ipv6_enabled: False - -response - -:: - - { - "changed": true, - "id": null, - "value": {} - } - - -Network Interface configuration -------------------------------- - -The appliance_networking_interfaces_info returns a list of the Network -Interface of the system: - -:: - - - name: Get a list of the network interfaces - vmware.vmware_rest.appliance_networking_interfaces_info: - -response - -:: - - { - "changed": false, - "value": [ - { - "ipv4": { - "address": "192.168.123.8", - "configurable": true, - "default_gateway": "192.168.123.1", - "mode": "STATIC", - "prefix": 24 - }, - "ipv6": { - "addresses": [ - { - "address": "fe80::5054:ff:fe70:4823", - "origin": "OTHER", - "prefix": 64, - "status": "PREFERRED" - } - ], - "autoconf": true, - "configurable": true, - "default_gateway": "", - "dhcp": false - }, - "mac": "52:54:00:70:48:23", - "name": "nic0", - "status": "up" - } - ] - } - -You can also use the ``interface_name`` parameter to just focus on one -single entry: - -:: - - - name: Get details about one network interfaces - vmware.vmware_rest.appliance_networking_interfaces_info: - interface_name: nic0 - -response - -:: - - { - "changed": false, - "id": "nic0", - "value": { - "ipv4": { - "address": "192.168.123.8", - "configurable": true, - "default_gateway": "192.168.123.1", - "mode": "STATIC", - "prefix": 24 - }, - "ipv6": { - "addresses": [ - { - "address": "fe80::5054:ff:fe70:4823", - "origin": "OTHER", - "prefix": 64, - "status": "PREFERRED" - } - ], - "autoconf": true, - "configurable": true, - "default_gateway": "", - "dhcp": false - }, - "mac": "52:54:00:70:48:23", - "name": "nic0", - "status": "up" - } - } - - -DNS configuration -================= - - -The hostname configuration --------------------------- - -The appliance_networking_dns_hostname_info module can be use to -retrieve the hostname of the VCSA: - -:: - - - name: Get the hostname configuration - vmware.vmware_rest.appliance_networking_dns_hostname_info: - -response - -:: - - { - "changed": false, - "value": "vcenter.test" - } - - -The DNS servers ---------------- - -Use the appliance_networking_dns_servers_info to get DNS servers -currently in use: - -:: - - - name: Get the DNS servers - vmware.vmware_rest.appliance_networking_dns_servers_info: - ignore_errors: True # May be failing because of the CI set-up - -response - -:: - - { - "changed": false, - "value": { - "mode": "is_static", - "servers": [ - "192.168.123.1" - ] - } - } - -The appliance_networking_dns_servers can be used to set a different -name server. - -:: - - - name: Set the DNS servers - vmware.vmware_rest.appliance_networking_dns_servers: - servers: - - 192.168.123.1 - mode: is_static - -response - -:: - - { - "changed": false, - "value": { - "mode": "is_static", - "servers": [ - "192.168.123.1" - ] - } - } - -You can test a list of servers if you set ``state=test``: - -:: - - - name: Test the DNS servers - vmware.vmware_rest.appliance_networking_dns_servers: - state: test - servers: - - var - -response - -:: - - { - "changed": false, - "value": { - "messages": [ - { - "message": "Failed to reach 'var'.", - "result": "failure" - } - ], - "status": "red" - } - } - - -The search domain configuration -------------------------------- - -The search domain configuration can be done with -appliance_networking_dns_domains and -appliance_networking_dns_domains_info. The second module returns a -list of domains: - -:: - - - name: Get DNS domains configuration - vmware.vmware_rest.appliance_networking_dns_domains_info: - -response - -:: - - { - "changed": false, - "value": [] - } - -There is two way to set the search domain. By default the value you -pass in ``domains`` will overwrite the existing domain: - -:: - - - name: Update the domain configuration - vmware.vmware_rest.appliance_networking_dns_domains: - domains: - - foobar - -response - -:: - - { - "changed": false, - "value": [] - } - -If you instead use the ``state=add`` parameter, the ``domain`` value -will complet the existing list of domains. - -:: - - - name: Add another domain configuration - vmware.vmware_rest.appliance_networking_dns_domains: - domain: barfoo - state: add - -response - -:: - - { - "changed": false, - "value": {} - } - - -Firewall settings -================= - -You can also configure the VCSA firewall. You can add new ruleset with -the appliance_networking_firewall_inbound module. In this example, we -reject all the traffic coming from the ``1.2.3.0/24`` subnet: - -:: - - - name: Set a firewall rule - vmware.vmware_rest.appliance_networking_firewall_inbound: - rules: - - address: 1.2.3.0 - prefix: 24 - policy: REJECT - -response - -:: - - { - "changed": false, - "value": [ - { - "address": "1.2.3.0", - "interface_name": "*", - "policy": "REJECT", - "prefix": 24 - } - ] - } - -The appliance_networking_firewall_inbound_info module returns a list -of the inbound ruleset: - -:: - - - name: Get the firewall inbound configuration - vmware.vmware_rest.appliance_networking_firewall_inbound_info: - -response - -:: - - { - "changed": false, - "value": [ - { - "address": "1.2.3.0", - "interface_name": "*", - "policy": "REJECT", - "prefix": 24 - } - ] - } - - -HTTP proxy -========== - -You can also configurre the VCSA to go through a HTTP proxy. The -collection provides a set of modules to configure the proxy server and -manage the noproxy filter. - -In this example, we will set up a proxy and configure the ``noproxy`` -for ``redhat.com`` and ``ansible.com``: - -:: - - - name: Set the HTTP proxy configuration - vmware.vmware_rest.appliance_networking_proxy: - enabled: true - server: https://datastore.test - port: 3128 - protocol: https - - name: Set HTTP noproxy configuration - vmware.vmware_rest.appliance_networking_noproxy: - servers: - - redhat.com - - ansible.com - -response - -:: - - { - "changed": false, - "value": { - "enabled": true, - "port": 3128, - "server": "https://datastore.test" - } - } - -:: - - { - "changed": true, - "value": {} - } - -We can validate the configuration with the associated _info modules: - -:: - - - name: Get the HTTP proxy configuration - vmware.vmware_rest.appliance_networking_proxy_info: - - name: Get HTTP noproxy configuration - vmware.vmware_rest.appliance_networking_noproxy_info: - -response - -:: - - { - "changed": false, - "value": { - "ftp": { - "enabled": false, - "port": -1, - "server": "" - }, - "http": { - "enabled": false, - "port": -1, - "server": "" - }, - "https": { - "enabled": true, - "port": 3128, - "server": "https://datastore.test" - } - } - } - -:: - - { - "changed": false, - "value": [ - "redhat.com", - "ansible.com", - "localhost", - "127.0.0.1" - ] - } - -And we finally reverse the configuration: - -:: - - - name: Delete the HTTP proxy configuration - vmware.vmware_rest.appliance_networking_proxy: - config: {} - protocol: http - state: absent - - name: Remove the noproxy entries - vmware.vmware_rest.appliance_networking_noproxy: - servers: [] - -response - -:: - - { - "changed": true, - "value": {} - } - -:: - - { - "changed": true, - "value": {} - } diff --git a/docs/docsite/rst/vmware_rest_scenarios/appliance/services.rst b/docs/docsite/rst/vmware_rest_scenarios/appliance/services.rst deleted file mode 100644 index 4f53a1f5c..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/appliance/services.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-appliance-services: - - -Services managment -****************** - - -Handle your VCSA services with Ansible -====================================== - -You can use Ansible to control the VCSA services. To get a view of all -the known services, you can use the appliance_services_info module: diff --git a/docs/docsite/rst/vmware_rest_scenarios/appliance/system_managment.rst b/docs/docsite/rst/vmware_rest_scenarios/appliance/system_managment.rst deleted file mode 100644 index 44e936890..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/appliance/system_managment.rst +++ /dev/null @@ -1,336 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-appliance-shutdown: - - -System managment -**************** - - -How to reboot or shutdown the VCSA -================================== - -You can use Ansible to trigger or cancel a shutdown. The -appliance_shutdown_info module is useful to know if a shutdown is -already scheduled. - -:: - - - name: Check if there is a shutdown scheduled - vmware.vmware_rest.appliance_shutdown_info: - -response - -:: - - { - "changed": false, - "value": { - "action": "", - "reason": "" - } - } - -When you trigger a shutdown, you can also specify a ``reason``. The -information will be exposed to the other users: - -:: - - - name: Shutdown the appliance - vmware.vmware_rest.appliance_shutdown: - state: poweroff - reason: this is an example - delay: 600 - -response - -:: - - { - "changed": false, - "value": {} - } - -To cancel a shutdown, you must set the ``state`` to ``cancel``: - -:: - - - name: Abort the shutdown of the appliance - vmware.vmware_rest.appliance_shutdown: - state: cancel - -response - -:: - - { - "changed": false, - "value": {} - } - - -FIPS mode -********* - - -Federal Information Processing Standards (FIPS) -=============================================== - -The appliance_system_globalfips_info module will tell you if FIPS is -enabled. - -:: - - - name: "Get the status of the Federal Information Processing Standard mode" - vmware.vmware_rest.appliance_system_globalfips_info: - -response - -:: - - { - "changed": false, - "value": { - "enabled": false - } - } - -You can turn the option on or off with appliance_system_globalfips: - -Warning: The VCSA will silently reboot itself if you change the FIPS - configuration. - -:: - - - name: Turn off the FIPS mode and reboot - vmware.vmware_rest.appliance_system_globalfips: - enabled: false - -response - -:: - - { - "changed": false, - "id": null, - "value": { - "enabled": false - } - } - - -Time and Timezone configuration -******************************* - - -Timezone -======== - -The appliance_system_time_timezone and -ppliance_system_time_timezone_info modules handle the Timezone -configuration. You can get the current configuration with: - -:: - - - name: Get the timezone configuration - vmware.vmware_rest.appliance_system_time_timezone_info: - -response - -:: - - { - "changed": false, - "value": "UTC" - } - -And to adjust the system"s timezone, just do: - -:: - - - name: Use the UTC timezone - vmware.vmware_rest.appliance_system_time_timezone: - name: UTC - -response - -:: - - { - "changed": false, - "value": "UTC" - } - -In this example we set the ``UTC`` timezone, you can also pass a -timezone in the ``Europe/Paris`` format. - - -Current time -============ - -If you want to get the current time, use appliance_system_time_info: - -:: - - - name: Get the current time - vmware.vmware_rest.appliance_system_time_info: - -response - -:: - - { - "changed": false, - "value": { - "date": "Wed 11-23-2022", - "seconds_since_epoch": 1669235407.547401, - "time": "08:30:07 PM", - "timezone": "UTC" - } - } - - -Time Service (NTP) -================== - -The VCSA can get the time from a NTP server: - -:: - - - name: Get the NTP configuration - vmware.vmware_rest.appliance_ntp_info: - -response - -:: - - { - "changed": false, - "value": [ - "time.google.com" - ] - } - -You can use the appliance_ntp module to adjust the system NTP servers. -The module accepts one or more NTP servers: - -:: - - - name: Adjust the NTP configuration - vmware.vmware_rest.appliance_ntp: - servers: - - time.google.com - -response - -:: - - { - "changed": false, - "value": [ - "time.google.com" - ] - } - -If you set ``state=test``, the module will validate the servers are -rechable. - -:: - - - name: Test the NTP configuration - vmware.vmware_rest.appliance_ntp: - state: test - servers: - - time.google.com - -response - -:: - - { - "changed": false, - "value": [ - { - "message": { - "args": [], - "default_message": "NTP Server is reachable.", - "id": "com.vmware.appliance.ntp_sync.success" - }, - "server": "time.google.com", - "status": "SERVER_REACHABLE" - } - ] - } - -You can check the clock synchronization with appliance_timesync_info: - -:: - - - name: Get information regarding the clock synchronization - vmware.vmware_rest.appliance_timesync_info: - -response - -:: - - { - "changed": false, - "value": "NTP" - } - -Or also validate the system use NTP with: - -:: - - - name: Ensure we use NTP - vmware.vmware_rest.appliance_timesync: - mode: NTP - -response - -:: - - { - "changed": false, - "value": "NTP" - } - - -Storage system -************** - -The collection also provides modules to manage the storage system. -appliance_system_storage_info will list the storage partitions: - -:: - - - name: Get the appliance storage information - vmware.vmware_rest.appliance_system_storage_info: - -response - -:: - - { - "changed": false, - "value": [] - } - -You can use the ``state=resize_ex`` option to extend an existing -partition: - -:: - - - name: Resize the first partition and return the state of the partition before and after the operation - vmware.vmware_rest.appliance_system_storage: - state: resize_ex - -response - -:: - - { - "changed": false, - "value": {} - } - -Note: ``state=resize`` also works, but you won"t get as much information - as with ``resize_ex``. diff --git a/docs/docsite/rst/vmware_rest_scenarios/vcenter/1_authentication.rst b/docs/docsite/rst/vmware_rest_scenarios/vcenter/1_authentication.rst deleted file mode 100644 index 6c41da413..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/vcenter/1_authentication.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-authentication: - - -How to configure the vmware_rest collection -******************************************* - - -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:: 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_host`` - -* ``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. diff --git a/docs/docsite/rst/vmware_rest_scenarios/vcenter/1_installation.rst b/docs/docsite/rst/vmware_rest_scenarios/vcenter/1_installation.rst deleted file mode 100644 index 85f948bcc..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/vcenter/1_installation.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-installation: - - -How to install the vmware_rest collection -***************************************** - - -Requirements -============ - -The collection depends on: - -* Ansible >=2.9.10 or greater - -* Python 3.6 or greater - - -aiohttp -======= - -`aiohttp `_ is the only -dependency of the collection. You can install it with ``pip`` if you -use a virtualenv to run Ansible. - -.. code:: shell - - $ pip install aiohttp - -Or using an RPM. - -.. code:: shell - - $ sudo dnf install python3-aiohttp - - -Installation -============ - -The best option to install the collection is to use the -``ansible-galaxy`` command: - -.. code:: shell - - $ ansible-galaxy collection install vmware.vmware_rest diff --git a/docs/docsite/rst/vmware_rest_scenarios/vcenter/2_collect_information.rst b/docs/docsite/rst/vmware_rest_scenarios/vcenter/2_collect_information.rst deleted file mode 100644 index 59fd12813..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/vcenter/2_collect_information.rst +++ /dev/null @@ -1,292 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-collect-info: - - -How to collect information about your environment -************************************************* - - -Introduction -============ - -This section shows you how to utilize Ansible to collect information -about your environment. This information is useful for the other -tutorials. - - -Scenario requirements -===================== - -In this scenario we"ve got a vCenter with an ESXi host. - -Our environment is pre-initialized with the following elements: - -* A datacenter called ``my_dc`` - -* A cluster called ``my_cluser`` - -* A cluster called ``my_cluser`` - -* An ESXi host called ``esxi1`` is in the cluster - -* Two datastores on the ESXi: ``rw_datastore`` and ``ro_datastore`` - -* A dvswitch based guest network - -Finally, we use the environment variables to authenticate ourselves as -explained in vmware_rest_authentication. - - -How to collect information -========================== - -In these examples, we use the ``vcenter_*_info`` module to collect -information about the associated resources. - -All these modules return a ``value`` key. Depending on the context, -this ``value`` key will be either a list or a dictionary. - - -Datacenter ----------- - -Here we use the ``vcenter_datacenter_info`` module to list all the -datacenters. As expected, the ``value`` key of the output is a list. - -:: - - - name: collect a list of the datacenters - vmware.vmware_rest.vcenter_datacenter_info: - register: my_datacenters - -response - -:: - - { - "changed": false, - "value": [ - { - "datacenter": "datacenter-1160", - "name": "my_dc" - } - ] - } - - -Cluster -------- - -Here we do the same with ``vcenter_cluster_info`` module: - -:: - - - name: Build a list of all the clusters - vmware.vmware_rest.vcenter_cluster_info: - register: all_the_clusters - -response - -:: - - { - "changed": false, - "value": [ - { - "cluster": "domain-c1165", - "drs_enabled": true, - "ha_enabled": false, - "name": "my_cluster" - } - ] - } - -And we can also fetch the details about a specific cluster, with the -``cluster`` parameter: - -:: - - - name: Retrieve details about the first cluster - vmware.vmware_rest.vcenter_cluster_info: - cluster: "{{ all_the_clusters.value[0].cluster }}" - register: my_cluster_info - -response - -:: - - { - "changed": false, - "id": "domain-c1165", - "value": { - "name": "my_cluster", - "resource_pool": "resgroup-1166" - } - } - -And the ``value`` key of the output is this time a dictionary. - - -Datastore ---------- - -Here we use ``vcenter_datastore_info`` to get a list of all the -datastore called ``rw_datastore``: - -:: - - - name: Retrieve a list of all the datastores - vmware.vmware_rest.vcenter_datastore_info: - filter_names: - - rw_datastore - register: my_datastores - -response - -:: - - { - "changed": false, - "value": [ - { - "capacity": 42314215424, - "datastore": "datastore-1175", - "free_space": 40362840064, - "name": "rw_datastore", - "type": "NFS" - } - ] - } - -We save the first datastore in *my_datastore* fact for later use. - -:: - - - name: Set my_datastore - set_fact: - my_datastore: '{{ my_datastores.value|first }}' - -response - -:: - - { - "ansible_facts": { - "my_datastore": { - "capacity": 42314215424, - "datastore": "datastore-1175", - "free_space": 40362840064, - "name": "rw_datastore", - "type": "NFS" - } - }, - "changed": false - } - - -Folder ------- - -And here again, you use the ``vcenter_folder_info`` module to retrieve -a list of all the folders. - -:: - - - name: Build a list of all the folders - vmware.vmware_rest.vcenter_folder_info: - register: my_folders - -response - -:: - - { - "changed": false, - "value": [ - { - "folder": "group-d1", - "name": "Datacenters", - "type": "DATACENTER" - }, - { - "folder": "group-h1162", - "name": "host", - "type": "HOST" - }, - { - "folder": "group-n1164", - "name": "network", - "type": "NETWORK" - }, - { - "folder": "group-s1163", - "name": "datastore", - "type": "DATASTORE" - }, - { - "folder": "group-v1161", - "name": "vm", - "type": "VIRTUAL_MACHINE" - }, - { - "folder": "group-v1169", - "name": "Discovered virtual machine", - "type": "VIRTUAL_MACHINE" - }, - { - "folder": "group-v1173", - "name": "vCLS", - "type": "VIRTUAL_MACHINE" - } - ] - } - -Most of the time, you will just want one type of folder. In this case -we can use filters to reduce the amount to collect. Most of the -``_info`` modules come with similar filters. - -:: - - - name: Build a list of all the folders with the type VIRTUAL_MACHINE and called vm - vmware.vmware_rest.vcenter_folder_info: - filter_type: VIRTUAL_MACHINE - filter_names: - - vm - register: my_folders - -response - -:: - - { - "changed": false, - "value": [ - { - "folder": "group-v1161", - "name": "vm", - "type": "VIRTUAL_MACHINE" - } - ] - } - -We register the first folder for later use with ``set_fact``. - -:: - - - name: Set my_virtual_machine_folder - set_fact: - my_virtual_machine_folder: '{{ my_folders.value|first }}' - -response - -:: - - { - "ansible_facts": { - "my_virtual_machine_folder": { - "folder": "group-v1161", - "name": "vm", - "type": "VIRTUAL_MACHINE" - } - }, - "changed": false - } diff --git a/docs/docsite/rst/vmware_rest_scenarios/vcenter/3_create_vm.rst b/docs/docsite/rst/vmware_rest_scenarios/vcenter/3_create_vm.rst deleted file mode 100644 index 09e957e39..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/vcenter/3_create_vm.rst +++ /dev/null @@ -1,137 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-create-vm: - - -How to create a Virtual Machine -******************************* - -* Introduction - -* Scenario requirements - -* How to create a virtual machine - - -Introduction -============ - -This section shows you how to use Ansible to create a virtual machine. - - -Scenario requirements -===================== - -You"ve already followed vmware_rest_collect_info and you"ve got the -following variables defined: - -* ``my_cluster_info`` - -* ``my_datastore`` - -* ``my_virtual_machine_folder`` - -* ``my_cluster_info`` - - -How to create a virtual machine -=============================== - -In this example, we will use the ``vcenter_vm`` module to create a new -guest. - -:: - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ my_cluster_info.id }}" - datastore: "{{ my_datastore.datastore }}" - folder: "{{ my_virtual_machine_folder.folder }}" - resource_pool: "{{ my_cluster_info.value.resource_pool }}" - name: test_vm1 - guest_OS: DEBIAN_8_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - register: _result - -response - -:: - - { - "changed": true, - "id": "vm-1184", - "value": { - "boot": { - "delay": 0, - "enter_setup_mode": false, - "retry": false, - "retry_delay": 10000, - "type": "BIOS" - }, - "boot_devices": [], - "cdroms": {}, - "cpu": { - "cores_per_socket": 1, - "count": 1, - "hot_add_enabled": false, - "hot_remove_enabled": false - }, - "disks": { - "2000": { - "backing": { - "type": "VMDK_FILE", - "vmdk_file": "[rw_datastore] test_vm1/test_vm1.vmdk" - }, - "capacity": 17179869184, - "label": "Hard disk 1", - "scsi": { - "bus": 0, - "unit": 0 - }, - "type": "SCSI" - } - }, - "floppies": {}, - "guest_OS": "DEBIAN_8_64", - "hardware": { - "upgrade_policy": "NEVER", - "upgrade_status": "NONE", - "version": "VMX_11" - }, - "identity": { - "bios_uuid": "423123c1-253c-9785-5925-16de430abbe5", - "instance_uuid": "50310cfd-c581-0f13-d0ed-9811073d02d7", - "name": "test_vm1" - }, - "instant_clone_frozen": false, - "memory": { - "hot_add_enabled": true, - "size_MiB": 1024 - }, - "name": "test_vm1", - "nics": {}, - "nvme_adapters": {}, - "parallel_ports": {}, - "power_state": "POWERED_OFF", - "sata_adapters": {}, - "scsi_adapters": { - "1000": { - "label": "SCSI controller 0", - "scsi": { - "bus": 0, - "unit": 7 - }, - "sharing": "NONE", - "type": "PVSCSI" - } - }, - "serial_ports": {} - } - } - -Note: ``vcenter_vm`` accepts more parameters, however you may prefer to - start with a simple VM and use the ``vcenter_vm_hardware`` modules - to tune it up afterwards. It"s easier this way to identify a - potential problematical step. diff --git a/docs/docsite/rst/vmware_rest_scenarios/vcenter/4_vm_info.rst b/docs/docsite/rst/vmware_rest_scenarios/vcenter/4_vm_info.rst deleted file mode 100644 index 604e8182b..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/vcenter/4_vm_info.rst +++ /dev/null @@ -1,333 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-vm-info: - - -Retrieve information from a specific VM -*************************************** - -* Introduction - -* Scenario requirements - -* How to collect virtual machine information - - * List the VM - - * Collect the details about a specific VM - - * Get the hardware version of a specific VM - - * List the SCSI adapter(s) of a specific VM - - * List the CDROM drive(s) of a specific VM - - * Get the memory information of the VM - - * Get the storage policy of the VM - - * Get the disk information of the VM - - -Introduction -============ - -This section shows you how to use Ansible to retrieve information -about a specific virtual machine. - - -Scenario requirements -===================== - -You"ve already followed vmware_rest_create_vm and you"ve got create a -new VM called ``test_vm1``. - - -How to collect virtual machine information -========================================== - - -List the VM ------------ - -In this example, we use the ``vcenter_vm_info`` module to collect -information about our new VM. - -In this example, we start by asking for a list of VMs. We use a filter -to limit the results to just the VM called ``test_vm1``. So we are in -a list context, with one single entry in the ``value`` key. - -:: - - - name: Look up the VM called test_vm1 in the inventory - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - register: search_result - -response - -:: - - { - "changed": false, - "value": [ - { - "cpu_count": 1, - "memory_size_MiB": 1024, - "name": "test_vm1", - "power_state": "POWERED_OFF", - "vm": "vm-1184" - } - ] - } - -As expected, we get a list. And thanks to our filter, we just get one -entry. - - -Collect the details about a specific VM ---------------------------------------- - -For the next steps, we pass the ID of the VM through the ``vm`` -parameter. This allow us to collect more details about this specific -VM. - -:: - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - -response - -:: - - { - "changed": false, - "id": "vm-1184", - "value": { - "boot": { - "delay": 0, - "enter_setup_mode": false, - "retry": false, - "retry_delay": 10000, - "type": "BIOS" - }, - "boot_devices": [], - "cdroms": {}, - "cpu": { - "cores_per_socket": 1, - "count": 1, - "hot_add_enabled": false, - "hot_remove_enabled": false - }, - "disks": { - "2000": { - "backing": { - "type": "VMDK_FILE", - "vmdk_file": "[rw_datastore] test_vm1/test_vm1.vmdk" - }, - "capacity": 17179869184, - "label": "Hard disk 1", - "scsi": { - "bus": 0, - "unit": 0 - }, - "type": "SCSI" - } - }, - "floppies": {}, - "guest_OS": "DEBIAN_8_64", - "hardware": { - "upgrade_policy": "NEVER", - "upgrade_status": "NONE", - "version": "VMX_11" - }, - "identity": { - "bios_uuid": "423123c1-253c-9785-5925-16de430abbe5", - "instance_uuid": "50310cfd-c581-0f13-d0ed-9811073d02d7", - "name": "test_vm1" - }, - "instant_clone_frozen": false, - "memory": { - "hot_add_enabled": true, - "size_MiB": 1024 - }, - "name": "test_vm1", - "nics": {}, - "nvme_adapters": {}, - "parallel_ports": {}, - "power_state": "POWERED_OFF", - "sata_adapters": {}, - "scsi_adapters": { - "1000": { - "label": "SCSI controller 0", - "scsi": { - "bus": 0, - "unit": 7 - }, - "sharing": "NONE", - "type": "PVSCSI" - } - }, - "serial_ports": {} - } - } - -The result is a structure with all the details about our VM. You will -note this is actually the same information that we get when we created -the VM. - - -Get the hardware version of a specific VM ------------------------------------------ - -We can also use all the ``vcenter_vm_*_info`` modules to retrieve a -smaller amount of information. Here we use -``vcenter_vm_hardware_info`` to know the hardware version of the VM. - -:: - - - name: Collect the hardware information - vmware.vmware_rest.vcenter_vm_hardware_info: - vm: '{{ search_result.value[0].vm }}' - register: my_vm1_hardware_info - -response - -:: - - { - "changed": false, - "value": { - "upgrade_policy": "NEVER", - "upgrade_status": "NONE", - "version": "VMX_11" - } - } - - -List the SCSI adapter(s) of a specific VM ------------------------------------------ - -Here for instance, we list the SCSI adapter(s) of the VM: - -:: - - - name: List the SCSI adapter of a given VM - vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info: - vm: '{{ test_vm1_info.id }}' - register: _result - -response - -:: - - { - "changed": false, - "value": [ - { - "adapter": "1000" - } - ] - } - -You can do the same for the SATA controllers with -``vcenter_vm_adapter_sata_info``. - - -List the CDROM drive(s) of a specific VM ----------------------------------------- - -And we list its CDROM drives. - -:: - - - name: List the cdrom devices on the guest - vmware.vmware_rest.vcenter_vm_hardware_cdrom_info: - vm: '{{ test_vm1_info.id }}' - register: _result - -response - -:: - - { - "changed": false, - "value": [] - } - - -Get the memory information of the VM ------------------------------------- - -Here we collect the memory information of the VM: - -:: - - - name: Retrieve the memory information from the VM - vmware.vmware_rest.vcenter_vm_hardware_memory_info: - vm: '{{ test_vm1_info.id }}' - register: _result - -response - -:: - - { - "changed": false, - "value": { - "hot_add_enabled": true, - "size_MiB": 1024 - } - } - - -Get the storage policy of the VM -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -We use the ``vcenter_vm_storage_policy_info`` module for that: - -:: - - - name: Get VM storage policy - vmware.vmware_rest.vcenter_vm_storage_policy_info: - vm: '{{ test_vm1_info.id }}' - register: _result - -response - -:: - - { - "changed": false, - "value": { - "disks": {} - } - } - - -Get the disk information of the VM -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -We use the ``vcenter_vm_hardware_disk_info`` for this operation: - -:: - - - name: Retrieve the disk information from the VM - vmware.vmware_rest.vcenter_vm_hardware_disk_info: - vm: '{{ test_vm1_info.id }}' - register: _result - -response - -:: - - { - "changed": false, - "value": [ - { - "disk": "2000" - } - ] - } diff --git a/docs/docsite/rst/vmware_rest_scenarios/vcenter/5_vm_hardware_tuning.rst b/docs/docsite/rst/vmware_rest_scenarios/vcenter/5_vm_hardware_tuning.rst deleted file mode 100644 index 1c0a6a6ab..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/vcenter/5_vm_hardware_tuning.rst +++ /dev/null @@ -1,405 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-vm-hardware-tuning: - - -How to modify a virtual machine -******************************* - -* Introduction - -* Scenario requirements - -* How to add a CDROM drive to a virtual machine - - * Add a new SATA adapter - - * Add a CDROM drive - -* How to attach a VM to a network - - * Attach a new NIC - - * Adjust the configuration of the NIC - -* Increase the memory of the VM - -* Upgrade the hardware version of the VM - -* Adjust the number of CPUs of the VM - -* Remove a SATA controller - -* Attach a floppy drive - -* Attach a new disk - - -Introduction -============ - -This section shows you how to use Ansible to modify an existing -virtual machine. - - -Scenario requirements -===================== - -You"ve already followed vmware_rest_create_vm and created a VM. - - -How to add a CDROM drive to a virtual machine -============================================= - -In this example, we use the ``vcenter_vm_hardware_*`` modules to add a -new CDROM to an existing VM. - - -Add a new SATA adapter ----------------------- - -First we create a new SATA adapter. We specify the -``pci_slot_number``. This way if we run the task again it won"t do -anything if there is already an adapter there. - -:: - - - name: Create a SATA adapter at PCI slot 34 - vmware.vmware_rest.vcenter_vm_hardware_adapter_sata: - vm: '{{ test_vm1_info.id }}' - pci_slot_number: 34 - register: _sata_adapter_result_1 - -response - -:: - - { - "changed": true, - "id": "15000", - "value": { - "bus": 0, - "label": "SATA controller 0", - "pci_slot_number": 34, - "type": "AHCI" - } - } - - -Add a CDROM drive ------------------ - -Now we can create the CDROM drive: - -:: - - - name: Attach an ISO image to a guest VM - vmware.vmware_rest.vcenter_vm_hardware_cdrom: - vm: '{{ test_vm1_info.id }}' - type: SATA - sata: - bus: 0 - unit: 2 - start_connected: true - backing: - iso_file: '[ro_datastore] fedora.iso' - type: ISO_FILE - register: _result - -response - -:: - - { - "changed": true, - "id": "16002", - "value": { - "allow_guest_control": false, - "backing": { - "iso_file": "[ro_datastore] fedora.iso", - "type": "ISO_FILE" - }, - "label": "CD/DVD drive 1", - "sata": { - "bus": 0, - "unit": 2 - }, - "start_connected": true, - "state": "NOT_CONNECTED", - "type": "SATA" - } - } - -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-attach-a-network: - - -How to attach a VM to a network -=============================== - - -Attach a new NIC ----------------- - -Here we attach the VM to the network (through the portgroup). We -specify a ``pci_slot_number`` for the same reason. - -The second task adjusts the NIC configuration. - -:: - - - name: Identify the portgroup called my-portgroup - vmware.vmware_rest.vcenter_network_info: - filter_types: DISTRIBUTED_PORTGROUP - filter_names: "my portrgoup" - register: my_portgroup - - - name: Attach a VM to a dvswitch - vmware.vmware_rest.vcenter_vm_hardware_ethernet: - vm: '{{ test_vm1_info.id }}' - pci_slot_number: 4 - backing: - type: DISTRIBUTED_PORTGROUP - network: "{{ my_portgroup.value[0].network }}" - start_connected: false - register: vm_hardware_ethernet_1 - -response - -:: - - { - "changed": false, - "value": [ - { - "name": "my portrgoup", - "network": "dvportgroup-1182", - "type": "DISTRIBUTED_PORTGROUP" - } - ] - } - -:: - - { - "changed": true, - "id": "4000", - "value": { - "allow_guest_control": false, - "backing": { - "connection_cookie": 730402685, - "distributed_port": "2", - "distributed_switch_uuid": "50 31 50 36 b4 93 ca 22-33 9b 18 30 3d b1 e7 03", - "network": "dvportgroup-1182", - "type": "DISTRIBUTED_PORTGROUP" - }, - "label": "Network adapter 1", - "mac_address": "00:50:56:b1:9c:a5", - "mac_type": "ASSIGNED", - "pci_slot_number": 4, - "start_connected": false, - "state": "NOT_CONNECTED", - "type": "VMXNET3", - "upt_compatibility_enabled": false, - "wake_on_lan_enabled": false - } - } - - -Adjust the configuration of the NIC ------------------------------------ - -:: - - - name: Turn the NIC's start_connected flag on - vmware.vmware_rest.vcenter_vm_hardware_ethernet: - nic: '{{ vm_hardware_ethernet_1.id }}' - start_connected: true - vm: '{{ test_vm1_info.id }}' - -response - -:: - - { - "changed": true, - "id": "4000", - "value": {} - } - - -Increase the memory of the VM -============================= - -We can also adjust the amount of memory that we dedicate to our VM. - -:: - - - name: Increase the memory of a VM - vmware.vmware_rest.vcenter_vm_hardware_memory: - vm: '{{ test_vm1_info.id }}' - size_MiB: 1080 - register: _result - -response - -:: - - { - "changed": true, - "id": null, - "value": {} - } - - -Upgrade the hardware version of the VM -====================================== - -Here we use the ``vcenter_vm_hardware`` module to upgrade the version -of the hardware: - -:: - - - name: Upgrade the VM hardware version - vmware.vmware_rest.vcenter_vm_hardware: - upgrade_policy: AFTER_CLEAN_SHUTDOWN - upgrade_version: VMX_13 - vm: '{{ test_vm1_info.id }}' - register: _result - -response - -:: - - { - "changed": true, - "id": null, - "value": {} - } - - -Adjust the number of CPUs of the VM -=================================== - -You can use ``vcenter_vm_hardware_cpu`` for that: - -:: - - - name: Dedicate one core to the VM - vmware.vmware_rest.vcenter_vm_hardware_cpu: - vm: '{{ test_vm1_info.id }}' - count: 1 - register: _result - -response - -:: - - { - "changed": false, - "id": null, - "value": { - "cores_per_socket": 1, - "count": 1, - "hot_add_enabled": false, - "hot_remove_enabled": false - } - } - - -Remove a SATA controller -======================== - -In this example, we remove the SATA controller of the PCI slot 34. - -:: - - - name: Dedicate one core to the VM - vmware.vmware_rest.vcenter_vm_hardware_cpu: - vm: '{{ test_vm1_info.id }}' - count: 1 - register: _result - -response - -:: - - { - "changed": false, - "id": null, - "value": { - "cores_per_socket": 1, - "count": 1, - "hot_add_enabled": false, - "hot_remove_enabled": false - } - } - - -Attach a floppy drive -===================== - -Here we attach a floppy drive to a VM. - -:: - - - name: Add a floppy disk drive - vmware.vmware_rest.vcenter_vm_hardware_floppy: - vm: '{{ test_vm1_info.id }}' - allow_guest_control: true - register: my_floppy_drive - -response - -:: - - { - "changed": true, - "id": "8000", - "value": { - "allow_guest_control": true, - "backing": { - "auto_detect": true, - "host_device": "", - "type": "HOST_DEVICE" - }, - "label": "Floppy drive 1", - "start_connected": false, - "state": "NOT_CONNECTED" - } - } - - -Attach a new disk -================= - -Here we attach a tiny disk to the VM. The ``capacity`` is in bytes. - -:: - - - name: Create a new disk - vmware.vmware_rest.vcenter_vm_hardware_disk: - vm: '{{ test_vm1_info.id }}' - type: SATA - new_vmdk: - capacity: 320000 - register: my_new_disk - -response - -:: - - { - "changed": true, - "id": "16000", - "value": { - "backing": { - "type": "VMDK_FILE", - "vmdk_file": "[rw_datastore] test_vm1/test_vm1_1.vmdk" - }, - "capacity": 320000, - "label": "Hard disk 2", - "sata": { - "bus": 0, - "unit": 0 - }, - "type": "SATA" - } - } diff --git a/docs/docsite/rst/vmware_rest_scenarios/vcenter/6_run_a_vm.rst b/docs/docsite/rst/vmware_rest_scenarios/vcenter/6_run_a_vm.rst deleted file mode 100644 index 3341f2bb7..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/vcenter/6_run_a_vm.rst +++ /dev/null @@ -1,104 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-run-a-vm: - - -How to run a virtual machine -**************************** - -* Introduction - -* Power information - -* How to start a virtual machine - -* How to wait until my virtual machine is ready - - -Introduction -============ - -This section covers the power management of your virtual machine. - - -Power information -================= - -Use ``vcenter_vm_power_info`` to know the power state of the VM. - -:: - - - name: Get guest power information - vmware.vmware_rest.vcenter_vm_power_info: - vm: '{{ test_vm1_info.id }}' - register: _result - -response - -:: - - { - "changed": false, - "value": { - "clean_power_off": true, - "state": "POWERED_OFF" - } - } - - -How to start a virtual machine -============================== - -Use the ``vcenter_vm_power`` module to start your VM: - -:: - - - name: Turn the power of the VM on - vmware.vmware_rest.vcenter_vm_power: - state: start - vm: '{{ test_vm1_info.id }}' - -response - -:: - - { - "changed": false, - "value": {} - } - - -How to wait until my virtual machine is ready -============================================= - -If your virtual machine runs VMware Tools, you can build a loop around -the ``center_vm_tools_info`` module: - -:: - - - name: Wait until my VM is ready - vmware.vmware_rest.vcenter_vm_tools_info: - vm: '{{ test_vm1_info.id }}' - register: vm_tools_info - until: - - vm_tools_info is not failed - - vm_tools_info.value.run_state == "RUNNING" - retries: 60 - delay: 5 - -response - -:: - - { - "attempts": 8, - "changed": false, - "value": { - "auto_update_supported": false, - "install_attempt_count": 0, - "install_type": "OPEN_VM_TOOLS", - "run_state": "RUNNING", - "upgrade_policy": "MANUAL", - "version": "10346", - "version_number": 10346, - "version_status": "UNMANAGED" - } - } diff --git a/docs/docsite/rst/vmware_rest_scenarios/vcenter/7_vm_tool_information.rst b/docs/docsite/rst/vmware_rest_scenarios/vcenter/7_vm_tool_information.rst deleted file mode 100644 index dc451e293..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/vcenter/7_vm_tool_information.rst +++ /dev/null @@ -1,225 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-vm-tool-information: - - -How to get information from a running virtual machine -***************************************************** - -* Introduction - -* Scenario requirements - -* How to collect information - - * Filesystem - - * Guest identity - - * Network - - * Network interfaces - - * Network routes - - -Introduction -============ - -This section shows you how to collection information from a running -virtual machine. - - -Scenario requirements -===================== - -You"ve already followed vmware_rest_run_a_vm and your virtual machine -runs VMware Tools. - - -How to collect information -========================== - -In this example, we use the ``vcenter_vm_guest_*`` module to collect -information about the associated resources. - - -Filesystem ----------- - -Here we use ``vcenter_vm_guest_localfilesystem_info`` to retrieve the -details about the filesystem of the guest. In this example we also use -a ``retries`` loop. The VMware Tools may take a bit of time to start -and by doing so, we give the VM a bit more time. - -:: - - - name: Get guest filesystem information - vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info: - vm: '{{ test_vm1_info.id }}' - register: _result - until: - - _result is not failed - retries: 60 - delay: 5 - -response - -:: - - { - "attempts": 6, - "changed": false, - "value": { - "/": { - "capacity": 2515173376, - "free_space": 774774784, - "mappings": [] - } - } - } - - -Guest identity --------------- - -You can use ``vcenter_vm_guest_identity_info`` to get details like the -OS family or the hostname of the running VM. - -:: - - - name: Get guest identity information - vmware.vmware_rest.vcenter_vm_guest_identity_info: - vm: '{{ test_vm1_info.id }}' - register: _result - -response - -:: - - { - "changed": false, - "value": { - "family": "LINUX", - "full_name": { - "args": [], - "default_message": "Red Hat Fedora (64-bit)", - "id": "vmsg.guestos.fedora64Guest.label" - }, - "host_name": "localhost.localdomain", - "ip_address": "fe80::e5f5:b5f1:dd56:798", - "name": "FEDORA_64" - } - } - - -Network -------- - -``vcenter_vm_guest_networking_info`` will return the OS network -configuration. - -:: - - - name: Get guest networking information - vmware.vmware_rest.vcenter_vm_guest_networking_info: - vm: '{{ test_vm1_info.id }}' - register: _result - -response - -:: - - { - "changed": false, - "value": { - "dns": { - "ip_addresses": [ - "10.0.2.3" - ], - "search_domains": [ - "localdomain" - ] - }, - "dns_values": { - "domain_name": "localdomain", - "host_name": "localhost.localdomain" - } - } - } - - -Network interfaces ------------------- - -``vcenter_vm_guest_networking_interfaces_info`` will return a list of -NIC configurations. - -See also vmware_rest_attach_a_network. - -:: - - - name: Get guest network interfaces information - vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info: - vm: '{{ test_vm1_info.id }}' - register: _result - -response - -:: - - { - "changed": false, - "value": [ - { - "ip": { - "ip_addresses": [ - { - "ip_address": "fe80::e5f5:b5f1:dd56:798", - "prefix_length": 64, - "state": "UNKNOWN" - } - ] - }, - "mac_address": "00:50:56:b1:9c:a5", - "nic": "4000" - } - ] - } - - -Network routes --------------- - -Use ``vcenter_vm_guest_networking_routes_info`` to explore the route -table of your vitual machine. - -:: - - - name: Get guest network routes information - vmware.vmware_rest.vcenter_vm_guest_networking_routes_info: - vm: '{{ test_vm1_info.id }}' - register: _result - -response - -:: - - { - "changed": false, - "value": [ - { - "interface_index": 0, - "network": "fe80::", - "prefix_length": 64 - }, - { - "interface_index": 0, - "network": "fe80::e5f5:b5f1:dd56:798", - "prefix_length": 128 - }, - { - "interface_index": 0, - "network": "ff00::", - "prefix_length": 8 - } - ] - } diff --git a/docs/docsite/rst/vmware_rest_scenarios/vcenter/8_vm_tool_configuration.rst b/docs/docsite/rst/vmware_rest_scenarios/vcenter/8_vm_tool_configuration.rst deleted file mode 100644 index 0a4413291..000000000 --- a/docs/docsite/rst/vmware_rest_scenarios/vcenter/8_vm_tool_configuration.rst +++ /dev/null @@ -1,89 +0,0 @@ -.. _ansible_collections.vmware.vmware_rest.docsite.vmware-rest-vm-tool-configuration: - - -How to configure the VMware tools of a running virtual machine -************************************************************** - -* Introduction - -* Scenario requirements - -* How to change the upgrade policy - - * Change the upgrade policy to MANUAL - - * Change the upgrade policy to UPGRADE_AT_POWER_CYCLE - - -Introduction -============ - -This section show you how to collection information from a running -virtual machine. - - -Scenario requirements -===================== - -You"ve already followed vmware_rest_run_a_vm and your virtual machine -runs VMware Tools. - - -How to change the upgrade policy -================================ - - -Change the upgrade policy to MANUAL ------------------------------------ - -You can adjust the VMware Tools upgrade policy with the -``vcenter_vm_tools`` module. - -:: - - - name: Change vm-tools upgrade policy to MANUAL - vmware.vmware_rest.vcenter_vm_tools: - vm: '{{ test_vm1_info.id }}' - upgrade_policy: MANUAL - register: _result - -response - -:: - - { - "changed": false, - "id": null, - "value": { - "auto_update_supported": false, - "install_attempt_count": 0, - "install_type": "OPEN_VM_TOOLS", - "run_state": "RUNNING", - "upgrade_policy": "MANUAL", - "version": "10346", - "version_number": 10346, - "version_status": "UNMANAGED" - } - } - - -Change the upgrade policy to UPGRADE_AT_POWER_CYCLE ---------------------------------------------------- - -:: - - - name: Change vm-tools upgrade policy to UPGRADE_AT_POWER_CYCLE - vmware.vmware_rest.vcenter_vm_tools: - vm: '{{ test_vm1_info.id }}' - upgrade_policy: UPGRADE_AT_POWER_CYCLE - register: _result - -response - -:: - - { - "changed": true, - "id": null, - "value": {} - }