From e5b9a4ec7699dfaeca10ad5b7dac8f0d5ad8be54 Mon Sep 17 00:00:00 2001 From: Alina Buzachis Date: Wed, 29 Nov 2023 11:08:08 +0100 Subject: [PATCH 1/5] Add workflows for docs generation Signed-off-by: Alina Buzachis --- .github/ISSUE_TEMPLATE/bug_report.yml | 148 ++ .github/ISSUE_TEMPLATE/ci_report.yml | 148 ++ .github/ISSUE_TEMPLATE/config.yml | 27 + .../ISSUE_TEMPLATE/documentation_report.yml | 130 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 74 + .github/settings.yml | 5 + .github/workflows/ansible-bot.yml | 17 + .github/workflows/docs-pr.yml | 71 + .github/workflows/docs-push.yml | 38 + .github/workflows/patchback.yml | 4 + ...ppliance_access_consolecli_info_module.rst | 214 --- ...est.appliance_access_consolecli_module.rst | 250 --- ...rest.appliance_access_dcui_info_module.rst | 214 --- ...ware_rest.appliance_access_dcui_module.rst | 250 --- ...est.appliance_access_shell_info_module.rst | 215 --- ...are_rest.appliance_access_shell_module.rst | 275 ---- ..._rest.appliance_access_ssh_info_module.rst | 215 --- ...mware_rest.appliance_access_ssh_module.rst | 253 --- ....appliance_health_applmgmt_info_module.rst | 215 --- ....appliance_health_database_info_module.rst | 183 --- ...nce_health_databasestorage_info_module.rst | 215 --- ...rest.appliance_health_load_info_module.rst | 215 --- ..._rest.appliance_health_mem_info_module.rst | 215 --- ...ce_health_softwarepackages_info_module.rst | 215 --- ...t.appliance_health_storage_info_module.rst | 215 --- ...rest.appliance_health_swap_info_module.rst | 215 --- ...st.appliance_health_system_info_module.rst | 215 --- ...iance_infraprofile_configs_info_module.rst | 215 --- ....appliance_infraprofile_configs_module.rst | 286 ---- ...localaccounts_globalpolicy_info_module.rst | 215 --- ...ance_localaccounts_globalpolicy_module.rst | 278 ---- ...st.appliance_localaccounts_info_module.rst | 230 --- ..._rest.appliance_monitoring_info_module.rst | 231 --- ...rest.appliance_monitoring_query_module.rst | 316 ---- ...nce_networking_dns_domains_info_module.rst | 213 --- ...ppliance_networking_dns_domains_module.rst | 270 --- ...ce_networking_dns_hostname_info_module.rst | 215 --- ...pliance_networking_dns_hostname_module.rst | 251 --- ...nce_networking_dns_servers_info_module.rst | 215 --- ...ppliance_networking_dns_servers_module.rst | 308 ---- ...etworking_firewall_inbound_info_module.rst | 213 --- ...nce_networking_firewall_inbound_module.rst | 288 ---- ..._rest.appliance_networking_info_module.rst | 215 --- ...ance_networking_interfaces_info_module.rst | 253 --- ...networking_interfaces_ipv4_info_module.rst | 232 --- ...ance_networking_interfaces_ipv4_module.rst | 341 ---- ...networking_interfaces_ipv6_info_module.rst | 232 --- ...ance_networking_interfaces_ipv6_module.rst | 347 ---- ...mware_rest.appliance_networking_module.rst | 267 --- ...pliance_networking_noproxy_info_module.rst | 213 --- ...st.appliance_networking_noproxy_module.rst | 255 --- ...appliance_networking_proxy_info_module.rst | 230 --- ...rest.appliance_networking_proxy_module.rst | 380 ----- ....vmware_rest.appliance_ntp_info_module.rst | 218 --- ...mware.vmware_rest.appliance_ntp_module.rst | 258 --- ...re_rest.appliance_services_info_module.rst | 249 --- ....vmware_rest.appliance_services_module.rst | 264 --- ...re_rest.appliance_shutdown_info_module.rst | 219 --- ....vmware_rest.appliance_shutdown_module.rst | 283 ---- ...ppliance_system_globalfips_info_module.rst | 175 -- ...est.appliance_system_globalfips_module.rst | 212 --- ...t.appliance_system_storage_info_module.rst | 213 --- ...e_rest.appliance_system_storage_module.rst | 240 --- ...rest.appliance_system_time_info_module.rst | 215 --- ...iance_system_time_timezone_info_module.rst | 215 --- ....appliance_system_time_timezone_module.rst | 247 --- ...t.appliance_system_version_info_module.rst | 215 --- ...re_rest.appliance_timesync_info_module.rst | 215 --- ....vmware_rest.appliance_timesync_module.rst | 253 --- ...ware_rest.appliance_update_info_module.rst | 215 --- ...est.appliance_vmon_service_info_module.rst | 232 --- ...are_rest.appliance_vmon_service_module.rst | 289 ---- ...vmware.vmware_rest.cluster_moid_lookup.rst | 230 --- ...rest.content_configuration_info_module.rst | 215 --- ...ware_rest.content_configuration_module.rst | 311 ---- ..._rest.content_library_item_info_module.rst | 313 ---- ..._rest.content_locallibrary_info_module.rst | 253 --- ...mware_rest.content_locallibrary_module.rst | 617 ------- ....content_subscribedlibrary_info_module.rst | 230 --- ..._rest.content_subscribedlibrary_module.rst | 599 ------- ...are.vmware_rest.datacenter_moid_lookup.rst | 230 --- ...ware.vmware_rest.datastore_moid_lookup.rst | 230 --- .../vmware.vmware_rest.folder_moid_lookup.rst | 230 --- docs/vmware.vmware_rest.host_moid_lookup.rst | 230 --- ...vmware.vmware_rest.network_moid_lookup.rst | 231 --- ....vmware_rest.resource_pool_moid_lookup.rst | 230 --- ...mware_rest.vcenter_cluster_info_module.rst | 327 ---- ...re_rest.vcenter_datacenter_info_module.rst | 291 ---- ....vmware_rest.vcenter_datacenter_module.rst | 331 ---- ...are_rest.vcenter_datastore_info_module.rst | 323 ---- ...vmware_rest.vcenter_folder_info_module.rst | 319 ---- ...e.vmware_rest.vcenter_host_info_module.rst | 344 ---- ...vmware.vmware_rest.vcenter_host_module.rst | 388 ----- ...mware_rest.vcenter_network_info_module.rst | 309 ---- ...re_rest.vcenter_ovf_libraryitem_module.rst | 426 ----- ..._rest.vcenter_resourcepool_info_module.rst | 370 ----- ...mware_rest.vcenter_resourcepool_module.rst | 409 ----- ...t.vcenter_storage_policies_info_module.rst | 233 --- ....vcenter_vm_guest_customization_module.rst | 378 ----- ...vm_guest_filesystem_directories_module.rst | 406 ----- ....vcenter_vm_guest_identity_info_module.rst | 243 --- ...r_vm_guest_localfilesystem_info_module.rst | 247 --- ...center_vm_guest_networking_info_module.rst | 243 --- ...uest_networking_interfaces_info_module.rst | 243 --- ...vm_guest_networking_routes_info_module.rst | 241 --- ...center_vm_guest_operations_info_module.rst | 191 --- ...est.vcenter_vm_guest_power_info_module.rst | 264 --- ...are_rest.vcenter_vm_guest_power_module.rst | 292 ---- ...r_vm_hardware_adapter_sata_info_module.rst | 296 ---- ...center_vm_hardware_adapter_sata_module.rst | 367 ----- ...r_vm_hardware_adapter_scsi_info_module.rst | 275 ---- ...center_vm_hardware_adapter_scsi_module.rst | 391 ----- ...er_vm_hardware_boot_device_info_module.rst | 248 --- ...vcenter_vm_hardware_boot_device_module.rst | 292 ---- ...t.vcenter_vm_hardware_boot_info_module.rst | 242 --- ...e_rest.vcenter_vm_hardware_boot_module.rst | 406 ----- ....vcenter_vm_hardware_cdrom_info_module.rst | 273 ---- ..._rest.vcenter_vm_hardware_cdrom_module.rst | 453 ------ ...st.vcenter_vm_hardware_cpu_info_module.rst | 243 --- ...re_rest.vcenter_vm_hardware_cpu_module.rst | 357 ---- ...t.vcenter_vm_hardware_disk_info_module.rst | 298 ---- ...e_rest.vcenter_vm_hardware_disk_module.rst | 474 ------ ...enter_vm_hardware_ethernet_info_module.rst | 278 ---- ...st.vcenter_vm_hardware_ethernet_module.rst | 560 ------- ...vcenter_vm_hardware_floppy_info_module.rst | 273 ---- ...rest.vcenter_vm_hardware_floppy_module.rst | 387 ----- ...e_rest.vcenter_vm_hardware_info_module.rst | 238 --- ...vcenter_vm_hardware_memory_info_module.rst | 243 --- ...rest.vcenter_vm_hardware_memory_module.rst | 319 ---- ...vmware_rest.vcenter_vm_hardware_module.rst | 352 ---- ...enter_vm_hardware_parallel_info_module.rst | 273 ---- ...st.vcenter_vm_hardware_parallel_module.rst | 379 ----- ...vcenter_vm_hardware_serial_info_module.rst | 298 ---- ...rest.vcenter_vm_hardware_serial_module.rst | 453 ------ ...are.vmware_rest.vcenter_vm_info_module.rst | 448 ----- ...est.vcenter_vm_libraryitem_info_module.rst | 241 --- docs/vmware.vmware_rest.vcenter_vm_module.rst | 1445 ----------------- ...ware_rest.vcenter_vm_power_info_module.rst | 243 --- ...re.vmware_rest.vcenter_vm_power_module.rst | 333 ---- ..._storage_policy_compliance_info_module.rst | 243 --- ...er_vm_storage_policy_compliance_module.rst | 248 --- ....vcenter_vm_storage_policy_info_module.rst | 243 --- ..._rest.vcenter_vm_storage_policy_module.rst | 324 ---- ...ware_rest.vcenter_vm_tools_info_module.rst | 301 ---- ...vcenter_vm_tools_installer_info_module.rst | 264 --- ...rest.vcenter_vm_tools_installer_module.rst | 283 ---- ...re.vmware_rest.vcenter_vm_tools_module.rst | 324 ---- ...er_vmtemplate_libraryitems_info_module.rst | 190 --- ...vcenter_vmtemplate_libraryitems_module.rst | 543 ------- docs/vmware.vmware_rest.vm_moid_lookup.rst | 230 --- 150 files changed, 662 insertions(+), 40463 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/ci_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/settings.yml create mode 100644 .github/workflows/ansible-bot.yml create mode 100644 .github/workflows/docs-pr.yml create mode 100644 .github/workflows/docs-push.yml create mode 100644 .github/workflows/patchback.yml delete mode 100644 docs/vmware.vmware_rest.appliance_access_consolecli_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_access_consolecli_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_access_dcui_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_access_dcui_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_access_shell_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_access_shell_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_access_ssh_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_access_ssh_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_health_applmgmt_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_health_database_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_health_databasestorage_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_health_load_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_health_mem_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_health_softwarepackages_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_health_storage_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_health_swap_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_health_system_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_infraprofile_configs_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_infraprofile_configs_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_localaccounts_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_monitoring_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_monitoring_query_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_dns_domains_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_dns_domains_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_dns_hostname_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_dns_hostname_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_dns_servers_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_dns_servers_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_firewall_inbound_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_firewall_inbound_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_interfaces_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_noproxy_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_noproxy_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_proxy_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_networking_proxy_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_ntp_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_ntp_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_services_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_services_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_shutdown_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_shutdown_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_system_globalfips_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_system_globalfips_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_system_storage_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_system_storage_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_system_time_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_system_time_timezone_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_system_time_timezone_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_system_version_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_timesync_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_timesync_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_update_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_vmon_service_info_module.rst delete mode 100644 docs/vmware.vmware_rest.appliance_vmon_service_module.rst delete mode 100644 docs/vmware.vmware_rest.cluster_moid_lookup.rst delete mode 100644 docs/vmware.vmware_rest.content_configuration_info_module.rst delete mode 100644 docs/vmware.vmware_rest.content_configuration_module.rst delete mode 100644 docs/vmware.vmware_rest.content_library_item_info_module.rst delete mode 100644 docs/vmware.vmware_rest.content_locallibrary_info_module.rst delete mode 100644 docs/vmware.vmware_rest.content_locallibrary_module.rst delete mode 100644 docs/vmware.vmware_rest.content_subscribedlibrary_info_module.rst delete mode 100644 docs/vmware.vmware_rest.content_subscribedlibrary_module.rst delete mode 100644 docs/vmware.vmware_rest.datacenter_moid_lookup.rst delete mode 100644 docs/vmware.vmware_rest.datastore_moid_lookup.rst delete mode 100644 docs/vmware.vmware_rest.folder_moid_lookup.rst delete mode 100644 docs/vmware.vmware_rest.host_moid_lookup.rst delete mode 100644 docs/vmware.vmware_rest.network_moid_lookup.rst delete mode 100644 docs/vmware.vmware_rest.resource_pool_moid_lookup.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_cluster_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_datacenter_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_datacenter_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_datastore_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_folder_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_host_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_host_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_network_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_ovf_libraryitem_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_resourcepool_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_resourcepool_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_storage_policies_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_guest_customization_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_guest_filesystem_directories_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_guest_identity_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_guest_networking_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_guest_operations_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_guest_power_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_guest_power_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_boot_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_boot_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_disk_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_disk_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_memory_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_serial_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_hardware_serial_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_libraryitem_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_power_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_power_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_storage_policy_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_storage_policy_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_tools_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_tools_installer_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_tools_installer_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vm_tools_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module.rst delete mode 100644 docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module.rst delete mode 100644 docs/vmware.vmware_rest.vm_moid_lookup.rst diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..078bd4389 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,148 @@ +--- +name: Bug report +description: Create a report to help us improve + +body: +- type: markdown + attributes: + value: | + ⚠ + Verify first that your issue is not [already reported on GitHub][issue search]. + Where possible also test if the latest release and main branch are affected too. + *Complete **all** sections as described, this form is processed automatically.* + + [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues + +- type: textarea + attributes: + label: Summary + description: | + Explain the problem briefly below. + placeholder: >- + When I try to do X with the collection from the main branch on GitHub, Y + breaks in a way Z under the env E. Here are all the details I know + about this problem... + validations: + required: true + +- type: dropdown + attributes: + label: Issue Type + # FIXME: Once GitHub allows defining the default choice, update this + options: + - Bug Report + validations: + required: true + +- type: textarea + attributes: + # For smaller collections we could use a multi-select and hardcode the list + # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins + # Select from list, filter as you type (`mysql` would only show the 3 mysql components) + # OR freeform - doesn't seem to be supported in adaptivecards + label: Component Name + description: >- + Write the short name of the module or plugin below, + *use your best guess if unsure*. + placeholder: vcenter_vm_tools, vcenter_vm_info + validations: + required: true + +- type: textarea + attributes: + label: Ansible Version + description: >- + Paste verbatim output from `ansible --version` between + tripple backticks. + value: | + ```console (paste below) + $ ansible --version + + ``` + validations: + required: true + +- type: textarea + attributes: + label: Collection Versions + description: >- + Paste verbatim output from `ansible-galaxy collection list` between + tripple backticks. + value: | + ```console (paste below) + $ ansible-galaxy collection list + ``` + validations: + required: true + +- type: textarea + attributes: + label: Configuration + description: >- + If this issue has an example piece of YAML that can help to reproduce this problem, please provide it. + This can be a piece of YAML from, e.g., an automation, script, scene or configuration. + + Paste verbatim output from `ansible-config dump --only-changed` between quotes + value: | + ```console (paste below) + $ ansible-config dump --only-changed + + ``` + +- type: textarea + attributes: + label: OS / Environment + description: >- + Provide all relevant information below, e.g. target OS versions, + network device firmware, etc. + placeholder: RHEL 8, CentOS Stream etc. + validations: + required: false + +- type: textarea + attributes: + label: Steps to Reproduce + description: | + Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also paste any playbooks, configs and commands you used. + + **HINT:** You can paste https://gist.github.com links for larger files. + value: | + + ```yaml (paste below) + + ``` + validations: + required: true + +- type: textarea + attributes: + label: Expected Results + description: >- + Describe what you expected to happen when running the steps above. + placeholder: >- + I expected X to happen because I assumed Y. + that it did not. + validations: + required: true + +- type: textarea + attributes: + label: Actual Results + description: | + Describe what actually happened. If possible run with extra verbosity (`-vvvv`). + + Paste verbatim command output between quotes. + value: | + ```console (paste below) + + ``` + +- type: checkboxes + attributes: + label: Code of Conduct + description: | + Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first. + options: + - label: I agree to follow the Ansible Code of Conduct + required: true +... diff --git a/.github/ISSUE_TEMPLATE/ci_report.yml b/.github/ISSUE_TEMPLATE/ci_report.yml new file mode 100644 index 000000000..078bd4389 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ci_report.yml @@ -0,0 +1,148 @@ +--- +name: Bug report +description: Create a report to help us improve + +body: +- type: markdown + attributes: + value: | + ⚠ + Verify first that your issue is not [already reported on GitHub][issue search]. + Where possible also test if the latest release and main branch are affected too. + *Complete **all** sections as described, this form is processed automatically.* + + [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues + +- type: textarea + attributes: + label: Summary + description: | + Explain the problem briefly below. + placeholder: >- + When I try to do X with the collection from the main branch on GitHub, Y + breaks in a way Z under the env E. Here are all the details I know + about this problem... + validations: + required: true + +- type: dropdown + attributes: + label: Issue Type + # FIXME: Once GitHub allows defining the default choice, update this + options: + - Bug Report + validations: + required: true + +- type: textarea + attributes: + # For smaller collections we could use a multi-select and hardcode the list + # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins + # Select from list, filter as you type (`mysql` would only show the 3 mysql components) + # OR freeform - doesn't seem to be supported in adaptivecards + label: Component Name + description: >- + Write the short name of the module or plugin below, + *use your best guess if unsure*. + placeholder: vcenter_vm_tools, vcenter_vm_info + validations: + required: true + +- type: textarea + attributes: + label: Ansible Version + description: >- + Paste verbatim output from `ansible --version` between + tripple backticks. + value: | + ```console (paste below) + $ ansible --version + + ``` + validations: + required: true + +- type: textarea + attributes: + label: Collection Versions + description: >- + Paste verbatim output from `ansible-galaxy collection list` between + tripple backticks. + value: | + ```console (paste below) + $ ansible-galaxy collection list + ``` + validations: + required: true + +- type: textarea + attributes: + label: Configuration + description: >- + If this issue has an example piece of YAML that can help to reproduce this problem, please provide it. + This can be a piece of YAML from, e.g., an automation, script, scene or configuration. + + Paste verbatim output from `ansible-config dump --only-changed` between quotes + value: | + ```console (paste below) + $ ansible-config dump --only-changed + + ``` + +- type: textarea + attributes: + label: OS / Environment + description: >- + Provide all relevant information below, e.g. target OS versions, + network device firmware, etc. + placeholder: RHEL 8, CentOS Stream etc. + validations: + required: false + +- type: textarea + attributes: + label: Steps to Reproduce + description: | + Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also paste any playbooks, configs and commands you used. + + **HINT:** You can paste https://gist.github.com links for larger files. + value: | + + ```yaml (paste below) + + ``` + validations: + required: true + +- type: textarea + attributes: + label: Expected Results + description: >- + Describe what you expected to happen when running the steps above. + placeholder: >- + I expected X to happen because I assumed Y. + that it did not. + validations: + required: true + +- type: textarea + attributes: + label: Actual Results + description: | + Describe what actually happened. If possible run with extra verbosity (`-vvvv`). + + Paste verbatim command output between quotes. + value: | + ```console (paste below) + + ``` + +- type: checkboxes + attributes: + label: Code of Conduct + description: | + Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first. + options: + - label: I agree to follow the Ansible Code of Conduct + required: true +... diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..f90bd1ad8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,27 @@ +--- +# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser +blank_issues_enabled: false # default: true +contact_links: +- name: Security bug report + url: https://docs.ansible.com/ansible-core/devel/community/reporting_bugs_and_features.html?utm_medium=github&utm_source=issue_template_chooser_ansible_collections + about: | + Please learn how to report security vulnerabilities here. + + For all security related bugs, email security@ansible.com + instead of using this issue tracker and you will receive + a prompt response. + + For more information, see + https://docs.ansible.com/ansible/latest/community/reporting_bugs_and_features.html +- name: Ansible Code of Conduct + url: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_template_chooser_ansible_collections + about: Be nice to other members of the community. +- name: Talks to the community + url: https://docs.ansible.com/ansible/latest/community/communication.html?utm_medium=github&utm_source=issue_template_chooser#mailing-list-information + about: Please ask and answer usage questions here +- name: Working groups + url: https://github.com/ansible/community/wiki + about: Interested in improving a specific area? Become a part of a working group! +- name: For Enterprise + url: https://www.ansible.com/products/engine?utm_medium=github&utm_source=issue_template_chooser_ansible_collections + about: Red Hat offers support for the Ansible Automation Platform diff --git a/.github/ISSUE_TEMPLATE/documentation_report.yml b/.github/ISSUE_TEMPLATE/documentation_report.yml new file mode 100644 index 000000000..cf3a84ee0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_report.yml @@ -0,0 +1,130 @@ +--- +name: Documentation Report +description: Ask us about docs +# NOTE: issue body is enabled to allow screenshots + +body: +- type: markdown + attributes: + value: | + ⚠ + Verify first that your issue is not [already reported on GitHub][issue search]. + Where possible also test if the latest release and main branch are affected too. + *Complete **all** sections as described, this form is processed automatically.* + + [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues + +- type: textarea + attributes: + label: Summary + description: | + Explain the problem briefly below, add suggestions to wording or structure. + + **HINT:** Did you know the documentation has an `Edit on GitHub` link on every page? + placeholder: >- + I was reading the Collection documentation of version X and I'm having + problems understanding Y. It would be very helpful if that got + rephrased as Z. + validations: + required: true + +- type: dropdown + attributes: + label: Issue Type + # FIXME: Once GitHub allows defining the default choice, update this + options: + - Documentation Report + validations: + required: true + +- type: textarea + attributes: + # For smaller collections we could use a multi-select and hardcode the list + # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins + # Select from list, filter as you type (`mysql` would only show the 3 mysql components) + # OR freeform - doesn't seem to be supported in adaptivecards + label: Component Name + description: >- + Write the short name of the rst file, module, plugin or task below, + *use your best guess if unsure*. + placeholder: vcenter_vm_tools, vcenter_vm_info + validations: + required: true + +- type: textarea + attributes: + label: Ansible Version + description: >- + Paste verbatim output from `ansible --version` between + tripple backticks. + value: | + ```console (paste below) + $ ansible --version + + ``` + validations: + required: false + +- type: textarea + attributes: + label: Collection Versions + description: >- + Paste verbatim output from `ansible-galaxy collection list` between + tripple backticks. + value: | + ```console (paste below) + $ ansible-galaxy collection list + ``` + validations: + required: false + +- type: textarea + attributes: + label: Configuration + description: >- + If this issue has an example piece of YAML that can help to reproduce this problem, please provide it. + This can be a piece of YAML from, e.g., an automation, script, scene or configuration. + + Paste verbatim output from `ansible-config dump --only-changed` between quotes + value: | + ```console (paste below) + $ ansible-config dump --only-changed + + ``` + validations: + required: false + +- type: textarea + attributes: + label: OS / Environment + description: >- + Provide all relevant information below, e.g. OS version, + browser, etc. + placeholder: RHEL 8, Firefox etc. + validations: + required: false + +- type: textarea + attributes: + label: Additional Information + description: | + Describe how this improves the documentation, e.g. before/after situation or screenshots. + + **Tip:** It's not possible to upload the screenshot via this field directly but you can use the last textarea in this form to attach them. + + **HINT:** You can paste https://gist.github.com links for larger files. + placeholder: >- + When the improvement is applied, it makes it more straightforward + to understand X. + validations: + required: false + +- type: checkboxes + attributes: + label: Code of Conduct + description: | + Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first. + options: + - label: I agree to follow the Ansible Code of Conduct + required: true +... diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..8f88acf88 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,74 @@ +--- +name: Feature request +description: Suggest an idea for this project + +body: +- type: markdown + attributes: + value: | + ⚠ + Verify first that your issue is not [already reported on GitHub][issue search]. + Where possible also test if the latest release and main branch are affected too. + *Complete **all** sections as described, this form is processed automatically.* + + [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues + +- type: textarea + attributes: + label: Summary + description: | + Describe the new feature/improvement briefly below. + placeholder: >- + I am trying to do X with the collection from the main branch on GitHub and + I think that implementing a feature Y would be very helpful for me and + every other user of vmware.vmware_rest because of Z. + validations: + required: true + +- type: dropdown + attributes: + label: Issue Type + # FIXME: Once GitHub allows defining the default choice, update this + options: + - Feature Idea + validations: + required: true + +- type: textarea + attributes: + # For smaller collections we could use a multi-select and hardcode the list + # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins + # Select from list, filter as you type (`mysql` would only show the 3 mysql components) + # OR freeform - doesn't seem to be supported in adaptivecards + label: Component Name + description: >- + Write the short name of the module or plugin below, + *use your best guess if unsure*. + placeholder: vcenter_vm_tools, vcenter_vm_info + validations: + required: true + +- type: textarea + attributes: + label: Additional Information + description: | + Describe how the feature would be used, why it is needed and what it would solve. + + **HINT:** You can paste https://gist.github.com links for larger files. + value: | + + ```yaml (paste below) + + ``` + validations: + required: false + +- type: checkboxes + attributes: + label: Code of Conduct + description: | + Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first. + options: + - label: I agree to follow the Ansible Code of Conduct + required: true +... diff --git a/.github/settings.yml b/.github/settings.yml new file mode 100644 index 000000000..b27b575f0 --- /dev/null +++ b/.github/settings.yml @@ -0,0 +1,5 @@ +# DO NOT MODIFY + +# Settings: https://probot.github.io/apps/settings/ +# Pull settings from https://github.com/ansible-collections/.github/blob/master/.github/settings.yml +_extends: ".github" diff --git a/.github/workflows/ansible-bot.yml b/.github/workflows/ansible-bot.yml new file mode 100644 index 000000000..347abc738 --- /dev/null +++ b/.github/workflows/ansible-bot.yml @@ -0,0 +1,17 @@ +name: ansible bot +on: + issues: + types: + - opened + - reopened + +jobs: + add_label: + runs-on: ubuntu-latest + permissions: + contents: write + issues: write + steps: + - uses: actions-ecosystem/action-add-labels@v1 + with: + labels: needs_triage diff --git a/.github/workflows/docs-pr.yml b/.github/workflows/docs-pr.yml new file mode 100644 index 000000000..9065b2f71 --- /dev/null +++ b/.github/workflows/docs-pr.yml @@ -0,0 +1,71 @@ +name: Collection Docs +concurrency: + group: docs-${{ github.head_ref }} + cancel-in-progress: true +on: + pull_request_target: + types: [opened, synchronize, reopened, closed] + +env: + GHP_BASE_URL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }} + +jobs: + validate-docs: + permissions: + contents: read + name: Validate Ansible Docs + uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main + with: + init-lenient: false + init-fail-on-error: true + intersphinx-links: | + ansible_devel:https://docs.ansible.com/ansible-core/devel/ + + + build-docs: + permissions: + contents: read + name: Build Ansible Docs + uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main + with: + init-lenient: true + init-fail-on-error: false + intersphinx-links: | + ansible_devel:https://docs.ansible.com/ansible-core/devel/ + + comment: + permissions: + pull-requests: write + runs-on: ubuntu-latest + needs: [build-docs] + name: PR comments + steps: + - name: PR comment + uses: ansible-community/github-docs-build/actions/ansible-docs-build-comment@main + with: + body-includes: '## Docs Build' + reactions: heart + action: ${{ needs.build-docs.outputs.changed != 'true' && 'remove' || '' }} + on-closed-action: remove + on-merged-body: | + ## Docs Build 📝 + + Thank you for contribution!✨ + + This PR has been merged and your docs changes will be incorporated when they are next published. + body: | + ## Docs Build 📝 + + Thank you for contribution!✨ + + The docsite for **this PR** is available for download as an artifact from this run: + ${{ needs.build-docs.outputs.artifact-url }} + + You can compare to the docs for the `main` branch here: + ${{ env.GHP_BASE_URL }}/branch/main + + File changes: + + ${{ needs.build-docs.outputs.diff-files-rendered }} + + ${{ needs.build-docs.outputs.diff-rendered }} diff --git a/.github/workflows/docs-push.yml b/.github/workflows/docs-push.yml new file mode 100644 index 000000000..a18b85105 --- /dev/null +++ b/.github/workflows/docs-push.yml @@ -0,0 +1,38 @@ +name: Collection Docs +concurrency: + group: docs-push-${{ github.sha }} + cancel-in-progress: true +on: + push: + branches: + - main + - stable-* + tags: + - '*' + schedule: + - cron: '0 12 * * *' + +jobs: + build-docs: + permissions: + contents: read + name: Build Ansible Docs + uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-push.yml@main + with: + init-lenient: false + init-fail-on-error: true + intersphinx-links: | + ansible_devel:https://docs.ansible.com/ansible-core/devel/ + + publish-docs-gh-pages: + # use to prevent running on forks + if: github.repository == 'ansible-collections/amazon.aws' + permissions: + contents: write + needs: [build-docs] + name: Publish Ansible Docs + uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-publish-gh-pages.yml@main + with: + artifact-name: ${{ needs.build-docs.outputs.artifact-name }} + secrets: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/patchback.yml b/.github/workflows/patchback.yml new file mode 100644 index 000000000..113fc5294 --- /dev/null +++ b/.github/workflows/patchback.yml @@ -0,0 +1,4 @@ +--- +backport_branch_prefix: patchback/backports/ +backport_label_prefix: backport- +target_branch_prefix: stable- diff --git a/docs/vmware.vmware_rest.appliance_access_consolecli_info_module.rst b/docs/vmware.vmware_rest.appliance_access_consolecli_info_module.rst deleted file mode 100644 index 0deef6706..000000000 --- a/docs/vmware.vmware_rest.appliance_access_consolecli_info_module.rst +++ /dev/null @@ -1,214 +0,0 @@ -.. _vmware.vmware_rest.appliance_access_consolecli_info_module: - - -*************************************************** -vmware.vmware_rest.appliance_access_consolecli_info -*************************************************** - -**Get enabled state of the console-based controlled CLI (TTY1).** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get enabled state of the console-based controlled CLI (TTY1). - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Check if the Console CLI is enabled - vmware.vmware_rest.appliance_access_consolecli_info: - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- integer -
- 		On success -
Check if the Console CLI is enabled
-
-
Sample:
-
1
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_access_consolecli_module.rst b/docs/vmware.vmware_rest.appliance_access_consolecli_module.rst deleted file mode 100644 index 3234237ee..000000000 --- a/docs/vmware.vmware_rest.appliance_access_consolecli_module.rst +++ /dev/null @@ -1,250 +0,0 @@ -.. _vmware.vmware_rest.appliance_access_consolecli_module: - - -********************************************** -vmware.vmware_rest.appliance_access_consolecli -********************************************** - -**Set enabled state of the console-based controlled CLI (TTY1).** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set enabled state of the console-based controlled CLI (TTY1). - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- enabled - -
- boolean - / required -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Console-based controlled CLI is enabled. This parameter is mandatory.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Disable the Console CLI - vmware.vmware_rest.appliance_access_consolecli: - enabled: false - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Disable the Console CLI
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_access_dcui_info_module.rst b/docs/vmware.vmware_rest.appliance_access_dcui_info_module.rst deleted file mode 100644 index 81635394d..000000000 --- a/docs/vmware.vmware_rest.appliance_access_dcui_info_module.rst +++ /dev/null @@ -1,214 +0,0 @@ -.. _vmware.vmware_rest.appliance_access_dcui_info_module: - - -********************************************* -vmware.vmware_rest.appliance_access_dcui_info -********************************************* - -**Get enabled state of Direct Console User Interface (DCUI TTY2).** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get enabled state of Direct Console User Interface (DCUI TTY2). - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Check if the Direct Console User Interface is enabled - vmware.vmware_rest.appliance_access_dcui_info: - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- integer -
- 		On success -
Check if the Direct Console User Interface is enabled
-
-
Sample:
-
1
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_access_dcui_module.rst b/docs/vmware.vmware_rest.appliance_access_dcui_module.rst deleted file mode 100644 index 5f8abce2b..000000000 --- a/docs/vmware.vmware_rest.appliance_access_dcui_module.rst +++ /dev/null @@ -1,250 +0,0 @@ -.. _vmware.vmware_rest.appliance_access_dcui_module: - - -**************************************** -vmware.vmware_rest.appliance_access_dcui -**************************************** - -**Set enabled state of Direct Console User Interface (DCUI TTY2).** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set enabled state of Direct Console User Interface (DCUI TTY2). - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- enabled - -
- boolean - / required -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
DCUI is enabled. This parameter is mandatory.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Disable the Direct Console User Interface - vmware.vmware_rest.appliance_access_dcui: - enabled: false - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Disable the Direct Console User Interface
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_access_shell_info_module.rst b/docs/vmware.vmware_rest.appliance_access_shell_info_module.rst deleted file mode 100644 index 1cb4dcdc5..000000000 --- a/docs/vmware.vmware_rest.appliance_access_shell_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_access_shell_info_module: - - -********************************************** -vmware.vmware_rest.appliance_access_shell_info -********************************************** - -**Get enabled state of BASH, that is, access to BASH from within the controlled CLI.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get enabled state of BASH, that is, access to BASH from within the controlled CLI. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Check if the Shell is enabled - vmware.vmware_rest.appliance_access_shell_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Check if the Shell is enabled
-
-
Sample:
-
{'enabled': 0, 'timeout': 0}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_access_shell_module.rst b/docs/vmware.vmware_rest.appliance_access_shell_module.rst deleted file mode 100644 index c7836791b..000000000 --- a/docs/vmware.vmware_rest.appliance_access_shell_module.rst +++ /dev/null @@ -1,275 +0,0 @@ -.. _vmware.vmware_rest.appliance_access_shell_module: - - -***************************************** -vmware.vmware_rest.appliance_access_shell -***************************************** - -**Set enabled state of BASH, that is, access to BASH from within the controlled CLI.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set enabled state of BASH, that is, access to BASH from within the controlled CLI. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- enabled - -
- boolean - / required -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enabled can be set to true or false This parameter is mandatory.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- timeout - -
- integer - / required -
- 		- -
The timeout (in seconds) specifies how long you enable the Shell access. The maximum timeout is 86400 seconds(1 day). This parameter is mandatory.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Disable the Shell - vmware.vmware_rest.appliance_access_shell: - enabled: false - timeout: 600 - - - name: Enable the Shell with a timeout - vmware.vmware_rest.appliance_access_shell: - enabled: true - timeout: 600 - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Disable the Shell
-
-
Sample:
-
{'enabled': 0, 'timeout': 0}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_access_ssh_info_module.rst b/docs/vmware.vmware_rest.appliance_access_ssh_info_module.rst deleted file mode 100644 index 1f71fd38c..000000000 --- a/docs/vmware.vmware_rest.appliance_access_ssh_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_access_ssh_info_module: - - -******************************************** -vmware.vmware_rest.appliance_access_ssh_info -******************************************** - -**Get enabled state of the SSH-based controlled CLI.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get enabled state of the SSH-based controlled CLI. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Check is the SSH access is enabled - vmware.vmware_rest.appliance_access_ssh_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- integer -
- 		On success -
Check is the SSH access is enabled
-
-
Sample:
-
1
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_access_ssh_module.rst b/docs/vmware.vmware_rest.appliance_access_ssh_module.rst deleted file mode 100644 index 7ea11cca3..000000000 --- a/docs/vmware.vmware_rest.appliance_access_ssh_module.rst +++ /dev/null @@ -1,253 +0,0 @@ -.. _vmware.vmware_rest.appliance_access_ssh_module: - - -*************************************** -vmware.vmware_rest.appliance_access_ssh -*************************************** - -**Set enabled state of the SSH-based controlled CLI.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set enabled state of the SSH-based controlled CLI. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- enabled - -
- boolean - / required -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
SSH-based controlled CLI is enabled. This parameter is mandatory.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure the SSH access ie enabled - vmware.vmware_rest.appliance_access_ssh: - enabled: true - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- integer -
- 		On success -
Ensure the SSH access ie enabled
-
-
Sample:
-
1
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_health_applmgmt_info_module.rst b/docs/vmware.vmware_rest.appliance_health_applmgmt_info_module.rst deleted file mode 100644 index 0f99a32ea..000000000 --- a/docs/vmware.vmware_rest.appliance_health_applmgmt_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_health_applmgmt_info_module: - - -************************************************* -vmware.vmware_rest.appliance_health_applmgmt_info -************************************************* - -**Get health status of applmgmt services.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get health status of applmgmt services. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the health state of applmgmt - vmware.vmware_rest.appliance_health_applmgmt_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Get the health state of applmgmt
-
-
Sample:
-
green
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_health_database_info_module.rst b/docs/vmware.vmware_rest.appliance_health_database_info_module.rst deleted file mode 100644 index 32437265d..000000000 --- a/docs/vmware.vmware_rest.appliance_health_database_info_module.rst +++ /dev/null @@ -1,183 +0,0 @@ -.. _vmware.vmware_rest.appliance_health_database_info_module: - - -************************************************* -vmware.vmware_rest.appliance_health_database_info -************************************************* - -**Returns the health status of the database.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns the health status of the database. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the database heath status - vmware.vmware_rest.appliance_health_database_info: - register: result - - - - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_health_databasestorage_info_module.rst b/docs/vmware.vmware_rest.appliance_health_databasestorage_info_module.rst deleted file mode 100644 index d87c9ec82..000000000 --- a/docs/vmware.vmware_rest.appliance_health_databasestorage_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_health_databasestorage_info_module: - - -******************************************************** -vmware.vmware_rest.appliance_health_databasestorage_info -******************************************************** - -**Get database storage health.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get database storage health. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the database storage heath status - vmware.vmware_rest.appliance_health_databasestorage_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Get the database storage heath status
-
-
Sample:
-
green
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_health_load_info_module.rst b/docs/vmware.vmware_rest.appliance_health_load_info_module.rst deleted file mode 100644 index 656243016..000000000 --- a/docs/vmware.vmware_rest.appliance_health_load_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_health_load_info_module: - - -********************************************* -vmware.vmware_rest.appliance_health_load_info -********************************************* - -**Get load health.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get load health. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the system load status - vmware.vmware_rest.appliance_health_load_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Get the system load status
-
-
Sample:
-
green
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_health_mem_info_module.rst b/docs/vmware.vmware_rest.appliance_health_mem_info_module.rst deleted file mode 100644 index 44cafb88c..000000000 --- a/docs/vmware.vmware_rest.appliance_health_mem_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_health_mem_info_module: - - -******************************************** -vmware.vmware_rest.appliance_health_mem_info -******************************************** - -**Get memory health.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get memory health. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the system mem status - vmware.vmware_rest.appliance_health_mem_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Get the system mem status
-
-
Sample:
-
green
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_health_softwarepackages_info_module.rst b/docs/vmware.vmware_rest.appliance_health_softwarepackages_info_module.rst deleted file mode 100644 index 061d7f6b6..000000000 --- a/docs/vmware.vmware_rest.appliance_health_softwarepackages_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_health_softwarepackages_info_module: - - -********************************************************* -vmware.vmware_rest.appliance_health_softwarepackages_info -********************************************************* - -**Get information on available software updates available in the remote vSphere Update Manager repository** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get information on available software updates available in the remote vSphere Update Manager repository. Red indicates that security updates are available. Orange indicates that non-security updates are available. Green indicates that there are no updates available. Gray indicates that there was an error retreiving information on software updates. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the health of the software package manager - vmware.vmware_rest.appliance_health_softwarepackages_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Get the health of the software package manager
-
-
Sample:
-
green
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_health_storage_info_module.rst b/docs/vmware.vmware_rest.appliance_health_storage_info_module.rst deleted file mode 100644 index c354fe489..000000000 --- a/docs/vmware.vmware_rest.appliance_health_storage_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_health_storage_info_module: - - -************************************************ -vmware.vmware_rest.appliance_health_storage_info -************************************************ - -**Get storage health.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get storage health. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the health of the storage system - vmware.vmware_rest.appliance_health_storage_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Get the health of the storage system
-
-
Sample:
-
green
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_health_swap_info_module.rst b/docs/vmware.vmware_rest.appliance_health_swap_info_module.rst deleted file mode 100644 index 365d475b3..000000000 --- a/docs/vmware.vmware_rest.appliance_health_swap_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_health_swap_info_module: - - -********************************************* -vmware.vmware_rest.appliance_health_swap_info -********************************************* - -**Get swap health.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get swap health. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the health of the swap - vmware.vmware_rest.appliance_health_swap_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Get the health of the swap
-
-
Sample:
-
green
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_health_system_info_module.rst b/docs/vmware.vmware_rest.appliance_health_system_info_module.rst deleted file mode 100644 index b5a597654..000000000 --- a/docs/vmware.vmware_rest.appliance_health_system_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_health_system_info_module: - - -*********************************************** -vmware.vmware_rest.appliance_health_system_info -*********************************************** - -**Get overall health of system.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get overall health of system. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the system health status - vmware.vmware_rest.appliance_health_system_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Get the system health status
-
-
Sample:
-
green
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_infraprofile_configs_info_module.rst b/docs/vmware.vmware_rest.appliance_infraprofile_configs_info_module.rst deleted file mode 100644 index 1387af2b8..000000000 --- a/docs/vmware.vmware_rest.appliance_infraprofile_configs_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_infraprofile_configs_info_module: - - -****************************************************** -vmware.vmware_rest.appliance_infraprofile_configs_info -****************************************************** - -**List all the profiles which are registered.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- List all the profiles which are registered. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: List infraprofile configs - vmware.vmware_rest.appliance_infraprofile_configs_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
List infraprofile configs
-
-
Sample:
-
[{'info': 'ApplianceManagement', 'name': 'ApplianceManagement'}, {'info': 'ApplianceNetwork', 'name': 'ApplianceNetwork'}, {'info': 'Authentication & Authorization Management', 'name': 'AuthManagement'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_infraprofile_configs_module.rst b/docs/vmware.vmware_rest.appliance_infraprofile_configs_module.rst deleted file mode 100644 index af0e71ed8..000000000 --- a/docs/vmware.vmware_rest.appliance_infraprofile_configs_module.rst +++ /dev/null @@ -1,286 +0,0 @@ -.. _vmware.vmware_rest.appliance_infraprofile_configs_module: - - -************************************************* -vmware.vmware_rest.appliance_infraprofile_configs -************************************************* - -**Exports the desired profile specification.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Exports the desired profile specification. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
- 		- -
Custom description provided by the user.
-
If unset description will be empty.
-
-
- encryption_key - -
- string -
- 		- -
Encryption Key to encrypt/decrypt profiles.
-
If unset encryption will not be used for the profile.
-
-
- profiles - -
- list - / elements=string -
- 		- -
Profiles to be exported/imported.
-
If unset or empty, all profiles will be returned.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.appliance_infraprofile_configs.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • export
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Export the ApplianceManagement profile - vmware.vmware_rest.appliance_infraprofile_configs: - state: export - profiles: - - ApplianceManagement - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Export the ApplianceManagement profile
-
-
Sample:
-
{"action":"RESTART_SERVICE","productName":"VMware vCenter Server","creationTime":"2022-11-23T20:11:00+0000","version":"7.0.3.00800","profiles":{"ApplianceManagement":{"action":"RESTART_SERVICE","actionOn":{"VC_SERVICES":["applmgmt"],"SYSTEMD":["sendmail","rsyslog"]},"description":"Appliance Mangment Service","version":"7.0","config":{"/etc/applmgmt/appliance/appliance.conf":{"Is shell Enabled":true,"Shell Expiration Time":9,"TimeSync Mode (Host/NTP)":"NTP"},"/etc/ntp.conf":{"Time servers":"time.nist.gov"},"/etc/shadow":{"root":{"maximumDays":"90","warningDays":"7"},"bin":{"maximumDays":"90","warningDays":"7"},"daemon":{"maximumDays":"90","warningDays":"7"},"messagebus":{"maximumDays":"90","warningDays":"7"},"systemd-bus-proxy":{"maximumDays":"90","warningDays":"7"},"systemd-journal-gateway":{"maximumDays":"90","warningDays":"7"},"systemd-journal-remote":{"maximumDays":"90","warningDays":"7"},"systemd-journal-upload":{"maximumDays":"90","warningDays":"7"},"systemd-network":{"maximumDays":"90","warningDays":"7"},"systemd-resolve":{"maximumDays":"90","warningDays":"7"},"systemd-timesync":{"maximumDays":"90","warningDays":"7"},"nobody":{"maximumDays":"90","warningDays":"7"},"rpc":{"maximumDays":"90","warningDays":"7"},"sshd":{"maximumDays":"90","warningDays":"7"},"ntp":{"maximumDays":"90","warningDays":"7"},"smmsp":{"maximumDays":"90","warningDays":"7"},"apache":{"maximumDays":"90","warningDays":"7"},"tftp":{"maximumDays":"","warningDays":""},"named":{"maximumDays":"","warningDays":""},"vmdird":{"maximumDays":"90","warningDays":"7"},"sso-user":{"maximumDays":"90","warningDays":"7"},"dnsmasq":{"maximumDays":"","warningDays":""},"observability":{"maximumDays":"","warningDays":""},"vdtc":{"maximumDays":"","warningDays":""},"vmafdd-user":{"maximumDays":"90","warningDays":"7"},"vmcad-user":{"maximumDays":"90","warningDays":"7"},"pod":{"maximumDays":"","warningDays":""},"vmonapi":{"maximumDays":"","warningDays":""},"envoy":{"maximumDays":"","warningDays":""},"vpostgres":{"maximumDays":"","warningDays":"7"},"lookupsvc":{"maximumDays":"","warningDays":""},"cis-license":{"maximumDays":"","warningDays":""},"pschealth":{"maximumDays":"","warningDays":""},"netdumper":{"maximumDays":"","warningDays":""},"vapiEndpoint":{"maximumDays":"90","warningDays":"7"},"vpxd-svcs":{"maximumDays":"","warningDays":""},"certauth":{"maximumDays":"90","warningDays":"7"},"certmgr":{"maximumDays":"90","warningDays":"7"},"infraprofile":{"maximumDays":"","warningDays":""},"topologysvc":{"maximumDays":"90","warningDays":"7"},"trustmanagement":{"maximumDays":"","warningDays":""},"vpxd":{"maximumDays":"","warningDays":""},"analytics":{"maximumDays":"","warningDays":""},"eam":{"maximumDays":"90","warningDays":"7"},"sps":{"maximumDays":"","warningDays":""},"deploy":{"maximumDays":"","warningDays":""},"updatemgr":{"maximumDays":"","warningDays":""},"vlcm":{"maximumDays":"90","warningDays":"7"},"vmcam":{"maximumDays":"90","warningDays":"7"},"vsan-health":{"maximumDays":"90","warningDays":"7"},"vsm":{"maximumDays":"90","warningDays":"7"},"vsphere-ui":{"maximumDays":"90","warningDays":"7"},"vtsdbuser":{"maximumDays":"","warningDays":""},"vstatsuser":{"maximumDays":"","warningDays":""},"wcp":{"maximumDays":"","warningDays":"7"},"content-library":{"maximumDays":"90","warningDays":"7"},"imagebuilder":{"maximumDays":"90","warningDays":"7"},"perfcharts":{"maximumDays":"90","warningDays":"7"},"vpgmonusr":{"maximumDays":"","warningDays":"7"},"vtsdbmonusr":{"maximumDays":"","warningDays":"7"},"zuul":{"maximumDays":"90","warningDays":"7"},"Send Waring before this No of Days.":null,"Password validity (days)":null},"/etc/sysconfig/clock":{"Time zone":"\"Etc/UTC\"","UTC":"1"},"/usr/bin/systemctl/sshd.service":{"Enable SSH":"true"},"/etc/mail/sendmail.cf":{"SMTP Port":null,"Mail server":null},"/etc/vmware-syslog/syslog.conf":{"Port [2]":null,"Port [1]":null,"Port [0]":null,"Protocol [2]":null,"Remote Syslog Host [1]":null,"Protocol [1]":null,"Remote Syslog Host [0]":null,"Protocol [0]":null,"Remote Syslog Host [2]":null},"/etc/pam.d/system-auth":{"Deny Login after these many Unsuccessful Attempts.":null,"Unlock root after (seconds)":null,"On Error Login will be.":null,"Include Root user for SSH lockout.":null,"Unlock user after (seconds)":null}},"name":"ApplianceManagement"}}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module.rst b/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module.rst deleted file mode 100644 index 2c3cfec27..000000000 --- a/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module: - - -************************************************************ -vmware.vmware_rest.appliance_localaccounts_globalpolicy_info -************************************************************ - -**Get the global password policy.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get the global password policy. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the global policy of the local accounts - vmware.vmware_rest.appliance_localaccounts_globalpolicy_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get the global policy of the local accounts
-
-
Sample:
-
{'max_days': 90, 'min_days': 1, 'warn_days': 7}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_module.rst b/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_module.rst deleted file mode 100644 index c8127a9e8..000000000 --- a/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_module.rst +++ /dev/null @@ -1,278 +0,0 @@ -.. _vmware.vmware_rest.appliance_localaccounts_globalpolicy_module: - - -******************************************************* -vmware.vmware_rest.appliance_localaccounts_globalpolicy -******************************************************* - -**Set the global password policy.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set the global password policy. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- max_days - -
- integer -
- 		- -
Maximum number of days a password may be used. If the password is older than this, a password change will be forced.
-
If unset then the restriction will be ignored.
-
-
- min_days - -
- integer -
- 		- -
Minimum number of days allowed between password changes. Any password changes attempted sooner than this will be rejected.
-
If unset then the restriction will be ignored.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- warn_days - -
- integer -
- 		- -
Number of days warning given before a password expires. A zero means warning is given only upon the day of expiration.
-
If unset then no warning will be provided.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Update the global policy of the local accounts - vmware.vmware_rest.appliance_localaccounts_globalpolicy: - warn_days: 5 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Update the global policy of the local accounts
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_localaccounts_info_module.rst b/docs/vmware.vmware_rest.appliance_localaccounts_info_module.rst deleted file mode 100644 index f7af04602..000000000 --- a/docs/vmware.vmware_rest.appliance_localaccounts_info_module.rst +++ /dev/null @@ -1,230 +0,0 @@ -.. _vmware.vmware_rest.appliance_localaccounts_info_module: - - -*********************************************** -vmware.vmware_rest.appliance_localaccounts_info -*********************************************** - -**Get the local user account information.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get the local user account information. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- username - -
- string -
- 		- -
User login name Required with state=['get']
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: List the local accounts - vmware.vmware_rest.appliance_localaccounts_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
List the local accounts
-
-
Sample:
-
[{'enabled': 1, 'fullname': 'root', 'has_password': 1, 'last_password_change': '2022-11-23T00:00:00.000Z', 'max_days_between_password_change': 90, 'min_days_between_password_change': 0, 'password_expires_at': '2023-02-21T00:00:00.000Z', 'roles': ['superAdmin'], 'warn_days_before_password_expiration': 7}, {'enabled': 0, 'has_password': 0, 'inactive_at': '2022-12-25T00:00:00.000Z', 'last_password_change': '2022-09-26T00:00:00.000Z', 'max_days_between_password_change': 90, 'min_days_between_password_change': 1, 'password_expires_at': '2022-12-25T00:00:00.000Z', 'roles': [''], 'warn_days_before_password_expiration': 7}, {'enabled': 0, 'has_password': 0, 'last_password_change': '2022-09-26T00:00:00.000Z', 'max_days_between_password_change': -1, 'min_days_between_password_change': -1, 'roles': [''], 'warn_days_before_password_expiration': -1}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_monitoring_info_module.rst b/docs/vmware.vmware_rest.appliance_monitoring_info_module.rst deleted file mode 100644 index ff263e4c8..000000000 --- a/docs/vmware.vmware_rest.appliance_monitoring_info_module.rst +++ /dev/null @@ -1,231 +0,0 @@ -.. _vmware.vmware_rest.appliance_monitoring_info_module: - - -******************************************** -vmware.vmware_rest.appliance_monitoring_info -******************************************** - -**Get monitored item info** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get monitored item info - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- stat_id - -
- string -
- 		- -
statistic item id
-
The parameter must be the id of a resource returned by vmware.vmware_rest.appliance_monitoring_info. Required with state=['get']
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the list of the monitored items - vmware.vmware_rest.appliance_monitoring_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Get the list of the monitored items
-
-
Sample:
-
[{'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'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_monitoring_query_module.rst b/docs/vmware.vmware_rest.appliance_monitoring_query_module.rst deleted file mode 100644 index 27bf8352c..000000000 --- a/docs/vmware.vmware_rest.appliance_monitoring_query_module.rst +++ /dev/null @@ -1,316 +0,0 @@ -.. _vmware.vmware_rest.appliance_monitoring_query_module: - - -********************************************* -vmware.vmware_rest.appliance_monitoring_query -********************************************* - -**Get monitoring data.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get monitoring data. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- end_time - -
- string - / required -
- 		- -
End time in UTC This parameter is mandatory.
-
-
- function - -
- string - / required -
- 		-
    Choices: -
  • AVG
    • -
  • COUNT
    • -
  • MAX
    • -
  • MIN
    • -
- 		-
function_type enumerated type Defines aggregation function This parameter is mandatory.
-
-
- interval - -
- string - / required -
- 		-
    Choices: -
  • DAY1
    • -
  • HOURS2
    • -
  • HOURS6
    • -
  • MINUTES30
    • -
  • MINUTES5
    • -
- 		-
interval_type enumerated type Defines interval between the values in hours and mins, for which aggregation will apply This parameter is mandatory.
-
-
- names - -
- list - / elements=string - / required -
- 		- -
monitored item IDs Ex: CPU, MEMORY
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.appliance_monitoring_info.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- start_time - -
- string - / required -
- 		- -
Start time in UTC This parameter is mandatory.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Query the monitoring backend - vmware.vmware_rest.appliance_monitoring_query: - end_time: 2021-04-14 09:34:56+00:00 - start_time: 2021-04-14 08:34:56+00:00 - names: - - mem.total - interval: MINUTES5 - function: AVG - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Query the monitoring backend
-
-
Sample:
-
[{'data': ['', '', '', '', '', '', '', '', '', '', '', '', ''], 'end_time': '2021-04-14T09:34:56.000Z', 'function': 'AVG', 'interval': 'MINUTES5', 'name': 'mem.total', 'start_time': '2021-04-14T08:34:56.000Z'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_dns_domains_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_dns_domains_info_module.rst deleted file mode 100644 index e3437c6a8..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_dns_domains_info_module.rst +++ /dev/null @@ -1,213 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_dns_domains_info_module: - - -******************************************************** -vmware.vmware_rest.appliance_networking_dns_domains_info -******************************************************** - -**Get list of DNS search domains.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get list of DNS search domains. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get DNS domains configuration - vmware.vmware_rest.appliance_networking_dns_domains_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Get DNS domains configuration
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_dns_domains_module.rst b/docs/vmware.vmware_rest.appliance_networking_dns_domains_module.rst deleted file mode 100644 index 66baf0ef0..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_dns_domains_module.rst +++ /dev/null @@ -1,270 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_dns_domains_module: - - -*************************************************** -vmware.vmware_rest.appliance_networking_dns_domains -*************************************************** - -**Set DNS search domains.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set DNS search domains. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- domain - -
- string -
- 		- -
Domain to add. Required with state=['add']
-
-
- domains - -
- list - / elements=string -
- 		- -
List of domains. Required with state=['set']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • add
    • -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Update the domain configuration - vmware.vmware_rest.appliance_networking_dns_domains: - domains: - - foobar - register: result - - - name: Add another domain configuration - vmware.vmware_rest.appliance_networking_dns_domains: - domain: barfoo - state: add - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Add another domain configuration
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_dns_hostname_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_dns_hostname_info_module.rst deleted file mode 100644 index 123c29bb7..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_dns_hostname_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_dns_hostname_info_module: - - -********************************************************* -vmware.vmware_rest.appliance_networking_dns_hostname_info -********************************************************* - -**Get the Fully Qualified Doman Name.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get the Fully Qualified Doman Name. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the hostname configuration - vmware.vmware_rest.appliance_networking_dns_hostname_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Get the hostname configuration
-
-
Sample:
-
vcenter.test
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_dns_hostname_module.rst b/docs/vmware.vmware_rest.appliance_networking_dns_hostname_module.rst deleted file mode 100644 index e1deee534..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_dns_hostname_module.rst +++ /dev/null @@ -1,251 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_dns_hostname_module: - - -**************************************************** -vmware.vmware_rest.appliance_networking_dns_hostname -**************************************************** - -**Set the Fully Qualified Domain Name.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set the Fully Qualified Domain Name. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- name - -
- string - / required -
- 		- -
FQDN. This parameter is mandatory.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
  • test
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Test the hostname configuration - vmware.vmware_rest.appliance_networking_dns_hostname: - state: test - name: vcenter.test - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Test the hostname configuration
-
-
Sample:
-
{'messages': [{'message': 'Hostname vcenter.test resolved using DNS to 192.168.123.8.', 'result': 'success'}], 'status': 'green'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_dns_servers_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_dns_servers_info_module.rst deleted file mode 100644 index 7a28f961b..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_dns_servers_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_dns_servers_info_module: - - -******************************************************** -vmware.vmware_rest.appliance_networking_dns_servers_info -******************************************************** - -**Get DNS server configuration.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get DNS server configuration. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the DNS servers - vmware.vmware_rest.appliance_networking_dns_servers_info: - register: original_DNS_config - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get the DNS servers
-
-
Sample:
-
{'mode': 'dhcp', 'servers': ['192.168.123.1']}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_dns_servers_module.rst b/docs/vmware.vmware_rest.appliance_networking_dns_servers_module.rst deleted file mode 100644 index d37c90071..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_dns_servers_module.rst +++ /dev/null @@ -1,308 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_dns_servers_module: - - -*************************************************** -vmware.vmware_rest.appliance_networking_dns_servers -*************************************************** - -**Set the DNS server configuration** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set the DNS server configuration. If you set the mode argument to "DHCP", a DHCP refresh is forced. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- mode - -
- string -
- 		-
    Choices: -
  • dhcp
    • -
  • is_static
    • -
- 		-
dns_server_mode enumerated type Describes DNS Server source (DHCP,static) Required with state=['set']
-
-
- server - -
- string -
- 		- -
DNS server. Required with state=['add']
-
-
- servers - -
- list - / elements=string -
- 		- -
List of the currently used DNS servers. Required with state=['set', 'test']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • add
    • -
  • set ←
    • -
  • test
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Set static DNS servers - vmware.vmware_rest.appliance_networking_dns_servers: - servers: - - 1.1.1.1 - mode: is_static - state: set - register: result - - - name: Add another DNS server - vmware.vmware_rest.appliance_networking_dns_servers: - server: 8.8.4.4 - state: add - register: result - - - name: Use the DNS servers from the DHCP - vmware.vmware_rest.appliance_networking_dns_servers: - mode: dhcp - servers: [] - state: set - register: result - - - name: Test the DNS servers - vmware.vmware_rest.appliance_networking_dns_servers: - state: test - servers: - - google.com - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Add another DNS server
-
-
Sample:
-
{'mode': 'is_static', 'servers': ['1.1.1.1', '192.168.123.1', '8.8.4.4']}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_info_module.rst deleted file mode 100644 index 69031bfbc..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_info_module.rst +++ /dev/null @@ -1,213 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_firewall_inbound_info_module: - - -************************************************************* -vmware.vmware_rest.appliance_networking_firewall_inbound_info -************************************************************* - -**Get the ordered list of firewall rules** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get the ordered list of firewall rules. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. When a connection matches a firewall rule, further processing for the connection stops, and the appliance ignores any additional firewall rules you have set. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the firewall inbound configuration - vmware.vmware_rest.appliance_networking_firewall_inbound_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Get the firewall inbound configuration
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_module.rst b/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_module.rst deleted file mode 100644 index 780a57ced..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_module.rst +++ /dev/null @@ -1,288 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_firewall_inbound_module: - - -******************************************************** -vmware.vmware_rest.appliance_networking_firewall_inbound -******************************************************** - -**Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses. This overwrites the existing firewall rules and creates a new rule list. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. For example, the list of rules can be as follows: [dropped table ] - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- rules - -
- list - / elements=dictionary - / required -
- 		- -
List of address-based firewall rules. This parameter is mandatory.
-
Valid attributes are:
-
- address (str): IPv4 or IPv6 address. (['set'])
-
This key is required with ['set'].
-
- prefix (int): CIDR prefix used to mask address. For example, an IPv4 prefix of 24 ignores the low-order 8 bits of address. (['set'])
-
This key is required with ['set'].
-
- policy (str): policy enumerated type Defines firewall rule policies. (['set'])
-
This key is required with ['set'].
-
- Accepted values:
-
- ACCEPT
-
- IGNORE
-
- REJECT
-
- RETURN
-
- interface_name (str): The interface to which this rule applies. An empty string indicates that the rule applies to all interfaces. (['set'])
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure the rules parameter is mandatory - vmware.vmware_rest.appliance_networking_firewall_inbound: - register: result - failed_when: - - not(result.failed) - - result.msg == 'missing required arguments: rules' - - - name: Set a firewall rule - vmware.vmware_rest.appliance_networking_firewall_inbound: - rules: - - address: 1.2.3.4 - prefix: 32 - policy: ACCEPT - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- failed_when_result - -
- integer -
- 		On success -
Ensure the rules parameter is mandatory
-
-
-
- msg - -
- string -
- 		On success -
Ensure the rules parameter is mandatory
-
-
Sample:
-
missing required arguments: rules
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_info_module.rst deleted file mode 100644 index 21d75be2c..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_info_module: - - -******************************************** -vmware.vmware_rest.appliance_networking_info -******************************************** - -**Get Networking information for all configured interfaces.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get Networking information for all configured interfaces. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get network information - vmware.vmware_rest.appliance_networking_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get network information
-
-
Sample:
-
{'dns': {'hostname': 'vcenter.test', 'mode': 'DHCP', 'servers': ['192.168.123.1']}, 'interfaces': {'nic0': {'ipv4': {'address': '192.168.123.8', 'configurable': 1, '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': 1, 'configurable': 1, 'default_gateway': '', 'dhcp': 0}, 'mac': '52:54:00:70:48:23', 'name': 'nic0', 'status': 'up'}}, 'vcenter_base_url': 'https://vcenter.test:443'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_interfaces_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_interfaces_info_module.rst deleted file mode 100644 index 1865a43c6..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_interfaces_info_module.rst +++ /dev/null @@ -1,253 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_interfaces_info_module: - - -******************************************************* -vmware.vmware_rest.appliance_networking_interfaces_info -******************************************************* - -**Get information about a particular network interface.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get information about a particular network interface. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- interface_name - -
- string -
- 		- -
Network interface, for example, "nic0".
-
The parameter must be the id of a resource returned by vmware.vmware_rest.appliance_networking_interfaces_info. Required with state=['get']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get a list of the network interfaces - vmware.vmware_rest.appliance_networking_interfaces_info: - register: result - - - name: Get details about one network interfaces - vmware.vmware_rest.appliance_networking_interfaces_info: - interface_name: nic0 - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
nic0
-
-
- value - -
- dictionary -
- 		On success -
Get details about one network interfaces
-
-
Sample:
-
{'ipv4': {'address': '192.168.123.8', 'configurable': 1, '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': 1, 'configurable': 1, 'default_gateway': '', 'dhcp': 0}, 'mac': '52:54:00:70:48:23', 'name': 'nic0', 'status': 'up'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module.rst deleted file mode 100644 index ae06749e7..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module.rst +++ /dev/null @@ -1,232 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module: - - -************************************************************ -vmware.vmware_rest.appliance_networking_interfaces_ipv4_info -************************************************************ - -**Get IPv4 network configuration for specific NIC.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get IPv4 network configuration for specific NIC. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- interface_name - -
- string -
- 		- -
The Network interface to query, for example, "nic0".
-
The parameter must be the id of a resource returned by vmware.vmware_rest.appliance_networking_interfaces_info. Required with state=['get']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Collect the IPv4 network information - vmware.vmware_rest.appliance_networking_interfaces_ipv4_info: - interface_name: nic0 - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Collect the IPv4 network information
-
-
Sample:
-
{'address': '192.168.123.8', 'configurable': 1, 'default_gateway': '192.168.123.1', 'mode': 'STATIC', 'prefix': 24}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_module.rst b/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_module.rst deleted file mode 100644 index fde23189d..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_module.rst +++ /dev/null @@ -1,341 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_interfaces_ipv4_module: - - -******************************************************* -vmware.vmware_rest.appliance_networking_interfaces_ipv4 -******************************************************* - -**Set IPv4 network configuration for specific network interface.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set IPv4 network configuration for specific network interface. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- address - -
- string -
- 		- -
The IPv4 address, for example, "10.20.80.191".
-
This field is optional and it is only relevant when the value of mode is STATIC.
-
-
- default_gateway - -
- string -
- 		- -
The IPv4 address of the default gateway. This configures the global default gateway on the appliance with the specified gateway address and interface. This gateway replaces the existing default gateway configured on the appliance. However, if the gateway address is link-local, then it is added for that interface. This does not support configuration of multiple global default gateways through different interfaces.
-
If unset, the defaultGateway was never set.
-
-
- interface_name - -
- string - / required -
- 		- -
Network interface to update, for example, "nic0".
-
The parameter must be the id of a resource returned by vmware.vmware_rest.appliance_networking_interfaces_info. This parameter is mandatory.
-
-
- mode - -
- string - / required -
- 		-
    Choices: -
  • DHCP
    • -
  • STATIC
    • -
  • UNCONFIGURED
    • -
- 		-
The mode enumerated type defines different IPv4 address assignment modes. This parameter is mandatory.
-
-
- prefix - -
- integer -
- 		- -
The IPv4 CIDR prefix, for example, 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion.
-
This field is optional and it is only relevant when the value of mode is STATIC.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Set the IPv4 network information of nic99 (which does not exist) - vmware.vmware_rest.appliance_networking_interfaces_ipv4: - interface_name: nic99 - config: - address: 10.20.80.191 - prefix: '32' - mode: STATIC - failed_when: - - not(result.failed) - - result.value.messages[0].default_message msg == "The interface is unknown." - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- failed_when_result - -
- integer -
- 		On success -
Set the IPv4 network information of nic99 (which does not exist)
-
-
-
- msg - -
- string -
- 		On success -
Set the IPv4 network information of nic99 (which does not exist)
-
-
Sample:
-
missing required arguments: mode
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module.rst deleted file mode 100644 index 8a9991f6f..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module.rst +++ /dev/null @@ -1,232 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module: - - -************************************************************ -vmware.vmware_rest.appliance_networking_interfaces_ipv6_info -************************************************************ - -**Get IPv6 network configuration for specific interface.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get IPv6 network configuration for specific interface. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- interface_name - -
- string -
- 		- -
Network interface to query, for example, "nic0".
-
The parameter must be the id of a resource returned by vmware.vmware_rest.appliance_networking_interfaces_info. Required with state=['get']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Collect the IPv6 network information - vmware.vmware_rest.appliance_networking_interfaces_ipv6_info: - interface_name: nic0 - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Collect the IPv6 network information
-
-
Sample:
-
{'addresses': [{'address': 'fe80::5054:ff:fe70:4823', 'origin': 'OTHER', 'prefix': 64, 'status': 'PREFERRED'}], 'autoconf': 1, 'configurable': 1, 'default_gateway': '', 'dhcp': 0}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_module.rst b/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_module.rst deleted file mode 100644 index 5426cc20b..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_module.rst +++ /dev/null @@ -1,347 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_interfaces_ipv6_module: - - -******************************************************* -vmware.vmware_rest.appliance_networking_interfaces_ipv6 -******************************************************* - -**Set IPv6 network configuration for specific interface.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set IPv6 network configuration for specific interface. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- addresses - -
- list - / elements=dictionary - / required -
- 		- -
The list of addresses to be statically assigned. This parameter is mandatory.
-
Valid attributes are:
-
- address (str): The IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a. (['set'])
-
This key is required with ['set'].
-
- prefix (int): The IPv6 CIDR prefix, for example, 64. (['set'])
-
This key is required with ['set'].
-
-
- autoconf - -
- boolean - / required -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
An address will be assigned by Stateless Address Autoconfiguration (SLAAC). This parameter is mandatory.
-
-
- default_gateway - -
- string - / required -
- 		- -
The default gateway for static IP address assignment. This configures the global IPv6 default gateway on the appliance with the specified gateway address and interface. This gateway replaces the existing default gateway configured on the appliance. However, if the gateway address is link-local, then it is added for that interface. This does not support configuration of multiple global default gateways through different interfaces. This parameter is mandatory.
-
-
- dhcp - -
- boolean - / required -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
An address will be assigned by a DHCP server. This parameter is mandatory.
-
-
- interface_name - -
- string - / required -
- 		- -
Network interface to update, for example, "nic0".
-
The parameter must be the id of a resource returned by vmware.vmware_rest.appliance_networking_interfaces_info. This parameter is mandatory.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Set the IPv6 network information of nic99 (which does not exist) - vmware.vmware_rest.appliance_networking_interfaces_ipv6: - interface_name: nic99 - mode: DHCP - failed_when: - - not(result.failed) - - result.value.messages[0].default_message msg == "The interface is unknown." - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- failed_when_result - -
- integer -
- 		On success -
Set the IPv6 network information of nic99 (which does not exist)
-
-
-
- msg - -
- string -
- 		On success -
Set the IPv6 network information of nic99 (which does not exist)
-
-
Sample:
-
missing required arguments: addresses, autoconf, default_gateway, dhcp
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_module.rst b/docs/vmware.vmware_rest.appliance_networking_module.rst deleted file mode 100644 index 4562354b3..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_module.rst +++ /dev/null @@ -1,267 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_module: - - -*************************************** -vmware.vmware_rest.appliance_networking -*************************************** - -**Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- ipv6_enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IPv6 Enabled or not
-
If unspecified, leaves the current state of Ipv6.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • reset
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Set network information - vmware.vmware_rest.appliance_networking: - ipv6_enabled: false - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- dictionary -
- 		On success -
moid of the resource
-
-
-
- value - -
- dictionary -
- 		On success -
Set network information
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_noproxy_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_noproxy_info_module.rst deleted file mode 100644 index 51e1a82d7..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_noproxy_info_module.rst +++ /dev/null @@ -1,213 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_noproxy_info_module: - - -**************************************************** -vmware.vmware_rest.appliance_networking_noproxy_info -**************************************************** - -**Returns servers for which no proxy configuration will be applied.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns servers for which no proxy configuration will be applied. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get HTTP noproxy configuration - vmware.vmware_rest.appliance_networking_noproxy_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Remove the noproxy entries
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_noproxy_module.rst b/docs/vmware.vmware_rest.appliance_networking_noproxy_module.rst deleted file mode 100644 index fc47e40d4..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_noproxy_module.rst +++ /dev/null @@ -1,255 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_noproxy_module: - - -*********************************************** -vmware.vmware_rest.appliance_networking_noproxy -*********************************************** - -**Sets servers for which no proxy configuration should be applied** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Sets servers for which no proxy configuration should be applied. This operation sets environment variables. In order for this operation to take effect, a logout from appliance or a service restart is required. If IPv4 is enabled, "127.0.0.1" and "localhost" will always bypass the proxy (even if they are not explicitly configured). - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- servers - -
- list - / elements=string - / required -
- 		- -
List of strings representing servers to bypass proxy. A server can be a FQDN, IP address, FQDN:port or IP:port combinations. This parameter is mandatory.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Set HTTP noproxy configuration - vmware.vmware_rest.appliance_networking_noproxy: - servers: - - redhat.com - - ansible.com - register: result - - - name: Remove the noproxy entries - vmware.vmware_rest.appliance_networking_noproxy: - servers: [] - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Remove the noproxy entries
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_proxy_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_proxy_info_module.rst deleted file mode 100644 index a66d640fb..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_proxy_info_module.rst +++ /dev/null @@ -1,230 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_proxy_info_module: - - -************************************************** -vmware.vmware_rest.appliance_networking_proxy_info -************************************************** - -**Gets the proxy configuration for a specific protocol.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Gets the proxy configuration for a specific protocol. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- protocol - -
- string -
- 		- -
The protocol whose proxy configuration is requested. Required with state=['get']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the HTTP proxy configuration - vmware.vmware_rest.appliance_networking_proxy_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get the HTTP proxy configuration
-
-
Sample:
-
{'ftp': {'enabled': 0, 'port': -1, 'server': ''}, 'http': {'enabled': 0, 'port': -1, 'server': ''}, 'https': {'enabled': 0, 'port': -1, 'server': ''}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_networking_proxy_module.rst b/docs/vmware.vmware_rest.appliance_networking_proxy_module.rst deleted file mode 100644 index a7e04b6a1..000000000 --- a/docs/vmware.vmware_rest.appliance_networking_proxy_module.rst +++ /dev/null @@ -1,380 +0,0 @@ -.. _vmware.vmware_rest.appliance_networking_proxy_module: - - -********************************************* -vmware.vmware_rest.appliance_networking_proxy -********************************************* - -**Configures which proxy server to use for the specified protocol** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
Proxy configuration for the specific protocol. Required with state=['test']
-
Valid attributes are:
-
- server (str): URL of the proxy server (['test'])
-
This key is required with ['test'].
-
- port (int): Port to connect to the proxy server. In a 'get' call, indicates the port connected to the proxy server. In a 'set' call, specifies the port to connect to the proxy server. A value of -1 indicates the default port. (['test'])
-
This key is required with ['test'].
-
- username (str): Username for proxy server.
-
Only set if proxy requires username. (['test'])
-
- password (str): Password for proxy server.
-
Only set if proxy requires password. (['test'])
-
- enabled (bool): In the result of the #get and #list operations this field indicates whether proxying is enabled for a particular protocol. In the input to the test and set operations this field specifies whether proxying should be enabled for a particular protocol. (['test'])
-
This key is required with ['test'].
-
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
In the result of the #get and #list operations this field indicates whether proxying is enabled for a particular protocol. In the input to the test and set operations this field specifies whether proxying should be enabled for a particular protocol. Required with state=['set']
-
-
- host - -
- string -
- 		- -
A hostname, IPv4 or Ipv6 address. Required with state=['test']
-
-
- password - -
- string -
- 		- -
Password for proxy server.
-
Only set if proxy requires password.
-
-
- port - -
- integer -
- 		- -
Port to connect to the proxy server. In a 'get' call, indicates the port connected to the proxy server. In a 'set' call, specifies the port to connect to the proxy server. A value of -1 indicates the default port. Required with state=['set']
-
-
- protocol - -
- string - / required -
- 		- -
The protocol for which proxy should be set. This parameter is mandatory.
-
-
- server - -
- string -
- 		- -
URL of the proxy server Required with state=['set']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • set ←
    • -
  • test
    • -
- 		-
-
- username - -
- string -
- 		- -
Username for proxy server.
-
Only set if proxy requires username.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Set the HTTP proxy configuration - vmware.vmware_rest.appliance_networking_proxy: - enabled: true - server: http://datastore.test - port: 3128 - protocol: http - register: result - - - name: Delete the HTTP proxy configuration - vmware.vmware_rest.appliance_networking_proxy: - protocol: http - state: absent - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Delete the HTTP proxy configuration
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_ntp_info_module.rst b/docs/vmware.vmware_rest.appliance_ntp_info_module.rst deleted file mode 100644 index b771d44c9..000000000 --- a/docs/vmware.vmware_rest.appliance_ntp_info_module.rst +++ /dev/null @@ -1,218 +0,0 @@ -.. _vmware.vmware_rest.appliance_ntp_info_module: - - -************************************* -vmware.vmware_rest.appliance_ntp_info -************************************* - -**Get the NTP configuration status** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get the NTP configuration status. If you run the 'timesync.get' command, you can retrieve the current time synchronization method (NTP- or VMware Tools-based). The 'ntp' command always returns the NTP server information, even when the time synchronization mode is not set to NTP. If the time synchronization mode is not NTP-based, the NTP server status is displayed as down. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the NTP configuration - vmware.vmware_rest.appliance_ntp_info: - - - name: Get the NTP configuration - vmware.vmware_rest.appliance_ntp_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Get the NTP configuration
-
-
Sample:
-
['time.nist.gov']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_ntp_module.rst b/docs/vmware.vmware_rest.appliance_ntp_module.rst deleted file mode 100644 index fb87a4138..000000000 --- a/docs/vmware.vmware_rest.appliance_ntp_module.rst +++ /dev/null @@ -1,258 +0,0 @@ -.. _vmware.vmware_rest.appliance_ntp_module: - - -******************************** -vmware.vmware_rest.appliance_ntp -******************************** - -**Set NTP servers** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set NTP servers. This method updates old NTP servers from configuration and sets the input NTP servers in the configuration. If NTP based time synchronization is used internally, the NTP daemon will be restarted to reload given NTP configuration. In case NTP based time synchronization is not used, this method only replaces servers in the NTP configuration. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- servers - -
- list - / elements=string - / required -
- 		- -
List of host names or ip addresses of ntp servers. This parameter is mandatory.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
  • test
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Adjust the NTP configuration - vmware.vmware_rest.appliance_ntp: - servers: - - time.google.com - - - name: Test the NTP configuration - vmware.vmware_rest.appliance_ntp: - state: test - servers: - - time.google.com - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Test the NTP configuration
-
-
Sample:
-
[{'message': {'args': [], 'default_message': 'NTP Server is reachable.', 'id': 'com.vmware.appliance.ntp_sync.success'}, 'server': 'time.google.com', 'status': 'SERVER_REACHABLE'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_services_info_module.rst b/docs/vmware.vmware_rest.appliance_services_info_module.rst deleted file mode 100644 index 90f8378c6..000000000 --- a/docs/vmware.vmware_rest.appliance_services_info_module.rst +++ /dev/null @@ -1,249 +0,0 @@ -.. _vmware.vmware_rest.appliance_services_info_module: - - -****************************************** -vmware.vmware_rest.appliance_services_info -****************************************** - -**Returns the state of a service.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns the state of a service. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- service - -
- string -
- 		- -
identifier of the service whose state is being queried.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.appliance_services_info. Required with state=['get']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get information about ntpd - vmware.vmware_rest.appliance_services_info: - service: ntpd - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
ntpd
-
-
- value - -
- dictionary -
- 		On success -
Get information about ntpd
-
-
Sample:
-
{'description': 'ntpd.service', 'state': 'STARTED'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_services_module.rst b/docs/vmware.vmware_rest.appliance_services_module.rst deleted file mode 100644 index 484e5cd12..000000000 --- a/docs/vmware.vmware_rest.appliance_services_module.rst +++ /dev/null @@ -1,264 +0,0 @@ -.. _vmware.vmware_rest.appliance_services_module: - - -************************************* -vmware.vmware_rest.appliance_services -************************************* - -**Restarts a service** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Restarts a service - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- service - -
- string - / required -
- 		- -
identifier of the service to restart
-
The parameter must be the id of a resource returned by vmware.vmware_rest.appliance_services_info. This parameter is mandatory.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • restart
    • -
  • start
    • -
  • stop
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Stop the ntpd service - vmware.vmware_rest.appliance_services: - service: ntpd - state: stop - register: result - - - name: Start the ntpd service - vmware.vmware_rest.appliance_services: - service: ntpd - state: start - register: result - - - name: Restart the ntpd service - vmware.vmware_rest.appliance_services: - service: ntpd - state: restart - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Restart the ntpd service
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_shutdown_info_module.rst b/docs/vmware.vmware_rest.appliance_shutdown_info_module.rst deleted file mode 100644 index e6e0e0e5b..000000000 --- a/docs/vmware.vmware_rest.appliance_shutdown_info_module.rst +++ /dev/null @@ -1,219 +0,0 @@ -.. _vmware.vmware_rest.appliance_shutdown_info_module: - - -****************************************** -vmware.vmware_rest.appliance_shutdown_info -****************************************** - -**Get details about the pending shutdown action.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get details about the pending shutdown action. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure there is no ongoing shutdown - vmware.vmware_rest.appliance_shutdown_info: - register: result - - - name: Get the ongoing shutdown - vmware.vmware_rest.appliance_shutdown_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get the ongoing shutdown
-
-
Sample:
-
{'action': 'reboot', 'reason': 'this is an example', 'shutdown_time': '2022-11-24T06:12:16.000Z'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_shutdown_module.rst b/docs/vmware.vmware_rest.appliance_shutdown_module.rst deleted file mode 100644 index d2b16d3bf..000000000 --- a/docs/vmware.vmware_rest.appliance_shutdown_module.rst +++ /dev/null @@ -1,283 +0,0 @@ -.. _vmware.vmware_rest.appliance_shutdown_module: - - -************************************* -vmware.vmware_rest.appliance_shutdown -************************************* - -**Cancel pending shutdown action.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Cancel pending shutdown action. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- delay - -
- integer -
- 		- -
Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately. Required with state=['poweroff', 'reboot']
-
-
- reason - -
- string -
- 		- -
Reason for peforming poweroff. Required with state=['poweroff', 'reboot']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • cancel
    • -
  • poweroff
    • -
  • reboot
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Shutdown the appliance - vmware.vmware_rest.appliance_shutdown: - state: poweroff - reason: this is an example - delay: 600 - register: result - - - name: Abort the shutdown of the appliance - vmware.vmware_rest.appliance_shutdown: - state: cancel - register: result - - - name: Reboot the appliance - vmware.vmware_rest.appliance_shutdown: - state: reboot - reason: this is an example - delay: 600 - register: result - - - name: Abort the reboot - vmware.vmware_rest.appliance_shutdown: - state: cancel - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Abort the reboot
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_system_globalfips_info_module.rst b/docs/vmware.vmware_rest.appliance_system_globalfips_info_module.rst deleted file mode 100644 index f4d349cef..000000000 --- a/docs/vmware.vmware_rest.appliance_system_globalfips_info_module.rst +++ /dev/null @@ -1,175 +0,0 @@ -.. _vmware.vmware_rest.appliance_system_globalfips_info_module: - - -*************************************************** -vmware.vmware_rest.appliance_system_globalfips_info -*************************************************** - -**Get current appliance FIPS settings.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get current appliance FIPS settings. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - - - - - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_system_globalfips_module.rst b/docs/vmware.vmware_rest.appliance_system_globalfips_module.rst deleted file mode 100644 index 730745653..000000000 --- a/docs/vmware.vmware_rest.appliance_system_globalfips_module.rst +++ /dev/null @@ -1,212 +0,0 @@ -.. _vmware.vmware_rest.appliance_system_globalfips_module: - - -********************************************** -vmware.vmware_rest.appliance_system_globalfips -********************************************** - -**Enable/Disable Global FIPS mode for the appliance** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Enable/Disable Global FIPS mode for the appliance. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
FIPS setting state.
-
If unset, the value is unchanged.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - - - - - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_system_storage_info_module.rst b/docs/vmware.vmware_rest.appliance_system_storage_info_module.rst deleted file mode 100644 index 59d86c925..000000000 --- a/docs/vmware.vmware_rest.appliance_system_storage_info_module.rst +++ /dev/null @@ -1,213 +0,0 @@ -.. _vmware.vmware_rest.appliance_system_storage_info_module: - - -************************************************ -vmware.vmware_rest.appliance_system_storage_info -************************************************ - -**Get disk to partition mapping.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get disk to partition mapping. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the appliance storage information - vmware.vmware_rest.appliance_system_storage_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Get the appliance storage information
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_system_storage_module.rst b/docs/vmware.vmware_rest.appliance_system_storage_module.rst deleted file mode 100644 index 4b32410f0..000000000 --- a/docs/vmware.vmware_rest.appliance_system_storage_module.rst +++ /dev/null @@ -1,240 +0,0 @@ -.. _vmware.vmware_rest.appliance_system_storage_module: - - -******************************************* -vmware.vmware_rest.appliance_system_storage -******************************************* - -**Resize all partitions to 100 percent of disk size.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Resize all partitions to 100 percent of disk size. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • resize
    • -
  • resize_ex
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - 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 - register: result - - - name: Resize the first partition - vmware.vmware_rest.appliance_system_storage: - state: resize - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Resize the first partition and return the state of the partition before and after the operation
-
-
Sample:
-
{'lv_root_0': {'new_size': 104312832, 'old_size': 53985280}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_system_time_info_module.rst b/docs/vmware.vmware_rest.appliance_system_time_info_module.rst deleted file mode 100644 index 90b33a6b1..000000000 --- a/docs/vmware.vmware_rest.appliance_system_time_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_system_time_info_module: - - -********************************************* -vmware.vmware_rest.appliance_system_time_info -********************************************* - -**Get system time.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get system time. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the current time - vmware.vmware_rest.appliance_system_time_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get the current time
-
-
Sample:
-
{'date': 'Wed 11-23-2022', 'seconds_since_epoch': None, 'time': '08:12:27 PM', 'timezone': 'UTC'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_system_time_timezone_info_module.rst b/docs/vmware.vmware_rest.appliance_system_time_timezone_info_module.rst deleted file mode 100644 index ce7397dff..000000000 --- a/docs/vmware.vmware_rest.appliance_system_time_timezone_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_system_time_timezone_info_module: - - -****************************************************** -vmware.vmware_rest.appliance_system_time_timezone_info -****************************************************** - -**Get time zone.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get time zone. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the timezone configuration - vmware.vmware_rest.appliance_system_time_timezone_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Get the timezone configuration
-
-
Sample:
-
Etc/UTC
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_system_time_timezone_module.rst b/docs/vmware.vmware_rest.appliance_system_time_timezone_module.rst deleted file mode 100644 index f3c18e8df..000000000 --- a/docs/vmware.vmware_rest.appliance_system_time_timezone_module.rst +++ /dev/null @@ -1,247 +0,0 @@ -.. _vmware.vmware_rest.appliance_system_time_timezone_module: - - -************************************************* -vmware.vmware_rest.appliance_system_time_timezone -************************************************* - -**Set time zone.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set time zone. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- name - -
- string - / required -
- 		- -
Time zone name. This parameter is mandatory.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Use the UTC timezone - vmware.vmware_rest.appliance_system_time_timezone: - name: UTC - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Use the UTC timezone
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_system_version_info_module.rst b/docs/vmware.vmware_rest.appliance_system_version_info_module.rst deleted file mode 100644 index 66fd273cd..000000000 --- a/docs/vmware.vmware_rest.appliance_system_version_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_system_version_info_module: - - -************************************************ -vmware.vmware_rest.appliance_system_version_info -************************************************ - -**Get the version.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get the version. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the VCSA version - vmware.vmware_rest.appliance_system_version_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get the VCSA version
-
-
Sample:
-
{'build': '20150588', 'install_time': '2022-09-26T19:22:25.765Z', 'product': 'VMware vCenter Server', 'releasedate': 'July 23, 2022', 'summary': 'Patch for VMware vCenter Server 7.0', 'type': 'vCenter Server with an embedded Platform Services Controller', 'version': '7.0.3.00800'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_timesync_info_module.rst b/docs/vmware.vmware_rest.appliance_timesync_info_module.rst deleted file mode 100644 index 876f14b76..000000000 --- a/docs/vmware.vmware_rest.appliance_timesync_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_timesync_info_module: - - -****************************************** -vmware.vmware_rest.appliance_timesync_info -****************************************** - -**Get time synchronization mode.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get time synchronization mode. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get information regarding the clock synchronization - vmware.vmware_rest.appliance_timesync_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Get information regarding the clock synchronization
-
-
Sample:
-
NTP
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_timesync_module.rst b/docs/vmware.vmware_rest.appliance_timesync_module.rst deleted file mode 100644 index 600fb85b7..000000000 --- a/docs/vmware.vmware_rest.appliance_timesync_module.rst +++ /dev/null @@ -1,253 +0,0 @@ -.. _vmware.vmware_rest.appliance_timesync_module: - - -************************************* -vmware.vmware_rest.appliance_timesync -************************************* - -**Set time synchronization mode.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set time synchronization mode. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- mode - -
- string - / required -
- 		-
    Choices: -
  • DISABLED
    • -
  • HOST
    • -
  • NTP
    • -
- 		-
The time_sync_mode enumerated type defines time synchronization modes This parameter is mandatory.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure we use NTP - vmware.vmware_rest.appliance_timesync: - mode: NTP - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Ensure we use NTP
-
-
Sample:
-
NTP
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_update_info_module.rst b/docs/vmware.vmware_rest.appliance_update_info_module.rst deleted file mode 100644 index b288a6dbb..000000000 --- a/docs/vmware.vmware_rest.appliance_update_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.appliance_update_info_module: - - -**************************************** -vmware.vmware_rest.appliance_update_info -**************************************** - -**Gets the current status of the appliance update.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Gets the current status of the appliance update. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Check if the system is up to date - vmware.vmware_rest.appliance_update_info: - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Check if the system is up to date
-
-
Sample:
-
{'state': 'UP_TO_DATE', 'version': '7.0.3.00800'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_vmon_service_info_module.rst b/docs/vmware.vmware_rest.appliance_vmon_service_info_module.rst deleted file mode 100644 index d62a3bb74..000000000 --- a/docs/vmware.vmware_rest.appliance_vmon_service_info_module.rst +++ /dev/null @@ -1,232 +0,0 @@ -.. _vmware.vmware_rest.appliance_vmon_service_info_module: - - -********************************************** -vmware.vmware_rest.appliance_vmon_service_info -********************************************** - -**Returns the state of a service.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns the state of a service. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- service - -
- string -
- 		- -
identifier of the service whose state is being queried.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.appliance_vmon_service. Required with state=['get']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get information about a VMON service - vmware.vmware_rest.appliance_vmon_service_info: - service: vpxd - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Get information about a VMON service
-
-
Sample:
-
[{'key': 'analytics', 'value': {'description_key': 'cis.analytics.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.analytics.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'applmgmt', 'value': {'description_key': 'cis.applmgmt.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.applmgmt.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'certificateauthority', 'value': {'description_key': 'cis.certificateauthority.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'certificateathority.health.statuscode'}], 'name_key': 'cis.certificateauthority.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'certificatemanagement', 'value': {'description_key': 'cis.certificatemanagement.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'certificatemanagement.health.statuscode'}], 'name_key': 'cis.certificatemanagement.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'cis-license', 'value': {'description_key': 'cis.cis-license.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'The License Service is operational.', 'id': 'cis.license.health.ok'}], 'name_key': 'cis.cis-license.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'content-library', 'value': {'description_key': 'cis.content-library.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'Database server connection is GREEN.', 'id': 'com.vmware.vdcs.vsphere-cs-lib.db_health_green'}], 'name_key': 'cis.content-library.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'eam', 'value': {'description_key': 'cis.eam.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': '', 'id': 'cis.eam.statusOK'}], 'name_key': 'cis.eam.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'envoy', 'value': {'description_key': 'cis.envoy.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.envoy.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'hvc', 'value': {'description_key': 'cis.hvc.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'hvc.health.statuscode'}], 'name_key': 'cis.hvc.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'imagebuilder', 'value': {'description_key': 'cis.imagebuilder.ServiceDescription', 'name_key': 'cis.imagebuilder.ServiceName', 'startup_type': 'MANUAL', 'state': 'STOPPED'}}, {'key': 'infraprofile', 'value': {'description_key': 'cis.infraprofile.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'infraprofile.health.statuscode'}], 'name_key': 'cis.infraprofile.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'lookupsvc', 'value': {'description_key': 'cis.lookupsvc.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.lookupsvc.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'netdumper', 'value': {'description_key': 'cis.netdumper.ServiceDescription', 'name_key': 'cis.netdumper.ServiceName', 'startup_type': 'MANUAL', 'state': 'STOPPED'}}, {'key': 'observability-vapi', 'value': {'description_key': 'cis.observability-vapi.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'observability.health.statuscode'}], 'name_key': 'cis.observability-vapi.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'perfcharts', 'value': {'description_key': 'cis.perfcharts.ServiceDescription', 'health': 'HEALTHY_WITH_WARNINGS', 'health_messages': [{'args': [], 'default_message': 'health.statsReoptInitalizer.illegalStateEx', 'id': 'health.statsReoptInitalizer.illegalStateEx'}], 'name_key': 'cis.perfcharts.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'pschealth', 'value': {'description_key': 'cis.pschealth.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.pschealth.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'rbd', 'value': {'description_key': 'cis.rbd.ServiceDescription', 'name_key': 'cis.rbd.ServiceName', 'startup_type': 'MANUAL', 'state': 'STOPPED'}}, {'key': 'rhttpproxy', 'value': {'description_key': 'cis.rhttpproxy.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.rhttpproxy.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'sca', 'value': {'description_key': 'cis.sca.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.sca.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'sps', 'value': {'description_key': 'cis.sps.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.sps.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'statsmonitor', 'value': {'description_key': 'cis.statsmonitor.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'Appliance monitoring service is healthy.', 'id': 'com.vmware.applmgmt.mon.health.healthy'}], 'name_key': 'cis.statsmonitor.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'sts', 'value': {'description_key': 'cis.sts.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.sts.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'topologysvc', 'value': {'description_key': 'cis.topologysvc.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'topologysvc.health.statuscode'}], 'name_key': 'cis.topologysvc.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'trustmanagement', 'value': {'description_key': 'cis.trustmanagement.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'trustmanagement.health.statuscode'}], 'name_key': 'cis.trustmanagement.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'updatemgr', 'value': {'description_key': 'cis.updatemgr.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.updatemgr.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vapi-endpoint', 'value': {'description_key': 'cis.vapi-endpoint.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['2022-11-23T20:10:44UTC', '2022-11-23T20:10:46UTC'], 'default_message': 'Configuration health status is created between 2022-11-23T20:10:44UTC and 2022-11-23T20:10:46UTC.', 'id': 'com.vmware.vapi.endpoint.healthStatusProducedTimes'}], 'name_key': 'cis.vapi-endpoint.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vcha', 'value': {'description_key': 'cis.vcha.ServiceDescription', 'name_key': 'cis.vcha.ServiceName', 'startup_type': 'DISABLED', 'state': 'STOPPED'}}, {'key': 'vlcm', 'value': {'description_key': 'cis.vlcm.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.vlcm.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vmcam', 'value': {'description_key': 'cis.vmcam.ServiceDescription', 'name_key': 'cis.vmcam.ServiceName', 'startup_type': 'MANUAL', 'state': 'STOPPED'}}, {'key': 'vmonapi', 'value': {'description_key': 'cis.vmonapi.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.vmonapi.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vmware-postgres-archiver', 'value': {'description_key': 'cis.vmware-postgres-archiver.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'VMware Archiver service is healthy.', 'id': 'cis.vmware-postgres-archiver.health.healthy'}], 'name_key': 'cis.vmware-postgres-archiver.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vmware-vpostgres', 'value': {'description_key': 'cis.vmware-vpostgres.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'Service vmware-vpostgres is healthy.', 'id': 'cis.vmware-vpostgres.health.healthy'}], 'name_key': 'cis.vmware-vpostgres.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vpxd', 'value': {'description_key': 'cis.vpxd.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['vCenter Server', 'GREEN'], 'default_message': '{0} health is {1}', 'id': 'vc.health.statuscode'}, {'args': ['VirtualCenter Database', 'GREEN'], 'default_message': '{0} health is {1}', 'id': 'vc.health.statuscode'}], 'name_key': 'cis.vpxd.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vpxd-svcs', 'value': {'description_key': 'cis.vpxd-svcs.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'Tagging service is in a healthy state', 'id': 'cis.tagging.health.status'}], 'name_key': 'cis.vpxd-svcs.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vsan-health', 'value': {'description_key': 'cis.vsan-health.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.vsan-health.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vsm', 'value': {'description_key': 'cis.vsm.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.vsm.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vsphere-ui', 'value': {'description_key': 'cis.vsphere-ui.ServiceDescription', 'name_key': 'cis.vsphere-ui.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STOPPED'}}, {'key': 'vstats', 'value': {'description_key': 'cis.vstats.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.vstats.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vtsdb', 'value': {'description_key': 'cis.vtsdb.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'Service vtsdb is healthy.', 'id': 'cis.vtsdb.health.healthy'}], 'name_key': 'cis.vtsdb.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'wcp', 'value': {'description_key': 'cis.wcp.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.wcp.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.appliance_vmon_service_module.rst b/docs/vmware.vmware_rest.appliance_vmon_service_module.rst deleted file mode 100644 index bbff189ba..000000000 --- a/docs/vmware.vmware_rest.appliance_vmon_service_module.rst +++ /dev/null @@ -1,289 +0,0 @@ -.. _vmware.vmware_rest.appliance_vmon_service_module: - - -***************************************** -vmware.vmware_rest.appliance_vmon_service -***************************************** - -**Lists details of services managed by vMon.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Lists details of services managed by vMon. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- service - -
- string -
- 		- -
identifier of the service whose properties are being updated.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.appliance_vmon_service. Required with state=['restart', 'start', 'stop']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- startup_type - -
- string -
- 		-
    Choices: -
  • AUTOMATIC
    • -
  • DISABLED
    • -
  • MANUAL
    • -
- 		-
The startup_type enumerated type defines valid Startup Type for services managed by vMon.
-
-
- state - -
- string -
- 		-
    Choices: -
  • list_details
    • -
  • present ←
    • -
  • restart
    • -
  • start
    • -
  • stop
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Adjust vpxd configuration - vmware.vmware_rest.appliance_vmon_service: - service: vpxd - startup_type: AUTOMATIC - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
vpxd
-
-
- value - -
- dictionary -
- 		On success -
Adjust vpxd configuration
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.cluster_moid_lookup.rst b/docs/vmware.vmware_rest.cluster_moid_lookup.rst deleted file mode 100644 index 1af5dd5c5..000000000 --- a/docs/vmware.vmware_rest.cluster_moid_lookup.rst +++ /dev/null @@ -1,230 +0,0 @@ -.. _vmware.vmware_rest.cluster_moid_lookup: - - -******************************* -vmware.vmware_rest.cluster_moid -******************************* - -**Look up MoID for vSphere cluster objects using vCenter REST API** - - -Version added: 2.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns Managed Object Reference (MoID) of the vSphere cluster object contained in the specified path. - - - -Requirements ------------- -The below requirements are needed on the local Ansible controller node that executes this lookup. - -- vSphere 7.0.2 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsConfigurationComments
-
- _terms - -
- string - / required -
- 		- - -
Path to query.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
env:VMWARE_HOST
- 		-
The hostname or IP address of the vSphere vCenter.
-
-
- vcenter_password - -
- string - / required -
- 		- -
env:VMWARE_PASSWORD
- 		-
The vSphere vCenter password.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
env:VMWARE_REST_LOG_FILE
- 		-
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interactions.
-
The file will be stored on the host that runs the module.
-
-
- vcenter_username - -
- string - / required -
- 		- -
env:VMWARE_USER
- 		-
The vSphere vCenter username.
-
-
- vcenter_validate_certs - -
- boolean -
- 		- Default:
"yes"
- 		-
env:VMWARE_VALIDATE_CERTS
- 		-
Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - # lookup sample - - name: set connection info - ansible.builtin.set_fact: - connection_args: - vcenter_hostname: "vcenter.test" - vcenter_username: "administrator@vsphere.local" - vcenter_password: "1234" - - - name: lookup MoID of the object - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster', **connection_args) }}" - - - name: lookup MoID of the object inside the path - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/') }}" - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this lookup: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- _raw - -
- string -
- 		-
MoID of the vSphere cluster object
-
-
Sample:
-
domain-c1007
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Alina Buzachis (@alinabuzachis) - - -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vmware.vmware_rest.content_configuration_info_module.rst b/docs/vmware.vmware_rest.content_configuration_info_module.rst deleted file mode 100644 index ff6b937ce..000000000 --- a/docs/vmware.vmware_rest.content_configuration_info_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _vmware.vmware_rest.content_configuration_info_module: - - -********************************************* -vmware.vmware_rest.content_configuration_info -********************************************* - -**Retrieves the current configuration values.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Retrieves the current configuration values. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the vSphere content syncrhronization configuration - vmware.vmware_rest.content_configuration_info: - register: current_content_configuration - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get the vSphere content syncrhronization configuration
-
-
Sample:
-
{'automatic_sync_enabled': 1, 'automatic_sync_start_hour': 20, 'automatic_sync_stop_hour': 7, 'maximum_concurrent_item_syncs': 5}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.content_configuration_module.rst b/docs/vmware.vmware_rest.content_configuration_module.rst deleted file mode 100644 index 52754ce8f..000000000 --- a/docs/vmware.vmware_rest.content_configuration_module.rst +++ /dev/null @@ -1,311 +0,0 @@ -.. _vmware.vmware_rest.content_configuration_module: - - -**************************************** -vmware.vmware_rest.content_configuration -**************************************** - -**Updates the configuration** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Updates the configuration. The update is incremental. Any {@term field} in the {@link ConfigurationModel} {@term structure} that is {@term unset} will not be modified. Note that this update {@term operation} doesn't guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- automatic_sync_enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Whether automatic synchronization is enabled. When automatic synchronization is enabled, the Content Library Service will automatically synchronize all subscribed libraries on a daily basis. Subscribed libraries with the subscription_info.automaticSyncEnabled flag turned on will be synchronized every hour between {@link #automaticSyncStartHour} and {@link #automaticSyncStopHour}.
-
-
- automatic_sync_start_hour - -
- integer -
- 		- -
The hour at which the automatic synchronization will start. This value is between 0 (midnight) and 23 inclusive.
-
-
- automatic_sync_stop_hour - -
- integer -
- 		- -
The hour at which the automatic synchronization will stop. Any active synchronization operation will continue to run, however no new synchronization operations will be triggered after the stop hour. This value is between 0 (midnight) and 23 inclusive.
-
-
- maximum_concurrent_item_syncs - -
- integer -
- 		- -
The maximum allowed number of library items to synchronize concurrently from remote libraries. This must be a positive number. The service may not be able to guarantee the requested concurrency if there is no available capacity. This setting is global across all subscribed libraries.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Turn on the autmatic syncrhronization - vmware.vmware_rest.content_configuration: - automatic_sync_enabled: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- dictionary -
- 		On success -
moid of the resource
-
-
-
- value - -
- dictionary -
- 		On success -
Turn on the autmatic syncrhronization
-
-
Sample:
-
{'automatic_sync_enabled': 1, 'automatic_sync_start_hour': 20, 'automatic_sync_stop_hour': 7, 'maximum_concurrent_item_syncs': 5}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.content_library_item_info_module.rst b/docs/vmware.vmware_rest.content_library_item_info_module.rst deleted file mode 100644 index b45b08afa..000000000 --- a/docs/vmware.vmware_rest.content_library_item_info_module.rst +++ /dev/null @@ -1,313 +0,0 @@ -.. _vmware.vmware_rest.content_library_item_info_module: - - -******************************************** -vmware.vmware_rest.content_library_item_info -******************************************** - -**Returns the {@link ItemModel} with the given identifier.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns the {@link ItemModel} with the given identifier. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- library_id - -
- string -
- 		- -
Identifier of the library whose items should be returned. Required with state=['list']
-
-
- library_item_id - -
- string -
- 		- -
Identifier of the library item to return. Required with state=['get']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Create a content library pointing on a NFS share - vmware.vmware_rest.content_locallibrary: - name: my_library_on_nfs - description: automated - publish_info: - published: true - authentication_method: NONE - storage_backings: - - storage_uri: nfs://datastore.test/srv/share/content-library - type: OTHER - state: present - register: nfs_lib - - - name: Get the list of items of the NFS library - vmware.vmware_rest.content_library_item_info: - library_id: '{{ nfs_lib.id }}' - register: lib_items - - - name: Get the list of items of the NFS library - vmware.vmware_rest.content_library_item_info: - library_id: '{{ nfs_lib.id }}' - register: result - - - name: Create a new local content library - vmware.vmware_rest.content_locallibrary: - name: local_library_001 - description: automated - publish_info: - published: true - authentication_method: NONE - storage_backings: - - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}" - type: DATASTORE - state: present - register: ds_lib - - - name: Get the (empty) list of items of the library - vmware.vmware_rest.content_library_item_info: - library_id: '{{ ds_lib.id }}' - register: result - - - name: Create subscribed library - vmware.vmware_rest.content_subscribedlibrary: - name: sub_lib - subscription_info: - subscription_url: '{{ nfs_lib.value.publish_info.publish_url }}' - authentication_method: NONE - automatic_sync_enabled: false - on_demand: true - storage_backings: - - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}" - type: DATASTORE - register: sub_lib - - - name: Ensure the OVF is here - vmware.vmware_rest.content_library_item_info: - library_id: '{{ sub_lib.id }}' - register: result - - - name: Create a content library based on a DataStore - vmware.vmware_rest.content_locallibrary: - name: my_library_on_datastore - description: automated - publish_info: - published: true - authentication_method: NONE - storage_backings: - - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - type: DATASTORE - state: present - register: nfs_lib - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Ensure the OVF is here
-
-
Sample:
-
[{'cached': 0, 'content_version': '2', 'creation_time': '2022-11-23T20:06:05.707Z', 'description': 'an OVF example', 'id': 'f6618d6b-301b-4202-aa9c-12eb0c7536b1', 'last_modified_time': '2022-11-23T20:06:06.062Z', 'last_sync_time': '2022-11-23T20:06:06.061Z', 'library_id': '8b4e355e-a463-44f1-9b04-d0786a49cc7d', 'metadata_version': '1', 'name': 'golden_image', 'security_compliance': 1, 'size': 0, 'source_id': '636ef270-b556-4972-924f-0d21b0f3bfce', 'type': 'ovf', 'version': '1'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.content_locallibrary_info_module.rst b/docs/vmware.vmware_rest.content_locallibrary_info_module.rst deleted file mode 100644 index 98f8192b9..000000000 --- a/docs/vmware.vmware_rest.content_locallibrary_info_module.rst +++ /dev/null @@ -1,253 +0,0 @@ -.. _vmware.vmware_rest.content_locallibrary_info_module: - - -******************************************** -vmware.vmware_rest.content_locallibrary_info -******************************************** - -**Returns a given local library.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns a given local library. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- library_id - -
- string -
- 		- -
Identifier of the local library to return. Required with state=['get']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: List Local Content Library - vmware.vmware_rest.content_locallibrary_info: - register: my_content_library - - - name: List all Local Content Library - vmware.vmware_rest.content_locallibrary_info: - register: all_content_libraries - - - name: Create a new local content library - vmware.vmware_rest.content_locallibrary: - name: local_library_001 - description: automated - publish_info: - published: true - authentication_method: NONE - storage_backings: - - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}" - type: DATASTORE - state: present - register: ds_lib - - - name: Retrieve the local content library information based upon id check mode - vmware.vmware_rest.content_locallibrary_info: - library_id: '{{ ds_lib.id }}' - register: result - check_mode: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
List all Local Content Library
-
-
Sample:
-
[{'creation_time': '2022-11-23T20:02:22.940Z', 'description': 'automated', 'id': 'a66d5c73-57f8-4a3a-9361-292a55f68516', 'last_modified_time': '2022-11-23T20:02:22.940Z', 'name': 'my_library_on_nfs', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:25.134Z', 'description': 'automated', 'id': '3393956a-43ed-4e7f-bd96-eb39bd604445', 'last_modified_time': '2022-11-23T20:02:25.134Z', 'name': 'my_library_on_nfs_0', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/3393956a-43ed-4e7f-bd96-eb39bd604445/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:26.342Z', 'description': 'automated', 'id': '87f66f86-c046-45a7-9563-d59ea220babf', 'last_modified_time': '2022-11-23T20:02:26.342Z', 'name': 'my_library_on_nfs_1', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/87f66f86-c046-45a7-9563-d59ea220babf/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:27.504Z', 'description': 'automated', 'id': 'f6c590c4-ae6d-4ad0-9362-378196e98a3c', 'last_modified_time': '2022-11-23T20:02:27.504Z', 'name': 'my_library_on_nfs_2', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/f6c590c4-ae6d-4ad0-9362-378196e98a3c/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:28.821Z', 'description': 'automated', 'id': 'e8917499-2a4c-4b70-b39b-ae0caaef89c3', 'last_modified_time': '2022-11-23T20:02:28.821Z', 'name': 'my_library_on_nfs_3', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/e8917499-2a4c-4b70-b39b-ae0caaef89c3/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:30.085Z', 'description': 'automated', 'id': '630ebdfe-8913-45d3-aaa8-9c2fdecbb76b', 'last_modified_time': '2022-11-23T20:02:30.085Z', 'name': 'my_library_on_nfs_4', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/630ebdfe-8913-45d3-aaa8-9c2fdecbb76b/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:31.482Z', 'description': 'automated', 'id': 'a046e2e5-bd55-4d04-9443-750a2ab35a6d', 'last_modified_time': '2022-11-23T20:02:31.482Z', 'name': 'my_library_on_nfs_5', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/a046e2e5-bd55-4d04-9443-750a2ab35a6d/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:32.846Z', 'description': 'automated', 'id': 'b94383b1-7877-4dbd-8c33-51abc39451ff', 'last_modified_time': '2022-11-23T20:02:32.846Z', 'name': 'my_library_on_nfs_6', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/b94383b1-7877-4dbd-8c33-51abc39451ff/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:34.218Z', 'description': 'automated', 'id': '8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00', 'last_modified_time': '2022-11-23T20:02:34.218Z', 'name': 'my_library_on_nfs_7', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:35.922Z', 'description': 'automated', 'id': '0b12c0b3-6c6d-448d-9033-e054a70183e7', 'last_modified_time': '2022-11-23T20:02:35.922Z', 'name': 'my_library_on_nfs_8', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/0b12c0b3-6c6d-448d-9033-e054a70183e7/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:37.796Z', 'description': 'automated', 'id': '46454797-bbe0-415a-9fe9-3cf2f74a14db', 'last_modified_time': '2022-11-23T20:02:37.796Z', 'name': 'my_library_on_nfs_9', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/46454797-bbe0-415a-9fe9-3cf2f74a14db/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:38.976Z', 'description': 'automated', 'id': '209926aa-e3fe-46a5-95f2-501e82a5139b', 'last_modified_time': '2022-11-23T20:02:38.976Z', 'name': 'my_library_on_nfs_10', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/209926aa-e3fe-46a5-95f2-501e82a5139b/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.content_locallibrary_module.rst b/docs/vmware.vmware_rest.content_locallibrary_module.rst deleted file mode 100644 index c4219c9ea..000000000 --- a/docs/vmware.vmware_rest.content_locallibrary_module.rst +++ /dev/null @@ -1,617 +0,0 @@ -.. _vmware.vmware_rest.content_locallibrary_module: - - -*************************************** -vmware.vmware_rest.content_locallibrary -*************************************** - -**Creates a new local library.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Creates a new local library. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- client_token - -
- string -
- 		- -
A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation.
-
-
- creation_time - -
- string -
- 		- -
The date and time when this library was created.
-
-
- description - -
- string -
- 		- -
A human-readable description for this library.
-
-
- id - -
- string -
- 		- -
An identifier which uniquely identifies this library_model.
-
-
- last_modified_time - -
- string -
- 		- -
The date and time when this library was last updated. This field is updated automatically when the library properties are changed. This field is not affected by adding, removing, or modifying a library item or its content within the library. Tagging the library or syncing the subscribed library does not alter this field.
-
-
- last_sync_time - -
- string -
- 		- -
The date and time when this library was last synchronized. This field applies only to subscribed libraries. It is updated every time a synchronization is triggered on the library. The value is not set for a local library.
-
-
- library_id - -
- string -
- 		- -
Identifier of the local library to delete. Required with state=['absent', 'present', 'publish']
-
-
- name - -
- string -
- 		- -
The name of the library. A Library is identified by a human-readable name. Library names cannot be undefined or an empty string. Names do not have to be unique.
-
-
- optimization_info - -
- dictionary -
- 		- -
Defines various optimizations and optimization parameters applied to this library.
-
Valid attributes are:
-
- optimize_remote_publishing (bool): If set to True then library would be optimized for remote publishing. Turn it on if remote publishing is dominant use case for this library. Remote publishing means here that publisher and subscribers are not the part of the same vcenter SSO domain. Any optimizations could be done as result of turning on this optimization during library creation. For example, library content could be stored in different format but optimizations are not limited to just storage format. Note, that value of this toggle could be set only during creation of the library and you would need to migrate your library in case you need to change this value (optimize the library for different use case). (['present'])
-
-
- publish_info - -
- dictionary -
- 		- -
Defines how this library is published so that it can be subscribed to by a remote subscribed library. The publish_info defines where and how the metadata for this local library is accessible. A local library is only published publically if publish_info.published is True.
-
Valid attributes are:
-
- authentication_method (str): The authentication_method indicates how a subscribed library should authenticate to the published library endpoint. (['present'])
-
- Accepted values:
-
- BASIC
-
- NONE
-
- published (bool): Whether the local library is published. (['present'])
-
- publish_url (str): The URL to which the library metadata is published by the Content Library Service. This value can be used to set the subscription_info.subscriptionurl property when creating a subscribed library. (['present'])
-
- user_name (str): The username to require for authentication. (['present'])
-
- password (str): The new password to require for authentication. (['present'])
-
- current_password (str): The current password to verify. This field is available starting in vSphere 6.7. (['present'])
-
- persist_json_enabled (bool): Whether library and library item metadata are persisted in the storage backing as JSON files. This flag only applies if the local library is published. Enabling JSON persistence allows you to synchronize a subscribed library manually instead of over HTTP. You copy the local library content and metadata to another storage backing manually and then create a subscribed library referencing the location of the library JSON file in the subscription_info.subscriptionurl. When the subscribed library's storage backing matches the subscription URL, files do not need to be copied to the subscribed library. For a library backed by a datastore, the library JSON file will be stored at the path contentlib-{library_id}/lib.json on the datastore. For a library backed by a remote file system, the library JSON file will be stored at {library_id}/lib.json in the remote file system path. (['present'])
-
-
- security_policy_id - -
- string -
- 		- -
Represents the security policy applied to this library. Setting the field will make the library secure. This field is ignored in updateoperation if {@link #unsetSecurityPolicyId} is set to True.
-
-
- server_guid - -
- string -
- 		- -
The unique identifier of the vCenter server where the library exists.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
  • publish
    • -
- 		-
-
- storage_backings - -
- list - / elements=dictionary -
- 		- -
The list of default storage backings which are available for this library. A storage backing defines a default storage location which can be used to store files for library items in this library. Some library items, for instance, virtual machine template items, support files that may be distributed across various storage backings. One or more item files may or may not be located on the default storage backing. Multiple default storage locations are not currently supported but may become supported in future releases.
-
Valid attributes are:
-
- type (str): The type specifies the type of the storage backing. (['present'])
-
- Accepted values:
-
- DATASTORE
-
- OTHER
-
- datastore_id (str): Identifier of the datastore used to store the content in the library. (['present'])
-
- storage_uri (str): URI identifying the location used to store the content in the library. The following URI formats are supported: vSphere 6.5 <ul> <li>nfs://server/path?version=4 (for vCenter Server Appliance only) - Specifies an NFS Version 4 server.</li> <li>nfs://server/path (for vCenter Server Appliance only) - Specifies an NFS Version 3 server. The nfs://server:/path format is also supported.</li> <li>smb://server/path - Specifies an SMB server or Windows share.</li> </ul> vSphere 6.0 Update 1 <ul> <li>nfs://server:/path (for vCenter Server Appliance only)</li> <li>file://unc-server/path (for vCenter Server for Windows only)</li> <li>file:///mount/point (for vCenter Server Appliance only) - Local file URIs are supported only when the path is a local mount point for an NFS file system. Use of file URIs is strongly discouraged. Instead, use an NFS URI to specify the remote file system.</li> </ul> vSphere 6.0 <ul> <li>nfs://server:/path (for vCenter Server Appliance only)</li> <li>file://unc-server/path (for vCenter Server for Windows only)</li> <li>file:///path - Local file URIs are supported but strongly discouraged because it may interfere with the performance of vCenter Server.</li> </ul> (['present'])
-
-
- subscription_info - -
- dictionary -
- 		- -
Defines the subscription behavior for this Library. The subscription_info defines how this subscribed library synchronizes to a remote source. Setting the value will determine the remote source to which the library synchronizes, and how. Changing the subscription will result in synchronizing to a new source. If the new source differs from the old one, the old library items and data will be lost. Setting subscription_info.automaticSyncEnabled to false will halt subscription but will not remove existing cached data.
-
Valid attributes are:
-
- authentication_method (str): Indicate how the subscribed library should authenticate with the published library endpoint. (['present'])
-
- Accepted values:
-
- BASIC
-
- NONE
-
- automatic_sync_enabled (bool): Whether the library should participate in automatic library synchronization. In order for automatic synchronization to happen, the global configuration_model.automatic_sync_enabled option must also be true. The subscription is still active even when automatic synchronization is turned off, but synchronization is only activated with an explicit call to vmware.vmware_rest.content_subscribedlibrary with state=sync or vmware.vmware_rest.content_library_item with state=sync. In other words, manual synchronization is still available even when automatic synchronization is disabled. (['present'])
-
- on_demand (bool): Indicates whether a library item's content will be synchronized only on demand. If this is set to True, then the library item's metadata will be synchronized but the item's content (its files) will not be synchronized. The Content Library Service will synchronize the content upon request only. This can cause the first use of the content to have a noticeable delay. Items without synchronized content can be forcefully synchronized in advance using the vmware.vmware_rest.content_library_item with state=sync call with force_sync_content set to true. Once content has been synchronized, the content can removed with the vmware.vmware_rest.content_library_item with state=sync call. If this value is set to False, all content will be synchronized in advance. (['present'])
-
- password (str): The password to use when authenticating. The password must be set when using a password-based authentication method; empty strings are not allowed. (['present'])
-
- ssl_thumbprint (str): An optional SHA-1 hash of the SSL certificate for the remote endpoint. If this value is defined the SSL certificate will be verified by comparing it to the SSL thumbprint. The SSL certificate must verify against the thumbprint. When specified, the standard certificate chain validation behavior is not used. The certificate chain is validated normally if this value is not set. (['present'])
-
- subscription_url (str): The URL of the endpoint where the metadata for the remotely published library is being served. This URL can be the publish_info.publish_url of the published library (for example, https://server/path/lib.json). If the source content comes from a published library with publish_info.persist_json_enabled, the subscription URL can be a URL pointing to the library JSON file on a datastore or remote file system. The supported formats are: vSphere 6.5 <ul> <li>ds:///vmfs/volumes/{uuid}/mylibrary/lib.json (for datastore)</li> <li>nfs://server/path/mylibrary/lib.json (for NFSv3 server on vCenter Server Appliance)</li> <li>nfs://server/path/mylibrary/lib.json?version=4 (for NFSv4 server on vCenter Server Appliance) </li> <li>smb://server/path/mylibrary/lib.json (for SMB server)</li> </ul> vSphere 6.0 <ul> <li>file://server/mylibrary/lib.json (for UNC server on vCenter Server for Windows)</li> <li>file:///path/mylibrary/lib.json (for local file system)</li> </ul> When you specify a DS subscription URL, the datastore must be on the same vCenter Server as the subscribed library. When you specify an NFS or SMB subscription URL, the storage_backings.storage_uri of the subscribed library must be on the same remote file server and should share a common parent path with the subscription URL. (['present'])
-
- user_name (str): The username to use when authenticating. The username must be set when using a password-based authentication method. Empty strings are allowed for usernames. (['present'])
-
- source_info (dict): Information about the source published library. This field will be set for a subscribed library which is associated with a subscription of the published library. (['present'])
-
- Accepted keys:
-
- source_library (string): Identifier of the published library.
-
- subscription (string): Identifier of the subscription associated with the subscribed library.
-
-
- subscriptions - -
- list - / elements=dictionary -
- 		- -
The list of subscriptions to publish this library to.
-
Valid attributes are:
-
- subscription (str): Identifier of the subscription associated with the subscribed library. (['publish'])
-
This key is required with ['publish'].
-
-
- type - -
- string -
- 		-
    Choices: -
  • LOCAL
    • -
  • SUBSCRIBED
    • -
- 		-
The library_type defines the type of a Library. The type of a library can be used to determine which additional services can be performed with a library.
-
-
- unset_security_policy_id - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
This represents the intent of the change to {@link #securityPolicyId} in updateoperation. If this field is set to True, any security policy applied to the library will be removed. If this field is set to False, any security policy applied to library will be changed to the value specified in {@link #securityPolicyId}, if any.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- version - -
- string -
- 		- -
A version number which is updated on metadata changes. This value allows clients to detect concurrent updates and prevent accidental clobbering of data. This value represents a number which is incremented every time library properties, such as name or description, are changed. It is not incremented by changes to a library item within the library, including adding or removing items. It is also not affected by tagging the library.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Create a content library pointing on a NFS share - vmware.vmware_rest.content_locallibrary: - name: my_library_on_nfs - description: automated - publish_info: - published: true - authentication_method: NONE - storage_backings: - - storage_uri: nfs://datastore.test/srv/share/content-library - type: OTHER - state: present - register: nfs_lib - - - name: Create some more content libraries - vmware.vmware_rest.content_locallibrary: - name: my_library_on_nfs_{{ item }} - description: automated - publish_info: - published: true - authentication_method: NONE - storage_backings: - - storage_uri: nfs://datastore.test/srv/share/content-library - type: OTHER - state: present - with_sequence: 0-10 - - - name: Create a new local content library - vmware.vmware_rest.content_locallibrary: - name: local_library_001 - description: automated - publish_info: - published: true - authentication_method: NONE - storage_backings: - - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}" - type: DATASTORE - state: present - register: ds_lib - - - name: Create a content library based on a DataStore - vmware.vmware_rest.content_locallibrary: - name: my_library_on_datastore - description: automated - publish_info: - published: true - authentication_method: NONE - storage_backings: - - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - type: DATASTORE - state: present - register: nfs_lib - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		On success -
Delete all the local libraries
-
-
Sample:
-
All items completed
-
-
- results - -
- list -
- 		On success -
Delete all the local libraries
-
-
Sample:
-
[{'_ansible_item_label': {'creation_time': '2022-11-23T20:02:22.940Z', 'description': 'automated', 'id': 'a66d5c73-57f8-4a3a-9361-292a55f68516', 'last_modified_time': '2022-11-23T20:02:22.940Z', 'name': 'my_library_on_nfs', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': 'a66d5c73-57f8-4a3a-9361-292a55f68516', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:22.940Z', 'description': 'automated', 'id': 'a66d5c73-57f8-4a3a-9361-292a55f68516', 'last_modified_time': '2022-11-23T20:02:22.940Z', 'name': 'my_library_on_nfs', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:25.134Z', 'description': 'automated', 'id': '3393956a-43ed-4e7f-bd96-eb39bd604445', 'last_modified_time': '2022-11-23T20:02:25.134Z', 'name': 'my_library_on_nfs_0', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/3393956a-43ed-4e7f-bd96-eb39bd604445/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '3393956a-43ed-4e7f-bd96-eb39bd604445', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:25.134Z', 'description': 'automated', 'id': '3393956a-43ed-4e7f-bd96-eb39bd604445', 'last_modified_time': '2022-11-23T20:02:25.134Z', 'name': 'my_library_on_nfs_0', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/3393956a-43ed-4e7f-bd96-eb39bd604445/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:26.342Z', 'description': 'automated', 'id': '87f66f86-c046-45a7-9563-d59ea220babf', 'last_modified_time': '2022-11-23T20:02:26.342Z', 'name': 'my_library_on_nfs_1', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/87f66f86-c046-45a7-9563-d59ea220babf/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '87f66f86-c046-45a7-9563-d59ea220babf', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:26.342Z', 'description': 'automated', 'id': '87f66f86-c046-45a7-9563-d59ea220babf', 'last_modified_time': '2022-11-23T20:02:26.342Z', 'name': 'my_library_on_nfs_1', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/87f66f86-c046-45a7-9563-d59ea220babf/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:27.504Z', 'description': 'automated', 'id': 'f6c590c4-ae6d-4ad0-9362-378196e98a3c', 'last_modified_time': '2022-11-23T20:02:27.504Z', 'name': 'my_library_on_nfs_2', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/f6c590c4-ae6d-4ad0-9362-378196e98a3c/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': 'f6c590c4-ae6d-4ad0-9362-378196e98a3c', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:27.504Z', 'description': 'automated', 'id': 'f6c590c4-ae6d-4ad0-9362-378196e98a3c', 'last_modified_time': '2022-11-23T20:02:27.504Z', 'name': 'my_library_on_nfs_2', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/f6c590c4-ae6d-4ad0-9362-378196e98a3c/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:28.821Z', 'description': 'automated', 'id': 'e8917499-2a4c-4b70-b39b-ae0caaef89c3', 'last_modified_time': '2022-11-23T20:02:28.821Z', 'name': 'my_library_on_nfs_3', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/e8917499-2a4c-4b70-b39b-ae0caaef89c3/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': 'e8917499-2a4c-4b70-b39b-ae0caaef89c3', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:28.821Z', 'description': 'automated', 'id': 'e8917499-2a4c-4b70-b39b-ae0caaef89c3', 'last_modified_time': '2022-11-23T20:02:28.821Z', 'name': 'my_library_on_nfs_3', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/e8917499-2a4c-4b70-b39b-ae0caaef89c3/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:30.085Z', 'description': 'automated', 'id': '630ebdfe-8913-45d3-aaa8-9c2fdecbb76b', 'last_modified_time': '2022-11-23T20:02:30.085Z', 'name': 'my_library_on_nfs_4', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/630ebdfe-8913-45d3-aaa8-9c2fdecbb76b/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '630ebdfe-8913-45d3-aaa8-9c2fdecbb76b', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:30.085Z', 'description': 'automated', 'id': '630ebdfe-8913-45d3-aaa8-9c2fdecbb76b', 'last_modified_time': '2022-11-23T20:02:30.085Z', 'name': 'my_library_on_nfs_4', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/630ebdfe-8913-45d3-aaa8-9c2fdecbb76b/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:31.482Z', 'description': 'automated', 'id': 'a046e2e5-bd55-4d04-9443-750a2ab35a6d', 'last_modified_time': '2022-11-23T20:02:31.482Z', 'name': 'my_library_on_nfs_5', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/a046e2e5-bd55-4d04-9443-750a2ab35a6d/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': 'a046e2e5-bd55-4d04-9443-750a2ab35a6d', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:31.482Z', 'description': 'automated', 'id': 'a046e2e5-bd55-4d04-9443-750a2ab35a6d', 'last_modified_time': '2022-11-23T20:02:31.482Z', 'name': 'my_library_on_nfs_5', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/a046e2e5-bd55-4d04-9443-750a2ab35a6d/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:32.846Z', 'description': 'automated', 'id': 'b94383b1-7877-4dbd-8c33-51abc39451ff', 'last_modified_time': '2022-11-23T20:02:32.846Z', 'name': 'my_library_on_nfs_6', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/b94383b1-7877-4dbd-8c33-51abc39451ff/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': 'b94383b1-7877-4dbd-8c33-51abc39451ff', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:32.846Z', 'description': 'automated', 'id': 'b94383b1-7877-4dbd-8c33-51abc39451ff', 'last_modified_time': '2022-11-23T20:02:32.846Z', 'name': 'my_library_on_nfs_6', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/b94383b1-7877-4dbd-8c33-51abc39451ff/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:34.218Z', 'description': 'automated', 'id': '8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00', 'last_modified_time': '2022-11-23T20:02:34.218Z', 'name': 'my_library_on_nfs_7', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:34.218Z', 'description': 'automated', 'id': '8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00', 'last_modified_time': '2022-11-23T20:02:34.218Z', 'name': 'my_library_on_nfs_7', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:35.922Z', 'description': 'automated', 'id': '0b12c0b3-6c6d-448d-9033-e054a70183e7', 'last_modified_time': '2022-11-23T20:02:35.922Z', 'name': 'my_library_on_nfs_8', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/0b12c0b3-6c6d-448d-9033-e054a70183e7/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '0b12c0b3-6c6d-448d-9033-e054a70183e7', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:35.922Z', 'description': 'automated', 'id': '0b12c0b3-6c6d-448d-9033-e054a70183e7', 'last_modified_time': '2022-11-23T20:02:35.922Z', 'name': 'my_library_on_nfs_8', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/0b12c0b3-6c6d-448d-9033-e054a70183e7/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:37.796Z', 'description': 'automated', 'id': '46454797-bbe0-415a-9fe9-3cf2f74a14db', 'last_modified_time': '2022-11-23T20:02:37.796Z', 'name': 'my_library_on_nfs_9', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/46454797-bbe0-415a-9fe9-3cf2f74a14db/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '46454797-bbe0-415a-9fe9-3cf2f74a14db', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:37.796Z', 'description': 'automated', 'id': '46454797-bbe0-415a-9fe9-3cf2f74a14db', 'last_modified_time': '2022-11-23T20:02:37.796Z', 'name': 'my_library_on_nfs_9', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/46454797-bbe0-415a-9fe9-3cf2f74a14db/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:38.976Z', 'description': 'automated', 'id': '209926aa-e3fe-46a5-95f2-501e82a5139b', 'last_modified_time': '2022-11-23T20:02:38.976Z', 'name': 'my_library_on_nfs_10', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/209926aa-e3fe-46a5-95f2-501e82a5139b/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '209926aa-e3fe-46a5-95f2-501e82a5139b', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:38.976Z', 'description': 'automated', 'id': '209926aa-e3fe-46a5-95f2-501e82a5139b', 'last_modified_time': '2022-11-23T20:02:38.976Z', 'name': 'my_library_on_nfs_10', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/209926aa-e3fe-46a5-95f2-501e82a5139b/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:06:02.958Z', 'description': 'automated', 'id': 'de0e9bff-3bae-45d0-a90c-6c2a01dfbe66', 'last_modified_time': '2022-11-23T20:06:02.958Z', 'name': 'local_library_001', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/de0e9bff-3bae-45d0-a90c-6c2a01dfbe66/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'datastore_id': 'datastore-1065', 'type': 'DATASTORE'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': 'de0e9bff-3bae-45d0-a90c-6c2a01dfbe66', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:06:02.958Z', 'description': 'automated', 'id': 'de0e9bff-3bae-45d0-a90c-6c2a01dfbe66', 'last_modified_time': '2022-11-23T20:06:02.958Z', 'name': 'local_library_001', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/de0e9bff-3bae-45d0-a90c-6c2a01dfbe66/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'datastore_id': 'datastore-1065', 'type': 'DATASTORE'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.content_subscribedlibrary_info_module.rst b/docs/vmware.vmware_rest.content_subscribedlibrary_info_module.rst deleted file mode 100644 index 4a90cfdab..000000000 --- a/docs/vmware.vmware_rest.content_subscribedlibrary_info_module.rst +++ /dev/null @@ -1,230 +0,0 @@ -.. _vmware.vmware_rest.content_subscribedlibrary_info_module: - - -************************************************* -vmware.vmware_rest.content_subscribedlibrary_info -************************************************* - -**Returns a given subscribed library.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns a given subscribed library. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- library_id - -
- string -
- 		- -
Identifier of the subscribed library to return. Required with state=['get']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: List Subscribed Content Library - vmware.vmware_rest.content_subscribedlibrary_info: - register: my_content_library - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
List Subscribed Content Library
-
-
Sample:
-
[{'creation_time': '2022-11-23T20:06:05.189Z', 'description': '', 'id': '8b4e355e-a463-44f1-9b04-d0786a49cc7d', 'last_modified_time': '2022-11-23T20:06:05.189Z', 'last_sync_time': '2022-11-23T20:06:07.717Z', 'name': 'sub_lib', 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'datastore_id': 'datastore-1065', 'type': 'DATASTORE'}], 'subscription_info': {'authentication_method': 'NONE', 'automatic_sync_enabled': 0, 'on_demand': 1, 'subscription_url': 'https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json'}, 'type': 'SUBSCRIBED', 'version': '4'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.content_subscribedlibrary_module.rst b/docs/vmware.vmware_rest.content_subscribedlibrary_module.rst deleted file mode 100644 index 17f25ebe8..000000000 --- a/docs/vmware.vmware_rest.content_subscribedlibrary_module.rst +++ /dev/null @@ -1,599 +0,0 @@ -.. _vmware.vmware_rest.content_subscribedlibrary_module: - - -******************************************** -vmware.vmware_rest.content_subscribedlibrary -******************************************** - -**Creates a new subscribed library** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Creates a new subscribed library.

Once created, the subscribed library will be empty. If the {@link LibraryModel#subscriptionInfo} property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- client_token - -
- string -
- 		- -
Unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation.
-
-
- creation_time - -
- string -
- 		- -
The date and time when this library was created.
-
-
- description - -
- string -
- 		- -
A human-readable description for this library.
-
-
- id - -
- string -
- 		- -
An identifier which uniquely identifies this library_model.
-
-
- last_modified_time - -
- string -
- 		- -
The date and time when this library was last updated. This field is updated automatically when the library properties are changed. This field is not affected by adding, removing, or modifying a library item or its content within the library. Tagging the library or syncing the subscribed library does not alter this field.
-
-
- last_sync_time - -
- string -
- 		- -
The date and time when this library was last synchronized. This field applies only to subscribed libraries. It is updated every time a synchronization is triggered on the library. The value is not set for a local library.
-
-
- library_id - -
- string -
- 		- -
Identifier of the subscribed library whose content should be evicted. Required with state=['absent', 'evict', 'present', 'sync']
-
-
- name - -
- string -
- 		- -
The name of the library. A Library is identified by a human-readable name. Library names cannot be undefined or an empty string. Names do not have to be unique.
-
-
- optimization_info - -
- dictionary -
- 		- -
Defines various optimizations and optimization parameters applied to this library.
-
Valid attributes are:
-
- optimize_remote_publishing (bool): If set to True then library would be optimized for remote publishing. Turn it on if remote publishing is dominant use case for this library. Remote publishing means here that publisher and subscribers are not the part of the same vcenter SSO domain. Any optimizations could be done as result of turning on this optimization during library creation. For example, library content could be stored in different format but optimizations are not limited to just storage format. Note, that value of this toggle could be set only during creation of the library and you would need to migrate your library in case you need to change this value (optimize the library for different use case). (['present'])
-
-
- publish_info - -
- dictionary -
- 		- -
Defines how this library is published so that it can be subscribed to by a remote subscribed library. The publish_info defines where and how the metadata for this local library is accessible. A local library is only published publically if publish_info.published is True.
-
Valid attributes are:
-
- authentication_method (str): The authentication_method indicates how a subscribed library should authenticate to the published library endpoint. (['present'])
-
- Accepted values:
-
- BASIC
-
- NONE
-
- published (bool): Whether the local library is published. (['present'])
-
- publish_url (str): The URL to which the library metadata is published by the Content Library Service. This value can be used to set the subscription_info.subscriptionurl property when creating a subscribed library. (['present'])
-
- user_name (str): The username to require for authentication. (['present'])
-
- password (str): The new password to require for authentication. (['present'])
-
- current_password (str): The current password to verify. This field is available starting in vSphere 6.7. (['present'])
-
- persist_json_enabled (bool): Whether library and library item metadata are persisted in the storage backing as JSON files. This flag only applies if the local library is published. Enabling JSON persistence allows you to synchronize a subscribed library manually instead of over HTTP. You copy the local library content and metadata to another storage backing manually and then create a subscribed library referencing the location of the library JSON file in the subscription_info.subscriptionurl. When the subscribed library's storage backing matches the subscription URL, files do not need to be copied to the subscribed library. For a library backed by a datastore, the library JSON file will be stored at the path contentlib-{library_id}/lib.json on the datastore. For a library backed by a remote file system, the library JSON file will be stored at {library_id}/lib.json in the remote file system path. (['present'])
-
-
- security_policy_id - -
- string -
- 		- -
Represents the security policy applied to this library. Setting the field will make the library secure. This field is ignored in updateoperation if {@link #unsetSecurityPolicyId} is set to True.
-
-
- server_guid - -
- string -
- 		- -
The unique identifier of the vCenter server where the library exists.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • evict
    • -
  • present ←
    • -
  • probe
    • -
  • sync
    • -
- 		-
-
- storage_backings - -
- list - / elements=dictionary -
- 		- -
The list of default storage backings which are available for this library. A storage backing defines a default storage location which can be used to store files for library items in this library. Some library items, for instance, virtual machine template items, support files that may be distributed across various storage backings. One or more item files may or may not be located on the default storage backing. Multiple default storage locations are not currently supported but may become supported in future releases.
-
Valid attributes are:
-
- type (str): The type specifies the type of the storage backing. (['present'])
-
- Accepted values:
-
- DATASTORE
-
- OTHER
-
- datastore_id (str): Identifier of the datastore used to store the content in the library. (['present'])
-
- storage_uri (str): URI identifying the location used to store the content in the library. The following URI formats are supported: vSphere 6.5 <ul> <li>nfs://server/path?version=4 (for vCenter Server Appliance only) - Specifies an NFS Version 4 server.</li> <li>nfs://server/path (for vCenter Server Appliance only) - Specifies an NFS Version 3 server. The nfs://server:/path format is also supported.</li> <li>smb://server/path - Specifies an SMB server or Windows share.</li> </ul> vSphere 6.0 Update 1 <ul> <li>nfs://server:/path (for vCenter Server Appliance only)</li> <li>file://unc-server/path (for vCenter Server for Windows only)</li> <li>file:///mount/point (for vCenter Server Appliance only) - Local file URIs are supported only when the path is a local mount point for an NFS file system. Use of file URIs is strongly discouraged. Instead, use an NFS URI to specify the remote file system.</li> </ul> vSphere 6.0 <ul> <li>nfs://server:/path (for vCenter Server Appliance only)</li> <li>file://unc-server/path (for vCenter Server for Windows only)</li> <li>file:///path - Local file URIs are supported but strongly discouraged because it may interfere with the performance of vCenter Server.</li> </ul> (['present'])
-
-
- subscription_info - -
- dictionary -
- 		- -
Defines the subscription behavior for this Library. The subscription_info defines how this subscribed library synchronizes to a remote source. Setting the value will determine the remote source to which the library synchronizes, and how. Changing the subscription will result in synchronizing to a new source. If the new source differs from the old one, the old library items and data will be lost. Setting subscription_info.automaticSyncEnabled to false will halt subscription but will not remove existing cached data.
-
Valid attributes are:
-
- authentication_method (str): Indicate how the subscribed library should authenticate with the published library endpoint. (['present', 'probe'])
-
- Accepted values:
-
- BASIC
-
- NONE
-
- automatic_sync_enabled (bool): Whether the library should participate in automatic library synchronization. In order for automatic synchronization to happen, the global configuration_model.automatic_sync_enabled option must also be true. The subscription is still active even when automatic synchronization is turned off, but synchronization is only activated with an explicit call to vmware.vmware_rest.content_subscribedlibrary with state=sync or vmware.vmware_rest.content_library_item with state=sync. In other words, manual synchronization is still available even when automatic synchronization is disabled. (['present', 'probe'])
-
- on_demand (bool): Indicates whether a library item's content will be synchronized only on demand. If this is set to True, then the library item's metadata will be synchronized but the item's content (its files) will not be synchronized. The Content Library Service will synchronize the content upon request only. This can cause the first use of the content to have a noticeable delay. Items without synchronized content can be forcefully synchronized in advance using the vmware.vmware_rest.content_library_item with state=sync call with force_sync_content set to true. Once content has been synchronized, the content can removed with the vmware.vmware_rest.content_library_item with state=sync call. If this value is set to False, all content will be synchronized in advance. (['present', 'probe'])
-
- password (str): The password to use when authenticating. The password must be set when using a password-based authentication method; empty strings are not allowed. (['present', 'probe'])
-
- ssl_thumbprint (str): An optional SHA-1 hash of the SSL certificate for the remote endpoint. If this value is defined the SSL certificate will be verified by comparing it to the SSL thumbprint. The SSL certificate must verify against the thumbprint. When specified, the standard certificate chain validation behavior is not used. The certificate chain is validated normally if this value is not set. (['present', 'probe'])
-
- subscription_url (str): The URL of the endpoint where the metadata for the remotely published library is being served. This URL can be the publish_info.publish_url of the published library (for example, https://server/path/lib.json). If the source content comes from a published library with publish_info.persist_json_enabled, the subscription URL can be a URL pointing to the library JSON file on a datastore or remote file system. The supported formats are: vSphere 6.5 <ul> <li>ds:///vmfs/volumes/{uuid}/mylibrary/lib.json (for datastore)</li> <li>nfs://server/path/mylibrary/lib.json (for NFSv3 server on vCenter Server Appliance)</li> <li>nfs://server/path/mylibrary/lib.json?version=4 (for NFSv4 server on vCenter Server Appliance) </li> <li>smb://server/path/mylibrary/lib.json (for SMB server)</li> </ul> vSphere 6.0 <ul> <li>file://server/mylibrary/lib.json (for UNC server on vCenter Server for Windows)</li> <li>file:///path/mylibrary/lib.json (for local file system)</li> </ul> When you specify a DS subscription URL, the datastore must be on the same vCenter Server as the subscribed library. When you specify an NFS or SMB subscription URL, the storage_backings.storage_uri of the subscribed library must be on the same remote file server and should share a common parent path with the subscription URL. (['present', 'probe'])
-
- user_name (str): The username to use when authenticating. The username must be set when using a password-based authentication method. Empty strings are allowed for usernames. (['present', 'probe'])
-
- source_info (dict): Information about the source published library. This field will be set for a subscribed library which is associated with a subscription of the published library. (['present', 'probe'])
-
- Accepted keys:
-
- source_library (string): Identifier of the published library.
-
- subscription (string): Identifier of the subscription associated with the subscribed library.
-
-
- type - -
- string -
- 		-
    Choices: -
  • LOCAL
    • -
  • SUBSCRIBED
    • -
- 		-
The library_type defines the type of a Library. The type of a library can be used to determine which additional services can be performed with a library.
-
-
- unset_security_policy_id - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
This represents the intent of the change to {@link #securityPolicyId} in updateoperation. If this field is set to True, any security policy applied to the library will be removed. If this field is set to False, any security policy applied to library will be changed to the value specified in {@link #securityPolicyId}, if any.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- version - -
- string -
- 		- -
A version number which is updated on metadata changes. This value allows clients to detect concurrent updates and prevent accidental clobbering of data. This value represents a number which is incremented every time library properties, such as name or description, are changed. It is not incremented by changes to a library item within the library, including adding or removing items. It is also not affected by tagging the library.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Create a content library pointing on a NFS share - vmware.vmware_rest.content_locallibrary: - name: my_library_on_nfs - description: automated - publish_info: - published: true - authentication_method: NONE - storage_backings: - - storage_uri: nfs://datastore.test/srv/share/content-library - type: OTHER - state: present - register: nfs_lib - - - name: Create subscribed library - vmware.vmware_rest.content_subscribedlibrary: - name: sub_lib - subscription_info: - subscription_url: '{{ nfs_lib.value.publish_info.publish_url }}' - authentication_method: NONE - automatic_sync_enabled: false - on_demand: true - storage_backings: - - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}" - type: DATASTORE - register: sub_lib - - - name: Create subscribed library (again) - vmware.vmware_rest.content_subscribedlibrary: - name: sub_lib - subscription_info: - subscription_url: '{{ nfs_lib.value.publish_info.publish_url }}' - authentication_method: NONE - automatic_sync_enabled: false - on_demand: true - storage_backings: - - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}" - type: DATASTORE - register: result - - - name: Clean up the cache - vmware.vmware_rest.content_subscribedlibrary: - name: sub_lib - library_id: '{{ sub_lib.id }}' - state: evict - - - name: Trigger a library sync - vmware.vmware_rest.content_subscribedlibrary: - name: sub_lib - library_id: '{{ sub_lib.id }}' - state: sync - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		On success -
Delete all the subscribed libraries
-
-
Sample:
-
All items completed
-
-
- results - -
- list -
- 		On success -
Delete all the subscribed libraries
-
-
Sample:
-
[{'_ansible_item_label': {'creation_time': '2022-11-23T20:06:05.189Z', 'description': '', 'id': '8b4e355e-a463-44f1-9b04-d0786a49cc7d', 'last_modified_time': '2022-11-23T20:06:05.189Z', 'last_sync_time': '2022-11-23T20:06:07.717Z', 'name': 'sub_lib', 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'datastore_id': 'datastore-1065', 'type': 'DATASTORE'}], 'subscription_info': {'authentication_method': 'NONE', 'automatic_sync_enabled': 0, 'on_demand': 1, 'subscription_url': 'https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json'}, 'type': 'SUBSCRIBED', 'version': '4'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '8b4e355e-a463-44f1-9b04-d0786a49cc7d', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:06:05.189Z', 'description': '', 'id': '8b4e355e-a463-44f1-9b04-d0786a49cc7d', 'last_modified_time': '2022-11-23T20:06:05.189Z', 'last_sync_time': '2022-11-23T20:06:07.717Z', 'name': 'sub_lib', 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'datastore_id': 'datastore-1065', 'type': 'DATASTORE'}], 'subscription_info': {'authentication_method': 'NONE', 'automatic_sync_enabled': 0, 'on_demand': 1, 'subscription_url': 'https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json'}, 'type': 'SUBSCRIBED', 'version': '4'}, 'value': {}}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.datacenter_moid_lookup.rst b/docs/vmware.vmware_rest.datacenter_moid_lookup.rst deleted file mode 100644 index 4291b22cb..000000000 --- a/docs/vmware.vmware_rest.datacenter_moid_lookup.rst +++ /dev/null @@ -1,230 +0,0 @@ -.. _vmware.vmware_rest.datacenter_moid_lookup: - - -********************************** -vmware.vmware_rest.datacenter_moid -********************************** - -**Look up MoID for vSphere datacenter objects using vCenter REST API** - - -Version added: 2.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns Managed Object Reference (MoID) of the vSphere datacenter object contained in the specified path. - - - -Requirements ------------- -The below requirements are needed on the local Ansible controller node that executes this lookup. - -- vSphere 7.0.2 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsConfigurationComments
-
- _terms - -
- string - / required -
- 		- - -
Path to query.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
env:VMWARE_HOST
- 		-
The hostname or IP address of the vSphere vCenter.
-
-
- vcenter_password - -
- string - / required -
- 		- -
env:VMWARE_PASSWORD
- 		-
The vSphere vCenter password.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
env:VMWARE_REST_LOG_FILE
- 		-
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interactions.
-
The file will be stored on the host that runs the module.
-
-
- vcenter_username - -
- string - / required -
- 		- -
env:VMWARE_USER
- 		-
The vSphere vCenter username.
-
-
- vcenter_validate_certs - -
- boolean -
- 		- Default:
"yes"
- 		-
env:VMWARE_VALIDATE_CERTS
- 		-
Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - # lookup sample - - name: set connection info - ansible.builtin.set_fact: - connection_args: - vcenter_hostname: "vcenter.test" - vcenter_username: "administrator@vsphere.local" - vcenter_password: "1234" - - - name: lookup MoID of the object - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.datacenter_moid', '/my_dc', **connection_args) }}" - - - name: lookup MoID of the object inside the path - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.datacenter_moid', '/my_folder/') }}" - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this lookup: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- _raw - -
- string -
- 		-
MoID of the vSphere datacenter object
-
-
Sample:
-
datacenter-1001
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Alina Buzachis (@alinabuzachis) - - -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vmware.vmware_rest.datastore_moid_lookup.rst b/docs/vmware.vmware_rest.datastore_moid_lookup.rst deleted file mode 100644 index c390bc466..000000000 --- a/docs/vmware.vmware_rest.datastore_moid_lookup.rst +++ /dev/null @@ -1,230 +0,0 @@ -.. _vmware.vmware_rest.datastore_moid_lookup: - - -********************************* -vmware.vmware_rest.datastore_moid -********************************* - -**Look up MoID for vSphere datastore objects using vCenter REST API** - - -Version added: 2.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns Managed Object Reference (MoID) of the vSphere datastore object object contained in the specified path. - - - -Requirements ------------- -The below requirements are needed on the local Ansible controller node that executes this lookup. - -- vSphere 7.0.2 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsConfigurationComments
-
- _terms - -
- string - / required -
- 		- - -
Path to query.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
env:VMWARE_HOST
- 		-
The hostname or IP address of the vSphere vCenter.
-
-
- vcenter_password - -
- string - / required -
- 		- -
env:VMWARE_PASSWORD
- 		-
The vSphere vCenter password.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
env:VMWARE_REST_LOG_FILE
- 		-
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interactions.
-
The file will be stored on the host that runs the module.
-
-
- vcenter_username - -
- string - / required -
- 		- -
env:VMWARE_USER
- 		-
The vSphere vCenter username.
-
-
- vcenter_validate_certs - -
- boolean -
- 		- Default:
"yes"
- 		-
env:VMWARE_VALIDATE_CERTS
- 		-
Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - # lookup sample - - name: set connection info - ansible.builtin.set_fact: - connection_args: - vcenter_hostname: "vcenter.test" - vcenter_username: "administrator@vsphere.local" - vcenter_password: "1234" - - - name: lookup MoID of the object - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/host/my_cluster/esxi1.test/ro_datastore', **connection_args) }}" - - - name: lookup MoID of the object inside the path - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/') }}" - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this lookup: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- _raw - -
- string -
- 		-
MoID of the vSphere datastore object
-
-
Sample:
-
datastore-1019
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Alina Buzachis (@alinabuzachis) - - -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vmware.vmware_rest.folder_moid_lookup.rst b/docs/vmware.vmware_rest.folder_moid_lookup.rst deleted file mode 100644 index 4bafe0066..000000000 --- a/docs/vmware.vmware_rest.folder_moid_lookup.rst +++ /dev/null @@ -1,230 +0,0 @@ -.. _vmware.vmware_rest.folder_moid_lookup: - - -****************************** -vmware.vmware_rest.folder_moid -****************************** - -**Look up MoID for vSphere folder objects using vCenter REST API** - - -Version added: 2.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns Managed Object Reference (MoID) of the vSphere folder object contained in the specified path. - - - -Requirements ------------- -The below requirements are needed on the local Ansible controller node that executes this lookup. - -- vSphere 7.0.2 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsConfigurationComments
-
- _terms - -
- string - / required -
- 		- - -
Path to query.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
env:VMWARE_HOST
- 		-
The hostname or IP address of the vSphere vCenter.
-
-
- vcenter_password - -
- string - / required -
- 		- -
env:VMWARE_PASSWORD
- 		-
The vSphere vCenter password.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
env:VMWARE_REST_LOG_FILE
- 		-
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interactions.
-
The file will be stored on the host that runs the module.
-
-
- vcenter_username - -
- string - / required -
- 		- -
env:VMWARE_USER
- 		-
The vSphere vCenter username.
-
-
- vcenter_validate_certs - -
- boolean -
- 		- Default:
"yes"
- 		-
env:VMWARE_VALIDATE_CERTS
- 		-
Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - # lookup sample - - name: set connection info - ansible.builtin.set_fact: - connection_args: - vcenter_hostname: "vcenter.test" - vcenter_username: "administrator@vsphere.local" - vcenter_password: "1234" - - - name: lookup MoID of the object - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm/foo/bar', **connection_args) }}" - - - name: lookup MoID of the object inside the path - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm/foo/') }}" - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this lookup: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- _raw - -
- string -
- 		-
MoID of the vSphere folder object
-
-
Sample:
-
group-v1029
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Alina Buzachis (@alinabuzachis) - - -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vmware.vmware_rest.host_moid_lookup.rst b/docs/vmware.vmware_rest.host_moid_lookup.rst deleted file mode 100644 index 9db9d8523..000000000 --- a/docs/vmware.vmware_rest.host_moid_lookup.rst +++ /dev/null @@ -1,230 +0,0 @@ -.. _vmware.vmware_rest.host_moid_lookup: - - -**************************** -vmware.vmware_rest.host_moid -**************************** - -**Look up MoID for vSphere host objects using vCenter REST API** - - -Version added: 2.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns Managed Object Reference (MoID) of the vSphere host object contained in the specified path. - - - -Requirements ------------- -The below requirements are needed on the local Ansible controller node that executes this lookup. - -- vSphere 7.0.2 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsConfigurationComments
-
- _terms - -
- string - / required -
- 		- - -
Path to query.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
env:VMWARE_HOST
- 		-
The hostname or IP address of the vSphere vCenter.
-
-
- vcenter_password - -
- string - / required -
- 		- -
env:VMWARE_PASSWORD
- 		-
The vSphere vCenter password.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
env:VMWARE_REST_LOG_FILE
- 		-
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interactions.
-
The file will be stored on the host that runs the module.
-
-
- vcenter_username - -
- string - / required -
- 		- -
env:VMWARE_USER
- 		-
The vSphere vCenter username.
-
-
- vcenter_validate_certs - -
- boolean -
- 		- Default:
"yes"
- 		-
env:VMWARE_VALIDATE_CERTS
- 		-
Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - # lookup sample - - name: set connection info - ansible.builtin.set_fact: - connection_args: - vcenter_hostname: "vcenter.test" - vcenter_username: "administrator@vsphere.local" - vcenter_password: "1234" - - - name: lookup MoID of the object - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.host_moid', '/my_dc/host/my_cluster/esxi1.test', **connection_args) }}" - - - name: lookup MoID of the object inside the path - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.host_moid', '/my_dc/host/my_cluster/') }}" - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this lookup: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- _raw - -
- string -
- 		-
MoID of the vSphere host object
-
-
Sample:
-
host-1014
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Alina Buzachis (@alinabuzachis) - - -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vmware.vmware_rest.network_moid_lookup.rst b/docs/vmware.vmware_rest.network_moid_lookup.rst deleted file mode 100644 index 2e7340705..000000000 --- a/docs/vmware.vmware_rest.network_moid_lookup.rst +++ /dev/null @@ -1,231 +0,0 @@ -.. _vmware.vmware_rest.network_moid_lookup: - - -******************************* -vmware.vmware_rest.network_moid -******************************* - -**Look up MoID for vSphere network objects using vCenter REST API** - - -Version added: 2.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns Managed Object Reference (MoID) of the vSphere network object contained in the specified path. -- This lookup cannot distinguish between multiple networks with the same name defined in multiple switches as that is not supported by the vSphere REST API; network names must be unique within a given datacenter/folder path. - - - -Requirements ------------- -The below requirements are needed on the local Ansible controller node that executes this lookup. - -- vSphere 7.0.2 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsConfigurationComments
-
- _terms - -
- string - / required -
- 		- - -
Path to query.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
env:VMWARE_HOST
- 		-
The hostname or IP address of the vSphere vCenter.
-
-
- vcenter_password - -
- string - / required -
- 		- -
env:VMWARE_PASSWORD
- 		-
The vSphere vCenter password.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
env:VMWARE_REST_LOG_FILE
- 		-
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interactions.
-
The file will be stored on the host that runs the module.
-
-
- vcenter_username - -
- string - / required -
- 		- -
env:VMWARE_USER
- 		-
The vSphere vCenter username.
-
-
- vcenter_validate_certs - -
- boolean -
- 		- Default:
"yes"
- 		-
env:VMWARE_VALIDATE_CERTS
- 		-
Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - # lookup sample - - name: set connection info - ansible.builtin.set_fact: - connection_args: - vcenter_hostname: "vcenter.test" - vcenter_username: "administrator@vsphere.local" - vcenter_password: "1234" - - - name: lookup MoID of the object - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/test_network', **connection_args) }}" - - - name: lookup MoID of the object inside the path - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/') }}" - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this lookup: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- _raw - -
- string -
- 		-
MoID of the vSphere network object
-
-
Sample:
-
network-1017
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Alina Buzachis (@alinabuzachis) - - -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vmware.vmware_rest.resource_pool_moid_lookup.rst b/docs/vmware.vmware_rest.resource_pool_moid_lookup.rst deleted file mode 100644 index 6267c69ad..000000000 --- a/docs/vmware.vmware_rest.resource_pool_moid_lookup.rst +++ /dev/null @@ -1,230 +0,0 @@ -.. _vmware.vmware_rest.resource_pool_moid_lookup: - - -************************************* -vmware.vmware_rest.resource_pool_moid -************************************* - -**Look up MoID for vSphere resource pool objects using vCenter REST API** - - -Version added: 2.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns Managed Object Reference (MoID) of the vSphere resource pool object contained in the specified path. - - - -Requirements ------------- -The below requirements are needed on the local Ansible controller node that executes this lookup. - -- vSphere 7.0.2 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsConfigurationComments
-
- _terms - -
- string - / required -
- 		- - -
Path to query.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
env:VMWARE_HOST
- 		-
The hostname or IP address of the vSphere vCenter.
-
-
- vcenter_password - -
- string - / required -
- 		- -
env:VMWARE_PASSWORD
- 		-
The vSphere vCenter password.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
env:VMWARE_REST_LOG_FILE
- 		-
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interactions.
-
The file will be stored on the host that runs the module.
-
-
- vcenter_username - -
- string - / required -
- 		- -
env:VMWARE_USER
- 		-
The vSphere vCenter username.
-
-
- vcenter_validate_certs - -
- boolean -
- 		- Default:
"yes"
- 		-
env:VMWARE_VALIDATE_CERTS
- 		-
Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - # lookup sample - - name: set connection info - ansible.builtin.set_fact: - connection_args: - vcenter_hostname: "vcenter.test" - vcenter_username: "administrator@vsphere.local" - vcenter_password: "1234" - - - name: lookup MoID of the object - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources/my_resource_pool', **connection_args) }}" - - - name: lookup MoID of the object inside the path - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources/') }}" - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this lookup: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- _raw - -
- string -
- 		-
MoID of the vSphere resource pool object
-
-
Sample:
-
resgroup-1008
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Alina Buzachis (@alinabuzachis) - - -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vmware.vmware_rest.vcenter_cluster_info_module.rst b/docs/vmware.vmware_rest.vcenter_cluster_info_module.rst deleted file mode 100644 index 879f9b5e6..000000000 --- a/docs/vmware.vmware_rest.vcenter_cluster_info_module.rst +++ /dev/null @@ -1,327 +0,0 @@ -.. _vmware.vmware_rest.vcenter_cluster_info_module: - - -*************************************** -vmware.vmware_rest.vcenter_cluster_info -*************************************** - -**Retrieves information about the cluster corresponding to cluster.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Retrieves information about the cluster corresponding to cluster. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster - -
- string -
- 		- -
Identifier of the cluster.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_cluster_info. Required with state=['get']
-
-
- clusters - -
- list - / elements=string -
- 		- -
Identifiers of clusters that can match the filter.
-
If unset or empty, clusters with any identifier match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_cluster_info.
-
-
- datacenters - -
- list - / elements=string -
- 		- -
Datacenters that must contain the cluster for the cluster to match the filter.
-
If unset or empty, clusters in any datacenter match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_datacenter_info.
-

aliases: filter_datacenters
-
-
- folders - -
- list - / elements=string -
- 		- -
Folders that must contain the cluster for the cluster to match the filter.
-
If unset or empty, clusters in any folder match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_folder_info.
-

aliases: filter_folders
-
-
- names - -
- list - / elements=string -
- 		- -
Names that clusters must have to match the filter (see name).
-
If unset or empty, clusters with any name match the filter.
-

aliases: filter_names
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Build a list of all the clusters - vmware.vmware_rest.vcenter_cluster_info: - register: all_the_clusters - - - name: Retrieve details about the first cluster - vmware.vmware_rest.vcenter_cluster_info: - cluster: '{{ all_the_clusters.value[0].cluster }}' - register: my_cluster_info - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
domain-c1006
-
-
- value - -
- dictionary -
- 		On success -
Retrieve details about the first cluster
-
-
Sample:
-
{'name': 'my_cluster', 'resource_pool': 'resgroup-1007'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_datacenter_info_module.rst b/docs/vmware.vmware_rest.vcenter_datacenter_info_module.rst deleted file mode 100644 index fc896abe1..000000000 --- a/docs/vmware.vmware_rest.vcenter_datacenter_info_module.rst +++ /dev/null @@ -1,291 +0,0 @@ -.. _vmware.vmware_rest.vcenter_datacenter_info_module: - - -****************************************** -vmware.vmware_rest.vcenter_datacenter_info -****************************************** - -**Retrieves information about the datacenter corresponding to datacenter.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Retrieves information about the datacenter corresponding to datacenter. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- datacenter - -
- string -
- 		- -
Identifier of the datacenter.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_datacenter_info. Required with state=['get']
-
-
- datacenters - -
- list - / elements=string -
- 		- -
Identifiers of datacenters that can match the filter.
-
If unset or empty, datacenters with any identifier match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_datacenter_info.
-

aliases: filter_datacenters
-
-
- folders - -
- list - / elements=string -
- 		- -
Folders that must contain the datacenters for the datacenter to match the filter.
-
If unset or empty, datacenters in any folder match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_folder_info.
-

aliases: filter_folders
-
-
- names - -
- list - / elements=string -
- 		- -
Names that datacenters must have to match the filter (see name).
-
If unset or empty, datacenters with any name match the filter.
-

aliases: filter_names
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get a list of all the datacenters - register: existing_datacenters - vmware.vmware_rest.vcenter_datacenter_info: - - - name: collect a list of the datacenters - vmware.vmware_rest.vcenter_datacenter_info: - register: my_datacenters - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
collect a list of the datacenters
-
-
Sample:
-
[{'datacenter': 'datacenter-1001', 'name': 'my_dc'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_datacenter_module.rst b/docs/vmware.vmware_rest.vcenter_datacenter_module.rst deleted file mode 100644 index 68c9d7bac..000000000 --- a/docs/vmware.vmware_rest.vcenter_datacenter_module.rst +++ /dev/null @@ -1,331 +0,0 @@ -.. _vmware.vmware_rest.vcenter_datacenter_module: - - -************************************* -vmware.vmware_rest.vcenter_datacenter -************************************* - -**Create a new datacenter in the vCenter inventory** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Create a new datacenter in the vCenter inventory - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- datacenter - -
- string -
- 		- -
Identifier of the datacenter to be deleted.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_datacenter_info. Required with state=['absent']
-
-
- folder - -
- string -
- 		- -
Datacenter folder in which the new datacenter should be created.
-
This field is currently required. In the future, if this field is unset, the system will attempt to choose a suitable folder for the datacenter; if a folder cannot be chosen, the datacenter creation operation will fail.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_folder_info.
-
-
- force - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
If true, delete the datacenter even if it is not empty.
-
If unset a ResourceInUse error will be reported if the datacenter is not empty. This is the equivalent of passing the value false.
-
-
- name - -
- string -
- 		- -
The name of the datacenter to be created. Required with state=['present']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get a list of all the datacenters - register: existing_datacenters - vmware.vmware_rest.vcenter_datacenter_info: - - name: Force delete the existing DC - vmware.vmware_rest.vcenter_datacenter: - state: absent - datacenter: '{{ item.datacenter }}' - force: true - with_items: '{{ existing_datacenters.value }}' - until: - - _result is not failed - retries: 7 - - name: Create datacenter my_dc - vmware.vmware_rest.vcenter_datacenter: - name: my_dc - folder: '{{ my_datacenter_folder.folder }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		On success -
Force delete the existing DC
-
-
Sample:
-
All items completed
-
-
- results - -
- list -
- 		On success -
Force delete the existing DC
-
-
Sample:
-
[{'_ansible_item_label': {'datacenter': 'datacenter-1001', 'name': 'my_dc'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'attempts': 1, 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'datacenter': 'datacenter-1001', 'folder': None, 'force': 1, 'name': None, 'session_timeout': None, 'state': 'absent', 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0}}, 'item': {'datacenter': 'datacenter-1001', 'name': 'my_dc'}, 'value': {}}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst b/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst deleted file mode 100644 index 4fa040e6c..000000000 --- a/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst +++ /dev/null @@ -1,323 +0,0 @@ -.. _vmware.vmware_rest.vcenter_datastore_info_module: - - -***************************************** -vmware.vmware_rest.vcenter_datastore_info -***************************************** - -**Retrieves information about the datastore indicated by datastore.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Retrieves information about the datastore indicated by datastore. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- datacenters - -
- list - / elements=string -
- 		- -
Datacenters that must contain the datastore for the datastore to match the filter.
-
If unset or empty, datastores in any datacenter match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_datacenter_info.
-

aliases: filter_datacenters
-
-
- datastore - -
- string -
- 		- -
Identifier of the datastore for which information should be retrieved.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_datastore_info. Required with state=['get']
-
-
- datastores - -
- list - / elements=string -
- 		- -
Identifiers of datastores that can match the filter.
-
If unset or empty, datastores with any identifier match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_datastore_info.
-
-
- folders - -
- list - / elements=string -
- 		- -
Folders that must contain the datastore for the datastore to match the filter.
-
If unset or empty, datastores in any folder match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_folder_info.
-

aliases: filter_folders
-
-
- names - -
- list - / elements=string -
- 		- -
Names that datastores must have to match the filter (see name).
-
If unset or empty, datastores with any name match the filter.
-

aliases: filter_names
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- types - -
- list - / elements=string -
- 		- -
Types that datastores must have to match the filter (see type).
-
If unset or empty, datastores with any type match the filter.
-

aliases: filter_types
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Build a list of all the datastores - vmware.vmware_rest.vcenter_datastore_info: - register: all_the_datastores - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Build a list of all the datastores
-
-
Sample:
-
[{'capacity': 11542724608, 'datastore': 'datastore-1015', 'free_space': 10033823744, 'name': 'local', 'type': 'VMFS'}, {'capacity': 42314215424, 'datastore': 'datastore-1017', 'free_space': 40374927360, 'name': 'ro_datastore', 'type': 'NFS'}, {'capacity': 42314215424, 'datastore': 'datastore-1019', 'free_space': 40374927360, 'name': 'rw_datastore', 'type': 'NFS'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_folder_info_module.rst b/docs/vmware.vmware_rest.vcenter_folder_info_module.rst deleted file mode 100644 index 99bcff22a..000000000 --- a/docs/vmware.vmware_rest.vcenter_folder_info_module.rst +++ /dev/null @@ -1,319 +0,0 @@ -.. _vmware.vmware_rest.vcenter_folder_info_module: - - -************************************** -vmware.vmware_rest.vcenter_folder_info -************************************** - -**Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- datacenters - -
- list - / elements=string -
- 		- -
Datacenters that must contain the folder for the folder to match the filter.
-
If unset or empty, folder in any datacenter match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_datacenter_info.
-

aliases: filter_datacenters
-
-
- folders - -
- list - / elements=string -
- 		- -
Identifiers of folders that can match the filter.
-
If unset or empty, folders with any identifier match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_folder_info.
-

aliases: filter_folders
-
-
- names - -
- list - / elements=string -
- 		- -
Names that folders must have to match the filter (see name).
-
If unset or empty, folders with any name match the filter.
-

aliases: filter_names
-
-
- parent_folders - -
- list - / elements=string -
- 		- -
Folders that must contain the folder for the folder to match the filter.
-
If unset or empty, folder in any folder match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_folder_info.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- type - -
- string -
- 		-
    Choices: -
  • DATACENTER
    • -
  • DATASTORE
    • -
  • HOST
    • -
  • NETWORK
    • -
  • VIRTUAL_MACHINE
    • -
- 		-
The type enumerated type defines the type of a vCenter Server folder. The type of a folder determines what what kinds of children can be contained in the folder.
-

aliases: filter_type
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Build a list of all the folders - vmware.vmware_rest.vcenter_folder_info: - register: my_folders - - - 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 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Build a list of all the folders with the type VIRTUAL_MACHINE and called vm
-
-
Sample:
-
[{'folder': 'group-v1002', 'name': 'vm', 'type': 'VIRTUAL_MACHINE'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_host_info_module.rst b/docs/vmware.vmware_rest.vcenter_host_info_module.rst deleted file mode 100644 index cf4a17c78..000000000 --- a/docs/vmware.vmware_rest.vcenter_host_info_module.rst +++ /dev/null @@ -1,344 +0,0 @@ -.. _vmware.vmware_rest.vcenter_host_info_module: - - -************************************ -vmware.vmware_rest.vcenter_host_info -************************************ - -**Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- clusters - -
- list - / elements=string -
- 		- -
Clusters that must contain the hosts for the hosts to match the filter.
-
If unset or empty, hosts in any cluster and hosts that are not in a cluster match the filter. If this field is not empty and standalone is true, no hosts will match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_cluster_info.
-
-
- connection_states - -
- list - / elements=string -
- 		- -
Connection states that a host must be in to match the filter (see I()
-
If unset or empty, hosts in any connection state match the filter.
-
-
- datacenters - -
- list - / elements=string -
- 		- -
Datacenters that must contain the hosts for the hosts to match the filter.
-
If unset or empty, hosts in any datacenter match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_datacenter_info.
-

aliases: filter_datacenters
-
-
- folders - -
- list - / elements=string -
- 		- -
Folders that must contain the hosts for the hosts to match the filter.
-
If unset or empty, hosts in any folder match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_folder_info.
-

aliases: filter_folders
-
-
- hosts - -
- list - / elements=string -
- 		- -
Identifiers of hosts that can match the filter.
-
If unset or empty, hosts with any identifier match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_host_info.
-
-
- names - -
- list - / elements=string -
- 		- -
Names that hosts must have to match the filter (see name).
-
If unset or empty, hosts with any name match the filter.
-

aliases: filter_names
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- standalone - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
If true, only hosts that are not part of a cluster can match the filter, and if false, only hosts that are are part of a cluster can match the filter.
-
If unset Hosts can match filter independent of whether they are part of a cluster or not. If this field is true and clusters os not empty, no hosts will match the filter.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get a list of the hosts - vmware.vmware_rest.vcenter_host_info: - register: my_hosts - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Get a list of the hosts
-
-
Sample:
-
[{'connection_state': 'CONNECTED', 'host': 'host-1013', 'name': 'esxi1.test', 'power_state': 'POWERED_ON'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_host_module.rst b/docs/vmware.vmware_rest.vcenter_host_module.rst deleted file mode 100644 index e03c304aa..000000000 --- a/docs/vmware.vmware_rest.vcenter_host_module.rst +++ /dev/null @@ -1,388 +0,0 @@ -.. _vmware.vmware_rest.vcenter_host_module: - - -******************************* -vmware.vmware_rest.vcenter_host -******************************* - -**Add a new standalone host in the vCenter inventory** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Add a new standalone host in the vCenter inventory. The newly connected host will be in connected state. The vCenter Server will verify the SSL certificate before adding the host to its inventory. In the case where the SSL certificate cannot be verified because the Certificate Authority is not recognized or the certificate is self signed, the vCenter Server will fall back to thumbprint verification mode as defined by Host.CreateSpec.ThumbprintVerification. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- folder - -
- string -
- 		- -
Host and cluster folder in which the new standalone host should be created.
-
This field is currently required. In the future, if this field is unset, the system will attempt to choose a suitable folder for the host; if a folder cannot be chosen, the host creation operation will fail.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_folder_info.
-
-
- force_add - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Whether host should be added to the vCenter Server even if it is being managed by another vCenter Server. The original vCenterServer loses connection to the host.
-
If unset, forceAdd is default to false.
-
-
- host - -
- string -
- 		- -
Identifier of the host to be disconnected.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_host_info. Required with state=['absent', 'connect', 'disconnect']
-
-
- hostname - -
- string -
- 		- -
The IP address or DNS resolvable name of the host. Required with state=['present']
-
-
- password - -
- string -
- 		- -
The password for the administrator account on the host. Required with state=['present']
-
-
- port - -
- integer -
- 		- -
The port of the host.
-
If unset, port 443 will be used.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • connect
    • -
  • disconnect
    • -
  • present ←
    • -
- 		-
-
- thumbprint - -
- string -
- 		- -
The thumbprint of the SSL certificate, which the host is expected to have. The thumbprint is always computed using the SHA1 hash and is the string representation of that hash in the format: xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx where, 'x' represents a hexadecimal digit.
-
This field is optional and it is only relevant when the value of thumbprint_verification is THUMBPRINT.
-
-
- thumbprint_verification - -
- string -
- 		-
    Choices: -
  • NONE
    • -
  • THUMBPRINT
    • -
- 		-
The thumbprint_verification enumerated type defines the thumbprint verification schemes for a host's SSL certificate. Required with state=['present']
-
-
- user_name - -
- string -
- 		- -
The administrator account on the host. Required with state=['present']
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Connect the host(s) - vmware.vmware_rest.vcenter_host: - hostname: "{{ lookup('env', 'ESXI1_HOSTNAME') }}" - user_name: "{{ lookup('env', 'ESXI1_USERNAME') }}" - password: "{{ lookup('env', 'ESXI1_PASSWORD') }}" - thumbprint_verification: NONE - folder: '{{ my_host_folder.folder }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- string -
- 		On success -
Connect the host(s)
-
-
Sample:
-
host-1013
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_network_info_module.rst b/docs/vmware.vmware_rest.vcenter_network_info_module.rst deleted file mode 100644 index edf435da0..000000000 --- a/docs/vmware.vmware_rest.vcenter_network_info_module.rst +++ /dev/null @@ -1,309 +0,0 @@ -.. _vmware.vmware_rest.vcenter_network_info_module: - - -*************************************** -vmware.vmware_rest.vcenter_network_info -*************************************** - -**Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- datacenters - -
- list - / elements=string -
- 		- -
Datacenters that must contain the network for the network to match the filter.
-
If unset or empty, networks in any datacenter match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_datacenter_info.
-

aliases: filter_datacenters
-
-
- folders - -
- list - / elements=string -
- 		- -
Folders that must contain the network for the network to match the filter.
-
If unset or empty, networks in any folder match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_folder_info.
-

aliases: filter_folders
-
-
- names - -
- list - / elements=string -
- 		- -
Names that networks must have to match the filter (see name).
-
If unset or empty, networks with any name match the filter.
-

aliases: filter_names
-
-
- networks - -
- list - / elements=string -
- 		- -
Identifiers of networks that can match the filter.
-
If unset or empty, networks with any identifier match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_network_info.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- types - -
- list - / elements=string -
- 		- -
Types that networks must have to match the filter (see type).
-
If unset, networks with any type match the filter.
-

aliases: filter_types
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the dvswitch called my-portgroup - vmware.vmware_rest.vcenter_network_info: - filter_types: DISTRIBUTED_PORTGROUP - filter_names: my portrgoup - register: my_portgroup - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Get a list of the networks
-
-
Sample:
-
[{'name': 'VM Network', 'network': 'network-1016', 'type': 'STANDARD_PORTGROUP'}, {'name': 'second_vswitch', 'network': 'network-1018', 'type': 'STANDARD_PORTGROUP'}, {'name': 'dvswitch1-DVUplinks-1020', 'network': 'dvportgroup-1021', 'type': 'DISTRIBUTED_PORTGROUP'}, {'name': 'my portrgoup', 'network': 'dvportgroup-1022', 'type': 'DISTRIBUTED_PORTGROUP'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_ovf_libraryitem_module.rst b/docs/vmware.vmware_rest.vcenter_ovf_libraryitem_module.rst deleted file mode 100644 index 76f36b677..000000000 --- a/docs/vmware.vmware_rest.vcenter_ovf_libraryitem_module.rst +++ /dev/null @@ -1,426 +0,0 @@ -.. _vmware.vmware_rest.vcenter_ovf_libraryitem_module: - - -****************************************** -vmware.vmware_rest.vcenter_ovf_libraryitem -****************************************** - -**Creates a library item in content library from a virtual machine or virtual appliance** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Creates a library item in content library from a virtual machine or virtual appliance.

This {@term operation} creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this {@term operation}, the original content is overwritten. Meta data such as name and description is not updated for the exisitng library item.

- - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- client_token - -
- string -
- 		- -
Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried.
-
-
- create_spec - -
- dictionary -
- 		- -
Information used to create the OVF package from the source virtual machine or virtual appliance. Required with state=['present']
-
Valid attributes are:
-
- name (str): Name to use in the OVF descriptor stored in the library item. (['present'])
-
- description (str): Description to use in the OVF descriptor stored in the library item. (['present'])
-
- flags (list): Flags to use for OVF package creation. The supported flags can be obtained using {@link ExportFlag#list}. (['present'])
-
-
- deployment_spec - -
- dictionary -
- 		- -
Specification of how the OVF package should be deployed to the target. Required with state=['deploy']
-
Valid attributes are:
-
- name (str): Name assigned to the deployed target virtual machine or virtual appliance. (['deploy'])
-
- annotation (str): Annotation assigned to the deployed target virtual machine or virtual appliance. (['deploy'])
-
- accept_all_EULA (bool): Whether to accept all End User License Agreements. (['deploy'])
-
This key is required with ['deploy'].
-
- network_mappings (dict): Specification of the target network to use for sections of type ovf:NetworkSection in the OVF descriptor. The key in the {@term map} is the section identifier of the ovf:NetworkSection section in the OVF descriptor and the value is the target network to be used for deployment. (['deploy'])
-
- storage_mappings (dict): Specification of the target storage to use for sections of type vmw:StorageGroupSection in the OVF descriptor. The key in the {@term map} is the section identifier of the ovf:StorageGroupSection section in the OVF descriptor and the value is the target storage specification to be used for deployment. (['deploy'])
-
- storage_provisioning (str): The disk_provisioning_type defines the virtual disk provisioning types that can be set for a disk on the target platform. (['deploy'])
-
- Accepted values:
-
- eagerZeroedThick
-
- thick
-
- thin
-
- storage_profile_id (str): Default storage profile to use for all sections of type vmw:StorageSection in the OVF descriptor. (['deploy'])
-
- locale (str): The locale to use for parsing the OVF descriptor. (['deploy'])
-
- flags (list): Flags to be use for deployment. The supported flag values can be obtained using {@link ImportFlag#list}. (['deploy'])
-
- additional_parameters (list): Additional OVF parameters that may be needed for the deployment. Additional OVF parameters may be required by the OVF descriptor of the OVF package in the library item. Examples of OVF parameters that can be specified through this field include, but are not limited to: <ul> <li>{@link DeploymentOptionParams}</li> <li>{@link ExtraConfigParams}</li> <li>{@link IpAllocationParams}</li> <li>{@link PropertyParams}</li> <li>{@link ScaleOutParams}</li> <li>{@link VcenterExtensionParams}</li> </ul> (['deploy'])
-
- default_datastore_id (str): Default datastore to use for all sections of type vmw:StorageSection in the OVF descriptor. (['deploy'])
-
-
- ovf_library_item_id - -
- string -
- 		- -
Identifier of the content library item containing the OVF package to be deployed. Required with state=['deploy', 'filter']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- source - -
- dictionary -
- 		- -
Identifier of the virtual machine or virtual appliance to use as the source. Required with state=['present']
-
Valid attributes are:
-
- type (str): Type of the deployable resource. (['present'])
-
This key is required with ['present'].
-
- id (str): Identifier of the deployable resource. (['present'])
-
This key is required with ['present'].
-
-
- state - -
- string -
- 		-
    Choices: -
  • deploy
    • -
  • filter
    • -
  • present ←
    • -
- 		-
-
- target - -
- dictionary - / required -
- 		- -
Specification of the target content library and library item. This parameter is mandatory.
-
Valid attributes are:
-
- library_id (str): Identifier of the library in which a new library item should be created. This field is not used if the #library_item_id field is specified. (['present'])
-
- library_item_id (str): Identifier of the library item that should be should be updated. (['present'])
-
- resource_pool_id (str): Identifier of the resource pool to which the virtual machine or virtual appliance should be attached. (['deploy', 'filter'])
-
This key is required with ['deploy', 'filter'].
-
- host_id (str): Identifier of the target host on which the virtual machine or virtual appliance will run. The target host must be a member of the cluster that contains the resource pool identified by {@link #resourcePoolId}. (['deploy', 'filter'])
-
- folder_id (str): Identifier of the vCenter folder that should contain the virtual machine or virtual appliance. The folder must be virtual machine folder. (['deploy', 'filter'])
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - name: test_vm1 - guest_OS: RHEL_7_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - register: my_vm - - - name: Create a content library pointing on a NFS share - vmware.vmware_rest.content_locallibrary: - name: my_library_on_nfs - description: automated - publish_info: - published: true - authentication_method: NONE - storage_backings: - - storage_uri: nfs://datastore.test/srv/share/content-library - type: OTHER - state: present - register: nfs_lib - - - name: Export the VM as an OVF on the library - vmware.vmware_rest.vcenter_ovf_libraryitem: - session_timeout: 2900 - source: - type: VirtualMachine - id: '{{ my_vm.id }}' - target: - library_id: '{{ nfs_lib.id }}' - create_spec: - name: golden_image - description: an OVF example - flags: [] - state: present - register: ovf_item - - - name: Get the list of items of the NFS library - vmware.vmware_rest.content_library_item_info: - library_id: '{{ nfs_lib.id }}' - register: lib_items - - - name: Create a new VM from the OVF - vmware.vmware_rest.vcenter_ovf_libraryitem: - ovf_library_item_id: '{{ (lib_items.value|selectattr("name", "equalto", "golden_image")|first).id }}' - state: deploy - target: - resource_pool_id: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - deployment_spec: - name: my_vm_from_ovf - accept_all_EULA: true - storage_provisioning: thin - - - name: Create a new VM from the OVF and specify the host and folder - vmware.vmware_rest.vcenter_ovf_libraryitem: - ovf_library_item_id: '{{ (lib_items.value|selectattr("name", "equalto", "golden_image")|first).id }}' - state: deploy - target: - resource_pool_id: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - folder_id: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - host_id: "{{ lookup('vmware.vmware_rest.host_moid', '/my_dc/host/my_cluster/esxi1.test/test_vm1') }}" - deployment_spec: - name: my_vm_from_ovf_on_a_host - accept_all_EULA: true - storage_provisioning: thin - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Create a new VM from the OVF and specify the host and folder
-
-
Sample:
-
{'error': {'errors': [], 'information': [], 'warnings': []}, 'resource_id': {'id': 'vm-1078', 'type': 'VirtualMachine'}, 'succeeded': 1}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_resourcepool_info_module.rst b/docs/vmware.vmware_rest.vcenter_resourcepool_info_module.rst deleted file mode 100644 index c2a833d59..000000000 --- a/docs/vmware.vmware_rest.vcenter_resourcepool_info_module.rst +++ /dev/null @@ -1,370 +0,0 @@ -.. _vmware.vmware_rest.vcenter_resourcepool_info_module: - - -******************************************** -vmware.vmware_rest.vcenter_resourcepool_info -******************************************** - -**Retrieves information about the resource pool indicated by resourcePool.** - - -Version added: 0.3.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Retrieves information about the resource pool indicated by resourcePool. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- clusters - -
- list - / elements=string -
- 		- -
Clusters that must contain the resource pool for the resource pool to match the filter.
-
If unset or empty, resource pools in any cluster match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_cluster_info.
-
-
- datacenters - -
- list - / elements=string -
- 		- -
Datacenters that must contain the resource pool for the resource pool to match the filter.
-
If unset or empty, resource pools in any datacenter match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_datacenter_info.
-

aliases: filter_datacenters
-
-
- hosts - -
- list - / elements=string -
- 		- -
Hosts that must contain the resource pool for the resource pool to match the filter.
-
If unset or empty, resource pools in any host match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_host_info.
-
-
- names - -
- list - / elements=string -
- 		- -
Names that resource pools must have to match the filter (see name).
-
If unset or empty, resource pools with any name match the filter.
-

aliases: filter_names
-
-
- parent_resource_pools - -
- list - / elements=string -
- 		- -
Resource pools that must contain the resource pool for the resource pool to match the filter.
-
If unset or empty, resource pools in any resource pool match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_resourcepool_info.
-
-
- resource_pool - -
- string -
- 		- -
Identifier of the resource pool for which information should be retrieved.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_resourcepool_info. Required with state=['get']
-
-
- resource_pools - -
- list - / elements=string -
- 		- -
Identifiers of resource pools that can match the filter.
-
If unset or empty, resource pools with any identifier match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_resourcepool_info.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the existing resource pools - vmware.vmware_rest.vcenter_resourcepool_info: - register: resource_pools - - name: Get the existing resource pool - vmware.vmware_rest.vcenter_resourcepool_info: - resource_pool: '{{ resource_pools.value[0].resource_pool }}' - register: my_resource_pool - - name: Create a generic resource pool - vmware.vmware_rest.vcenter_resourcepool: - name: my_resource_pool - parent: '{{ resource_pools.value[0].resource_pool }}' - register: my_resource_pool - - name: Read details from a specific resource pool - vmware.vmware_rest.vcenter_resourcepool_info: - resource_pool: '{{ my_resource_pool.id }}' - register: my_resource_pool - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
resgroup-1009
-
-
- value - -
- dictionary -
- 		On success -
Read details from a specific resource pool
-
-
Sample:
-
{'cpu_allocation': {'expandable_reservation': 1, 'limit': -1, 'reservation': 0, 'shares': {'level': 'NORMAL'}}, 'memory_allocation': {'expandable_reservation': 0, 'limit': 1000, 'reservation': 0, 'shares': {'level': 'NORMAL'}}, 'name': 'my_resource_pool', 'resource_pools': []}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_resourcepool_module.rst b/docs/vmware.vmware_rest.vcenter_resourcepool_module.rst deleted file mode 100644 index 6383e31ee..000000000 --- a/docs/vmware.vmware_rest.vcenter_resourcepool_module.rst +++ /dev/null @@ -1,409 +0,0 @@ -.. _vmware.vmware_rest.vcenter_resourcepool_module: - - -*************************************** -vmware.vmware_rest.vcenter_resourcepool -*************************************** - -**Creates a resource pool.** - - -Version added: 0.3.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Creates a resource pool. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cpu_allocation - -
- dictionary -
- 		- -
Resource allocation for CPU.
-
if unset or empty, the CPU allocation of the resource pool will not be changed.
-
Valid attributes are:
-
- reservation (int): Amount of resource that is guaranteed available to a resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB fo memory, and MHz for CPU.
-
If unset or empty, reservation will be set to 0. (['present'])
-
- expandable_reservation (bool): In a resource pool with an expandable reservation, the reservation can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation.
-
If unset or empty, expandable_reservation will be set to true. (['present'])
-
- limit (int): The utilization of a resource pool will not exceed this limit, even if there are available resources. This is typically used to ensure a consistent performance of resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB for memory, and MHz for CPU.
-
If unset or empty, limit will be set to -1. (['present'])
-
- shares (dict): Shares are used in case of resource contention. (['present'])
-
- Accepted keys:
-
- level (string): This option defines the possible values for the allocation level.
-
Accepted value for this field:
-
- CUSTOM
-
- HIGH
-
- LOW
-
- NORMAL
-
- shares (integer): When level is set to CUSTOM, it is the number of shares allocated. Otherwise, this value is ignored.
-
There is no unit for this value. It is a relative measure based on the settings for other resource pools.
-
-
This field is optional and it is only relevant when the value of level is CUSTOM.
-
-
- memory_allocation - -
- dictionary -
- 		- -
Resource allocation for CPU.
-
if unset or empty, the CPU allocation of the resource pool will not be changed.
-
Valid attributes are:
-
- reservation (int): Amount of resource that is guaranteed available to a resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB fo memory, and MHz for CPU.
-
If unset or empty, reservation will be set to 0. (['present'])
-
- expandable_reservation (bool): In a resource pool with an expandable reservation, the reservation can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation.
-
If unset or empty, expandable_reservation will be set to true. (['present'])
-
- limit (int): The utilization of a resource pool will not exceed this limit, even if there are available resources. This is typically used to ensure a consistent performance of resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB for memory, and MHz for CPU.
-
If unset or empty, limit will be set to -1. (['present'])
-
- shares (dict): Shares are used in case of resource contention. (['present'])
-
- Accepted keys:
-
- level (string): This option defines the possible values for the allocation level.
-
Accepted value for this field:
-
- CUSTOM
-
- HIGH
-
- LOW
-
- NORMAL
-
- shares (integer): When level is set to CUSTOM, it is the number of shares allocated. Otherwise, this value is ignored.
-
There is no unit for this value. It is a relative measure based on the settings for other resource pools.
-
-
This field is optional and it is only relevant when the value of level is CUSTOM.
-
-
- name - -
- string -
- 		- -
Name of the resource pool.
-
if unset or empty, the name of the resource pool will not be changed. Required with state=['present']
-
-
- parent - -
- string -
- 		- -
Parent of the created resource pool.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_resourcepool_info. Required with state=['present']
-
-
- resource_pool - -
- string -
- 		- -
Identifier of the resource pool to be deleted.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_resourcepool_info. Required with state=['absent', 'present']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the existing resource pools - vmware.vmware_rest.vcenter_resourcepool_info: - register: resource_pools - - name: Create an Ad hoc resource pool - vmware.vmware_rest.vcenter_resourcepool: - name: my_resource_pool - parent: '{{ resource_pools.value[0].resource_pool }}' - cpu_allocation: - expandable_reservation: true - limit: 40 - reservation: 0 - shares: - level: NORMAL - memory_allocation: - expandable_reservation: false - limit: 2000 - reservation: 0 - shares: - level: NORMAL - register: my_resource_pool - - name: Remove a resource pool - vmware.vmware_rest.vcenter_resourcepool: - resource_pool: '{{ my_resource_pool.id }}' - state: absent - - name: Create a generic resource pool - vmware.vmware_rest.vcenter_resourcepool: - name: my_resource_pool - parent: '{{ resource_pools.value[0].resource_pool }}' - register: my_resource_pool - - name: Modify a resource pool - vmware.vmware_rest.vcenter_resourcepool: - resource_pool: '{{ my_resource_pool.id }}' - cpu_allocation: - expandable_reservation: true - limit: -1 - reservation: 0 - shares: - level: NORMAL - memory_allocation: - expandable_reservation: false - limit: 1000 - reservation: 0 - shares: - level: NORMAL - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
resgroup-1009
-
-
- value - -
- dictionary -
- 		On success -
Create a generic resource pool
-
-
Sample:
-
{'cpu_allocation': {'expandable_reservation': 1, 'limit': -1, 'reservation': 0, 'shares': {'level': 'NORMAL'}}, 'memory_allocation': {'expandable_reservation': 1, 'limit': -1, 'reservation': 0, 'shares': {'level': 'NORMAL'}}, 'name': 'my_resource_pool', 'resource_pools': []}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_storage_policies_info_module.rst b/docs/vmware.vmware_rest.vcenter_storage_policies_info_module.rst deleted file mode 100644 index 59c953224..000000000 --- a/docs/vmware.vmware_rest.vcenter_storage_policies_info_module.rst +++ /dev/null @@ -1,233 +0,0 @@ -.. _vmware.vmware_rest.vcenter_storage_policies_info_module: - - -************************************************ -vmware.vmware_rest.vcenter_storage_policies_info -************************************************ - -**Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter** - - -Version added: 0.3.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter. These storage policies can be used for provisioning virtual machines or disks. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- policies - -
- list - / elements=string -
- 		- -
Identifiers of storage policies that can match the filter.
-
If unset or empty, storage policies with any identifiers match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_storage_policies.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: List existing storage policies - vmware.vmware_rest.vcenter_storage_policies_info: - register: storage_policies - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
List existing storage policies
-
-
Sample:
-
[{'description': 'Management Storage policy used for VMC large cluster', 'name': 'Management Storage Policy - Large', 'policy': 'cd8f7c94-3e11-67fc-17f5-4e96d91a5beb'}, {'description': 'Allow the datastore to determine the best placement strategy for storage objects', 'name': 'VVol No Requirements Policy', 'policy': 'f4e5bade-15a2-4805-bf8e-52318c4ce443'}, {'description': 'Management Storage policy used for smaller VMC Stretched Cluster configuration.', 'name': 'Management Storage Policy - Stretched Lite', 'policy': 'd109de24-c966-428f-8da2-d281e6671e35'}, {'description': "Sample storage policy for VMware's VM and virtual disk encryption", 'name': 'VM Encryption Policy', 'policy': '4d5f673c-536f-11e6-beb8-9e71128cae77'}, {'description': 'Management Storage policy used for encrypting VM', 'name': 'Management Storage policy - Encryption', 'policy': 'b1263970-8662-69e2-adc6-fa8ae01abecc'}, {'description': 'Management Storage policy used for VMC single node cluster', 'name': 'Management Storage Policy - Single Node', 'policy': 'a9423670-7455-11e8-adc0-fa7ae01bbebc'}, {'description': 'Storage policy used as default for Host-local PMem datastores', 'name': 'Host-local PMem Default Storage Policy', 'policy': 'c268da1b-b343-49f7-a468-b1deeb7078e0'}, {'description': 'Storage policy used as default for vSAN datastores', 'name': 'vSAN Default Storage Policy', 'policy': 'aa6d5a82-1c88-45da-85d3-3d74b91a5bad'}, {'description': 'Management Storage policy used for VMC regular cluster', 'name': 'Management Storage Policy - Regular', 'policy': 'bb7e6b13-2d99-46eb-96e4-3d85c91a5bde'}, {'description': 'Management Storage policy used for VMC regular cluster which requires THIN provisioning', 'name': 'Management Storage policy - Thin', 'policy': 'b6423670-8552-66e8-adc1-fa6ae01abeac'}, {'description': 'Management Storage policy used for VMC stretched cluster', 'name': 'Management Storage Policy - Stretched', 'policy': 'f31f2442-8247-4517-87c2-8d69d7a6c696'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_customization_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_customization_module.rst deleted file mode 100644 index 65b62d24d..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_customization_module.rst +++ /dev/null @@ -1,378 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_guest_customization_module: - - -************************************************* -vmware.vmware_rest.vcenter_vm_guest_customization -************************************************* - -**Applies a customization specification on the virtual machine** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Applies a customization specification on the virtual machine in {@param.name vm}. The actual customization happens inside the guest when the virtual machine is powered on. If there is a pending customization for the virtual machine and a new one is set, then the existing customization setting will be overwritten with the new settings. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- configuration_spec - -
- dictionary - / required -
- 		- -
Settings to be applied to the guest during the customization. This parameter is mandatory.
-
Valid attributes are:
-
- windows_config (dict): Guest customization specification for a Windows guest operating system
-
If unset, ConfigurationSpec.linux-config or ConfigurationSpec.cloud-config must be set. Otherwise, an appropriate fault will be thrown. (['set'])
-
- Accepted keys:
-
- reboot (string): This option specifies what should be done to the guest after the customization.
-
Accepted value for this field:
-
- NO_REBOOT
-
- REBOOT
-
- SHUTDOWN
-
- sysprep (object): Customization settings like user details, administrator details, etc for the windows guest operating system. Exactly one of WindowsConfiguration.sysprep or WindowsConfiguration.sysprep-xml must be specified.
-
If unset, sysprep settings will not be applied to the windows guest operating system.
-
- sysprep_xml (string): All settings specified in a XML format. This is the content of a typical answer.xml file that is used by System administrators during the Windows image customization. Check https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/update-windows-settings-and-scripts-create-your-own-answer-file-sxs Exactly one of WindowsConfiguration.sysprep or WindowsConfiguration.sysprep-xml must be specified.
-
If unset, sysprep settings will not be applied to the windows guest operating system.
-
- linux_config (dict): Guest customization specification for a linux guest operating system
-
If unset, ConfigurationSpec.windows-config or ConfigurationSpec.cloud-config must be set. Otherwise, an appropriate fault will be thrown. (['set'])
-
- Accepted keys:
-
- hostname (object): The computer name of the (Windows) virtual machine. A computer name may contain letters (A-Z), numbers(0-9) and hyphens (-) but no spaces or periods (.). The name may not consist entirely of digits. A computer name is restricted to 15 characters in length. If the computer name is longer than 15 characters, it will be truncated to 15 characters. Check HostnameGenerator for various options.
-
- domain (string): The fully qualified domain name.
-
- time_zone (string): The case-sensitive time zone, such as Europe/Sofia. Valid time zone values are based on the tz (time zone) database used by Linux. The values are strings (string) in the form "Area/Location," in which Area is a continent or ocean name, and Location is the city, island, or other regional designation.
-
See the https://kb.vmware.com/kb/2145518 for a list of supported time zones for different versions in Linux.
-
-
If unset, time zone is not modified inside guest operating system.
-
- script_text (string): The script to run before and after Linux guest customization.
-
The max size of the script is 1500 bytes. As long as the script (shell, perl, python...) has the right "#!" in the header, it is supported. The caller should not assume any environment variables when the script is run.
-
The script is invoked by the customization engine using the command line: 1) with argument "precustomization" before customization, 2) with argument "postcustomization" after customization. The script should parse this argument and implement pre-customization or post-customization task code details in the corresponding block.
-
-
A Linux shell script example:
-
-
#!/bin/sh
-
if [ x$1 == x"precustomization" ]; then
-
echo "Do Precustomization tasks"
-
#code for pre-customization actions...
-
elif [ x$1 == x"postcustomization" ]; then
-
echo "Do Postcustomization tasks"
-
#code for post-customization actions...
-
fi
-
-
-
If unset, no script will be executed.
-
- cloud_config (dict): Guest customization specification with cloud configuration.
-
If unset, ConfigurationSpec.windows-config or ConfigurationSpec.linux-config must be set. Otherwise, an appropriate fault will be thrown. (['set'])
-
- Accepted keys:
-
- type (string): This option specifies different types of the cloud configuration.
-
Accepted value for this field:
-
- CLOUDINIT
-
- cloudinit (object): cloud-init configuration
-
This field is optional and it is only relevant when the value of CloudConfiguration.type is CLOUDINIT.
-
-
- global_DNS_settings - -
- dictionary - / required -
- 		- -
Global DNS settings constitute the DNS settings that are not specific to a particular virtual network adapter. This parameter is mandatory.
-
Valid attributes are:
-
- dns_suffix_list (list): List of name resolution suffixes for the virtual network adapter. This list applies to both Windows and Linux guest customization. For Linux, this setting is global, whereas in Windows, this setting is listed on a per-adapter basis.
-
If unset, no DNS suffixes are set. (['set'])
-
- dns_servers (list): List of DNS servers, for a virtual network adapter with a static IP address. If this list is empty, then the guest operating system is expected to use a DHCP server to get its DNS server settings. These settings configure the virtual machine to use the specified DNS servers. These DNS server settings are listed in the order of preference.
-
If unset, no DNS servers are set. (['set'])
-
-
- interfaces - -
- list - / elements=dictionary - / required -
- 		- -
IP settings that are specific to a particular virtual network adapter. The AdapterMapping structure maps a network adapter's MAC address to its IPSettings. May be empty if there are no network adapters, else should match number of network adapters configured for the VM. This parameter is mandatory.
-
Valid attributes are:
-
- mac_address (str): The MAC address of a network adapter being customized.
-
If unset, the customization process maps the the settings from the list of i_p_settings in the CustomizationSpec.interfaces to the virtual machine's network adapters, in PCI slot order. The first virtual network adapter on the PCI bus is assigned interfaces[0].IPSettings, the second adapter is assigned interfaces[1].IPSettings, and so on. (['set'])
-
- adapter (dict): The IP settings for the associated virtual network adapter. (['set'])
-
This key is required with ['set'].
-
- Accepted keys:
-
- ipv4 (object): Specification to configure IPv4 address, subnet mask and gateway info for this virtual network adapter.
-
If unset, no IPv4 addresses are set.
-
- ipv6 (object): Specification to configure IPv6 address, subnet mask and gateway info for this virtual network adapter.
-
If unset, no IPv6 addresses are set.
-
- windows (object): Windows settings to be configured for this specific virtual Network adapter. This is valid only for Windows guest operating systems.
-
If unset, no specific Windows settings are set.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
The unique identifier of the virtual machine that needs to be customized.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Customize the VM - vmware.vmware_rest.vcenter_vm_guest_customization: - vm: "{{ lookup('vmware.vmware_rest.vm_moid', '/my_dc/vm/test_vm1') }}" - configuration_spec: - linux_config: - domain: mydomain - hostname: - fixed_name: foobar - type: FIXED - interfaces: - - adapter: - ipv4: - type: STATIC - gateways: - - 192.168.123.1 - ip_address: 192.168.123.50 - prefix: 24 - global_DNS_settings: - dns_suffix_list: [] - dns_servers: - - 1.1.1.1 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Customize the VM
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_filesystem_directories_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_filesystem_directories_module.rst deleted file mode 100644 index b5bd50377..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_filesystem_directories_module.rst +++ /dev/null @@ -1,406 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_guest_filesystem_directories_module: - - -********************************************************** -vmware.vmware_rest.vcenter_vm_guest_filesystem_directories -********************************************************** - -**Creates a directory in the guest operating system** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Creates a directory in the guest operating system. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- create_parents - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Whether any parent directories should be created. If any failure occurs, some parent directories could be left behind.
-
If unset parent directories are not created.
-
-
- credentials - -
- dictionary - / required -
- 		- -
The guest authentication data. This parameter is mandatory.
-
Valid attributes are:
-
- interactive_session (bool): If set, the operation will interact with the logged-in desktop session in the guest. This requires that the logged-on user matches the user specified by the Credentials. This is currently only supported for USERNAME_PASSWORD. (['absent', 'create_temporary', 'move', 'present'])
-
This key is required with ['absent', 'create_temporary', 'move', 'present'].
-
- type (str): Types of guest credentials (['absent', 'create_temporary', 'move', 'present'])
-
This key is required with ['absent', 'create_temporary', 'move', 'present'].
-
- Accepted values:
-
- SAML_BEARER_TOKEN
-
- USERNAME_PASSWORD
-
- user_name (str): For SAML_BEARER_TOKEN, this is the guest user to be associated with the credentials. For USERNAME_PASSWORD this is the guest username.
-
If no user is specified for SAML_BEARER_TOKEN, a guest dependent mapping will decide what guest user account is applied. (['absent', 'create_temporary', 'move', 'present'])
-
- password (str): password
-
This field is optional and it is only relevant when the value of Credentials.type is USERNAME_PASSWORD. (['absent', 'create_temporary', 'move', 'present'])
-
- saml_token (str): SAML Bearer Token
-
This field is optional and it is only relevant when the value of Credentials.type is SAML_BEARER_TOKEN. (['absent', 'create_temporary', 'move', 'present'])
-
-
- new_path - -
- string -
- 		- -
The complete path to where the directory is moved or its new name. It cannot be a path to an existing directory or an existing file. Required with state=['move']
-
-
- parent_path - -
- string -
- 		- -
The complete path to the directory in which to create the new directory.
-
Directory If unset a guest-specific default will be used.
-
-
- path - -
- string -
- 		- -
The complete path to the directory to be created. Required with state=['absent', 'move', 'present']
-
-
- prefix - -
- string -
- 		- -
The prefix to be given to the new temporary directory. Required with state=['create_temporary']
-
-
- recursive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
If true, all files and subdirectories are also deleted. If false, the directory must be empty for the operation to succeed.
-
If unset, any directory content is not deleted.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • create_temporary
    • -
  • move
    • -
  • present ←
    • -
- 		-
-
- suffix - -
- string -
- 		- -
The suffix to be given to the new temporary directory. Required with state=['create_temporary']
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual Machine to perform the operation on.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - name: test_vm1 - guest_OS: RHEL_7_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - disks: - - type: SATA - backing: - type: VMDK_FILE - vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk' - - type: SATA - new_vmdk: - name: second_disk - capacity: 32000000000 - cdroms: - - type: SATA - sata: - bus: 0 - unit: 2 - nics: - - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: my_vm - - - name: Create a directory in /tmp - vmware.vmware_rest.vcenter_vm_guest_filesystem_directories: - vm: '{{ my_vm.id }}' - path: /tmp/my/path - create_parents: true - credentials: - interactive_session: false - type: USERNAME_PASSWORD - user_name: root - password: root - - - - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_identity_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_identity_info_module.rst deleted file mode 100644 index a123db8bb..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_identity_info_module.rst +++ /dev/null @@ -1,243 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_guest_identity_info_module: - - -************************************************* -vmware.vmware_rest.vcenter_vm_guest_identity_info -************************************************* - -**Return information about the guest.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Return information about the guest. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Identifier of the virtual machine.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Get guest identity information - vmware.vmware_rest.vcenter_vm_guest_identity_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get guest identity information
-
-
Sample:
-
{'family': 'LINUX', 'full_name': {'args': [], 'default_message': 'Red Hat Fedora (64-bit)', 'id': 'vmsg.guestos.fedora64Guest.label'}, 'host_name': 'localhost.localdomain', 'name': 'FEDORA_64'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module.rst deleted file mode 100644 index 6fd66d8d6..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module.rst +++ /dev/null @@ -1,247 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module: - - -******************************************************** -vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info -******************************************************** - -**Returns details of the local file systems in the guest operating system.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns details of the local file systems in the guest operating system. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Identifier of the virtual machine.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - 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 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get guest filesystem information
-
-
Sample:
-
{'/': {'capacity': 2515173376, 'free_space': 774787072, 'mappings': []}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_networking_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_networking_info_module.rst deleted file mode 100644 index 0683b64e2..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_networking_info_module.rst +++ /dev/null @@ -1,243 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_guest_networking_info_module: - - -*************************************************** -vmware.vmware_rest.vcenter_vm_guest_networking_info -*************************************************** - -**Returns information about the network configuration in the guest operating system.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about the network configuration in the guest operating system. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Virtual machine ID
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Get guest networking information - vmware.vmware_rest.vcenter_vm_guest_networking_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get guest networking information
-
-
Sample:
-
{'dns': {'ip_addresses': ['10.0.2.3'], 'search_domains': ['localdomain']}, 'dns_values': {'domain_name': 'localdomain', 'host_name': 'localhost.localdomain'}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module.rst deleted file mode 100644 index 9d54f8bcf..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module.rst +++ /dev/null @@ -1,243 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module: - - -************************************************************** -vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info -************************************************************** - -**Returns information about the networking interfaces in the guest operating system.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about the networking interfaces in the guest operating system. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Virtual machine ID
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['list']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Get guest network interfaces information - vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Get guest network interfaces information
-
-
Sample:
-
[{'ip': {'ip_addresses': []}, 'mac_address': '00:50:56:b1:33:76', 'nic': '4000'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module.rst deleted file mode 100644 index 46aebcdb0..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module.rst +++ /dev/null @@ -1,241 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module: - - -********************************************************** -vmware.vmware_rest.vcenter_vm_guest_networking_routes_info -********************************************************** - -**Returns information about network routing in the guest operating system.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about network routing in the guest operating system. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Virtual machine ID
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['list']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Get guest network routes information - vmware.vmware_rest.vcenter_vm_guest_networking_routes_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Get guest network routes information
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_operations_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_operations_info_module.rst deleted file mode 100644 index 3faabfc53..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_operations_info_module.rst +++ /dev/null @@ -1,191 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_guest_operations_info_module: - - -*************************************************** -vmware.vmware_rest.vcenter_vm_guest_operations_info -*************************************************** - -**Get information about the guest operation status.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get information about the guest operation status. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Identifier of the virtual machine.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - - - - - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_power_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_power_info_module.rst deleted file mode 100644 index 57c211d9e..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_power_info_module.rst +++ /dev/null @@ -1,264 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_guest_power_info_module: - - -********************************************** -vmware.vmware_rest.vcenter_vm_guest_power_info -********************************************** - -**Returns information about the guest operating system power state.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about the guest operating system power state. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Identifier of the virtual machine.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - name: test_vm1 - guest_OS: RHEL_7_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - disks: - - type: SATA - backing: - type: VMDK_FILE - vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk' - - type: SATA - new_vmdk: - name: second_disk - capacity: 32000000000 - cdroms: - - type: SATA - sata: - bus: 0 - unit: 2 - nics: - - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: my_vm - - - name: Read the power status of the VM - vmware.vmware_rest.vcenter_vm_guest_power_info: - vm: '{{ my_vm.id }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Read the power status of the VM
-
-
Sample:
-
{'operations_ready': 0, 'state': 'NOT_RUNNING'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_power_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_power_module.rst deleted file mode 100644 index 84f3346b3..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_power_module.rst +++ /dev/null @@ -1,292 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_guest_power_module: - - -***************************************** -vmware.vmware_rest.vcenter_vm_guest_power -***************************************** - -**Issues a request to the guest operating system asking it to perform a soft shutdown, standby (suspend) or soft reboot** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Issues a request to the guest operating system asking it to perform a soft shutdown, standby (suspend) or soft reboot. This request returns immediately and does not wait for the guest operating. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • reboot
    • -
  • shutdown
    • -
  • standby
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Identifier of the virtual machine.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - -See Also --------- - -.. seealso:: - - :ref:`vmware.vmware_rest.vcenter_vm_power_module` - A module to boot, hard shutdown and hard reset guest - - -Examples --------- - -.. code-block:: yaml - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - name: test_vm1 - guest_OS: RHEL_7_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - disks: - - type: SATA - backing: - type: VMDK_FILE - vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk' - - type: SATA - new_vmdk: - name: second_disk - capacity: 32000000000 - cdroms: - - type: SATA - sata: - bus: 0 - unit: 2 - nics: - - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: my_vm - - - name: Shut down the VM - vmware.vmware_rest.vcenter_vm_guest_power: - state: shutdown - vm: '{{ my_vm.id }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Shut down the VM
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module.rst deleted file mode 100644 index 29762340b..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module.rst +++ /dev/null @@ -1,296 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module: - - -******************************************************** -vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info -******************************************************** - -**Returns information about a virtual SATA adapter.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about a virtual SATA adapter. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- adapter - -
- string -
- 		- -
Virtual SATA adapter identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_adapter_sata. Required with state=['get']
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Get information about a specific controller - vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info: - vm: '{{ test_vm1_info.id }}' - adapter: '{{ _sata_adapter_result_1.id }}' - - - name: List the controller - vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info: - vm: '{{ test_vm1_info.id }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
15000
-
-
- value - -
- dictionary -
- 		On success -
Get information about a specific controller
-
-
Sample:
-
{'bus': 0, 'label': 'SATA controller 0', 'pci_slot_number': 34, 'type': 'AHCI'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module.rst deleted file mode 100644 index 945a6e42b..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module.rst +++ /dev/null @@ -1,367 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module: - - -*************************************************** -vmware.vmware_rest.vcenter_vm_hardware_adapter_sata -*************************************************** - -**Adds a virtual SATA adapter to the virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Adds a virtual SATA adapter to the virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- adapter - -
- string -
- 		- -
Virtual SATA adapter identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_adapter_sata. Required with state=['absent']
-
-
- bus - -
- integer -
- 		- -
SATA bus number.
-
If unset, the server will choose an available bus number; if none is available, the request will fail.
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- pci_slot_number - -
- integer -
- 		- -
Address of the SATA adapter on the PCI bus.
-
If unset, the server will choose an available address when the virtual machine is powered on.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
-
- type - -
- string -
- 		-
    Choices: -
  • AHCI
    • -
- 		-
The type enumerated type defines the valid emulation types for a virtual SATA adapter.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - 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 - - - name: Remove SATA adapter at PCI slot 34 - vmware.vmware_rest.vcenter_vm_hardware_adapter_sata: - vm: '{{ test_vm1_info.id }}' - pci_slot_number: 34 - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
15000
-
-
- value - -
- dictionary -
- 		On success -
Create a SATA adapter at PCI slot 34
-
-
Sample:
-
{'bus': 0, 'label': 'SATA controller 0', 'pci_slot_number': 34, 'type': 'AHCI'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module.rst deleted file mode 100644 index 52ae8f07f..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module.rst +++ /dev/null @@ -1,275 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module: - - -******************************************************** -vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info -******************************************************** - -**Returns information about a virtual SCSI adapter.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about a virtual SCSI adapter. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- adapter - -
- string -
- 		- -
Virtual SCSI adapter identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi. Required with state=['get']
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - 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 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
List the SCSI adapter of a given VM
-
-
Sample:
-
[{'adapter': '1000'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module.rst deleted file mode 100644 index aae1344b9..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module.rst +++ /dev/null @@ -1,391 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module: - - -*************************************************** -vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi -*************************************************** - -**Adds a virtual SCSI adapter to the virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Adds a virtual SCSI adapter to the virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- adapter - -
- string -
- 		- -
Virtual SCSI adapter identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi. Required with state=['absent', 'present']
-
-
- bus - -
- integer -
- 		- -
SCSI bus number.
-
If unset, the server will choose an available bus number; if none is available, the request will fail.
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- pci_slot_number - -
- integer -
- 		- -
Address of the SCSI adapter on the PCI bus. If the PCI address is invalid, the server will change it when the VM is started or as the device is hot added.
-
If unset, the server will choose an available address when the virtual machine is powered on.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- sharing - -
- string -
- 		-
    Choices: -
  • NONE
    • -
  • PHYSICAL
    • -
  • VIRTUAL
    • -
- 		-
The sharing enumerated type defines the valid bus sharing modes for a virtual SCSI adapter.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
-
- type - -
- string -
- 		-
    Choices: -
  • BUSLOGIC
    • -
  • LSILOGIC
    • -
  • LSILOGICSAS
    • -
  • PVSCSI
    • -
- 		-
The type enumerated type defines the valid emulation types for a virtual SCSI adapter.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Create a SCSI adapter at PCI slot 35 - vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi: - vm: '{{ test_vm1_info.id }}' - pci_slot_number: 35 - register: _scsi_adapter_result_1 - - - name: Drop the SCSI controller - vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi: - vm: '{{ test_vm1_info.id }}' - pci_slot_number: 35 - state: absent - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
1000
-
-
- value - -
- dictionary -
- 		On success -
Create a SCSI adapter at PCI slot 35
-
-
Sample:
-
{'label': 'SCSI controller 0', 'pci_slot_number': 35, 'scsi': {'bus': 0, 'unit': 7}, 'sharing': 'NONE', 'type': 'PVSCSI'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module.rst deleted file mode 100644 index 3f2b048b5..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module.rst +++ /dev/null @@ -1,248 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module: - - -******************************************************* -vmware.vmware_rest.vcenter_vm_hardware_boot_device_info -******************************************************* - -**Returns an ordered list of boot devices for the virtual machine** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns an ordered list of boot devices for the virtual machine. If the list is empty, the virtual machine uses a default boot sequence. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Get boot device info - vmware.vmware_rest.vcenter_vm_hardware_boot_device_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - name: Get information about the boot device - vmware.vmware_rest.vcenter_vm_hardware_boot_device_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Get information about the boot device
-
-
Sample:
-
[{'type': 'CDROM'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_module.rst deleted file mode 100644 index 6aff2733f..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_module.rst +++ /dev/null @@ -1,292 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_boot_device_module: - - -************************************************** -vmware.vmware_rest.vcenter_vm_hardware_boot_device -************************************************** - -**Sets the virtual devices that will be used to boot the virtual machine** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Sets the virtual devices that will be used to boot the virtual machine. The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the list is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of Device.Entry for a given device type except ETHERNET in the list. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- devices - -
- list - / elements=dictionary - / required -
- 		- -
Ordered list of boot devices. This parameter is mandatory.
-
Valid attributes are:
-
- type (str): This option defines the valid device types that may be used as bootable devices. (['set'])
-
This key is required with ['set'].
-
- Accepted values:
-
- CDROM
-
- DISK
-
- ETHERNET
-
- FLOPPY
-
- nic (str): Virtual Ethernet device. Ethernet device to use as boot device for this entry.
-
This field is optional and it is only relevant when the value of type is ETHERNET.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_ethernet. (['set'])
-
- disks (list): Virtual disk device. List of virtual disks in boot order.
-
This field is optional and it is only relevant when the value of type is DISK.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_vm_hardware_disk. (['set'])
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • set ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Set a boot device - vmware.vmware_rest.vcenter_vm_hardware_boot_device: - vm: '{{ test_vm1_info.id }}' - devices: - - type: CDROM - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Set a boot device
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_info_module.rst deleted file mode 100644 index 0b8e28183..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_info_module.rst +++ /dev/null @@ -1,242 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_boot_info_module: - - -************************************************ -vmware.vmware_rest.vcenter_vm_hardware_boot_info -************************************************ - -**Returns the boot-related settings of a virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns the boot-related settings of a virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Retrieve the boot information from the VM - vmware.vmware_rest.vcenter_vm_hardware_boot_info: - vm: '{{ test_vm1_info.id }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Retrieve the boot information from the VM
-
-
Sample:
-
{'delay': 0, 'enter_setup_mode': 0, 'retry': 0, 'retry_delay': 10000, 'type': 'BIOS'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_module.rst deleted file mode 100644 index 3d87bf1ec..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_module.rst +++ /dev/null @@ -1,406 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_boot_module: - - -******************************************* -vmware.vmware_rest.vcenter_vm_hardware_boot -******************************************* - -**Updates the boot-related settings of a virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Updates the boot-related settings of a virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- delay - -
- integer -
- 		- -
Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode.
-
If unset, the value is unchanged.
-
-
- efi_legacy_boot - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether to use EFI legacy boot mode.
-
If unset, the value is unchanged.
-
-
- enter_setup_mode - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether the firmware boot process should automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode.
-
If unset, the value is unchanged.
-
-
- network_protocol - -
- string -
- 		-
    Choices: -
  • IPV4
    • -
  • IPV6
    • -
- 		-
The network_protocol enumerated type defines the valid network boot protocols supported when booting a virtual machine with EFI firmware over the network.
-
-
- retry - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether the virtual machine should automatically retry the boot process after a failure.
-
If unset, the value is unchanged.
-
-
- retry_delay - -
- integer -
- 		- -
Delay in milliseconds before retrying the boot process after a failure; applicable only when retry is true.
-
If unset, the value is unchanged.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
- 		-
-
- type - -
- string -
- 		-
    Choices: -
  • BIOS
    • -
  • EFI
    • -
- 		-
The type enumerated type defines the valid firmware types for a virtual machine.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Change a VM boot parameters - vmware.vmware_rest.vcenter_vm_hardware_boot: - vm: '{{ test_vm1_info.id }}' - efi_legacy_boot: true - type: EFI - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- dictionary -
- 		On success -
moid of the resource
-
-
-
- value - -
- dictionary -
- 		On success -
Change a VM boot parameters
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module.rst deleted file mode 100644 index ead0e0aa7..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module.rst +++ /dev/null @@ -1,273 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module: - - -************************************************* -vmware.vmware_rest.vcenter_vm_hardware_cdrom_info -************************************************* - -**Returns information about a virtual CD-ROM device.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about a virtual CD-ROM device. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cdrom - -
- string -
- 		- -
Virtual CD-ROM device identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_cdrom. Required with state=['get']
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: List the cdrom devices on the guest - vmware.vmware_rest.vcenter_vm_hardware_cdrom_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
List the cdrom devices on the guest
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_module.rst deleted file mode 100644 index f83db83d7..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_module.rst +++ /dev/null @@ -1,453 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_cdrom_module: - - -******************************************** -vmware.vmware_rest.vcenter_vm_hardware_cdrom -******************************************** - -**Adds a virtual CD-ROM device to the virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Adds a virtual CD-ROM device to the virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- allow_guest_control - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether the guest can connect and disconnect the device.
-
If unset, the value is unchanged.
-
-
- backing - -
- dictionary -
- 		- -
Physical resource backing for the virtual CD-ROM device.
-
If unset, defaults to automatic detection of a suitable host device. Required with state=['present']
-
Valid attributes are:
-
- type (str): This option defines the valid backing types for a virtual CD-ROM device. (['present'])
-
This key is required with ['present'].
-
- Accepted values:
-
- CLIENT_DEVICE
-
- HOST_DEVICE
-
- ISO_FILE
-
- iso_file (str): Path of the image file that should be used as the virtual CD-ROM device backing.
-
This field is optional and it is only relevant when the value of type is ISO_FILE. (['present'])
-
- host_device (str): Name of the device that should be used as the virtual CD-ROM device backing.
-
If unset, the virtual CD-ROM device will be configured to automatically detect a suitable host device. (['present'])
-
- device_access_type (str): This option defines the valid device access types for a physical device packing of a virtual CD-ROM device. (['present'])
-
- Accepted values:
-
- EMULATION
-
- PASSTHRU
-
- PASSTHRU_EXCLUSIVE
-
-
- cdrom - -
- string -
- 		- -
Virtual CD-ROM device identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_cdrom. Required with state=['absent', 'connect', 'disconnect', 'present']
-
-
- ide - -
- dictionary -
- 		- -
Address for attaching the device to a virtual IDE adapter.
-
If unset, the server will choose an available address; if none is available, the request will fail.
-
Valid attributes are:
-
- primary (bool): Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine.
-
If unset, the server will choose a adapter with an available connection. If no IDE connections are available, the request will be rejected. (['present'])
-
- master (bool): Flag specifying whether the device should be the master or slave device on the IDE adapter.
-
If unset, the server will choose an available connection type. If no IDE connections are available, the request will be rejected. (['present'])
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- sata - -
- dictionary -
- 		- -
Address for attaching the device to a virtual SATA adapter.
-
If unset, the server will choose an available address; if none is available, the request will fail. Required with state=['present']
-
Valid attributes are:
-
- bus (int): Bus number of the adapter to which the device should be attached. (['present'])
-
This key is required with ['present'].
-
- unit (int): Unit number of the device.
-
If unset, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected. (['present'])
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- start_connected - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
-
If unset, the value is unchanged.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • connect
    • -
  • disconnect
    • -
  • present ←
    • -
- 		-
-
- type - -
- string -
- 		-
    Choices: -
  • IDE
    • -
  • SATA
    • -
- 		-
The host_bus_adapter_type enumerated type defines the valid types of host bus adapters that may be used for attaching a Cdrom to a virtual machine.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - 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 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
16002
-
-
- value - -
- dictionary -
- 		On success -
Attach an ISO image to a guest VM
-
-
Sample:
-
{'allow_guest_control': 0, 'backing': {'iso_file': '[ro_datastore] fedora.iso', 'type': 'ISO_FILE'}, 'label': 'CD/DVD drive 1', 'sata': {'bus': 0, 'unit': 2}, 'start_connected': 1, 'state': 'NOT_CONNECTED', 'type': 'SATA'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module.rst deleted file mode 100644 index 39768d877..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module.rst +++ /dev/null @@ -1,243 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module: - - -*********************************************** -vmware.vmware_rest.vcenter_vm_hardware_cpu_info -*********************************************** - -**Returns the CPU-related settings of a virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns the CPU-related settings of a virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Retrieve the CPU information from the VM - vmware.vmware_rest.vcenter_vm_hardware_cpu_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Retrieve the CPU information from the VM
-
-
Sample:
-
{'cores_per_socket': 1, 'count': 1, 'hot_add_enabled': 0, 'hot_remove_enabled': 0}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_module.rst deleted file mode 100644 index e6593b755..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_module.rst +++ /dev/null @@ -1,357 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_cpu_module: - - -****************************************** -vmware.vmware_rest.vcenter_vm_hardware_cpu -****************************************** - -**Updates the CPU-related settings of a virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Updates the CPU-related settings of a virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cores_per_socket - -
- integer -
- 		- -
New number of CPU cores per socket. The number of CPU cores in the virtual machine must be a multiple of the number of cores per socket.
-
If unset, the value is unchanged.
-
-
- count - -
- integer -
- 		- -
New number of CPU cores. The number of CPU cores in the virtual machine must be a multiple of the number of cores per socket.
-
The supported range of CPU counts is constrained by the configured guest operating system and virtual hardware version of the virtual machine.
-
-
If the virtual machine is running, the number of CPU cores may only be increased if hot_add_enabled is true, and may only be decreased if hot_remove_enabled is true.
-
-
If unset, the value is unchanged.
-
-
- hot_add_enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether adding CPUs while the virtual machine is running is enabled.
-
This field may only be modified if the virtual machine is powered off.
-
-
If unset, the value is unchanged.
-
-
- hot_remove_enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether removing CPUs while the virtual machine is running is enabled.
-
This field may only be modified if the virtual machine is powered off.
-
-
If unset, the value is unchanged.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Dedicate one core to the VM - vmware.vmware_rest.vcenter_vm_hardware_cpu: - vm: '{{ test_vm1_info.id }}' - count: 1 - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- dictionary -
- 		On success -
moid of the resource
-
-
-
- value - -
- dictionary -
- 		On success -
Dedicate one core to the VM
-
-
Sample:
-
{'cores_per_socket': 1, 'count': 1, 'hot_add_enabled': 0, 'hot_remove_enabled': 0}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_info_module.rst deleted file mode 100644 index 748e08588..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_info_module.rst +++ /dev/null @@ -1,298 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_disk_info_module: - - -************************************************ -vmware.vmware_rest.vcenter_vm_hardware_disk_info -************************************************ - -**Returns information about a virtual disk.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about a virtual disk. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- disk - -
- string -
- 		- -
Virtual disk identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_disk. Required with state=['get']
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Retrieve the disk information from the VM - vmware.vmware_rest.vcenter_vm_hardware_disk_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - name: Retrieve disk information using the label - vmware.vmware_rest.vcenter_vm_hardware_disk_info: - vm: '{{ test_vm1_info.id }}' - label: Hard disk 1 - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
2000
-
-
- value - -
- dictionary -
- 		On success -
Retrieve disk information using the label
-
-
Sample:
-
{'backing': {'type': 'VMDK_FILE', 'vmdk_file': '[local] test_vm1/test_vm1.vmdk'}, 'capacity': 17179869184, 'label': 'Hard disk 1', 'scsi': {'bus': 0, 'unit': 0}, 'type': 'SCSI'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_module.rst deleted file mode 100644 index e0c81c96c..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_module.rst +++ /dev/null @@ -1,474 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_disk_module: - - -******************************************* -vmware.vmware_rest.vcenter_vm_hardware_disk -******************************************* - -**Adds a virtual disk to the virtual machine** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- backing - -
- dictionary -
- 		- -
Existing physical resource backing for the virtual disk. Exactly one of backing or new_vmdk must be specified.
-
If unset, the virtual disk will not be connected to an existing backing. Required with state=['present']
-
Valid attributes are:
-
- type (str): This option defines the valid backing types for a virtual disk. (['present'])
-
This key is required with ['present'].
-
- Accepted values:
-
- VMDK_FILE
-
- vmdk_file (str): Path of the VMDK file backing the virtual disk.
-
This field is optional and it is only relevant when the value of type is VMDK_FILE. (['present'])
-
-
- disk - -
- string -
- 		- -
Virtual disk identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_disk. Required with state=['absent', 'present']
-
-
- ide - -
- dictionary -
- 		- -
Address for attaching the device to a virtual IDE adapter.
-
If unset, the server will choose an available address; if none is available, the request will fail.
-
Valid attributes are:
-
- primary (bool): Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine.
-
If unset, the server will choose a adapter with an available connection. If no IDE connections are available, the request will be rejected. (['present'])
-
- master (bool): Flag specifying whether the device should be the master or slave device on the IDE adapter.
-
If unset, the server will choose an available connection type. If no IDE connections are available, the request will be rejected. (['present'])
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- new_vmdk - -
- dictionary -
- 		- -
Specification for creating a new VMDK backing for the virtual disk. Exactly one of backing or new_vmdk must be specified.
-
If unset, a new VMDK backing will not be created.
-
Valid attributes are:
-
- name (str): Base name of the VMDK file. The name should not include the '.vmdk' file extension.
-
If unset, a name (derived from the name of the virtual machine) will be chosen by the server. (['present'])
-
- capacity (int): Capacity of the virtual disk backing in bytes.
-
If unset, defaults to a guest-specific capacity. (['present'])
-
- storage_policy (dict): The storage_policy_spec structure contains information about the storage policy that is to be associated the with VMDK file.
-
If unset the default storage policy of the target datastore (if applicable) is applied. Currently a default storage policy is only supported by object based datastores : VVol & vSAN. For non- object datastores, if unset then no storage policy would be associated with the VMDK file. (['present'])
-
- Accepted keys:
-
- policy (string): Identifier of the storage policy which should be associated with the VMDK file.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_storage_policies.
-
-
- nvme - -
- dictionary -
- 		- -
Address for attaching the device to a virtual NVMe adapter.
-
If unset, the server will choose an available address; if none is available, the request will fail. Required with state=['present']
-
Valid attributes are:
-
- bus (int): Bus number of the adapter to which the device should be attached. (['present'])
-
This key is required with ['present'].
-
- unit (int): Unit number of the device.
-
If unset, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected. (['present'])
-
-
- sata - -
- dictionary -
- 		- -
Address for attaching the device to a virtual SATA adapter.
-
If unset, the server will choose an available address; if none is available, the request will fail. Required with state=['present']
-
Valid attributes are:
-
- bus (int): Bus number of the adapter to which the device should be attached. (['present'])
-
This key is required with ['present'].
-
- unit (int): Unit number of the device.
-
If unset, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected. (['present'])
-
-
- scsi - -
- dictionary -
- 		- -
Address for attaching the device to a virtual SCSI adapter.
-
If unset, the server will choose an available address; if none is available, the request will fail. Required with state=['present']
-
Valid attributes are:
-
- bus (int): Bus number of the adapter to which the device should be attached. (['present'])
-
This key is required with ['present'].
-
- unit (int): Unit number of the device.
-
If unset, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected. (['present'])
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
-
- type - -
- string -
- 		-
    Choices: -
  • IDE
    • -
  • NVME
    • -
  • SATA
    • -
  • SCSI
    • -
- 		-
The host_bus_adapter_type enumerated type defines the valid types of host bus adapters that may be used for attaching a virtual storage device to a virtual machine.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - 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 - - - name: Delete the disk - vmware.vmware_rest.vcenter_vm_hardware_disk: - vm: '{{ test_vm1_info.id }}' - disk: '{{ my_new_disk.id }}' - state: absent - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
16000
-
-
- value - -
- dictionary -
- 		On success -
Create a new disk
-
-
Sample:
-
{'backing': {'type': 'VMDK_FILE', 'vmdk_file': '[local] test_vm1/test_vm1_1.vmdk'}, 'capacity': 320000, 'label': 'Hard disk 2', 'sata': {'bus': 0, 'unit': 0}, 'type': 'SATA'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module.rst deleted file mode 100644 index a90d2c37b..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module.rst +++ /dev/null @@ -1,278 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module: - - -**************************************************** -vmware.vmware_rest.vcenter_vm_hardware_ethernet_info -**************************************************** - -**Returns information about a virtual Ethernet adapter.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about a virtual Ethernet adapter. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- label - -
- string -
- 		- -
The name of the item
-
-
- nic - -
- string -
- 		- -
Virtual Ethernet adapter identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_ethernet. Required with state=['get']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Collect a list of the NIC for a given VM - vmware.vmware_rest.vcenter_vm_hardware_ethernet_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - name: Collect a list of the NIC for a given VM - vmware.vmware_rest.vcenter_vm_hardware_ethernet_info: - vm: '{{ test_vm1_info.id }}' - register: vm_nic - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Collect a list of the NIC for a given VM
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_module.rst deleted file mode 100644 index dc7bb1bfc..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_module.rst +++ /dev/null @@ -1,560 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_ethernet_module: - - -*********************************************** -vmware.vmware_rest.vcenter_vm_hardware_ethernet -*********************************************** - -**Adds a virtual Ethernet adapter to the virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Adds a virtual Ethernet adapter to the virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- allow_guest_control - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether the guest can connect and disconnect the device.
-
If unset, the value is unchanged.
-
-
- backing - -
- dictionary -
- 		- -
Physical resource backing for the virtual Ethernet adapter.
-
If unset, the system may try to find an appropriate backing. If one is not found, the request will fail. Required with state=['present']
-
Valid attributes are:
-
- type (str): This option defines the valid backing types for a virtual Ethernet adapter. (['present'])
-
This key is required with ['present'].
-
- Accepted values:
-
- DISTRIBUTED_PORTGROUP
-
- HOST_DEVICE
-
- OPAQUE_NETWORK
-
- STANDARD_PORTGROUP
-
- network (str): Identifier of the network that backs the virtual Ethernet adapter.
-
This field is optional and it is only relevant when the value of type is one of STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP, or OPAQUE_NETWORK.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_network_info. (['present'])
-
- distributed_port (str): Key of the distributed virtual port that backs the virtual Ethernet adapter. Depending on the type of the Portgroup, the port may be specified using this field. If the portgroup type is early-binding (also known as static), a port is assigned when the Ethernet adapter is configured to use the port. The port may be either automatically or specifically assigned based on the value of this field. If the portgroup type is ephemeral, the port is created and assigned to a virtual machine when it is powered on and the Ethernet adapter is connected. This field cannot be specified as no free ports exist before use.
-
May be used to specify a port when the network specified on the network field is a static or early binding distributed portgroup. If unset, the port will be automatically assigned to the Ethernet adapter based on the policy embodied by the portgroup type. (['present'])
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- mac_address - -
- string -
- 		- -
MAC address.
-
This field may be modified at any time, and changes will be applied the next time the virtual machine is powered on.
-
-
If unset, the value is unchanged. Must be specified if mac_type is MANUAL. Must be unset if the MAC address type is not MANUAL.
-
-
- mac_type - -
- string -
- 		-
    Choices: -
  • ASSIGNED
    • -
  • GENERATED
    • -
  • MANUAL
    • -
- 		-
The mac_address_type enumerated type defines the valid MAC address origins for a virtual Ethernet adapter.
-
-
- nic - -
- string -
- 		- -
Virtual Ethernet adapter identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_ethernet. Required with state=['absent', 'connect', 'disconnect', 'present']
-
-
- pci_slot_number - -
- integer -
- 		- -
Address of the virtual Ethernet adapter on the PCI bus. If the PCI address is invalid, the server will change when it the VM is started or as the device is hot added.
-
If unset, the server will choose an available address when the virtual machine is powered on.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- start_connected - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
-
If unset, the value is unchanged.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • connect
    • -
  • disconnect
    • -
  • present ←
    • -
- 		-
-
- type - -
- string -
- 		-
    Choices: -
  • E1000
    • -
  • E1000E
    • -
  • PCNET32
    • -
  • VMXNET
    • -
  • VMXNET2
    • -
  • VMXNET3
    • -
- 		-
The emulation_type enumerated type defines the valid emulation types for a virtual Ethernet adapter.
-
-
- upt_compatibility_enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether Universal Pass-Through (UPT) compatibility should be enabled on this virtual Ethernet adapter.
-
This field may be modified at any time, and changes will be applied the next time the virtual machine is powered on.
-
-
If unset, the value is unchanged. Must be unset if the emulation type of the virtual Ethernet adapter is not VMXNET3.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- wake_on_lan_enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether wake-on-LAN shoud be enabled on this virtual Ethernet adapter.
-
This field may be modified at any time, and changes will be applied the next time the virtual machine is powered on.
-
-
If unset, the value is unchanged.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Get the dvswitch called my-portgroup - vmware.vmware_rest.vcenter_network_info: - filter_types: DISTRIBUTED_PORTGROUP - filter_names: my portrgoup - register: my_portgroup - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - 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 - - - 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 }}' - - - name: Attach the VM to a standard portgroup - vmware.vmware_rest.vcenter_vm_hardware_ethernet: - vm: '{{ test_vm1_info.id }}' - pci_slot_number: 4 - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: _result - - - name: Attach the VM to a standard portgroup (again) - vmware.vmware_rest.vcenter_vm_hardware_ethernet: - vm: '{{ test_vm1_info.id }}' - pci_slot_number: 4 - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: _result - - - name: Collect a list of the NIC for a given VM - vmware.vmware_rest.vcenter_vm_hardware_ethernet_info: - vm: '{{ test_vm1_info.id }}' - register: vm_nic - - - name: Attach the VM to a standard portgroup (again) using the nic ID - vmware.vmware_rest.vcenter_vm_hardware_ethernet: - vm: '{{ test_vm1_info.id }}' - nic: '{{ vm_nic.value[0].nic }}' - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: _result - - - name: Attach to another standard portgroup - vmware.vmware_rest.vcenter_vm_hardware_ethernet: - vm: '{{ test_vm1_info.id }}' - nic: '{{ vm_nic.value[0].nic }}' - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/second_vswitch') }}" - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
4000
-
-
- value - -
- dictionary -
- 		On success -
Attach a VM to a dvswitch
-
-
Sample:
-
{'allow_guest_control': 0, 'backing': {'connection_cookie': 632732945, 'distributed_port': '2', 'distributed_switch_uuid': '50 31 d3 c4 2d 09 4f e3-0f d6 7f 30 3d fe d4 a0', 'network': 'dvportgroup-1022', 'type': 'DISTRIBUTED_PORTGROUP'}, 'label': 'Network adapter 1', 'mac_address': '00:50:56:b1:33:76', 'mac_type': 'ASSIGNED', 'pci_slot_number': 4, 'start_connected': 0, 'state': 'NOT_CONNECTED', 'type': 'VMXNET3', 'upt_compatibility_enabled': 0, 'wake_on_lan_enabled': 0}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module.rst deleted file mode 100644 index acd1d7efc..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module.rst +++ /dev/null @@ -1,273 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module: - - -************************************************** -vmware.vmware_rest.vcenter_vm_hardware_floppy_info -************************************************** - -**Returns information about a virtual floppy drive.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about a virtual floppy drive. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- floppy - -
- string -
- 		- -
Virtual floppy drive identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_floppy. Required with state=['get']
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: List the floppy disk drives - vmware.vmware_rest.vcenter_vm_hardware_floppy_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
List the floppy disk drives
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_module.rst deleted file mode 100644 index 1a04cbd9f..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_module.rst +++ /dev/null @@ -1,387 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_floppy_module: - - -********************************************* -vmware.vmware_rest.vcenter_vm_hardware_floppy -********************************************* - -**Adds a virtual floppy drive to the virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Adds a virtual floppy drive to the virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- allow_guest_control - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether the guest can connect and disconnect the device.
-
If unset, the value is unchanged.
-
-
- backing - -
- dictionary -
- 		- -
Physical resource backing for the virtual floppy drive.
-
If unset, defaults to automatic detection of a suitable host device. Required with state=['present']
-
Valid attributes are:
-
- type (str): This option defines the valid backing types for a virtual floppy drive. (['present'])
-
This key is required with ['present'].
-
- Accepted values:
-
- CLIENT_DEVICE
-
- HOST_DEVICE
-
- IMAGE_FILE
-
- image_file (str): Path of the image file that should be used as the virtual floppy drive backing.
-
This field is optional and it is only relevant when the value of type is IMAGE_FILE. (['present'])
-
- host_device (str): Name of the device that should be used as the virtual floppy drive backing.
-
If unset, the virtual floppy drive will be configured to automatically detect a suitable host device. (['present'])
-
-
- floppy - -
- string -
- 		- -
Virtual floppy drive identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_floppy. Required with state=['absent', 'connect', 'disconnect', 'present']
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- start_connected - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
-
If unset, the value is unchanged.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • connect
    • -
  • disconnect
    • -
  • present ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - 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 - - - name: Remove a floppy drive - vmware.vmware_rest.vcenter_vm_hardware_floppy: - vm: '{{ test_vm1_info.id }}' - floppy: '{{ my_floppy_drive.id }}' - state: absent - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
8000
-
-
- value - -
- dictionary -
- 		On success -
Add a floppy disk drive
-
-
Sample:
-
{'allow_guest_control': 1, 'backing': {'auto_detect': 1, 'host_device': '', 'type': 'HOST_DEVICE'}, 'label': 'Floppy drive 1', 'start_connected': 0, 'state': 'NOT_CONNECTED'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_info_module.rst deleted file mode 100644 index a99fc6956..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_info_module.rst +++ /dev/null @@ -1,238 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_info_module: - - -******************************************* -vmware.vmware_rest.vcenter_vm_hardware_info -******************************************* - -**Returns the virtual hardware settings of a virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns the virtual hardware settings of a virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect the hardware information - vmware.vmware_rest.vcenter_vm_hardware_info: - vm: '{{ search_result.value[0].vm }}' - register: my_vm1_hardware_info - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Collect the hardware information
-
-
Sample:
-
{'upgrade_policy': 'NEVER', 'upgrade_status': 'NONE', 'version': 'VMX_10'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst deleted file mode 100644 index 15fafb532..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst +++ /dev/null @@ -1,243 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_memory_info_module: - - -************************************************** -vmware.vmware_rest.vcenter_vm_hardware_memory_info -************************************************** - -**Returns the memory-related settings of a virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns the memory-related settings of a virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Retrieve the memory information from the VM - vmware.vmware_rest.vcenter_vm_hardware_memory_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Retrieve the memory information from the VM
-
-
Sample:
-
{'hot_add_enabled': 1, 'size_MiB': 1024}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_module.rst deleted file mode 100644 index c42d8e5d2..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_module.rst +++ /dev/null @@ -1,319 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_memory_module: - - -********************************************* -vmware.vmware_rest.vcenter_vm_hardware_memory -********************************************* - -**Updates the memory-related settings of a virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Updates the memory-related settings of a virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- hot_add_enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether adding memory while the virtual machine is running should be enabled.
-
Some guest operating systems may consume more resources or perform less efficiently when they run on hardware that supports adding memory while the machine is running.
-
-
This field may only be modified if the virtual machine is not powered on.
-
-
If unset, the value is unchanged.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- size_MiB - -
- integer -
- 		- -
New memory size in mebibytes.
-
The supported range of memory sizes is constrained by the configured guest operating system and virtual hardware version of the virtual machine.
-
-
If the virtual machine is running, this value may only be changed if hot_add_enabled is true, and the new memory size must satisfy the constraints specified by hot_add_increment_size_mib and I()
-
-
If unset, the value is unchanged.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Increase the memory of a VM - vmware.vmware_rest.vcenter_vm_hardware_memory: - vm: '{{ test_vm1_info.id }}' - size_MiB: 1080 - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- dictionary -
- 		On success -
moid of the resource
-
-
-
- value - -
- dictionary -
- 		On success -
Increase the memory of a VM
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_module.rst deleted file mode 100644 index 142648ab0..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_module.rst +++ /dev/null @@ -1,352 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_module: - - -************************************** -vmware.vmware_rest.vcenter_vm_hardware -************************************** - -**Updates the virtual hardware settings of a virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Updates the virtual hardware settings of a virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • upgrade
    • -
- 		-
-
- upgrade_policy - -
- string -
- 		-
    Choices: -
  • AFTER_CLEAN_SHUTDOWN
    • -
  • ALWAYS
    • -
  • NEVER
    • -
- 		-
The upgrade_policy enumerated type defines the valid virtual hardware upgrade policies for a virtual machine.
-
-
- upgrade_version - -
- string -
- 		-
    Choices: -
  • VMX_03
    • -
  • VMX_04
    • -
  • VMX_06
    • -
  • VMX_07
    • -
  • VMX_08
    • -
  • VMX_09
    • -
  • VMX_10
    • -
  • VMX_11
    • -
  • VMX_12
    • -
  • VMX_13
    • -
  • VMX_14
    • -
  • VMX_15
    • -
  • VMX_16
    • -
  • VMX_17
    • -
  • VMX_18
    • -
  • VMX_19
    • -
- 		-
The version enumerated type defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)).
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- version - -
- string -
- 		-
    Choices: -
  • VMX_03
    • -
  • VMX_04
    • -
  • VMX_06
    • -
  • VMX_07
    • -
  • VMX_08
    • -
  • VMX_09
    • -
  • VMX_10
    • -
  • VMX_11
    • -
  • VMX_12
    • -
  • VMX_13
    • -
  • VMX_14
    • -
  • VMX_15
    • -
  • VMX_16
    • -
  • VMX_17
    • -
  • VMX_18
    • -
  • VMX_19
    • -
- 		-
The version enumerated type defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)).
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Upgrade the VM hardware version - vmware.vmware_rest.vcenter_vm_hardware: - upgrade_policy: AFTER_CLEAN_SHUTDOWN - upgrade_version: VMX_11 - vm: "{{ lookup('vmware.vmware_rest.vm_moid', '/my_dc/vm/test_vm1') }}" - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- dictionary -
- 		On success -
moid of the resource
-
-
-
- value - -
- dictionary -
- 		On success -
Upgrade the VM hardware version
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module.rst deleted file mode 100644 index 216e1717e..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module.rst +++ /dev/null @@ -1,273 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module: - - -**************************************************** -vmware.vmware_rest.vcenter_vm_hardware_parallel_info -**************************************************** - -**Returns information about a virtual parallel port.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about a virtual parallel port. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- label - -
- string -
- 		- -
The name of the item
-
-
- port - -
- string -
- 		- -
Virtual parallel port identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_parallel. Required with state=['get']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Retrieve the parallel port information from the VM - vmware.vmware_rest.vcenter_vm_hardware_parallel_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- list -
- 		On success -
Retrieve the parallel port information from the VM
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_module.rst deleted file mode 100644 index cc8acbfec..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_module.rst +++ /dev/null @@ -1,379 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_parallel_module: - - -*********************************************** -vmware.vmware_rest.vcenter_vm_hardware_parallel -*********************************************** - -**Adds a virtual parallel port to the virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Adds a virtual parallel port to the virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- allow_guest_control - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether the guest can connect and disconnect the device.
-
If unset, the value is unchanged.
-
-
- backing - -
- dictionary -
- 		- -
Physical resource backing for the virtual parallel port.
-
If unset, defaults to automatic detection of a suitable host device. Required with state=['present']
-
Valid attributes are:
-
- type (str): This option defines the valid backing types for a virtual parallel port. (['present'])
-
This key is required with ['present'].
-
- Accepted values:
-
- FILE
-
- HOST_DEVICE
-
- file (str): Path of the file that should be used as the virtual parallel port backing.
-
This field is optional and it is only relevant when the value of type is FILE. (['present'])
-
- host_device (str): Name of the device that should be used as the virtual parallel port backing.
-
If unset, the virtual parallel port will be configured to automatically detect a suitable host device. (['present'])
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- port - -
- string -
- 		- -
Virtual parallel port identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_parallel. Required with state=['absent', 'connect', 'disconnect', 'present']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- start_connected - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
-
If unset, the value is unchanged.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • connect
    • -
  • disconnect
    • -
  • present ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Turn on guest control on the parallel port - vmware.vmware_rest.vcenter_vm_hardware_parallel: - vm: '{{ test_vm1_info.id }}' - allow_guest_control: true - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
10000
-
-
- value - -
- dictionary -
- 		On success -
Turn on guest control on the parallel port
-
-
Sample:
-
{'allow_guest_control': 1, 'backing': {'auto_detect': 1, 'host_device': '', 'type': 'HOST_DEVICE'}, 'label': 'Parallel port 1', 'start_connected': 0, 'state': 'NOT_CONNECTED'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_info_module.rst deleted file mode 100644 index 2749aecf1..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_info_module.rst +++ /dev/null @@ -1,298 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_serial_info_module: - - -************************************************** -vmware.vmware_rest.vcenter_vm_hardware_serial_info -************************************************** - -**Returns information about a virtual serial port.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about a virtual serial port. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- label - -
- string -
- 		- -
The name of the item
-
-
- port - -
- string -
- 		- -
Virtual serial port identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_serial. Required with state=['get']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Retrieve the serial ports information from the VM - vmware.vmware_rest.vcenter_vm_hardware_serial_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - name: Get an existing serial port (label) - vmware.vmware_rest.vcenter_vm_hardware_serial_info: - vm: '{{ test_vm1_info.id }}' - label: Serial port 1 - register: serial_port_1 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
9000
-
-
- value - -
- dictionary -
- 		On success -
Get an existing serial port (label)
-
-
Sample:
-
{'allow_guest_control': 1, 'backing': {'auto_detect': 1, 'host_device': '', 'type': 'HOST_DEVICE'}, 'label': 'Serial port 1', 'start_connected': 0, 'state': 'NOT_CONNECTED', 'yield_on_poll': 0}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_module.rst deleted file mode 100644 index e04e688ae..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_module.rst +++ /dev/null @@ -1,453 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_hardware_serial_module: - - -********************************************* -vmware.vmware_rest.vcenter_vm_hardware_serial -********************************************* - -**Adds a virtual serial port to the virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Adds a virtual serial port to the virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- allow_guest_control - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether the guest can connect and disconnect the device.
-
If unset, the value is unchanged.
-
-
- backing - -
- dictionary -
- 		- -
Physical resource backing for the virtual serial port.
-
If unset, defaults to automatic detection of a suitable host device. Required with state=['present']
-
Valid attributes are:
-
- type (str): This option defines the valid backing types for a virtual serial port. (['present'])
-
This key is required with ['present'].
-
- Accepted values:
-
- FILE
-
- HOST_DEVICE
-
- NETWORK_CLIENT
-
- NETWORK_SERVER
-
- PIPE_CLIENT
-
- PIPE_SERVER
-
- file (str): Path of the file backing the virtual serial port.
-
This field is optional and it is only relevant when the value of type is FILE. (['present'])
-
- host_device (str): Name of the device backing the virtual serial port.
-
-
-
If unset, the virtual serial port will be configured to automatically detect a suitable host device. (['present'])
-
- pipe (str): Name of the pipe backing the virtual serial port.
-
This field is optional and it is only relevant when the value of type is one of PIPE_SERVER or PIPE_CLIENT. (['present'])
-
- no_rx_loss (bool): Flag that enables optimized data transfer over the pipe. When the value is true, the host buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss.
-
If unset, defaults to false. (['present'])
-
- network_location (str): URI specifying the location of the network service backing the virtual serial port.
-
- If type is NETWORK_SERVER, this field is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running.
-
- If type is NETWORK_CLIENT, this field is the location used by the virtual machine to connect to the remote server.
-
-
This field is optional and it is only relevant when the value of type is one of NETWORK_SERVER or NETWORK_CLIENT. (['present'])
-
- proxy (str): Proxy service that provides network access to the network backing. If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy.
-
If unset, no proxy service should be used. (['present'])
-
-
- label - -
- string -
- 		- -
The name of the item
-
-
- port - -
- string -
- 		- -
Virtual serial port identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_serial. Required with state=['absent', 'connect', 'disconnect', 'present']
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- start_connected - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
-
If unset, the value is unchanged.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • connect
    • -
  • disconnect
    • -
  • present ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- yield_on_poll - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host.
-
This field may be modified at any time, and changes applied to a connected virtual serial port take effect immediately.
-
-
If unset, the value is unchanged.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Create a new serial port - vmware.vmware_rest.vcenter_vm_hardware_serial: - vm: '{{ test_vm1_info.id }}' - label: Serial port 2 - allow_guest_control: true - register: _result - - - name: Create another serial port with a label - vmware.vmware_rest.vcenter_vm_hardware_serial: - vm: '{{ test_vm1_info.id }}' - label: Serial port 2 - allow_guest_control: true - register: _result - - - name: Create an existing serial port (label) - vmware.vmware_rest.vcenter_vm_hardware_serial: - vm: '{{ test_vm1_info.id }}' - label: Serial port 1 - allow_guest_control: true - register: _result - - - name: Get an existing serial port (label) - vmware.vmware_rest.vcenter_vm_hardware_serial_info: - vm: '{{ test_vm1_info.id }}' - label: Serial port 1 - register: serial_port_1 - - - name: Delete an existing serial port (port id) - vmware.vmware_rest.vcenter_vm_hardware_serial: - vm: '{{ test_vm1_info.id }}' - port: '{{ serial_port_1.id }}' - state: absent - register: _result - - - name: Delete an existing serial port (label) - vmware.vmware_rest.vcenter_vm_hardware_serial: - vm: '{{ test_vm1_info.id }}' - label: Serial port 2 - state: absent - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
9000
-
-
- value - -
- dictionary -
- 		On success -
Create an existing serial port (label)
-
-
Sample:
-
{'allow_guest_control': 1, 'backing': {'auto_detect': 1, 'host_device': '', 'type': 'HOST_DEVICE'}, 'label': 'Serial port 1', 'start_connected': 0, 'state': 'NOT_CONNECTED', 'yield_on_poll': 0}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_info_module.rst deleted file mode 100644 index 512177c81..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_info_module.rst +++ /dev/null @@ -1,448 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_info_module: - - -********************************** -vmware.vmware_rest.vcenter_vm_info -********************************** - -**Returns information about a virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about a virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- clusters - -
- list - / elements=string -
- 		- -
Clusters that must contain the virtual machine for the virtual machine to match the filter.
-
If unset or empty, virtual machines in any cluster match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_cluster_info.
-
-
- datacenters - -
- list - / elements=string -
- 		- -
Datacenters that must contain the virtual machine for the virtual machine to match the filter.
-
If unset or empty, virtual machines in any datacenter match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_datacenter_info.
-

aliases: filter_datacenters
-
-
- folders - -
- list - / elements=string -
- 		- -
Folders that must contain the virtual machine for the virtual machine to match the filter.
-
If unset or empty, virtual machines in any folder match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_folder_info.
-

aliases: filter_folders
-
-
- hosts - -
- list - / elements=string -
- 		- -
Hosts that must contain the virtual machine for the virtual machine to match the filter.
-
If unset or empty, virtual machines on any host match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_host_info.
-
-
- names - -
- list - / elements=string -
- 		- -
Names that virtual machines must have to match the filter (see name).
-
If unset or empty, virtual machines with any name match the filter.
-

aliases: filter_names
-
-
- power_states - -
- list - / elements=string -
- 		- -
Power states that a virtual machine must be in to match the filter (see I()
-
If unset or empty, virtual machines in any power state match the filter.
-
-
- resource_pools - -
- list - / elements=string -
- 		- -
Resource pools that must contain the virtual machine for the virtual machine to match the filter.
-
If unset or empty, virtual machines in any resource pool match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_resourcepool_info.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- vms - -
- list - / elements=string -
- 		- -
Identifiers of virtual machines that can match the filter.
-
If unset or empty, virtual machines with any identifier match the filter.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_vm_info.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - name: test_vm1 - guest_OS: RHEL_7_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - disks: - - type: SATA - backing: - type: VMDK_FILE - vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk' - - type: SATA - new_vmdk: - name: second_disk - capacity: 32000000000 - cdroms: - - type: SATA - sata: - bus: 0 - unit: 2 - nics: - - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: my_vm - - - name: Wait until my VM is off - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ my_vm.id }}' - register: vm_info - until: - - vm_info is not failed - - vm_info.value.power_state == "POWERED_OFF" - retries: 60 - delay: 5 - - - register: _should_be_empty - name: Search with an invalid filter - vmware.vmware_rest.vcenter_vm_info: - filter_names: test_vm1_does_not_exists - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
vm-1049
-
-
- value - -
- dictionary -
- 		On success -
Wait until my VM is off
-
-
Sample:
-
{'boot': {'delay': 0, 'enter_setup_mode': 0, 'retry': 0, 'retry_delay': 10000, 'type': 'BIOS'}, 'boot_devices': [], 'cdroms': {'16002': {'allow_guest_control': 0, 'backing': {'auto_detect': 1, 'device_access_type': 'EMULATION', 'type': 'HOST_DEVICE'}, 'label': 'CD/DVD drive 1', 'sata': {'bus': 0, 'unit': 2}, 'start_connected': 0, 'state': 'NOT_CONNECTED', 'type': 'SATA'}}, 'cpu': {'cores_per_socket': 1, 'count': 1, 'hot_add_enabled': 0, 'hot_remove_enabled': 0}, 'disks': {'16000': {'backing': {'type': 'VMDK_FILE', 'vmdk_file': '[local] test_vm1/rhel-8.5.vmdk'}, 'capacity': 16106127360, 'label': 'Hard disk 1', 'sata': {'bus': 0, 'unit': 0}, 'type': 'SATA'}, '16001': {'backing': {'type': 'VMDK_FILE', 'vmdk_file': '[local] test_vm1_1/second_disk.vmdk'}, 'capacity': 32000000000, 'label': 'Hard disk 2', 'sata': {'bus': 0, 'unit': 1}, 'type': 'SATA'}}, 'floppies': {}, 'guest_OS': 'RHEL_7_64', 'hardware': {'upgrade_policy': 'NEVER', 'upgrade_status': 'NONE', 'version': 'VMX_11'}, 'identity': {'bios_uuid': '4231943a-a1b5-9d24-1e05-d447e9ff0396', 'instance_uuid': '5031e081-01a7-d61a-31f8-4bc54057ec60', 'name': 'test_vm1'}, 'instant_clone_frozen': 0, 'memory': {'hot_add_enabled': 1, 'size_MiB': 1024}, 'name': 'test_vm1', 'nics': {'4000': {'allow_guest_control': 0, 'backing': {'network': 'network-1041', 'network_name': 'VM Network', 'type': 'STANDARD_PORTGROUP'}, 'label': 'Network adapter 1', 'mac_address': '00:50:56:b1:22:7d', 'mac_type': 'ASSIGNED', 'pci_slot_number': 160, 'start_connected': 0, 'state': 'NOT_CONNECTED', 'type': 'VMXNET3', 'upt_compatibility_enabled': 0, 'wake_on_lan_enabled': 0}}, 'nvme_adapters': {}, 'parallel_ports': {}, 'power_state': 'POWERED_OFF', 'sata_adapters': {'15000': {'bus': 0, 'label': 'SATA controller 0', 'pci_slot_number': 32, 'type': 'AHCI'}}, 'scsi_adapters': {}, 'serial_ports': {}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_libraryitem_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_libraryitem_info_module.rst deleted file mode 100644 index bcb66ccdc..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_libraryitem_info_module.rst +++ /dev/null @@ -1,241 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_libraryitem_info_module: - - -********************************************** -vmware.vmware_rest.vcenter_vm_libraryitem_info -********************************************** - -**Returns the information about the library item associated with the virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns the information about the library item associated with the virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Identifier of the virtual machine.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Get the information from the library - vmware.vmware_rest.vcenter_vm_libraryitem_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get the information from the library
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_module.rst b/docs/vmware.vmware_rest.vcenter_vm_module.rst deleted file mode 100644 index 3911f62d6..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_module.rst +++ /dev/null @@ -1,1445 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_module: - - -***************************** -vmware.vmware_rest.vcenter_vm -***************************** - -**Creates a virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Creates a virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- bios_uuid - -
- string -
- 		- -
128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format.
-
If unset, will be generated.
-
-
- boot - -
- dictionary -
- 		- -
Boot configuration.
-
If unset, guest-specific default values will be used.
-
Valid attributes are:
-
- type (str): This option defines the valid firmware types for a virtual machine. (['present'])
-
- Accepted values:
-
- BIOS
-
- EFI
-
- efi_legacy_boot (bool): Flag indicating whether to use EFI legacy boot mode.
-
If unset, defaults to value that is recommended for the guest OS and is supported for the virtual hardware version. (['present'])
-
- network_protocol (str): This option defines the valid network boot protocols supported when booting a virtual machine with EFI firmware over the network. (['present'])
-
- Accepted values:
-
- IPV4
-
- IPV6
-
- delay (int): Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode.
-
If unset, default value is 0. (['present'])
-
- retry (bool): Flag indicating whether the virtual machine should automatically retry the boot process after a failure.
-
If unset, default value is false. (['present'])
-
- retry_delay (int): Delay in milliseconds before retrying the boot process after a failure; applicable only when retry is true.
-
If unset, default value is 10000. (['present'])
-
- enter_setup_mode (bool): Flag indicating whether the firmware boot process should automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode.
-
If unset, the value is unchanged. (['present'])
-
-
- boot_devices - -
- list - / elements=dictionary -
- 		- -
Boot device configuration.
-
If unset, a server-specific boot sequence will be used.
-
Valid attributes are:
-
- type (str): This option defines the valid device types that may be used as bootable devices. (['present'])
-
This key is required with ['present'].
-
- Accepted values:
-
- CDROM
-
- DISK
-
- ETHERNET
-
- FLOPPY
-
-
- cdroms - -
- list - / elements=dictionary -
- 		- -
List of CD-ROMs.
-
If unset, no CD-ROM devices will be created.
-
Valid attributes are:
-
- type (str): This option defines the valid types of host bus adapters that may be used for attaching a Cdrom to a virtual machine. (['present'])
-
- Accepted values:
-
- IDE
-
- SATA
-
- ide (dict): Address for attaching the device to a virtual IDE adapter.
-
If unset, the server will choose an available address; if none is available, the request will fail. (['present'])
-
- Accepted keys:
-
- primary (boolean): Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine.
-
If unset, the server will choose a adapter with an available connection. If no IDE connections are available, the request will be rejected.
-
- master (boolean): Flag specifying whether the device should be the master or slave device on the IDE adapter.
-
If unset, the server will choose an available connection type. If no IDE connections are available, the request will be rejected.
-
- sata (dict): Address for attaching the device to a virtual SATA adapter.
-
If unset, the server will choose an available address; if none is available, the request will fail. (['present'])
-
- Accepted keys:
-
- bus (integer): Bus number of the adapter to which the device should be attached.
-
- unit (integer): Unit number of the device.
-
If unset, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected.
-
- backing (dict): Physical resource backing for the virtual CD-ROM device.
-
If unset, defaults to automatic detection of a suitable host device. (['present'])
-
- Accepted keys:
-
- type (string): This option defines the valid backing types for a virtual CD-ROM device.
-
Accepted value for this field:
-
- CLIENT_DEVICE
-
- HOST_DEVICE
-
- ISO_FILE
-
- iso_file (string): Path of the image file that should be used as the virtual CD-ROM device backing.
-
This field is optional and it is only relevant when the value of type is ISO_FILE.
-
- host_device (string): Name of the device that should be used as the virtual CD-ROM device backing.
-
If unset, the virtual CD-ROM device will be configured to automatically detect a suitable host device.
-
- device_access_type (string): This option defines the valid device access types for a physical device packing of a virtual CD-ROM device.
-
Accepted value for this field:
-
- EMULATION
-
- PASSTHRU
-
- PASSTHRU_EXCLUSIVE
-
- start_connected (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
-
Defaults to false if unset. (['present'])
-
- allow_guest_control (bool): Flag indicating whether the guest can connect and disconnect the device.
-
Defaults to false if unset. (['present'])
-
-
- cpu - -
- dictionary -
- 		- -
CPU configuration.
-
If unset, guest-specific default values will be used.
-
Valid attributes are:
-
- count (int): New number of CPU cores. The number of CPU cores in the virtual machine must be a multiple of the number of cores per socket.
-
The supported range of CPU counts is constrained by the configured guest operating system and virtual hardware version of the virtual machine.
-
-
If the virtual machine is running, the number of CPU cores may only be increased if hot_add_enabled is true, and may only be decreased if hot_remove_enabled is true.
-
-
If unset, the value is unchanged. (['present'])
-
- cores_per_socket (int): New number of CPU cores per socket. The number of CPU cores in the virtual machine must be a multiple of the number of cores per socket.
-
If unset, the value is unchanged. (['present'])
-
- hot_add_enabled (bool): Flag indicating whether adding CPUs while the virtual machine is running is enabled.
-
This field may only be modified if the virtual machine is powered off.
-
-
If unset, the value is unchanged. (['present'])
-
- hot_remove_enabled (bool): Flag indicating whether removing CPUs while the virtual machine is running is enabled.
-
This field may only be modified if the virtual machine is powered off.
-
-
If unset, the value is unchanged. (['present'])
-
-
- datastore - -
- string -
- 		- -
Identifier of the datastore on which the virtual machine's configuration state is stored.
-
If unset, path must also be unset and datastore_path must be set.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_datastore_info.
-
-
- datastore_path - -
- string -
- 		- -
Datastore path for the virtual machine's configuration file in the format "[datastore name] path". For example "[storage1] Test-VM/Test-VM.vmx".
-
If unset, both datastore and path must be set.
-
-
- disconnect_all_nics - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Indicates whether all NICs on the destination virtual machine should be disconnected from the newtwork
-
If unset, connection status of all NICs on the destination virtual machine will be the same as on the source virtual machine.
-
-
- disks - -
- list - / elements=dictionary -
- 		- -
Individual disk relocation map.
-
If unset, all disks will migrate to the datastore specified in the datastore field of I()
-
When clients pass a value of this structure as a parameter, the key in the field map must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_disk.
-
Valid attributes are:
-
- type (str): This option defines the valid types of host bus adapters that may be used for attaching a virtual storage device to a virtual machine. (['present'])
-
- Accepted values:
-
- IDE
-
- NVME
-
- SATA
-
- SCSI
-
- ide (dict): Address for attaching the device to a virtual IDE adapter.
-
If unset, the server will choose an available address; if none is available, the request will fail. (['present'])
-
- Accepted keys:
-
- primary (boolean): Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine.
-
If unset, the server will choose a adapter with an available connection. If no IDE connections are available, the request will be rejected.
-
- master (boolean): Flag specifying whether the device should be the master or slave device on the IDE adapter.
-
If unset, the server will choose an available connection type. If no IDE connections are available, the request will be rejected.
-
- scsi (dict): Address for attaching the device to a virtual SCSI adapter.
-
If unset, the server will choose an available address; if none is available, the request will fail. (['present'])
-
- Accepted keys:
-
- bus (integer): Bus number of the adapter to which the device should be attached.
-
- unit (integer): Unit number of the device.
-
If unset, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected.
-
- sata (dict): Address for attaching the device to a virtual SATA adapter.
-
If unset, the server will choose an available address; if none is available, the request will fail. (['present'])
-
- Accepted keys:
-
- bus (integer): Bus number of the adapter to which the device should be attached.
-
- unit (integer): Unit number of the device.
-
If unset, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected.
-
- nvme (dict): Address for attaching the device to a virtual NVMe adapter.
-
If unset, the server will choose an available address; if none is available, the request will fail. (['present'])
-
- Accepted keys:
-
- bus (integer): Bus number of the adapter to which the device should be attached.
-
- unit (integer): Unit number of the device.
-
If unset, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected.
-
- backing (dict): Existing physical resource backing for the virtual disk. Exactly one of backing or new_vmdk must be specified.
-
If unset, the virtual disk will not be connected to an existing backing. (['present'])
-
- Accepted keys:
-
- type (string): This option defines the valid backing types for a virtual disk.
-
Accepted value for this field:
-
- VMDK_FILE
-
- vmdk_file (string): Path of the VMDK file backing the virtual disk.
-
This field is optional and it is only relevant when the value of type is VMDK_FILE.
-
- new_vmdk (dict): Specification for creating a new VMDK backing for the virtual disk. Exactly one of backing or new_vmdk must be specified.
-
If unset, a new VMDK backing will not be created. (['present'])
-
- Accepted keys:
-
- name (string): Base name of the VMDK file. The name should not include the '.vmdk' file extension.
-
If unset, a name (derived from the name of the virtual machine) will be chosen by the server.
-
- capacity (integer): Capacity of the virtual disk backing in bytes.
-
If unset, defaults to a guest-specific capacity.
-
- storage_policy (object): The storage_policy_spec structure contains information about the storage policy that is to be associated the with VMDK file.
-
If unset the default storage policy of the target datastore (if applicable) is applied. Currently a default storage policy is only supported by object based datastores : VVol & vSAN. For non- object datastores, if unset then no storage policy would be associated with the VMDK file.
-
-
- disks_to_remove - -
- list - / elements=string -
- 		- -
Set of Disks to Remove.
-
If unset, all disks will be copied. If the same identifier is in disks_to_update InvalidArgument fault will be returned.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_vm_hardware_disk.
-
-
- disks_to_update - -
- dictionary -
- 		- -
Map of Disks to Update.
-
If unset, all disks will copied to the datastore specified in the datastore field of I() If the same identifier is in disks_to_remove InvalidArgument fault will be thrown.
-
When clients pass a value of this structure as a parameter, the key in the field map must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_disk.
-
-
- floppies - -
- list - / elements=dictionary -
- 		- -
List of floppy drives.
-
If unset, no floppy drives will be created.
-
Valid attributes are:
-
- backing (dict): Physical resource backing for the virtual floppy drive.
-
If unset, defaults to automatic detection of a suitable host device. (['present'])
-
- Accepted keys:
-
- type (string): This option defines the valid backing types for a virtual floppy drive.
-
Accepted value for this field:
-
- CLIENT_DEVICE
-
- HOST_DEVICE
-
- IMAGE_FILE
-
- image_file (string): Path of the image file that should be used as the virtual floppy drive backing.
-
This field is optional and it is only relevant when the value of type is IMAGE_FILE.
-
- host_device (string): Name of the device that should be used as the virtual floppy drive backing.
-
If unset, the virtual floppy drive will be configured to automatically detect a suitable host device.
-
- start_connected (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
-
Defaults to false if unset. (['present'])
-
- allow_guest_control (bool): Flag indicating whether the guest can connect and disconnect the device.
-
Defaults to false if unset. (['present'])
-
-
- guest_customization_spec - -
- dictionary -
- 		- -
Guest customization spec to apply to the virtual machine after the virtual machine is deployed.
-
If unset, the guest operating system is not customized after clone.
-
Valid attributes are:
-
- name (str): Name of the customization specification.
-
If unset, no guest customization is performed. (['clone'])
-
-
- guest_OS - -
- string -
- 		-
    Choices: -
  • AMAZONLINUX2_64
    • -
  • AMAZONLINUX3_64
    • -
  • ASIANUX_3
    • -
  • ASIANUX_3_64
    • -
  • ASIANUX_4
    • -
  • ASIANUX_4_64
    • -
  • ASIANUX_5_64
    • -
  • ASIANUX_7_64
    • -
  • ASIANUX_8_64
    • -
  • ASIANUX_9_64
    • -
  • CENTOS
    • -
  • CENTOS_6
    • -
  • CENTOS_64
    • -
  • CENTOS_6_64
    • -
  • CENTOS_7
    • -
  • CENTOS_7_64
    • -
  • CENTOS_8_64
    • -
  • CENTOS_9_64
    • -
  • COREOS_64
    • -
  • CRXPOD_1
    • -
  • DARWIN
    • -
  • DARWIN_10
    • -
  • DARWIN_10_64
    • -
  • DARWIN_11
    • -
  • DARWIN_11_64
    • -
  • DARWIN_12_64
    • -
  • DARWIN_13_64
    • -
  • DARWIN_14_64
    • -
  • DARWIN_15_64
    • -
  • DARWIN_16_64
    • -
  • DARWIN_17_64
    • -
  • DARWIN_18_64
    • -
  • DARWIN_19_64
    • -
  • DARWIN_20_64
    • -
  • DARWIN_21_64
    • -
  • DARWIN_64
    • -
  • DEBIAN_10
    • -
  • DEBIAN_10_64
    • -
  • DEBIAN_11
    • -
  • DEBIAN_11_64
    • -
  • DEBIAN_4
    • -
  • DEBIAN_4_64
    • -
  • DEBIAN_5
    • -
  • DEBIAN_5_64
    • -
  • DEBIAN_6
    • -
  • DEBIAN_6_64
    • -
  • DEBIAN_7
    • -
  • DEBIAN_7_64
    • -
  • DEBIAN_8
    • -
  • DEBIAN_8_64
    • -
  • DEBIAN_9
    • -
  • DEBIAN_9_64
    • -
  • DOS
    • -
  • ECOMSTATION
    • -
  • ECOMSTATION_2
    • -
  • FEDORA
    • -
  • FEDORA_64
    • -
  • FREEBSD
    • -
  • FREEBSD_11
    • -
  • FREEBSD_11_64
    • -
  • FREEBSD_12
    • -
  • FREEBSD_12_64
    • -
  • FREEBSD_13
    • -
  • FREEBSD_13_64
    • -
  • FREEBSD_64
    • -
  • GENERIC_LINUX
    • -
  • MANDRAKE
    • -
  • MANDRIVA
    • -
  • MANDRIVA_64
    • -
  • NETWARE_4
    • -
  • NETWARE_5
    • -
  • NETWARE_6
    • -
  • NLD_9
    • -
  • OES
    • -
  • OPENSERVER_5
    • -
  • OPENSERVER_6
    • -
  • OPENSUSE
    • -
  • OPENSUSE_64
    • -
  • ORACLE_LINUX
    • -
  • ORACLE_LINUX_6
    • -
  • ORACLE_LINUX_64
    • -
  • ORACLE_LINUX_6_64
    • -
  • ORACLE_LINUX_7
    • -
  • ORACLE_LINUX_7_64
    • -
  • ORACLE_LINUX_8_64
    • -
  • ORACLE_LINUX_9_64
    • -
  • OS2
    • -
  • OTHER
    • -
  • OTHER_24X_LINUX
    • -
  • OTHER_24X_LINUX_64
    • -
  • OTHER_26X_LINUX
    • -
  • OTHER_26X_LINUX_64
    • -
  • OTHER_3X_LINUX
    • -
  • OTHER_3X_LINUX_64
    • -
  • OTHER_4X_LINUX
    • -
  • OTHER_4X_LINUX_64
    • -
  • OTHER_5X_LINUX
    • -
  • OTHER_5X_LINUX_64
    • -
  • OTHER_64
    • -
  • OTHER_LINUX
    • -
  • OTHER_LINUX_64
    • -
  • REDHAT
    • -
  • RHEL_2
    • -
  • RHEL_3
    • -
  • RHEL_3_64
    • -
  • RHEL_4
    • -
  • RHEL_4_64
    • -
  • RHEL_5
    • -
  • RHEL_5_64
    • -
  • RHEL_6
    • -
  • RHEL_6_64
    • -
  • RHEL_7
    • -
  • RHEL_7_64
    • -
  • RHEL_8_64
    • -
  • RHEL_9_64
    • -
  • SJDS
    • -
  • SLES
    • -
  • SLES_10
    • -
  • SLES_10_64
    • -
  • SLES_11
    • -
  • SLES_11_64
    • -
  • SLES_12
    • -
  • SLES_12_64
    • -
  • SLES_15_64
    • -
  • SLES_16_64
    • -
  • SLES_64
    • -
  • SOLARIS_10
    • -
  • SOLARIS_10_64
    • -
  • SOLARIS_11_64
    • -
  • SOLARIS_6
    • -
  • SOLARIS_7
    • -
  • SOLARIS_8
    • -
  • SOLARIS_9
    • -
  • SUSE
    • -
  • SUSE_64
    • -
  • TURBO_LINUX
    • -
  • TURBO_LINUX_64
    • -
  • UBUNTU
    • -
  • UBUNTU_64
    • -
  • UNIXWARE_7
    • -
  • VMKERNEL
    • -
  • VMKERNEL_5
    • -
  • VMKERNEL_6
    • -
  • VMKERNEL_65
    • -
  • VMKERNEL_7
    • -
  • VMWARE_PHOTON_64
    • -
  • WINDOWS_7
    • -
  • WINDOWS_7_64
    • -
  • WINDOWS_7_SERVER_64
    • -
  • WINDOWS_8
    • -
  • WINDOWS_8_64
    • -
  • WINDOWS_8_SERVER_64
    • -
  • WINDOWS_9
    • -
  • WINDOWS_9_64
    • -
  • WINDOWS_9_SERVER_64
    • -
  • WINDOWS_HYPERV
    • -
  • WINDOWS_SERVER_2019
    • -
  • WINDOWS_SERVER_2021
    • -
  • WIN_2000_ADV_SERV
    • -
  • WIN_2000_PRO
    • -
  • WIN_2000_SERV
    • -
  • WIN_31
    • -
  • WIN_95
    • -
  • WIN_98
    • -
  • WIN_LONGHORN
    • -
  • WIN_LONGHORN_64
    • -
  • WIN_ME
    • -
  • WIN_NET_BUSINESS
    • -
  • WIN_NET_DATACENTER
    • -
  • WIN_NET_DATACENTER_64
    • -
  • WIN_NET_ENTERPRISE
    • -
  • WIN_NET_ENTERPRISE_64
    • -
  • WIN_NET_STANDARD
    • -
  • WIN_NET_STANDARD_64
    • -
  • WIN_NET_WEB
    • -
  • WIN_NT
    • -
  • WIN_VISTA
    • -
  • WIN_VISTA_64
    • -
  • WIN_XP_HOME
    • -
  • WIN_XP_PRO
    • -
  • WIN_XP_PRO_64
    • -
- 		-
The GuestOS enumerated type defines the valid guest operating system types used for configuring a virtual machine. Required with state=['present']
-
-
- hardware_version - -
- string -
- 		-
    Choices: -
  • VMX_03
    • -
  • VMX_04
    • -
  • VMX_06
    • -
  • VMX_07
    • -
  • VMX_08
    • -
  • VMX_09
    • -
  • VMX_10
    • -
  • VMX_11
    • -
  • VMX_12
    • -
  • VMX_13
    • -
  • VMX_14
    • -
  • VMX_15
    • -
  • VMX_16
    • -
  • VMX_17
    • -
  • VMX_18
    • -
  • VMX_19
    • -
- 		-
The version enumerated type defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)).
-
-
- memory - -
- dictionary -
- 		- -
Memory configuration.
-
If unset, guest-specific default values will be used.
-
Valid attributes are:
-
- size_MiB (int): New memory size in mebibytes.
-
The supported range of memory sizes is constrained by the configured guest operating system and virtual hardware version of the virtual machine.
-
-
If the virtual machine is running, this value may only be changed if hot_add_enabled is true, and the new memory size must satisfy the constraints specified by hot_add_increment_size_mib and I()
-
-
If unset, the value is unchanged. (['present'])
-
- hot_add_enabled (bool): Flag indicating whether adding memory while the virtual machine is running should be enabled.
-
Some guest operating systems may consume more resources or perform less efficiently when they run on hardware that supports adding memory while the machine is running.
-
-
This field may only be modified if the virtual machine is not powered on.
-
-
If unset, the value is unchanged. (['present'])
-
-
- name - -
- string -
- 		- -
Virtual machine name.
-
If unset, the display name from the virtual machine's configuration file will be used.
-
-
- nics - -
- list - / elements=dictionary -
- 		- -
List of Ethernet adapters.
-
If unset, no Ethernet adapters will be created.
-
Valid attributes are:
-
- type (str): This option defines the valid emulation types for a virtual Ethernet adapter. (['present'])
-
- Accepted values:
-
- E1000
-
- E1000E
-
- PCNET32
-
- VMXNET
-
- VMXNET2
-
- VMXNET3
-
- upt_compatibility_enabled (bool): Flag indicating whether Universal Pass-Through (UPT) compatibility is enabled on this virtual Ethernet adapter.
-
If unset, defaults to false. (['present'])
-
- mac_type (str): This option defines the valid MAC address origins for a virtual Ethernet adapter. (['present'])
-
- Accepted values:
-
- ASSIGNED
-
- GENERATED
-
- MANUAL
-
- mac_address (str): MAC address.
-
Workaround for PR1459647 (['present'])
-
- pci_slot_number (int): Address of the virtual Ethernet adapter on the PCI bus. If the PCI address is invalid, the server will change when it the VM is started or as the device is hot added.
-
If unset, the server will choose an available address when the virtual machine is powered on. (['present'])
-
- wake_on_lan_enabled (bool): Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter.
-
Defaults to false if unset. (['present'])
-
- backing (dict): Physical resource backing for the virtual Ethernet adapter.
-
If unset, the system may try to find an appropriate backing. If one is not found, the request will fail. (['present'])
-
- Accepted keys:
-
- type (string): This option defines the valid backing types for a virtual Ethernet adapter.
-
Accepted value for this field:
-
- DISTRIBUTED_PORTGROUP
-
- HOST_DEVICE
-
- OPAQUE_NETWORK
-
- STANDARD_PORTGROUP
-
- network (string): Identifier of the network that backs the virtual Ethernet adapter.
-
This field is optional and it is only relevant when the value of type is one of STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP, or OPAQUE_NETWORK.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_network_info.
-
- distributed_port (string): Key of the distributed virtual port that backs the virtual Ethernet adapter. Depending on the type of the Portgroup, the port may be specified using this field. If the portgroup type is early-binding (also known as static), a port is assigned when the Ethernet adapter is configured to use the port. The port may be either automatically or specifically assigned based on the value of this field. If the portgroup type is ephemeral, the port is created and assigned to a virtual machine when it is powered on and the Ethernet adapter is connected. This field cannot be specified as no free ports exist before use.
-
May be used to specify a port when the network specified on the network field is a static or early binding distributed portgroup. If unset, the port will be automatically assigned to the Ethernet adapter based on the policy embodied by the portgroup type.
-
- start_connected (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
-
Defaults to false if unset. (['present'])
-
- allow_guest_control (bool): Flag indicating whether the guest can connect and disconnect the device.
-
Defaults to false if unset. (['present'])
-
-
- nics_to_update - -
- dictionary -
- 		- -
Map of NICs to update.
-
If unset, no NICs will be updated.
-
When clients pass a value of this structure as a parameter, the key in the field map must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_ethernet.
-
-
- nvme_adapters - -
- list - / elements=dictionary -
- 		- -
List of NVMe adapters.
-
If unset, any adapters necessary to connect the virtual machine's storage devices will be created; this includes any devices that explicitly specify a NVMe host bus adapter, as well as any devices that do not specify a host bus adapter if the guest's preferred adapter type is NVMe.
-
Valid attributes are:
-
- bus (int): NVMe bus number.
-
If unset, the server will choose an available bus number; if none is available, the request will fail. (['present'])
-
- pci_slot_number (int): Address of the NVMe adapter on the PCI bus.
-
If unset, the server will choose an available address when the virtual machine is powered on. (['present'])
-
-
- parallel_ports - -
- list - / elements=dictionary -
- 		- -
List of parallel ports.
-
If unset, no parallel ports will be created.
-
Valid attributes are:
-
- backing (dict): Physical resource backing for the virtual parallel port.
-
If unset, defaults to automatic detection of a suitable host device. (['present'])
-
- Accepted keys:
-
- type (string): This option defines the valid backing types for a virtual parallel port.
-
Accepted value for this field:
-
- FILE
-
- HOST_DEVICE
-
- file (string): Path of the file that should be used as the virtual parallel port backing.
-
This field is optional and it is only relevant when the value of type is FILE.
-
- host_device (string): Name of the device that should be used as the virtual parallel port backing.
-
If unset, the virtual parallel port will be configured to automatically detect a suitable host device.
-
- start_connected (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
-
Defaults to false if unset. (['present'])
-
- allow_guest_control (bool): Flag indicating whether the guest can connect and disconnect the device.
-
Defaults to false if unset. (['present'])
-
-
- parallel_ports_to_update - -
- dictionary -
- 		- -
Map of parallel ports to Update.
-
If unset, no parallel ports will be updated.
-
When clients pass a value of this structure as a parameter, the key in the field map must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_parallel.
-
-
- path - -
- string -
- 		- -
Path to the virtual machine's configuration file on the datastore corresponding to {@link #datastore).
-
If unset, datastore must also be unset and datastore_path must be set.
-
-
- placement - -
- dictionary -
- 		- -
Virtual machine placement information.
-
If this field is unset, the system will use the values from the source virtual machine. If specified, each field will be used for placement. If the fields result in disjoint placement the operation will fail. If the fields along with the other existing placement of the virtual machine result in disjoint placement the operation will fail.
-
Valid attributes are:
-
- folder (str): Virtual machine folder into which the virtual machine should be placed.
-
If this field is unset, the virtual machine will stay in the current folder.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_folder_info. (['clone', 'instant_clone', 'present', 'register', 'relocate'])
-
- resource_pool (str): Resource pool into which the virtual machine should be placed.
-
If this field is unset, the virtual machine will stay in the current resource pool.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_resourcepool_info. (['clone', 'instant_clone', 'present', 'register', 'relocate'])
-
- host (str): Host onto which the virtual machine should be placed.
-
If host and resource_pool are both specified, resource_pool must belong to host.
-
-
If host and cluster are both specified, host must be a member of cluster.
-
-
If this field is unset, if resource_pool is unset, the virtual machine will remain on the current host. if resource_pool is set, and the target is a standalone host, the host is used. if resource_pool is set, and the target is a DRS cluster, a host will be picked by DRS. if resource_pool is set, and the target is a cluster without DRS, InvalidArgument will be thrown.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_host_info. (['clone', 'present', 'register', 'relocate'])
-
- cluster (str): Cluster into which the virtual machine should be placed.
-
If cluster and resource_pool are both specified, resource_pool must belong to cluster.
-
-
If cluster and host are both specified, host must be a member of cluster.
-
-
If resource_pool or host is specified, it is recommended that this field be unset.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_cluster_info. (['clone', 'present', 'register', 'relocate'])
-
- datastore (str): Datastore on which the virtual machine's configuration state should be stored. This datastore will also be used for any virtual disks that are associated with the virtual machine, unless individually overridden.
-
If this field is unset, the virtual machine will remain on the current datastore.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_datastore_info. (['clone', 'instant_clone', 'present', 'relocate'])
-
-
- power_on - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Attempt to perform a power_on after clone.
-
If unset, the virtual machine will not be powered on.
-
-
- sata_adapters - -
- list - / elements=dictionary -
- 		- -
List of SATA adapters.
-
If unset, any adapters necessary to connect the virtual machine's storage devices will be created; this includes any devices that explicitly specify a SATA host bus adapter, as well as any devices that do not specify a host bus adapter if the guest's preferred adapter type is SATA.
-
Valid attributes are:
-
- type (str): This option defines the valid emulation types for a virtual SATA adapter. (['present'])
-
- Accepted values:
-
- AHCI
-
- bus (int): SATA bus number.
-
If unset, the server will choose an available bus number; if none is available, the request will fail. (['present'])
-
- pci_slot_number (int): Address of the SATA adapter on the PCI bus.
-
If unset, the server will choose an available address when the virtual machine is powered on. (['present'])
-
-
- scsi_adapters - -
- list - / elements=dictionary -
- 		- -
List of SCSI adapters.
-
If unset, any adapters necessary to connect the virtual machine's storage devices will be created; this includes any devices that explicitly specify a SCSI host bus adapter, as well as any devices that do not specify a host bus adapter if the guest's preferred adapter type is SCSI. The type of the SCSI adapter will be a guest-specific default type.
-
Valid attributes are:
-
- type (str): This option defines the valid emulation types for a virtual SCSI adapter. (['present'])
-
- Accepted values:
-
- BUSLOGIC
-
- LSILOGIC
-
- LSILOGICSAS
-
- PVSCSI
-
- bus (int): SCSI bus number.
-
If unset, the server will choose an available bus number; if none is available, the request will fail. (['present'])
-
- pci_slot_number (int): Address of the SCSI adapter on the PCI bus. If the PCI address is invalid, the server will change it when the VM is started or as the device is hot added.
-
If unset, the server will choose an available address when the virtual machine is powered on. (['present'])
-
- sharing (str): This option defines the valid bus sharing modes for a virtual SCSI adapter. (['present'])
-
- Accepted values:
-
- NONE
-
- PHYSICAL
-
- VIRTUAL
-
-
- serial_ports - -
- list - / elements=dictionary -
- 		- -
List of serial ports.
-
If unset, no serial ports will be created.
-
Valid attributes are:
-
- yield_on_poll (bool): CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host.
-
If unset, defaults to false. (['present'])
-
- backing (dict): Physical resource backing for the virtual serial port.
-
If unset, defaults to automatic detection of a suitable host device. (['present'])
-
- Accepted keys:
-
- type (string): This option defines the valid backing types for a virtual serial port.
-
Accepted value for this field:
-
- FILE
-
- HOST_DEVICE
-
- NETWORK_CLIENT
-
- NETWORK_SERVER
-
- PIPE_CLIENT
-
- PIPE_SERVER
-
- file (string): Path of the file backing the virtual serial port.
-
This field is optional and it is only relevant when the value of type is FILE.
-
- host_device (string): Name of the device backing the virtual serial port.
-
-
-
If unset, the virtual serial port will be configured to automatically detect a suitable host device.
-
- pipe (string): Name of the pipe backing the virtual serial port.
-
This field is optional and it is only relevant when the value of type is one of PIPE_SERVER or PIPE_CLIENT.
-
- no_rx_loss (boolean): Flag that enables optimized data transfer over the pipe. When the value is true, the host buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss.
-
If unset, defaults to false.
-
- network_location (string): URI specifying the location of the network service backing the virtual serial port.
-
- If type is NETWORK_SERVER, this field is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running.
-
- If type is NETWORK_CLIENT, this field is the location used by the virtual machine to connect to the remote server.
-
-
This field is optional and it is only relevant when the value of type is one of NETWORK_SERVER or NETWORK_CLIENT.
-
- proxy (string): Proxy service that provides network access to the network backing. If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy.
-
If unset, no proxy service should be used.
-
- start_connected (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
-
Defaults to false if unset. (['present'])
-
- allow_guest_control (bool): Flag indicating whether the guest can connect and disconnect the device.
-
Defaults to false if unset. (['present'])
-
-
- serial_ports_to_update - -
- dictionary -
- 		- -
Map of serial ports to Update.
-
If unset, no serial ports will be updated.
-
When clients pass a value of this structure as a parameter, the key in the field map must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_serial.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- source - -
- string -
- 		- -
Virtual machine to InstantClone from.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['clone', 'instant_clone']
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • clone
    • -
  • instant_clone
    • -
  • present ←
    • -
  • register
    • -
  • relocate
    • -
  • unregister
    • -
- 		-
-
- storage_policy - -
- dictionary -
- 		- -
The storage_policy_spec structure contains information about the storage policy that is to be associated with the virtual machine home (which contains the configuration and log files).
-
If unset the datastore default storage policy (if applicable) is applied. Currently a default storage policy is only supported by object datastores : VVol and vSAN. For non-object datastores, if unset then no storage policy would be associated with the virtual machine home. Required with state=['present']
-
Valid attributes are:
-
- policy (str): Identifier of the storage policy which should be associated with the virtual machine.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_storage_policies. (['present'])
-
This key is required with ['present'].
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Identifier of the virtual machine to be unregistered.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['absent', 'relocate', 'unregister']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - name: test_vm1 - guest_OS: RHEL_7_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - register: my_vm - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - name: test_vm1 - guest_OS: RHEL_7_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - disks: - - type: SATA - backing: - type: VMDK_FILE - vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk' - - type: SATA - new_vmdk: - name: second_disk - capacity: 32000000000 - cdroms: - - type: SATA - sata: - bus: 0 - unit: 2 - nics: - - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: my_vm - - - name: Create a content library based on a DataStore - vmware.vmware_rest.content_locallibrary: - name: my_library_on_datastore - description: automated - publish_info: - published: true - authentication_method: NONE - storage_backings: - - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - type: DATASTORE - state: present - register: nfs_lib - - - name: Get the list of items of the NFS library - vmware.vmware_rest.content_library_item_info: - library_id: '{{ nfs_lib.id }}' - register: lib_items - - - name: Use the name to identify the item - set_fact: - my_template_item: "{{ lib_items.value | selectattr('name', 'equalto', 'golden-template')|first }}" - - - name: Deploy a new VM based on the template - vmware.vmware_rest.vcenter_vmtemplate_libraryitems: - name: vm-from-template - library: '{{ nfs_lib.id }}' - template_library_item: '{{ my_template_item.id }}' - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - state: deploy - register: my_new_vm - - - name: Retrieve all the details about the new VM - vmware.vmware_rest.vcenter_vm: - vm: '{{ my_new_vm.value }}' - register: my_new_vm_info - - - name: Create an instant clone of a VM - vmware.vmware_rest.vcenter_vm: - placement: - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - source: '{{ my_vm.id }}' - name: test_vm2 - state: instant_clone - register: my_instant_clone - - - name: Create a clone of a VM - vmware.vmware_rest.vcenter_vm: - placement: - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - source: '{{ my_vm.id }}' - name: test_vm3 - state: clone - register: my_clone_vm - - - name: Build a list of all the clusters - vmware.vmware_rest.vcenter_cluster_info: - register: all_the_clusters - - - name: Retrieve details about the first cluster - vmware.vmware_rest.vcenter_cluster_info: - cluster: '{{ all_the_clusters.value[0].cluster }}' - register: my_cluster_info - - - 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 - - - name: Set my_virtual_machine_folder - ansible.builtin.set_fact: - my_virtual_machine_folder: '{{ my_folders.value|first }}' - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: '{{ my_cluster_info.id }}' - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: '{{ my_virtual_machine_folder.folder }}' - resource_pool: '{{ my_cluster_info.value.resource_pool }}' - name: test_vm1 - guest_OS: DEBIAN_7_64 - hardware_version: VMX_10 - memory: - hot_add_enabled: true - size_MiB: 1024 - register: my_vm - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
vm-1104
-
-
- value - -
- dictionary -
- 		On success -
Create an instant clone of a VM
-
-
Sample:
-
{'boot': {'delay': 0, 'enter_setup_mode': 0, 'retry': 0, 'retry_delay': 10000, 'type': 'BIOS'}, 'boot_devices': [], 'cdroms': {'16002': {'allow_guest_control': 0, 'backing': {'auto_detect': 1, 'device_access_type': 'EMULATION', 'type': 'HOST_DEVICE'}, 'label': 'CD/DVD drive 1', 'sata': {'bus': 0, 'unit': 2}, 'start_connected': 0, 'state': 'NOT_CONNECTED', 'type': 'SATA'}}, 'cpu': {'cores_per_socket': 1, 'count': 1, 'hot_add_enabled': 0, 'hot_remove_enabled': 0}, 'disks': {'16000': {'backing': {'type': 'VMDK_FILE', 'vmdk_file': '[local] test_vm2/test_vm2_2.vmdk'}, 'capacity': 16106127360, 'label': 'Hard disk 1', 'sata': {'bus': 0, 'unit': 0}, 'type': 'SATA'}, '16001': {'backing': {'type': 'VMDK_FILE', 'vmdk_file': '[local] test_vm2/test_vm2_1.vmdk'}, 'capacity': 32000000000, 'label': 'Hard disk 2', 'sata': {'bus': 0, 'unit': 1}, 'type': 'SATA'}}, 'floppies': {}, 'guest_OS': 'RHEL_7_64', 'hardware': {'upgrade_policy': 'NEVER', 'upgrade_status': 'NONE', 'version': 'VMX_11'}, 'identity': {'bios_uuid': '4231bf8b-3cb4-3a3f-1bfb-18c857ce95b6', 'instance_uuid': '5031b322-6030-a020-8e73-1a9ad0fd03ce', 'name': 'test_vm2'}, 'instant_clone_frozen': 0, 'memory': {'hot_add_enabled': 1, 'hot_add_increment_size_MiB': 128, 'hot_add_limit_MiB': 3072, 'size_MiB': 1024}, 'name': 'test_vm2', 'nics': {'4000': {'allow_guest_control': 0, 'backing': {'network': 'network-1095', 'network_name': 'VM Network', 'type': 'STANDARD_PORTGROUP'}, 'label': 'Network adapter 1', 'mac_address': '00:50:56:b1:26:0c', 'mac_type': 'ASSIGNED', 'pci_slot_number': 160, 'start_connected': 0, 'state': 'NOT_CONNECTED', 'type': 'VMXNET3', 'upt_compatibility_enabled': 0, 'wake_on_lan_enabled': 0}}, 'nvme_adapters': {}, 'parallel_ports': {}, 'power_state': 'POWERED_ON', 'sata_adapters': {'15000': {'bus': 0, 'label': 'SATA controller 0', 'pci_slot_number': 32, 'type': 'AHCI'}}, 'scsi_adapters': {}, 'serial_ports': {}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_power_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_power_info_module.rst deleted file mode 100644 index 41dd52a0a..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_power_info_module.rst +++ /dev/null @@ -1,243 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_power_info_module: - - -**************************************** -vmware.vmware_rest.vcenter_vm_power_info -**************************************** - -**Returns the power state information of a virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns the power state information of a virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Get guest power information - vmware.vmware_rest.vcenter_vm_power_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get guest power information
-
-
Sample:
-
{'state': 'POWERED_ON'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_power_module.rst b/docs/vmware.vmware_rest.vcenter_vm_power_module.rst deleted file mode 100644 index bcc0a64b7..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_power_module.rst +++ /dev/null @@ -1,333 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_power_module: - - -*********************************** -vmware.vmware_rest.vcenter_vm_power -*********************************** - -**Operate a boot, hard shutdown, hard reset or hard suspend on a guest.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Ask the vCenter to boot, force shutdown or force reset a guest. If you want to do a soft shutdown or a soft reset, you can use :ref:`vmware.vmware_rest.vmware_vm_guest_power ` instead. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • reset
    • -
  • start
    • -
  • stop
    • -
  • suspend
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - -See Also --------- - -.. seealso:: - - :ref:`vmware.vmware_rest.vcenter_vm_guest_power_module` - Issues a request to the guest operating system asking it to perform a soft shutdown, standby (suspend) or soft reboot - - -Examples --------- - -.. code-block:: yaml - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - name: test_vm1 - guest_OS: RHEL_7_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - disks: - - type: SATA - backing: - type: VMDK_FILE - vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk' - - type: SATA - new_vmdk: - name: second_disk - capacity: 32000000000 - cdroms: - - type: SATA - sata: - bus: 0 - unit: 2 - nics: - - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: my_vm - - - name: Turn the power of the VM on - vmware.vmware_rest.vcenter_vm_power: - state: start - vm: '{{ my_vm.id }}' - - - name: Turn on the power of the VM - vmware.vmware_rest.vcenter_vm_power: - state: start - vm: '{{ my_vm.id }}' - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Turn the power of the VM on - vmware.vmware_rest.vcenter_vm_power: - state: start - vm: '{{ test_vm1_info.id }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		On success -
Turn off the VM
-
-
Sample:
-
All items completed
-
-
- results - -
- list -
- 		On success -
Turn off the VM
-
-
Sample:
-
[{'_ansible_item_label': {'cpu_count': 1, 'memory_size_MiB': 128, 'name': 'vCLS-e89f3630-0f4d-4adb-bac5-1912e2b5d8ab', 'power_state': 'POWERED_OFF', 'vm': 'vm-1023'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 0, 'failed': 0, 'invocation': {'module_args': {'session_timeout': None, 'state': 'stop', 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'vm': 'vm-1023'}}, 'item': {'cpu_count': 1, 'memory_size_MiB': 128, 'name': 'vCLS-e89f3630-0f4d-4adb-bac5-1912e2b5d8ab', 'power_state': 'POWERED_OFF', 'vm': 'vm-1023'}, 'value': {'error_type': 'ALREADY_IN_DESIRED_STATE', 'messages': [{'args': [], 'default_message': 'Virtual machine is already powered off.', 'id': 'com.vmware.api.vcenter.vm.power.already_powered_off'}, {'args': [], 'default_message': 'The attempted operation cannot be performed in the current state (Powered off).', 'id': 'vmsg.InvalidPowerState.summary'}]}}, {'_ansible_item_label': {'cpu_count': 1, 'memory_size_MiB': 1080, 'name': 'test_vm1', 'power_state': 'POWERED_ON', 'vm': 'vm-1024'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 0, 'failed': 0, 'invocation': {'module_args': {'session_timeout': None, 'state': 'stop', 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'vm': 'vm-1024'}}, 'item': {'cpu_count': 1, 'memory_size_MiB': 1080, 'name': 'test_vm1', 'power_state': 'POWERED_ON', 'vm': 'vm-1024'}, 'value': {}}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module.rst deleted file mode 100644 index 99a2e5ea8..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module.rst +++ /dev/null @@ -1,243 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module: - - -************************************************************ -vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info -************************************************************ - -**Returns the cached storage policy compliance information of a virtual machine.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns the cached storage policy compliance information of a virtual machine. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Get VM storage policy compliance information - vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get VM storage policy compliance information
-
-
Sample:
-
{'disks': {'16000': {'check_time': '2022-11-23T19:53:45.594Z', 'failure_cause': [], 'policy': 'f4e5bade-15a2-4805-bf8e-52318c4ce443', 'status': 'NOT_APPLICABLE'}}, 'overall_compliance': 'NOT_APPLICABLE'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module.rst b/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module.rst deleted file mode 100644 index 0061dcaae..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module.rst +++ /dev/null @@ -1,248 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module: - - -******************************************************* -vmware.vmware_rest.vcenter_vm_storage_policy_compliance -******************************************************* - -**Returns the storage policy Compliance Compliance.Info of a virtual machine after explicitly re-computing compliance check.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns the storage policy Compliance Compliance.Info of a virtual machine after explicitly re-computing compliance check. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- disks - -
- list - / elements=string -
- 		- -
Identifiers of the virtual machine's virtual disks for which compliance should be checked.
-
If unset or empty, compliance check is invoked on all the associated disks.
-
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_vm_hardware_disk.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • check
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- vm_home - -
- boolean - / required -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Invoke compliance check on the virtual machine home directory if set to true. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - - - - - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_storage_policy_info_module.rst deleted file mode 100644 index 118f24ad0..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_info_module.rst +++ /dev/null @@ -1,243 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_storage_policy_info_module: - - -************************************************* -vmware.vmware_rest.vcenter_vm_storage_policy_info -************************************************* - -**Returns Information about Storage Policy associated with a virtual machine's home directory and/or its virtual hard disks.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns Information about Storage Policy associated with a virtual machine's home directory and/or its virtual hard disks. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Virtual machine identifier
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Get VM storage policy - vmware.vmware_rest.vcenter_vm_storage_policy_info: - vm: '{{ test_vm1_info.id }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get VM storage policy
-
-
Sample:
-
{'disks': {}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_module.rst b/docs/vmware.vmware_rest.vcenter_vm_storage_policy_module.rst deleted file mode 100644 index 41476b453..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_module.rst +++ /dev/null @@ -1,324 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_storage_policy_module: - - -******************************************** -vmware.vmware_rest.vcenter_vm_storage_policy -******************************************** - -**Updates the storage policy configuration of a virtual machine and/or its associated virtual hard disks.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Updates the storage policy configuration of a virtual machine and/or its associated virtual hard disks. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- disks - -
- dictionary -
- 		- -
Storage policy or policies to be used when reconfiguring virtual machine diks.
-
if unset the current storage policy is retained.
-
When clients pass a value of this structure as a parameter, the key in the field map must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_disk.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine identifier.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- vm_home - -
- dictionary - / required -
- 		- -
Storage policy to be used when reconfiguring the virtual machine home.
-
if unset the current storage policy is retained. This parameter is mandatory.
-
Valid attributes are:
-
- type (str): This option defines the choices for how to specify the policy to be associated with the virtual machine home's directory. (['present'])
-
This key is required with ['present'].
-
- Accepted values:
-
- USE_DEFAULT_POLICY
-
- USE_SPECIFIED_POLICY
-
- policy (str): Storage Policy identification.
-
This field is optional and it is only relevant when the value of type is USE_SPECIFIED_POLICY.
-
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_storage_policies. (['present'])
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Prepare the disk policy dict - ansible.builtin.set_fact: - vm_disk_policy: "{{ {} | combine({ my_new_disk.id: {'policy': my_storage_policy.policy, 'type': 'USE_SPECIFIED_POLICY'} }) }}" - - - name: Adjust VM storage policy - vmware.vmware_rest.vcenter_vm_storage_policy: - vm: '{{ test_vm1_info.id }}' - vm_home: - type: USE_DEFAULT_POLICY - disks: '{{ vm_disk_policy }}' - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- dictionary -
- 		On success -
moid of the resource
-
-
-
- value - -
- dictionary -
- 		On success -
Adjust VM storage policy
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_tools_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_tools_info_module.rst deleted file mode 100644 index 16ac1f9ae..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_tools_info_module.rst +++ /dev/null @@ -1,301 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_tools_info_module: - - -**************************************** -vmware.vmware_rest.vcenter_vm_tools_info -**************************************** - -**Get the properties of VMware Tools.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get the properties of VMware Tools. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Identifier of the virtual machine.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - name: test_vm1 - guest_OS: RHEL_7_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - disks: - - type: SATA - backing: - type: VMDK_FILE - vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk' - - type: SATA - new_vmdk: - name: second_disk - capacity: 32000000000 - cdroms: - - type: SATA - sata: - bus: 0 - unit: 2 - nics: - - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: my_vm - - - name: Wait until my VM is ready - vmware.vmware_rest.vcenter_vm_tools_info: - vm: '{{ my_vm.id }}' - register: vm_tools_info - until: - - vm_tools_info is not failed - - vm_tools_info.value.run_state == "RUNNING" - retries: 10 - delay: 5 - - - name: Wait until my VM is ready - vmware.vmware_rest.vcenter_vm_tools_info: - vm: '{{ my_vm.id }}' - register: vm_tools_info - until: - - vm_tools_info is not failed - - vm_tools_info.value.run_state == "RUNNING" - retries: 60 - delay: 5 - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - 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 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Wait until my VM is ready
-
-
Sample:
-
{'auto_update_supported': 0, 'install_attempt_count': 0, 'install_type': 'OPEN_VM_TOOLS', 'run_state': 'RUNNING', 'upgrade_policy': 'MANUAL', 'version': '10346', 'version_number': 10346, 'version_status': 'UNMANAGED'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_tools_installer_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_tools_installer_info_module.rst deleted file mode 100644 index 2040aabc2..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_tools_installer_info_module.rst +++ /dev/null @@ -1,264 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_tools_installer_info_module: - - -************************************************** -vmware.vmware_rest.vcenter_vm_tools_installer_info -************************************************** - -**Get information about the VMware Tools installer.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Get information about the VMware Tools installer. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string -
- 		- -
Identifier of the virtual machine.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - name: test_vm1 - guest_OS: RHEL_7_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - disks: - - type: SATA - backing: - type: VMDK_FILE - vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk' - - type: SATA - new_vmdk: - name: second_disk - capacity: 32000000000 - cdroms: - - type: SATA - sata: - bus: 0 - unit: 2 - nics: - - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: my_vm - - - name: Get information about the vm-tools - vmware.vmware_rest.vcenter_vm_tools_installer_info: - vm: '{{ my_vm.id }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Get information about the vm-tools
-
-
Sample:
-
{'is_connected': 0}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_tools_installer_module.rst b/docs/vmware.vmware_rest.vcenter_vm_tools_installer_module.rst deleted file mode 100644 index 85465118d..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_tools_installer_module.rst +++ /dev/null @@ -1,283 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_tools_installer_module: - - -********************************************* -vmware.vmware_rest.vcenter_vm_tools_installer -********************************************* - -**Connects the VMware Tools CD installer as a CD-ROM for the guest operating system** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Connects the VMware Tools CD installer as a CD-ROM for the guest operating system. On Windows guest operating systems with autorun, this should cause the installer to initiate the Tools installation which will need user input to complete. On other (non-Windows) guest operating systems this will make the Tools installation available, and a a user will need to do guest-specific actions. On Linux, this includes opening an archive and running the installer. To monitor the status of the Tools install, clients should check the Tools.Info.version-status and Tools.Info.run-state from Tools.get - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • connect
    • -
  • disconnect
    • -
- 		-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Virtual machine ID
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - name: test_vm1 - guest_OS: RHEL_7_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - disks: - - type: SATA - backing: - type: VMDK_FILE - vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk' - - type: SATA - new_vmdk: - name: second_disk - capacity: 32000000000 - cdroms: - - type: SATA - sata: - bus: 0 - unit: 2 - nics: - - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: my_vm - - - name: Update the vm-tools - vmware.vmware_rest.vcenter_vm_tools_installer: - vm: '{{ my_vm.id }}' - state: connect - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- value - -
- dictionary -
- 		On success -
Update the vm-tools
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vm_tools_module.rst b/docs/vmware.vmware_rest.vcenter_vm_tools_module.rst deleted file mode 100644 index 113a7e709..000000000 --- a/docs/vmware.vmware_rest.vcenter_vm_tools_module.rst +++ /dev/null @@ -1,324 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vm_tools_module: - - -*********************************** -vmware.vmware_rest.vcenter_vm_tools -*********************************** - -**Update the properties of VMware Tools.** - - -Version added: 0.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Update the properties of VMware Tools. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- command_line_options - -
- string -
- 		- -
Command line options passed to the installer to modify the installation procedure for Tools.
-
Set if any additional options are desired.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • upgrade
    • -
- 		-
-
- upgrade_policy - -
- string -
- 		-
    Choices: -
  • MANUAL
    • -
  • UPGRADE_AT_POWER_CYCLE
    • -
- 		-
The upgrade_policy enumerated type defines when Tools are auto-upgraded for a virtual machine.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm - -
- string - / required -
- 		- -
Identifier of the virtual machine.
-
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Look up the VM called test_vm1 in the inventory - register: search_result - vmware.vmware_rest.vcenter_vm_info: - filter_names: - - test_vm1 - - - name: Collect information about a specific VM - vmware.vmware_rest.vcenter_vm_info: - vm: '{{ search_result.value[0].vm }}' - register: test_vm1_info - - - name: Retrive vm-tools information - vmware.vmware_rest.vcenter_vm_tools: - vm: '{{ test_vm1_info.id }}' - register: _result - - - 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 - - - name: Change vm-tools upgrade policy to MANUAL - vmware.vmware_rest.vcenter_vm_tools: - vm: '{{ test_vm1_info.id }}' - upgrade_policy: MANUAL - register: _result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- dictionary -
- 		On success -
moid of the resource
-
-
-
- value - -
- dictionary -
- 		On success -
Retrive vm-tools information
-
-
Sample:
-
{'auto_update_supported': 0, 'install_attempt_count': 0, 'install_type': 'OPEN_VM_TOOLS', 'run_state': 'RUNNING', 'upgrade_policy': 'MANUAL', 'version': '10346', 'version_number': 10346, 'version_status': 'UNMANAGED'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module.rst b/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module.rst deleted file mode 100644 index bf83dc6c8..000000000 --- a/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module.rst +++ /dev/null @@ -1,190 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module: - - -******************************************************* -vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info -******************************************************* - -**Returns information about a virtual machine template contained in the library item specified by {@param.name templateLibraryItem}** - - -Version added: 2.2.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about a virtual machine template contained in the library item specified by {@param.name templateLibraryItem} - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- template_library_item - -
- string -
- 		- -
identifier of the library item containing the virtual machine template. Required with state=['get']
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - - - - - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module.rst b/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module.rst deleted file mode 100644 index bd523525d..000000000 --- a/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module.rst +++ /dev/null @@ -1,543 +0,0 @@ -.. _vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module: - - -************************************************** -vmware.vmware_rest.vcenter_vmtemplate_libraryitems -************************************************** - -**Creates a library item in content library from a virtual machine** - - -Version added: 2.2.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Creates a library item in content library from a virtual machine. This {@term operation} creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere 7.0.3 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
- 		- -
Description of the deployed virtual machine.
-
-
- disk_storage - -
- dictionary -
- 		- -
Storage specification for the virtual machine template's disks.
-
Valid attributes are:
-
- datastore (str): Identifier for the datastore associated the deployed virtual machine's disk. (['deploy', 'present'])
-
- storage_policy (dict): Storage policy for the deployed virtual machine's disk. (['deploy', 'present'])
-
- Accepted keys:
-
- type (string): Policy type for a virtual machine template's disk.
-
Accepted value for this field:
-
- USE_SPECIFIED_POLICY
-
- policy (string): Identifier for the storage policy to use.
-
-
- disk_storage_overrides - -
- dictionary -
- 		- -
Storage specification for individual disks in the deployed virtual machine. This is specified as a mapping between disk identifiers in the source virtual machine template contained in the library item and their storage specifications.
-
-
- guest_customization - -
- dictionary -
- 		- -
Guest customization spec to apply to the deployed virtual machine.
-
Valid attributes are:
-
- name (str): Name of the customization specification. (['deploy'])
-
-
- hardware_customization - -
- dictionary -
- 		- -
Hardware customization spec which specifies updates to the deployed virtual machine.
-
Valid attributes are:
-
- nics (dict): Map of Ethernet network adapters to update. (['deploy'])
-
- disks_to_remove (list): Idenfiers of disks to remove from the deployed virtual machine. (['deploy'])
-
- disks_to_update (dict): Disk update specification for individual disks in the deployed virtual machine. (['deploy'])
-
- cpu_update (dict): CPU update specification for the deployed virtual machine. (['deploy'])
-
- Accepted keys:
-
- num_cpus (integer): Number of virtual processors in the deployed virtual machine.
-
- num_cores_per_socket (integer): Number of cores among which to distribute CPUs in the deployed virtual machine.
-
- memory_update (dict): Memory update specification for the deployed virtual machine. (['deploy'])
-
- Accepted keys:
-
- memory (integer): Size of a virtual machine's memory in MB.
-
-
- library - -
- string -
- 		- -
Identifier of the library in which the new library item should be created. Required with state=['present']
-
-
- name - -
- string - / required -
- 		- -
Name of the deployed virtual machine. This parameter is mandatory.
-
-
- placement - -
- dictionary -
- 		- -
Information used to place the virtual machine template.
-
Valid attributes are:
-
- folder (str): Virtual machine folder into which the deployed virtual machine should be placed. (['deploy', 'present'])
-
- resource_pool (str): Resource pool into which the deployed virtual machine should be placed. (['deploy', 'present'])
-
- host (str): Host onto which the virtual machine should be placed. If #host and #resource_pool are both specified, #resource_pool must belong to #host. If #host and #cluster are both specified, #host must be a member of #cluster. (['deploy', 'present'])
-
- cluster (str): Cluster onto which the deployed virtual machine should be placed. If #cluster and #resource_pool are both specified, #resource_pool must belong to #cluster. If #cluster and #host are both specified, #host must be a member of #cluster. (['deploy', 'present'])
-
-
- powered_on - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specifies whether the deployed virtual machine should be powered on after deployment.
-
-
- session_timeout - -
- float -
-
added in 2.1.0
- 		- -
Timeout settings for client session.
-
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
-
The default value is 300s.
-
-
- source_vm - -
- string -
- 		- -
Identifier of the source virtual machine to create the library item from. Required with state=['present']
-
-
- state - -
- string -
- 		-
    Choices: -
  • deploy
    • -
  • present ←
    • -
- 		-
-
- template_library_item - -
- string -
- 		- -
identifier of the content library item containing the source virtual machine template to be deployed. Required with state=['deploy']
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
The hostname or IP address of the vSphere vCenter
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- vcenter_password - -
- string - / required -
- 		- -
The vSphere vCenter password
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interaction.
-
The file will be stored on the host that run the module.
-
If the value is not specified in the task, the value of
-
environment variable VMWARE_REST_LOG_FILE will be used instead.
-
-
- vcenter_username - -
- string - / required -
- 		- -
The vSphere vCenter username
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
-
- vcenter_validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- vm_home_storage - -
- dictionary -
- 		- -
Storage location for the virtual machine template's configuration and log files.
-
Valid attributes are:
-
- datastore (str): Identifier of the datastore for the deployed virtual machine's configuration and log files. (['deploy', 'present'])
-
- storage_policy (dict): Storage policy for the deployed virtual machine's configuration and log files. (['deploy', 'present'])
-
- Accepted keys:
-
- type (string): Policy type for the virtual machine template's configuration and log files.
-
Accepted value for this field:
-
- USE_SPECIFIED_POLICY
-
- policy (string): Identifier for the storage policy to use.
-
-
- - -Notes ------ - -.. note:: - - Tested on vSphere 7.0.3 - - - -Examples --------- - -.. code-block:: yaml - - - name: Create a VM - vmware.vmware_rest.vcenter_vm: - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - name: test_vm1 - guest_OS: RHEL_7_64 - hardware_version: VMX_11 - memory: - hot_add_enabled: true - size_MiB: 1024 - disks: - - type: SATA - backing: - type: VMDK_FILE - vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk' - - type: SATA - new_vmdk: - name: second_disk - capacity: 32000000000 - cdroms: - - type: SATA - sata: - bus: 0 - unit: 2 - nics: - - backing: - type: STANDARD_PORTGROUP - network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}" - register: my_vm - - - name: Create a content library based on a DataStore - vmware.vmware_rest.content_locallibrary: - name: my_library_on_datastore - description: automated - publish_info: - published: true - authentication_method: NONE - storage_backings: - - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" - type: DATASTORE - state: present - register: nfs_lib - - - name: Create a VM template on the library - vmware.vmware_rest.vcenter_vmtemplate_libraryitems: - name: golden-template - library: '{{ nfs_lib.id }}' - source_vm: '{{ my_vm.id }}' - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - register: mylib_item - - - name: Get the list of items of the NFS library - vmware.vmware_rest.content_library_item_info: - library_id: '{{ nfs_lib.id }}' - register: lib_items - - - name: Use the name to identify the item - set_fact: - my_template_item: "{{ lib_items.value | selectattr('name', 'equalto', 'golden-template')|first }}" - - - name: Deploy a new VM based on the template - vmware.vmware_rest.vcenter_vmtemplate_libraryitems: - name: vm-from-template - library: '{{ nfs_lib.id }}' - template_library_item: '{{ my_template_item.id }}' - placement: - cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" - folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" - resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" - state: deploy - register: my_new_vm - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- id - -
- string -
- 		On success -
moid of the resource
-
-
Sample:
-
9c6df1f5-faba-490c-a8e6-edb72f787ab8
-
-
- value - -
- dictionary -
- 		On success -
Create a VM template on the library
-
-
Sample:
-
{'cpu': {'cores_per_socket': 1, 'count': 1}, 'disks': {'16000': {'capacity': 16106127360, 'disk_storage': {'datastore': 'datastore-1122'}}, '16001': {'capacity': 32000000000, 'disk_storage': {'datastore': 'datastore-1122'}}}, 'guest_OS': 'RHEL_7_64', 'memory': {'size_MiB': 1024}, 'nics': {'4000': {'backing_type': 'STANDARD_PORTGROUP', 'mac_type': 'ASSIGNED', 'network': 'network-1123'}}, 'vm_home_storage': {'datastore': 'datastore-1122'}, 'vm_template': 'vm-1132'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Cloud Team (@ansible-collections) diff --git a/docs/vmware.vmware_rest.vm_moid_lookup.rst b/docs/vmware.vmware_rest.vm_moid_lookup.rst deleted file mode 100644 index 1a5904c88..000000000 --- a/docs/vmware.vmware_rest.vm_moid_lookup.rst +++ /dev/null @@ -1,230 +0,0 @@ -.. _vmware.vmware_rest.vm_moid_lookup: - - -************************** -vmware.vmware_rest.vm_moid -************************** - -**Look up MoID for vSphere vm objects using vCenter REST API** - - -Version added: 2.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns Managed Object Reference (MoID) of the vSphere vm object contained in the specified path. - - - -Requirements ------------- -The below requirements are needed on the local Ansible controller node that executes this lookup. - -- vSphere 7.0.2 or greater -- python >= 3.6 -- aiohttp - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsConfigurationComments
-
- _terms - -
- string - / required -
- 		- - -
Path to query.
-
-
- vcenter_hostname - -
- string - / required -
- 		- -
env:VMWARE_HOST
- 		-
The hostname or IP address of the vSphere vCenter.
-
-
- vcenter_password - -
- string - / required -
- 		- -
env:VMWARE_PASSWORD
- 		-
The vSphere vCenter password.
-
-
- vcenter_rest_log_file - -
- string -
- 		- -
env:VMWARE_REST_LOG_FILE
- 		-
You can use this optional parameter to set the location of a log file.
-
This file will be used to record the HTTP REST interactions.
-
The file will be stored on the host that runs the module.
-
-
- vcenter_username - -
- string - / required -
- 		- -
env:VMWARE_USER
- 		-
The vSphere vCenter username.
-
-
- vcenter_validate_certs - -
- boolean -
- 		- Default:
"yes"
- 		-
env:VMWARE_VALIDATE_CERTS
- 		-
Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - # lookup sample - - name: set connection info - ansible.builtin.set_fact: - connection_args: - vcenter_hostname: "vcenter.test" - vcenter_username: "administrator@vsphere.local" - vcenter_password: "1234" - - - name: lookup MoID of the object - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.vm_moid', '/my_dc/host/my_cluster/esxi1.test/test_vm1', **connection_args) }}" - - - name: lookup MoID of the object inside the path - ansible.builtin.debug: msg="{{ lookup('vmware.vmware_rest.vm_moid', '/my_dc/vm/') }}" - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this lookup: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- _raw - -
- string -
- 		-
MoID of the vSphere vm object
-
-
Sample:
-
vm-1026
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Alina Buzachis (@alinabuzachis) - - -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. From c549e15a60c0c7f513f07a238659541c58f5c97b Mon Sep 17 00:00:00 2001 From: Alina Buzachis Date: Wed, 29 Nov 2023 11:14:56 +0100 Subject: [PATCH 2/5] Add .yamllint Signed-off-by: Alina Buzachis --- .yamllint | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .yamllint diff --git a/.yamllint b/.yamllint new file mode 100644 index 000000000..ac5297cdf --- /dev/null +++ b/.yamllint @@ -0,0 +1,15 @@ +--- +rules: + indentation: + ignore: &default_ignores | + # automatically generated, we can't control it + changelogs/changelog.yaml + # Will be gone when we release and automatically reformatted + changelogs/fragments/* + document-start: + ignore: *default_ignores + line-length: + ignore: *default_ignores + max: 160 + +ignore-from-file: .gitignore From a9690322a5224d56839b7d63bffcfd6105329aed Mon Sep 17 00:00:00 2001 From: Alina Buzachis Date: Wed, 29 Nov 2023 14:54:04 +0100 Subject: [PATCH 3/5] Fix indentation Signed-off-by: Alina Buzachis --- .github/ISSUE_TEMPLATE/bug_report.yml | 282 +++++++++--------- .github/ISSUE_TEMPLATE/ci_report.yml | 282 +++++++++--------- .github/ISSUE_TEMPLATE/config.yml | 2 +- .../ISSUE_TEMPLATE/documentation_report.yml | 244 +++++++-------- .github/ISSUE_TEMPLATE/feature_request.yml | 120 ++++---- .github/settings.yml | 1 + .github/workflows/ansible-bot.yml | 1 + .github/workflows/docs-pr.yml | 1 + .github/workflows/docs-push.yml | 1 + .github/workflows/linters.yaml | 1 + .github/workflows/sanity-tests.yaml | 1 + 11 files changed, 471 insertions(+), 465 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 078bd4389..a97eaa855 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -3,146 +3,146 @@ name: Bug report description: Create a report to help us improve body: -- type: markdown - attributes: - value: | - ⚠ - Verify first that your issue is not [already reported on GitHub][issue search]. - Where possible also test if the latest release and main branch are affected too. - *Complete **all** sections as described, this form is processed automatically.* - - [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues - -- type: textarea - attributes: - label: Summary - description: | - Explain the problem briefly below. - placeholder: >- - When I try to do X with the collection from the main branch on GitHub, Y - breaks in a way Z under the env E. Here are all the details I know - about this problem... - validations: - required: true - -- type: dropdown - attributes: - label: Issue Type - # FIXME: Once GitHub allows defining the default choice, update this - options: - - Bug Report - validations: - required: true - -- type: textarea - attributes: - # For smaller collections we could use a multi-select and hardcode the list - # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins - # Select from list, filter as you type (`mysql` would only show the 3 mysql components) - # OR freeform - doesn't seem to be supported in adaptivecards - label: Component Name - description: >- - Write the short name of the module or plugin below, - *use your best guess if unsure*. - placeholder: vcenter_vm_tools, vcenter_vm_info - validations: - required: true - -- type: textarea - attributes: - label: Ansible Version - description: >- - Paste verbatim output from `ansible --version` between - tripple backticks. - value: | - ```console (paste below) - $ ansible --version - - ``` - validations: - required: true - -- type: textarea - attributes: - label: Collection Versions - description: >- - Paste verbatim output from `ansible-galaxy collection list` between - tripple backticks. - value: | - ```console (paste below) - $ ansible-galaxy collection list - ``` - validations: - required: true - -- type: textarea - attributes: - label: Configuration - description: >- - If this issue has an example piece of YAML that can help to reproduce this problem, please provide it. - This can be a piece of YAML from, e.g., an automation, script, scene or configuration. - - Paste verbatim output from `ansible-config dump --only-changed` between quotes - value: | - ```console (paste below) - $ ansible-config dump --only-changed - - ``` - -- type: textarea - attributes: - label: OS / Environment - description: >- - Provide all relevant information below, e.g. target OS versions, - network device firmware, etc. - placeholder: RHEL 8, CentOS Stream etc. - validations: - required: false - -- type: textarea - attributes: - label: Steps to Reproduce - description: | - Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also paste any playbooks, configs and commands you used. - - **HINT:** You can paste https://gist.github.com links for larger files. - value: | - - ```yaml (paste below) - - ``` - validations: - required: true - -- type: textarea - attributes: - label: Expected Results - description: >- - Describe what you expected to happen when running the steps above. - placeholder: >- - I expected X to happen because I assumed Y. - that it did not. - validations: - required: true - -- type: textarea - attributes: - label: Actual Results - description: | - Describe what actually happened. If possible run with extra verbosity (`-vvvv`). - - Paste verbatim command output between quotes. - value: | - ```console (paste below) - - ``` - -- type: checkboxes - attributes: - label: Code of Conduct - description: | - Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first. - options: - - label: I agree to follow the Ansible Code of Conduct + - type: markdown + attributes: + value: | + ⚠ + Verify first that your issue is not [already reported on GitHub][issue search]. + Where possible also test if the latest release and main branch are affected too. + *Complete **all** sections as described, this form is processed automatically.* + + [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues + + - type: textarea + attributes: + label: Summary + description: | + Explain the problem briefly below. + placeholder: >- + When I try to do X with the collection from the main branch on GitHub, Y + breaks in a way Z under the env E. Here are all the details I know + about this problem... + validations: required: true + + - type: dropdown + attributes: + label: Issue Type + # FIXME: Once GitHub allows defining the default choice, update this + options: + - Bug Report + validations: + required: true + + - type: textarea + attributes: + # For smaller collections we could use a multi-select and hardcode the list + # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins + # Select from list, filter as you type (`mysql` would only show the 3 mysql components) + # OR freeform - doesn't seem to be supported in adaptivecards + label: Component Name + description: >- + Write the short name of the module or plugin below, + *use your best guess if unsure*. + placeholder: vcenter_vm_tools, vcenter_vm_info + validations: + required: true + + - type: textarea + attributes: + label: Ansible Version + description: >- + Paste verbatim output from `ansible --version` between + tripple backticks. + value: | + ```console (paste below) + $ ansible --version + + ``` + validations: + required: true + + - type: textarea + attributes: + label: Collection Versions + description: >- + Paste verbatim output from `ansible-galaxy collection list` between + tripple backticks. + value: | + ```console (paste below) + $ ansible-galaxy collection list + ``` + validations: + required: true + + - type: textarea + attributes: + label: Configuration + description: >- + If this issue has an example piece of YAML that can help to reproduce this problem, please provide it. + This can be a piece of YAML from, e.g., an automation, script, scene or configuration. + + Paste verbatim output from `ansible-config dump --only-changed` between quotes + value: | + ```console (paste below) + $ ansible-config dump --only-changed + + ``` + + - type: textarea + attributes: + label: OS / Environment + description: >- + Provide all relevant information below, e.g. target OS versions, + network device firmware, etc. + placeholder: RHEL 8, CentOS Stream etc. + validations: + required: false + + - type: textarea + attributes: + label: Steps to Reproduce + description: | + Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also paste any playbooks, configs and commands you used. + + **HINT:** You can paste https://gist.github.com links for larger files. + value: | + + ```yaml (paste below) + + ``` + validations: + required: true + + - type: textarea + attributes: + label: Expected Results + description: >- + Describe what you expected to happen when running the steps above. + placeholder: >- + I expected X to happen because I assumed Y. + that it did not. + validations: + required: true + + - type: textarea + attributes: + label: Actual Results + description: | + Describe what actually happened. If possible run with extra verbosity (`-vvvv`). + + Paste verbatim command output between quotes. + value: | + ```console (paste below) + + ``` + + - type: checkboxes + attributes: + label: Code of Conduct + description: | + Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first. + options: + - label: I agree to follow the Ansible Code of Conduct + required: true ... diff --git a/.github/ISSUE_TEMPLATE/ci_report.yml b/.github/ISSUE_TEMPLATE/ci_report.yml index 078bd4389..a97eaa855 100644 --- a/.github/ISSUE_TEMPLATE/ci_report.yml +++ b/.github/ISSUE_TEMPLATE/ci_report.yml @@ -3,146 +3,146 @@ name: Bug report description: Create a report to help us improve body: -- type: markdown - attributes: - value: | - ⚠ - Verify first that your issue is not [already reported on GitHub][issue search]. - Where possible also test if the latest release and main branch are affected too. - *Complete **all** sections as described, this form is processed automatically.* - - [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues - -- type: textarea - attributes: - label: Summary - description: | - Explain the problem briefly below. - placeholder: >- - When I try to do X with the collection from the main branch on GitHub, Y - breaks in a way Z under the env E. Here are all the details I know - about this problem... - validations: - required: true - -- type: dropdown - attributes: - label: Issue Type - # FIXME: Once GitHub allows defining the default choice, update this - options: - - Bug Report - validations: - required: true - -- type: textarea - attributes: - # For smaller collections we could use a multi-select and hardcode the list - # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins - # Select from list, filter as you type (`mysql` would only show the 3 mysql components) - # OR freeform - doesn't seem to be supported in adaptivecards - label: Component Name - description: >- - Write the short name of the module or plugin below, - *use your best guess if unsure*. - placeholder: vcenter_vm_tools, vcenter_vm_info - validations: - required: true - -- type: textarea - attributes: - label: Ansible Version - description: >- - Paste verbatim output from `ansible --version` between - tripple backticks. - value: | - ```console (paste below) - $ ansible --version - - ``` - validations: - required: true - -- type: textarea - attributes: - label: Collection Versions - description: >- - Paste verbatim output from `ansible-galaxy collection list` between - tripple backticks. - value: | - ```console (paste below) - $ ansible-galaxy collection list - ``` - validations: - required: true - -- type: textarea - attributes: - label: Configuration - description: >- - If this issue has an example piece of YAML that can help to reproduce this problem, please provide it. - This can be a piece of YAML from, e.g., an automation, script, scene or configuration. - - Paste verbatim output from `ansible-config dump --only-changed` between quotes - value: | - ```console (paste below) - $ ansible-config dump --only-changed - - ``` - -- type: textarea - attributes: - label: OS / Environment - description: >- - Provide all relevant information below, e.g. target OS versions, - network device firmware, etc. - placeholder: RHEL 8, CentOS Stream etc. - validations: - required: false - -- type: textarea - attributes: - label: Steps to Reproduce - description: | - Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also paste any playbooks, configs and commands you used. - - **HINT:** You can paste https://gist.github.com links for larger files. - value: | - - ```yaml (paste below) - - ``` - validations: - required: true - -- type: textarea - attributes: - label: Expected Results - description: >- - Describe what you expected to happen when running the steps above. - placeholder: >- - I expected X to happen because I assumed Y. - that it did not. - validations: - required: true - -- type: textarea - attributes: - label: Actual Results - description: | - Describe what actually happened. If possible run with extra verbosity (`-vvvv`). - - Paste verbatim command output between quotes. - value: | - ```console (paste below) - - ``` - -- type: checkboxes - attributes: - label: Code of Conduct - description: | - Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first. - options: - - label: I agree to follow the Ansible Code of Conduct + - type: markdown + attributes: + value: | + ⚠ + Verify first that your issue is not [already reported on GitHub][issue search]. + Where possible also test if the latest release and main branch are affected too. + *Complete **all** sections as described, this form is processed automatically.* + + [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues + + - type: textarea + attributes: + label: Summary + description: | + Explain the problem briefly below. + placeholder: >- + When I try to do X with the collection from the main branch on GitHub, Y + breaks in a way Z under the env E. Here are all the details I know + about this problem... + validations: required: true + + - type: dropdown + attributes: + label: Issue Type + # FIXME: Once GitHub allows defining the default choice, update this + options: + - Bug Report + validations: + required: true + + - type: textarea + attributes: + # For smaller collections we could use a multi-select and hardcode the list + # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins + # Select from list, filter as you type (`mysql` would only show the 3 mysql components) + # OR freeform - doesn't seem to be supported in adaptivecards + label: Component Name + description: >- + Write the short name of the module or plugin below, + *use your best guess if unsure*. + placeholder: vcenter_vm_tools, vcenter_vm_info + validations: + required: true + + - type: textarea + attributes: + label: Ansible Version + description: >- + Paste verbatim output from `ansible --version` between + tripple backticks. + value: | + ```console (paste below) + $ ansible --version + + ``` + validations: + required: true + + - type: textarea + attributes: + label: Collection Versions + description: >- + Paste verbatim output from `ansible-galaxy collection list` between + tripple backticks. + value: | + ```console (paste below) + $ ansible-galaxy collection list + ``` + validations: + required: true + + - type: textarea + attributes: + label: Configuration + description: >- + If this issue has an example piece of YAML that can help to reproduce this problem, please provide it. + This can be a piece of YAML from, e.g., an automation, script, scene or configuration. + + Paste verbatim output from `ansible-config dump --only-changed` between quotes + value: | + ```console (paste below) + $ ansible-config dump --only-changed + + ``` + + - type: textarea + attributes: + label: OS / Environment + description: >- + Provide all relevant information below, e.g. target OS versions, + network device firmware, etc. + placeholder: RHEL 8, CentOS Stream etc. + validations: + required: false + + - type: textarea + attributes: + label: Steps to Reproduce + description: | + Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also paste any playbooks, configs and commands you used. + + **HINT:** You can paste https://gist.github.com links for larger files. + value: | + + ```yaml (paste below) + + ``` + validations: + required: true + + - type: textarea + attributes: + label: Expected Results + description: >- + Describe what you expected to happen when running the steps above. + placeholder: >- + I expected X to happen because I assumed Y. + that it did not. + validations: + required: true + + - type: textarea + attributes: + label: Actual Results + description: | + Describe what actually happened. If possible run with extra verbosity (`-vvvv`). + + Paste verbatim command output between quotes. + value: | + ```console (paste below) + + ``` + + - type: checkboxes + attributes: + label: Code of Conduct + description: | + Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first. + options: + - label: I agree to follow the Ansible Code of Conduct + required: true ... diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f90bd1ad8..b17d146d3 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ ---- # Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser +--- blank_issues_enabled: false # default: true contact_links: - name: Security bug report diff --git a/.github/ISSUE_TEMPLATE/documentation_report.yml b/.github/ISSUE_TEMPLATE/documentation_report.yml index cf3a84ee0..ce24bc2fe 100644 --- a/.github/ISSUE_TEMPLATE/documentation_report.yml +++ b/.github/ISSUE_TEMPLATE/documentation_report.yml @@ -4,127 +4,127 @@ description: Ask us about docs # NOTE: issue body is enabled to allow screenshots body: -- type: markdown - attributes: - value: | - ⚠ - Verify first that your issue is not [already reported on GitHub][issue search]. - Where possible also test if the latest release and main branch are affected too. - *Complete **all** sections as described, this form is processed automatically.* - - [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues - -- type: textarea - attributes: - label: Summary - description: | - Explain the problem briefly below, add suggestions to wording or structure. - - **HINT:** Did you know the documentation has an `Edit on GitHub` link on every page? - placeholder: >- - I was reading the Collection documentation of version X and I'm having - problems understanding Y. It would be very helpful if that got - rephrased as Z. - validations: - required: true - -- type: dropdown - attributes: - label: Issue Type - # FIXME: Once GitHub allows defining the default choice, update this - options: - - Documentation Report - validations: - required: true - -- type: textarea - attributes: - # For smaller collections we could use a multi-select and hardcode the list - # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins - # Select from list, filter as you type (`mysql` would only show the 3 mysql components) - # OR freeform - doesn't seem to be supported in adaptivecards - label: Component Name - description: >- - Write the short name of the rst file, module, plugin or task below, - *use your best guess if unsure*. - placeholder: vcenter_vm_tools, vcenter_vm_info - validations: - required: true - -- type: textarea - attributes: - label: Ansible Version - description: >- - Paste verbatim output from `ansible --version` between - tripple backticks. - value: | - ```console (paste below) - $ ansible --version - - ``` - validations: - required: false - -- type: textarea - attributes: - label: Collection Versions - description: >- - Paste verbatim output from `ansible-galaxy collection list` between - tripple backticks. - value: | - ```console (paste below) - $ ansible-galaxy collection list - ``` - validations: - required: false - -- type: textarea - attributes: - label: Configuration - description: >- - If this issue has an example piece of YAML that can help to reproduce this problem, please provide it. - This can be a piece of YAML from, e.g., an automation, script, scene or configuration. - - Paste verbatim output from `ansible-config dump --only-changed` between quotes - value: | - ```console (paste below) - $ ansible-config dump --only-changed - - ``` - validations: - required: false - -- type: textarea - attributes: - label: OS / Environment - description: >- - Provide all relevant information below, e.g. OS version, - browser, etc. - placeholder: RHEL 8, Firefox etc. - validations: - required: false - -- type: textarea - attributes: - label: Additional Information - description: | - Describe how this improves the documentation, e.g. before/after situation or screenshots. - - **Tip:** It's not possible to upload the screenshot via this field directly but you can use the last textarea in this form to attach them. - - **HINT:** You can paste https://gist.github.com links for larger files. - placeholder: >- - When the improvement is applied, it makes it more straightforward - to understand X. - validations: - required: false - -- type: checkboxes - attributes: - label: Code of Conduct - description: | - Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first. - options: - - label: I agree to follow the Ansible Code of Conduct + - type: markdown + attributes: + value: | + ⚠ + Verify first that your issue is not [already reported on GitHub][issue search]. + Where possible also test if the latest release and main branch are affected too. + *Complete **all** sections as described, this form is processed automatically.* + + [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues + + - type: textarea + attributes: + label: Summary + description: | + Explain the problem briefly below, add suggestions to wording or structure. + + **HINT:** Did you know the documentation has an `Edit on GitHub` link on every page? + placeholder: >- + I was reading the Collection documentation of version X and I'm having + problems understanding Y. It would be very helpful if that got + rephrased as Z. + validations: required: true + + - type: dropdown + attributes: + label: Issue Type + # FIXME: Once GitHub allows defining the default choice, update this + options: + - Documentation Report + validations: + required: true + + - type: textarea + attributes: + # For smaller collections we could use a multi-select and hardcode the list + # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins + # Select from list, filter as you type (`mysql` would only show the 3 mysql components) + # OR freeform - doesn't seem to be supported in adaptivecards + label: Component Name + description: >- + Write the short name of the rst file, module, plugin or task below, + *use your best guess if unsure*. + placeholder: vcenter_vm_tools, vcenter_vm_info + validations: + required: true + + - type: textarea + attributes: + label: Ansible Version + description: >- + Paste verbatim output from `ansible --version` between + tripple backticks. + value: | + ```console (paste below) + $ ansible --version + + ``` + validations: + required: false + + - type: textarea + attributes: + label: Collection Versions + description: >- + Paste verbatim output from `ansible-galaxy collection list` between + tripple backticks. + value: | + ```console (paste below) + $ ansible-galaxy collection list + ``` + validations: + required: false + + - type: textarea + attributes: + label: Configuration + description: >- + If this issue has an example piece of YAML that can help to reproduce this problem, please provide it. + This can be a piece of YAML from, e.g., an automation, script, scene or configuration. + + Paste verbatim output from `ansible-config dump --only-changed` between quotes + value: | + ```console (paste below) + $ ansible-config dump --only-changed + + ``` + validations: + required: false + + - type: textarea + attributes: + label: OS / Environment + description: >- + Provide all relevant information below, e.g. OS version, + browser, etc. + placeholder: RHEL 8, Firefox etc. + validations: + required: false + + - type: textarea + attributes: + label: Additional Information + description: | + Describe how this improves the documentation, e.g. before/after situation or screenshots. + + **Tip:** It's not possible to upload the screenshot via this field directly but you can use the last textarea in this form to attach them. + + **HINT:** You can paste https://gist.github.com links for larger files. + placeholder: >- + When the improvement is applied, it makes it more straightforward + to understand X. + validations: + required: false + + - type: checkboxes + attributes: + label: Code of Conduct + description: | + Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first. + options: + - label: I agree to follow the Ansible Code of Conduct + required: true ... diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 8f88acf88..c24177de5 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -3,72 +3,72 @@ name: Feature request description: Suggest an idea for this project body: -- type: markdown - attributes: - value: | - ⚠ - Verify first that your issue is not [already reported on GitHub][issue search]. - Where possible also test if the latest release and main branch are affected too. - *Complete **all** sections as described, this form is processed automatically.* + - type: markdown + attributes: + value: | + ⚠ + Verify first that your issue is not [already reported on GitHub][issue search]. + Where possible also test if the latest release and main branch are affected too. + *Complete **all** sections as described, this form is processed automatically.* - [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues + [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues -- type: textarea - attributes: - label: Summary - description: | - Describe the new feature/improvement briefly below. - placeholder: >- - I am trying to do X with the collection from the main branch on GitHub and - I think that implementing a feature Y would be very helpful for me and - every other user of vmware.vmware_rest because of Z. - validations: - required: true + - type: textarea + attributes: + label: Summary + description: | + Describe the new feature/improvement briefly below. + placeholder: >- + I am trying to do X with the collection from the main branch on GitHub and + I think that implementing a feature Y would be very helpful for me and + every other user of vmware.vmware_rest because of Z. + validations: + required: true -- type: dropdown - attributes: - label: Issue Type - # FIXME: Once GitHub allows defining the default choice, update this - options: - - Feature Idea - validations: - required: true + - type: dropdown + attributes: + label: Issue Type + # FIXME: Once GitHub allows defining the default choice, update this + options: + - Feature Idea + validations: + required: true -- type: textarea - attributes: - # For smaller collections we could use a multi-select and hardcode the list - # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins - # Select from list, filter as you type (`mysql` would only show the 3 mysql components) - # OR freeform - doesn't seem to be supported in adaptivecards - label: Component Name - description: >- - Write the short name of the module or plugin below, - *use your best guess if unsure*. - placeholder: vcenter_vm_tools, vcenter_vm_info - validations: - required: true + - type: textarea + attributes: + # For smaller collections we could use a multi-select and hardcode the list + # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins + # Select from list, filter as you type (`mysql` would only show the 3 mysql components) + # OR freeform - doesn't seem to be supported in adaptivecards + label: Component Name + description: >- + Write the short name of the module or plugin below, + *use your best guess if unsure*. + placeholder: vcenter_vm_tools, vcenter_vm_info + validations: + required: true -- type: textarea - attributes: - label: Additional Information - description: | - Describe how the feature would be used, why it is needed and what it would solve. + - type: textarea + attributes: + label: Additional Information + description: | + Describe how the feature would be used, why it is needed and what it would solve. - **HINT:** You can paste https://gist.github.com links for larger files. - value: | - - ```yaml (paste below) + **HINT:** You can paste https://gist.github.com links for larger files. + value: | + + ```yaml (paste below) - ``` - validations: - required: false + ``` + validations: + required: false -- type: checkboxes - attributes: - label: Code of Conduct - description: | - Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first. - options: - - label: I agree to follow the Ansible Code of Conduct - required: true + - type: checkboxes + attributes: + label: Code of Conduct + description: | + Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first. + options: + - label: I agree to follow the Ansible Code of Conduct + required: true ... diff --git a/.github/settings.yml b/.github/settings.yml index b27b575f0..7808d9a7f 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -2,4 +2,5 @@ # Settings: https://probot.github.io/apps/settings/ # Pull settings from https://github.com/ansible-collections/.github/blob/master/.github/settings.yml +--- _extends: ".github" diff --git a/.github/workflows/ansible-bot.yml b/.github/workflows/ansible-bot.yml index 347abc738..2015ef480 100644 --- a/.github/workflows/ansible-bot.yml +++ b/.github/workflows/ansible-bot.yml @@ -1,3 +1,4 @@ +--- name: ansible bot on: issues: diff --git a/.github/workflows/docs-pr.yml b/.github/workflows/docs-pr.yml index 9065b2f71..d22fd9ae2 100644 --- a/.github/workflows/docs-pr.yml +++ b/.github/workflows/docs-pr.yml @@ -1,3 +1,4 @@ +--- name: Collection Docs concurrency: group: docs-${{ github.head_ref }} diff --git a/.github/workflows/docs-push.yml b/.github/workflows/docs-push.yml index a18b85105..a802a7bb8 100644 --- a/.github/workflows/docs-push.yml +++ b/.github/workflows/docs-push.yml @@ -1,3 +1,4 @@ +--- name: Collection Docs concurrency: group: docs-push-${{ github.sha }} diff --git a/.github/workflows/linters.yaml b/.github/workflows/linters.yaml index 6931b40ee..c0f120f7c 100644 --- a/.github/workflows/linters.yaml +++ b/.github/workflows/linters.yaml @@ -1,3 +1,4 @@ +--- name: Linters concurrency: group: ${{ github.workflow }}-${{ github.ref }} diff --git a/.github/workflows/sanity-tests.yaml b/.github/workflows/sanity-tests.yaml index 87875c53f..1fb92fd8e 100644 --- a/.github/workflows/sanity-tests.yaml +++ b/.github/workflows/sanity-tests.yaml @@ -30,6 +30,7 @@ # it has to adhere to Python compatibility and CI testing requirements described in # https://docs.ansible.com/ansible/latest/community/collection_contributors/collection_requirements.html. +--- name: Sanity tests on: # Run CI against all pushes (direct commits, also merged PRs), Pull Requests From cc136e8a26c66bf7cb003f882d18b2bd17ac087b Mon Sep 17 00:00:00 2001 From: Mike Morency Date: Thu, 1 Aug 2024 11:01:32 -0400 Subject: [PATCH 4/5] fix lint issues --- .yamllint | 3 +++ changelogs/config.yaml | 33 +++++++++++++++++---------------- tests/config.yml | 3 ++- 3 files changed, 22 insertions(+), 17 deletions(-) diff --git a/.yamllint b/.yamllint index ac5297cdf..eb4298094 100644 --- a/.yamllint +++ b/.yamllint @@ -13,3 +13,6 @@ rules: max: 160 ignore-from-file: .gitignore +ignore: + - .github/ + - changelogs/fragments/ diff --git a/changelogs/config.yaml b/changelogs/config.yaml index 33a52ac2d..619746ae1 100644 --- a/changelogs/config.yaml +++ b/changelogs/config.yaml @@ -1,3 +1,4 @@ +--- changelog_filename_template: ../CHANGELOG.rst changelog_filename_version_depth: 0 changes_file: changelog.yaml @@ -9,21 +10,21 @@ notesdir: fragments prelude_section_name: release_summary prelude_section_title: Release Summary sections: -- - major_changes - - Major Changes -- - minor_changes - - Minor Changes -- - breaking_changes - - Breaking Changes / Porting Guide -- - deprecated_features - - Deprecated Features -- - removed_features - - Removed Features (previously deprecated) -- - security_fixes - - Security Fixes -- - bugfixes - - Bugfixes -- - known_issues - - Known Issues + - - major_changes + - Major Changes + - - minor_changes + - Minor Changes + - - breaking_changes + - Breaking Changes / Porting Guide + - - deprecated_features + - Deprecated Features + - - removed_features + - Removed Features (previously deprecated) + - - security_fixes + - Security Fixes + - - bugfixes + - Bugfixes + - - known_issues + - Known Issues title: vmware.vmware_rest trivial_section_name: trivial diff --git a/tests/config.yml b/tests/config.yml index 33941df95..340add1aa 100644 --- a/tests/config.yml +++ b/tests/config.yml @@ -1,2 +1,3 @@ +--- modules: - python_requires: '>=3.8' + python_requires: ">=3.8" From 7d7752cdead468d91c5eecbebc45204616209507 Mon Sep 17 00:00:00 2001 From: Mike Morency Date: Thu, 1 Aug 2024 11:05:04 -0400 Subject: [PATCH 5/5] fix lint config --- .yamllint | 1 - 1 file changed, 1 deletion(-) diff --git a/.yamllint b/.yamllint index eb4298094..0d1e0f8ed 100644 --- a/.yamllint +++ b/.yamllint @@ -12,7 +12,6 @@ rules: ignore: *default_ignores max: 160 -ignore-from-file: .gitignore ignore: - .github/ - changelogs/fragments/