diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-05 16:18:34 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-05 16:18:34 +0000 |
| commit | 3667197efb7b18ec842efd504785965911f8ac4b (patch) | |
| tree | 0b986a4bc6879d080b100666a97cdabbc9ca1f28 /ansible_collections/vmware/vmware_rest/docs | |
| parent | Adding upstream version 9.5.1+dfsg. (diff) | |
| download | ansible-upstream/10.0.0+dfsg.tar.xz ansible-upstream/10.0.0+dfsg.zip | |
Adding upstream version 10.0.0+dfsg.upstream/10.0.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/vmware/vmware_rest/docs')
140 files changed, 1304 insertions, 715 deletions
diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_consolecli_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_consolecli_info_module.rst index ad97257d3..0deef6706 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_consolecli_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_consolecli_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_consolecli_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_consolecli_module.rst index 4a82a5175..3234237ee 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_consolecli_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_consolecli_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -194,7 +194,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_dcui_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_dcui_info_module.rst index 199ad6a61..81635394d 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_dcui_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_dcui_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_dcui_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_dcui_module.rst index c92150307..5f8abce2b 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_dcui_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_dcui_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -194,7 +194,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_shell_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_shell_info_module.rst index d8472f76b..1cb4dcdc5 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_shell_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_shell_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_shell_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_shell_module.rst index 2980f0647..c7836791b 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_shell_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_shell_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -210,7 +210,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_ssh_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_ssh_info_module.rst index 5ebf87111..1f71fd38c 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_ssh_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_ssh_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_ssh_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_ssh_module.rst index ce689f6b4..7ea11cca3 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_ssh_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_access_ssh_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -194,7 +194,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_applmgmt_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_applmgmt_info_module.rst index 42623d726..0f99a32ea 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_applmgmt_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_applmgmt_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_database_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_database_info_module.rst index d781bbd41..32437265d 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_database_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_database_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_databasestorage_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_databasestorage_info_module.rst index aa54178b7..d87c9ec82 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_databasestorage_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_databasestorage_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_load_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_load_info_module.rst index f6069d4a9..656243016 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_load_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_load_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_mem_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_mem_info_module.rst index a77c552ad..44cafb88c 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_mem_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_mem_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_softwarepackages_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_softwarepackages_info_module.rst index 66e7c43b2..061d7f6b6 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_softwarepackages_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_softwarepackages_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_storage_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_storage_info_module.rst index 941178c0c..c354fe489 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_storage_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_storage_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_swap_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_swap_info_module.rst index ba8dc6f4f..365d475b3 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_swap_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_swap_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_system_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_system_info_module.rst index e192df669..b5a597654 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_system_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_health_system_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_infraprofile_configs_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_infraprofile_configs_info_module.rst index 563c26205..1387af2b8 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_infraprofile_configs_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_infraprofile_configs_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_infraprofile_configs_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_infraprofile_configs_module.rst index 842336a15..af0e71ed8 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_infraprofile_configs_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_infraprofile_configs_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -225,7 +225,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module.rst index 5dc2b7069..2c3cfec27 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_module.rst index 4a4a26f4d..c8127a9e8 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -54,6 +54,7 @@ Parameters </td> <td> <div>Maximum number of days a password may be used. If the password is older than this, a password change will be forced.</div> + <div>If unset then the restriction will be ignored.</div> </td> </tr> <tr> @@ -69,6 +70,7 @@ Parameters </td> <td> <div>Minimum number of days allowed between password changes. Any password changes attempted sooner than this will be rejected.</div> + <div>If unset then the restriction will be ignored.</div> </td> </tr> <tr> @@ -209,6 +211,7 @@ Parameters </td> <td> <div>Number of days warning given before a password expires. A zero means warning is given only upon the day of expiration.</div> + <div>If unset then no warning will be provided.</div> </td> </tr> </table> @@ -219,7 +222,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_localaccounts_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_localaccounts_info_module.rst index 3ac8895f0..f7af04602 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_localaccounts_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_localaccounts_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -172,7 +172,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_monitoring_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_monitoring_info_module.rst index 7f642c9eb..ff263e4c8 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_monitoring_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_monitoring_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -71,7 +71,8 @@ Parameters <td> </td> <td> - <div>statistic item id Required with <em>state=['get']</em></div> + <div>statistic item id</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.appliance_monitoring_info</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_monitoring_query_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_monitoring_query_module.rst index cbb5420fb..27bf8352c 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_monitoring_query_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_monitoring_query_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -76,7 +76,7 @@ Parameters </ul> </td> <td> - <div><code>function_type</code> Defines aggregation function This parameter is mandatory.</div> + <div><em>function_type</em> enumerated type Defines aggregation function This parameter is mandatory.</div> </td> </tr> <tr> @@ -99,7 +99,7 @@ Parameters </ul> </td> <td> - <div><code>interval_type</code> Defines interval between the values in hours and mins, for which aggregation will apply This parameter is mandatory.</div> + <div><em>interval_type</em> enumerated type Defines interval between the values in hours and mins, for which aggregation will apply This parameter is mandatory.</div> </td> </tr> <tr> @@ -116,7 +116,8 @@ Parameters <td> </td> <td> - <div>monitored item IDs Ex: CPU, MEMORY This parameter is mandatory.</div> + <div>monitored item IDs Ex: CPU, MEMORY</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.appliance_monitoring_info</span>.</div> </td> </tr> <tr> @@ -251,7 +252,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_domains_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_domains_info_module.rst index f3e455aa4..e3437c6a8 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_domains_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_domains_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_domains_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_domains_module.rst index 30cfd355f..66baf0ef0 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_domains_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_domains_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -206,7 +206,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_hostname_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_hostname_info_module.rst index 09bbfbd38..123c29bb7 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_hostname_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_hostname_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_hostname_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_hostname_module.rst index 9fac06b19..e1deee534 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_hostname_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_hostname_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -191,7 +191,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_servers_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_servers_info_module.rst index 22e3a7105..7a28f961b 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_servers_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_servers_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_servers_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_servers_module.rst index d64a7fff2..d37c90071 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_servers_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_dns_servers_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -57,7 +57,7 @@ Parameters </ul> </td> <td> - <div><code>dns_server_mode</code> Describes DNS Server source (DHCP,static) Required with <em>state=['set']</em></div> + <div><em>dns_server_mode</em> enumerated type Describes DNS Server source (DHCP,static) Required with <em>state=['set']</em></div> </td> </tr> <tr> @@ -226,7 +226,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_info_module.rst index 5315be6d4..69031bfbc 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_module.rst index cd25a625b..780a57ced 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_module.rst @@ -17,7 +17,7 @@ Version added: 2.0.0 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: <table> <tr> <th>Address</th><th>Prefix</th><th>Interface Name</th><th>Policy</th> </tr> <tr> <td>10.112.0.1</td><td>0</td><td>*</td><td>REJECT</td> </tr> <tr> <td>10.112.0.1</td><td>0</td><td>nic0</td><td>ACCEPT</td> </tr> </table> In the above example, the first rule drops all packets originating from 10.112.0.1 and<br> the second rule accepts all packets originating from 10.112.0.1 only on nic0. In effect, the second rule is always ignored which is not desired, hence the order has to be swapped. When a connection matches a firewall rule, further processing for the connection stops, and the appliance ignores any additional firewall rules you have set. +- 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 ] @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -61,7 +61,7 @@ Parameters <div>This key is required with ['set'].</div> <div>- <code>prefix</code> (int): CIDR prefix used to mask address. For example, an IPv4 prefix of 24 ignores the low-order 8 bits of address. (['set'])</div> <div>This key is required with ['set'].</div> - <div>- <code>policy</code> (str): <code>policy</code> Defines firewall rule policies. (['set'])</div> + <div>- <code>policy</code> (str): <em>policy</em> enumerated type Defines firewall rule policies. (['set'])</div> <div>This key is required with ['set'].</div> <div>- Accepted values:</div> <div>- ACCEPT</div> @@ -204,7 +204,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_info_module.rst index 81e483b01..21d75be2c 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_info_module.rst index 4c53c478a..1865a43c6 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>Network interface, for example, "nic0". Required with <em>state=['get']</em></div> + <div>Network interface, for example, "nic0".</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.appliance_networking_interfaces_info</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module.rst index f151d1397..ae06749e7 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>The Network interface to query, for example, "nic0". Required with <em>state=['get']</em></div> + <div>The Network interface to query, for example, "nic0".</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.appliance_networking_interfaces_info</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_module.rst index 7477b360d..fde23189d 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -54,6 +54,7 @@ Parameters </td> <td> <div>The IPv4 address, for example, "10.20.80.191".</div> + <div>This field is optional and it is only relevant when the value of <em>mode</em> is STATIC.</div> </td> </tr> <tr> @@ -69,6 +70,7 @@ Parameters </td> <td> <div>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.</div> + <div>If unset, the defaultGateway was never set.</div> </td> </tr> <tr> @@ -84,7 +86,8 @@ Parameters <td> </td> <td> - <div>Network interface to update, for example, "nic0". This parameter is mandatory.</div> + <div>Network interface to update, for example, "nic0".</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.appliance_networking_interfaces_info</span>. This parameter is mandatory.</div> </td> </tr> <tr> @@ -105,7 +108,7 @@ Parameters </ul> </td> <td> - <div>The <code>mode</code> defines different IPv4 address assignment modes. This parameter is mandatory.</div> + <div>The <em>mode</em> enumerated type defines different IPv4 address assignment modes. This parameter is mandatory.</div> </td> </tr> <tr> @@ -120,7 +123,8 @@ Parameters <td> </td> <td> - <div>The IPv4 CIDR prefix, for example, 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion.</div> + <div>The IPv4 CIDR prefix, for example, 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion.</div> + <div>This field is optional and it is only relevant when the value of <em>mode</em> is STATIC.</div> </td> </tr> <tr> @@ -256,7 +260,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module.rst index 9df1a4bd8..8a9991f6f 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>Network interface to query, for example, "nic0". Required with <em>state=['get']</em></div> + <div>Network interface to query, for example, "nic0".</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.appliance_networking_interfaces_info</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_module.rst index 16e571e75..5426cc20b 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -132,7 +132,8 @@ Parameters <td> </td> <td> - <div>Network interface to update, for example, "nic0". This parameter is mandatory.</div> + <div>Network interface to update, for example, "nic0".</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.appliance_networking_interfaces_info</span>. This parameter is mandatory.</div> </td> </tr> <tr> @@ -268,7 +269,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_module.rst index 40b348c1e..4562354b3 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -58,6 +58,7 @@ Parameters </td> <td> <div>IPv6 Enabled or not</div> + <div>If unspecified, leaves the current state of Ipv6.</div> </td> </tr> <tr> @@ -194,7 +195,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_noproxy_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_noproxy_info_module.rst index 711c60ff2..51e1a82d7 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_noproxy_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_noproxy_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 @@ -190,15 +190,13 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <b>value</b> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <div style="font-size: small"> - <span style="color: purple">list</span> + <span style="color: purple">dictionary</span> </div> </td> <td>On success</td> <td> - <div>Get HTTP noproxy configuration</div> + <div>Remove the noproxy entries</div> <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['localhost', '127.0.0.1']</div> </td> </tr> </table> diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_noproxy_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_noproxy_module.rst index 1a606ff45..fc47e40d4 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_noproxy_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_noproxy_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -191,7 +191,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_proxy_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_proxy_info_module.rst index b081af34b..a66d640fb 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_proxy_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_proxy_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -172,7 +172,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_proxy_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_proxy_module.rst index 2b010a621..a7e04b6a1 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_proxy_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_networking_proxy_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -59,9 +59,11 @@ Parameters <div>This key is required with ['test'].</div> <div>- <code>port</code> (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'])</div> <div>This key is required with ['test'].</div> - <div>- <code>username</code> (str): Username for proxy server. (['test'])</div> - <div>- <code>password</code> (str): Password for proxy server. (['test'])</div> - <div>- <code>enabled</code> (bool): In the result of the <code>#get</code> and <code>#list</code> {@term operations} this field indicates whether proxying is enabled for a particular protocol. In the input to the <code>test</code> and <code>set</code> {@term operations} this field specifies whether proxying should be enabled for a particular protocol. (['test'])</div> + <div>- <code>username</code> (str): Username for proxy server.</div> + <div>Only set if proxy requires username. (['test'])</div> + <div>- <code>password</code> (str): Password for proxy server.</div> + <div>Only set if proxy requires password. (['test'])</div> + <div>- <code>enabled</code> (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'])</div> <div>This key is required with ['test'].</div> </td> </tr> @@ -81,7 +83,7 @@ Parameters </ul> </td> <td> - <div>In the result of the <code>#get</code> and <code>#list</code> {@term operations} this field indicates whether proxying is enabled for a particular protocol. In the input to the <code>test</code> and <code>set</code> {@term operations} this field specifies whether proxying should be enabled for a particular protocol. Required with <em>state=['set']</em></div> + <div>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 <em>state=['set']</em></div> </td> </tr> <tr> @@ -112,6 +114,7 @@ Parameters </td> <td> <div>Password for proxy server.</div> + <div>Only set if proxy requires password.</div> </td> </tr> <tr> @@ -210,6 +213,7 @@ Parameters </td> <td> <div>Username for proxy server.</div> + <div>Only set if proxy requires username.</div> </td> </tr> <tr> @@ -310,7 +314,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_ntp_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_ntp_info_module.rst index 8a98ad912..b771d44c9 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_ntp_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_ntp_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_ntp_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_ntp_module.rst index 6c8fc2fe5..fb87a4138 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_ntp_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_ntp_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -192,7 +192,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_services_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_services_info_module.rst index 0d11d786f..90f8378c6 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_services_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_services_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>identifier of the service whose state is being queried. Required with <em>state=['get']</em></div> + <div>identifier of the service whose state is being queried.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.appliance_services_info</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_services_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_services_module.rst index fb5be4141..484e5cd12 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_services_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_services_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -54,7 +54,8 @@ Parameters <td> </td> <td> - <div>identifier of the service to restart This parameter is mandatory.</div> + <div>identifier of the service to restart</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.appliance_services_info</span>. This parameter is mandatory.</div> </td> </tr> <tr> @@ -193,7 +194,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_shutdown_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_shutdown_info_module.rst index 8f90e9a24..e6e0e0e5b 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_shutdown_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_shutdown_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_shutdown_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_shutdown_module.rst index 6dd695fe7..d2b16d3bf 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_shutdown_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_shutdown_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -207,7 +207,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_globalfips_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_globalfips_info_module.rst index 47d61da0c..f4d349cef 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_globalfips_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_globalfips_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_globalfips_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_globalfips_module.rst index 77af351d1..730745653 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_globalfips_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_globalfips_module.rst @@ -17,7 +17,7 @@ Version added: 2.0.0 Synopsis -------- -- Enable/Disable Global FIPS mode for the appliance. <p><b>Caution:</b> Changing the value of this setting will reboot the Appliance. +- Enable/Disable Global FIPS mode for the appliance. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -58,6 +58,7 @@ Parameters </td> <td> <div>FIPS setting state.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -193,7 +194,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_storage_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_storage_info_module.rst index cf7e5089b..59d86c925 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_storage_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_storage_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_storage_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_storage_module.rst index a61dc5897..4b32410f0 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_storage_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_storage_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -176,7 +176,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_time_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_time_info_module.rst index 217270a1e..90b33a6b1 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_time_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_time_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_time_timezone_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_time_timezone_info_module.rst index 276ce7fa2..ce7397dff 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_time_timezone_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_time_timezone_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_time_timezone_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_time_timezone_module.rst index e15484e47..f3c18e8df 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_time_timezone_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_time_timezone_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -190,7 +190,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_version_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_version_info_module.rst index 425a493f5..66fd273cd 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_version_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_system_version_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_timesync_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_timesync_info_module.rst index 178f4266f..876f14b76 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_timesync_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_timesync_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_timesync_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_timesync_module.rst index ab78afe93..600fb85b7 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_timesync_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_timesync_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -59,7 +59,7 @@ Parameters </ul> </td> <td> - <div>The <code>time_sync_mode</code> defines time synchronization modes This parameter is mandatory.</div> + <div>The <em>time_sync_mode</em> enumerated type defines time synchronization modes This parameter is mandatory.</div> </td> </tr> <tr> @@ -195,7 +195,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_update_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_update_info_module.rst index d2fd392fb..b288a6dbb 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_update_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_update_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_vmon_service_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_vmon_service_info_module.rst index ed7104315..d62a3bb74 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_vmon_service_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_vmon_service_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -173,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_vmon_service_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_vmon_service_module.rst index 5fa8058ff..bbff189ba 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_vmon_service_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.appliance_vmon_service_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -214,7 +214,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.cluster_moid_lookup.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.cluster_moid_lookup.rst index 190d3535a..1af5dd5c5 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.cluster_moid_lookup.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.cluster_moid_lookup.rst @@ -48,7 +48,7 @@ Parameters <b>_terms</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> / <span style="color: red">required</span> </div> </td> @@ -73,10 +73,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_HOST</div> </td> <td> <div>The hostname or IP address of the vSphere vCenter.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_HOST</code> will be used instead.</div> </td> </tr> <tr> @@ -92,10 +92,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_PASSWORD</div> </td> <td> <div>The vSphere vCenter password.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PASSWORD</code> will be used instead.</div> </td> </tr> <tr> @@ -110,12 +110,12 @@ Parameters <td> </td> <td> + <div>env:VMWARE_REST_LOG_FILE</div> </td> <td> <div>You can use this optional parameter to set the location of a log file.</div> - <div>This file will be used to record the HTTP REST interaction.</div> - <div>The file will be stored on the host that run the module.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_REST_LOG_FILE</code> will be used instead.</div> + <div>This file will be used to record the HTTP REST interactions.</div> + <div>The file will be stored on the host that runs the module.</div> </td> </tr> <tr> @@ -131,10 +131,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_USER</div> </td> <td> <div>The vSphere vCenter username.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_USER</code> will be used instead.</div> </td> </tr> <tr> @@ -147,16 +147,13 @@ Parameters </div> </td> <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> + <b>Default:</b><br/><div style="color: blue">"yes"</div> </td> <td> + <div>env:VMWARE_VALIDATE_CERTS</div> </td> <td> - <div>Allows connection when SSL certificates are not valid. Set to <code>false</code> when certificates are not trusted.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_VALIDATE_CERTS</code> will be used instead.</div> + <div>Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.</div> </td> </tr> </table> @@ -174,9 +171,9 @@ Examples - name: set connection info ansible.builtin.set_fact: connection_args: - vcenter_hostname: "vcenter.test" - vcenter_username: "administrator@vsphere.local" - vcenter_password: "1234" + 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) }}" diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_configuration_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_configuration_info_module.rst index dced88933..ff6b937ce 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_configuration_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_configuration_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -157,7 +157,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_configuration_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_configuration_module.rst index 9eb24b58d..52754ce8f 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_configuration_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_configuration_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -238,7 +238,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_library_item_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_library_item_info_module.rst index 171c029de..b45b08afa 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_library_item_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_library_item_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -187,7 +187,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_locallibrary_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_locallibrary_info_module.rst index ff24517b4..98f8192b9 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_locallibrary_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_locallibrary_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -172,7 +172,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_locallibrary_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_locallibrary_module.rst index 6c55afc4b..c4219c9ea 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_locallibrary_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_locallibrary_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -207,6 +207,21 @@ Parameters <tr> <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>security_policy_id</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Represents the security policy applied to this library. Setting the field will make the library secure. This field is ignored in <code>update</code>operation if {@link #unsetSecurityPolicyId} is set to <code>True</code>.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>server_guid</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -350,6 +365,25 @@ Parameters <tr> <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>unset_security_policy_id</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>This represents the intent of the change to {@link #securityPolicyId} in <code>update</code>operation. If this field is set to <code>True</code>, any security policy applied to the library will be removed. If this field is set to <code>False</code>, any security policy applied to library will be changed to the value specified in {@link #securityPolicyId}, if any.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>vcenter_hostname</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -460,7 +494,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_subscribedlibrary_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_subscribedlibrary_info_module.rst index 054750d64..4a90cfdab 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_subscribedlibrary_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_subscribedlibrary_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -172,7 +172,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_subscribedlibrary_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_subscribedlibrary_module.rst index a98f77fda..17f25ebe8 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_subscribedlibrary_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.content_subscribedlibrary_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -207,6 +207,21 @@ Parameters <tr> <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>security_policy_id</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Represents the security policy applied to this library. Setting the field will make the library secure. This field is ignored in <code>update</code>operation if {@link #unsetSecurityPolicyId} is set to <code>True</code>.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>server_guid</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -333,6 +348,25 @@ Parameters <tr> <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>unset_security_policy_id</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>This represents the intent of the change to {@link #securityPolicyId} in <code>update</code>operation. If this field is set to <code>True</code>, any security policy applied to the library will be removed. If this field is set to <code>False</code>, any security policy applied to library will be changed to the value specified in {@link #securityPolicyId}, if any.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>vcenter_hostname</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -443,7 +477,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.datacenter_moid_lookup.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.datacenter_moid_lookup.rst index 122bca9ed..4291b22cb 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.datacenter_moid_lookup.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.datacenter_moid_lookup.rst @@ -48,7 +48,7 @@ Parameters <b>_terms</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> / <span style="color: red">required</span> </div> </td> @@ -73,10 +73,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_HOST</div> </td> <td> <div>The hostname or IP address of the vSphere vCenter.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_HOST</code> will be used instead.</div> </td> </tr> <tr> @@ -92,10 +92,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_PASSWORD</div> </td> <td> <div>The vSphere vCenter password.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PASSWORD</code> will be used instead.</div> </td> </tr> <tr> @@ -110,12 +110,12 @@ Parameters <td> </td> <td> + <div>env:VMWARE_REST_LOG_FILE</div> </td> <td> <div>You can use this optional parameter to set the location of a log file.</div> - <div>This file will be used to record the HTTP REST interaction.</div> - <div>The file will be stored on the host that run the module.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_REST_LOG_FILE</code> will be used instead.</div> + <div>This file will be used to record the HTTP REST interactions.</div> + <div>The file will be stored on the host that runs the module.</div> </td> </tr> <tr> @@ -131,10 +131,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_USER</div> </td> <td> <div>The vSphere vCenter username.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_USER</code> will be used instead.</div> </td> </tr> <tr> @@ -147,16 +147,13 @@ Parameters </div> </td> <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> + <b>Default:</b><br/><div style="color: blue">"yes"</div> </td> <td> + <div>env:VMWARE_VALIDATE_CERTS</div> </td> <td> - <div>Allows connection when SSL certificates are not valid. Set to <code>false</code> when certificates are not trusted.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_VALIDATE_CERTS</code> will be used instead.</div> + <div>Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.</div> </td> </tr> </table> diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.datastore_moid_lookup.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.datastore_moid_lookup.rst index cdd04ae4b..c390bc466 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.datastore_moid_lookup.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.datastore_moid_lookup.rst @@ -48,7 +48,7 @@ Parameters <b>_terms</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> / <span style="color: red">required</span> </div> </td> @@ -73,10 +73,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_HOST</div> </td> <td> <div>The hostname or IP address of the vSphere vCenter.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_HOST</code> will be used instead.</div> </td> </tr> <tr> @@ -92,10 +92,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_PASSWORD</div> </td> <td> <div>The vSphere vCenter password.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PASSWORD</code> will be used instead.</div> </td> </tr> <tr> @@ -110,12 +110,12 @@ Parameters <td> </td> <td> + <div>env:VMWARE_REST_LOG_FILE</div> </td> <td> <div>You can use this optional parameter to set the location of a log file.</div> - <div>This file will be used to record the HTTP REST interaction.</div> - <div>The file will be stored on the host that run the module.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_REST_LOG_FILE</code> will be used instead.</div> + <div>This file will be used to record the HTTP REST interactions.</div> + <div>The file will be stored on the host that runs the module.</div> </td> </tr> <tr> @@ -131,10 +131,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_USER</div> </td> <td> <div>The vSphere vCenter username.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_USER</code> will be used instead.</div> </td> </tr> <tr> @@ -147,16 +147,13 @@ Parameters </div> </td> <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> + <b>Default:</b><br/><div style="color: blue">"yes"</div> </td> <td> + <div>env:VMWARE_VALIDATE_CERTS</div> </td> <td> - <div>Allows connection when SSL certificates are not valid. Set to <code>false</code> when certificates are not trusted.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_VALIDATE_CERTS</code> will be used instead.</div> + <div>Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.</div> </td> </tr> </table> diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.folder_moid_lookup.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.folder_moid_lookup.rst index 6dbf99e4f..4bafe0066 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.folder_moid_lookup.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.folder_moid_lookup.rst @@ -48,7 +48,7 @@ Parameters <b>_terms</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> / <span style="color: red">required</span> </div> </td> @@ -73,10 +73,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_HOST</div> </td> <td> <div>The hostname or IP address of the vSphere vCenter.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_HOST</code> will be used instead.</div> </td> </tr> <tr> @@ -92,10 +92,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_PASSWORD</div> </td> <td> <div>The vSphere vCenter password.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PASSWORD</code> will be used instead.</div> </td> </tr> <tr> @@ -110,12 +110,12 @@ Parameters <td> </td> <td> + <div>env:VMWARE_REST_LOG_FILE</div> </td> <td> <div>You can use this optional parameter to set the location of a log file.</div> - <div>This file will be used to record the HTTP REST interaction.</div> - <div>The file will be stored on the host that run the module.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_REST_LOG_FILE</code> will be used instead.</div> + <div>This file will be used to record the HTTP REST interactions.</div> + <div>The file will be stored on the host that runs the module.</div> </td> </tr> <tr> @@ -131,10 +131,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_USER</div> </td> <td> <div>The vSphere vCenter username.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_USER</code> will be used instead.</div> </td> </tr> <tr> @@ -147,16 +147,13 @@ Parameters </div> </td> <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> + <b>Default:</b><br/><div style="color: blue">"yes"</div> </td> <td> + <div>env:VMWARE_VALIDATE_CERTS</div> </td> <td> - <div>Allows connection when SSL certificates are not valid. Set to <code>false</code> when certificates are not trusted.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_VALIDATE_CERTS</code> will be used instead.</div> + <div>Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.</div> </td> </tr> </table> diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.host_moid_lookup.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.host_moid_lookup.rst index d95332d1f..9db9d8523 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.host_moid_lookup.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.host_moid_lookup.rst @@ -48,7 +48,7 @@ Parameters <b>_terms</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> / <span style="color: red">required</span> </div> </td> @@ -73,10 +73,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_HOST</div> </td> <td> <div>The hostname or IP address of the vSphere vCenter.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_HOST</code> will be used instead.</div> </td> </tr> <tr> @@ -92,10 +92,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_PASSWORD</div> </td> <td> <div>The vSphere vCenter password.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PASSWORD</code> will be used instead.</div> </td> </tr> <tr> @@ -110,12 +110,12 @@ Parameters <td> </td> <td> + <div>env:VMWARE_REST_LOG_FILE</div> </td> <td> <div>You can use this optional parameter to set the location of a log file.</div> - <div>This file will be used to record the HTTP REST interaction.</div> - <div>The file will be stored on the host that run the module.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_REST_LOG_FILE</code> will be used instead.</div> + <div>This file will be used to record the HTTP REST interactions.</div> + <div>The file will be stored on the host that runs the module.</div> </td> </tr> <tr> @@ -131,10 +131,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_USER</div> </td> <td> <div>The vSphere vCenter username.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_USER</code> will be used instead.</div> </td> </tr> <tr> @@ -147,16 +147,13 @@ Parameters </div> </td> <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> + <b>Default:</b><br/><div style="color: blue">"yes"</div> </td> <td> + <div>env:VMWARE_VALIDATE_CERTS</div> </td> <td> - <div>Allows connection when SSL certificates are not valid. Set to <code>false</code> when certificates are not trusted.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_VALIDATE_CERTS</code> will be used instead.</div> + <div>Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.</div> </td> </tr> </table> diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.network_moid_lookup.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.network_moid_lookup.rst index af0d35175..2e7340705 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.network_moid_lookup.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.network_moid_lookup.rst @@ -18,6 +18,7 @@ Version added: 2.1.0 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. @@ -48,7 +49,7 @@ Parameters <b>_terms</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> / <span style="color: red">required</span> </div> </td> @@ -73,10 +74,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_HOST</div> </td> <td> <div>The hostname or IP address of the vSphere vCenter.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_HOST</code> will be used instead.</div> </td> </tr> <tr> @@ -92,10 +93,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_PASSWORD</div> </td> <td> <div>The vSphere vCenter password.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PASSWORD</code> will be used instead.</div> </td> </tr> <tr> @@ -110,12 +111,12 @@ Parameters <td> </td> <td> + <div>env:VMWARE_REST_LOG_FILE</div> </td> <td> <div>You can use this optional parameter to set the location of a log file.</div> - <div>This file will be used to record the HTTP REST interaction.</div> - <div>The file will be stored on the host that run the module.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_REST_LOG_FILE</code> will be used instead.</div> + <div>This file will be used to record the HTTP REST interactions.</div> + <div>The file will be stored on the host that runs the module.</div> </td> </tr> <tr> @@ -131,10 +132,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_USER</div> </td> <td> <div>The vSphere vCenter username.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_USER</code> will be used instead.</div> </td> </tr> <tr> @@ -147,16 +148,13 @@ Parameters </div> </td> <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> + <b>Default:</b><br/><div style="color: blue">"yes"</div> </td> <td> + <div>env:VMWARE_VALIDATE_CERTS</div> </td> <td> - <div>Allows connection when SSL certificates are not valid. Set to <code>false</code> when certificates are not trusted.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_VALIDATE_CERTS</code> will be used instead.</div> + <div>Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.</div> </td> </tr> </table> diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.resource_pool_moid_lookup.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.resource_pool_moid_lookup.rst index 006edcd9d..6267c69ad 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.resource_pool_moid_lookup.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.resource_pool_moid_lookup.rst @@ -48,7 +48,7 @@ Parameters <b>_terms</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> / <span style="color: red">required</span> </div> </td> @@ -73,10 +73,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_HOST</div> </td> <td> <div>The hostname or IP address of the vSphere vCenter.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_HOST</code> will be used instead.</div> </td> </tr> <tr> @@ -92,10 +92,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_PASSWORD</div> </td> <td> <div>The vSphere vCenter password.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PASSWORD</code> will be used instead.</div> </td> </tr> <tr> @@ -110,12 +110,12 @@ Parameters <td> </td> <td> + <div>env:VMWARE_REST_LOG_FILE</div> </td> <td> <div>You can use this optional parameter to set the location of a log file.</div> - <div>This file will be used to record the HTTP REST interaction.</div> - <div>The file will be stored on the host that run the module.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_REST_LOG_FILE</code> will be used instead.</div> + <div>This file will be used to record the HTTP REST interactions.</div> + <div>The file will be stored on the host that runs the module.</div> </td> </tr> <tr> @@ -131,10 +131,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_USER</div> </td> <td> <div>The vSphere vCenter username.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_USER</code> will be used instead.</div> </td> </tr> <tr> @@ -147,16 +147,13 @@ Parameters </div> </td> <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> + <b>Default:</b><br/><div style="color: blue">"yes"</div> </td> <td> + <div>env:VMWARE_VALIDATE_CERTS</div> </td> <td> - <div>Allows connection when SSL certificates are not valid. Set to <code>false</code> when certificates are not trusted.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_VALIDATE_CERTS</code> will be used instead.</div> + <div>Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.</div> </td> </tr> </table> diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_cluster_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_cluster_info_module.rst index b1e012370..879f9b5e6 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_cluster_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_cluster_info_module.rst @@ -5,7 +5,7 @@ vmware.vmware_rest.vcenter_cluster_info *************************************** -**Retrieves information about the cluster corresponding to {@param.name cluster}.** +**Retrieves information about the cluster corresponding to cluster.** Version added: 0.1.0 @@ -17,7 +17,7 @@ Version added: 0.1.0 Synopsis -------- -- Retrieves information about the cluster corresponding to {@param.name cluster}. +- Retrieves information about the cluster corresponding to cluster. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>Identifier of the cluster. Required with <em>state=['get']</em></div> + <div>Identifier of the cluster.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_cluster_info</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -70,6 +71,8 @@ Parameters </td> <td> <div>Identifiers of clusters that can match the filter.</div> + <div>If unset or empty, clusters with any identifier match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_cluster_info</span>.</div> </td> </tr> <tr> @@ -86,6 +89,8 @@ Parameters </td> <td> <div>Datacenters that must contain the cluster for the cluster to match the filter.</div> + <div>If unset or empty, clusters in any datacenter match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_datacenter_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_datacenters</div> </td> </tr> @@ -103,6 +108,8 @@ Parameters </td> <td> <div>Folders that must contain the cluster for the cluster to match the filter.</div> + <div>If unset or empty, clusters in any folder match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_folder_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_folders</div> </td> </tr> @@ -119,7 +126,8 @@ Parameters <td> </td> <td> - <div>Names that clusters must have to match the filter (see {@link Info#name}).</div> + <div>Names that clusters must have to match the filter (see <em>name</em>).</div> + <div>If unset or empty, clusters with any name match the filter.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_names</div> </td> </tr> @@ -239,7 +247,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datacenter_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datacenter_info_module.rst index 65fcd317b..fc896abe1 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datacenter_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datacenter_info_module.rst @@ -5,7 +5,7 @@ vmware.vmware_rest.vcenter_datacenter_info ****************************************** -**Retrieves information about the datacenter corresponding to {@param.name datacenter}.** +**Retrieves information about the datacenter corresponding to datacenter.** Version added: 0.1.0 @@ -17,7 +17,7 @@ Version added: 0.1.0 Synopsis -------- -- Retrieves information about the datacenter corresponding to {@param.name datacenter}. +- Retrieves information about the datacenter corresponding to datacenter. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>Identifier of the datacenter. Required with <em>state=['get']</em></div> + <div>Identifier of the datacenter.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_datacenter_info</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -70,6 +71,8 @@ Parameters </td> <td> <div>Identifiers of datacenters that can match the filter.</div> + <div>If unset or empty, datacenters with any identifier match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_datacenter_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_datacenters</div> </td> </tr> @@ -87,6 +90,8 @@ Parameters </td> <td> <div>Folders that must contain the datacenters for the datacenter to match the filter.</div> + <div>If unset or empty, datacenters in any folder match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_folder_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_folders</div> </td> </tr> @@ -103,7 +108,8 @@ Parameters <td> </td> <td> - <div>Names that datacenters must have to match the filter (see {@link Info#name}).</div> + <div>Names that datacenters must have to match the filter (see <em>name</em>).</div> + <div>If unset or empty, datacenters with any name match the filter.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_names</div> </td> </tr> @@ -223,7 +229,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datacenter_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datacenter_module.rst index db29e2eb3..68c9d7bac 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datacenter_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datacenter_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>Identifier of the datacenter to be deleted. Required with <em>state=['absent']</em></div> + <div>Identifier of the datacenter to be deleted.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_datacenter_info</span>. Required with <em>state=['absent']</em></div> </td> </tr> <tr> @@ -69,6 +70,8 @@ Parameters </td> <td> <div>Datacenter folder in which the new datacenter should be created.</div> + <div>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.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_folder_info</span>.</div> </td> </tr> <tr> @@ -88,6 +91,7 @@ Parameters </td> <td> <div>If true, delete the datacenter even if it is not empty.</div> + <div>If unset a ResourceInUse error will be reported if the datacenter is not empty. This is the equivalent of passing the value false.</div> </td> </tr> <tr> @@ -239,7 +243,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 @@ -251,7 +255,6 @@ Examples - 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 @@ -261,7 +264,6 @@ Examples until: - _result is not failed retries: 7 - - name: Create datacenter my_dc vmware.vmware_rest.vcenter_datacenter: name: my_dc diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst index bdc4e6b98..4fa040e6c 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst @@ -5,7 +5,7 @@ vmware.vmware_rest.vcenter_datastore_info ***************************************** -**Retrieves information about the datastore indicated by {@param.name datastore}.** +**Retrieves information about the datastore indicated by datastore.** Version added: 0.1.0 @@ -17,7 +17,7 @@ Version added: 0.1.0 Synopsis -------- -- Retrieves information about the datastore indicated by {@param.name datastore}. +- Retrieves information about the datastore indicated by datastore. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -55,6 +55,8 @@ Parameters </td> <td> <div>Datacenters that must contain the datastore for the datastore to match the filter.</div> + <div>If unset or empty, datastores in any datacenter match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_datacenter_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_datacenters</div> </td> </tr> @@ -70,7 +72,8 @@ Parameters <td> </td> <td> - <div>Identifier of the datastore for which information should be retrieved. Required with <em>state=['get']</em></div> + <div>Identifier of the datastore for which information should be retrieved.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_datastore_info</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -87,6 +90,8 @@ Parameters </td> <td> <div>Identifiers of datastores that can match the filter.</div> + <div>If unset or empty, datastores with any identifier match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_datastore_info</span>.</div> </td> </tr> <tr> @@ -103,6 +108,8 @@ Parameters </td> <td> <div>Folders that must contain the datastore for the datastore to match the filter.</div> + <div>If unset or empty, datastores in any folder match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_folder_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_folders</div> </td> </tr> @@ -119,7 +126,8 @@ Parameters <td> </td> <td> - <div>Names that datastores must have to match the filter (see {@link Info#name}).</div> + <div>Names that datastores must have to match the filter (see <em>name</em>).</div> + <div>If unset or empty, datastores with any name match the filter.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_names</div> </td> </tr> @@ -154,7 +162,8 @@ Parameters <td> </td> <td> - <div>Types that datastores must have to match the filter (see {@link Summary#type}).</div> + <div>Types that datastores must have to match the filter (see <em>type</em>).</div> + <div>If unset or empty, datastores with any type match the filter.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_types</div> </td> </tr> @@ -256,7 +265,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_folder_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_folder_info_module.rst index 6c5612e06..99bcff22a 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_folder_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_folder_info_module.rst @@ -5,7 +5,7 @@ vmware.vmware_rest.vcenter_folder_info ************************************** -**Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the {@link FilterSpec}.** +**Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec.** Version added: 0.1.0 @@ -17,7 +17,7 @@ Version added: 0.1.0 Synopsis -------- -- Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the {@link FilterSpec}. +- Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -55,6 +55,8 @@ Parameters </td> <td> <div>Datacenters that must contain the folder for the folder to match the filter.</div> + <div>If unset or empty, folder in any datacenter match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_datacenter_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_datacenters</div> </td> </tr> @@ -72,6 +74,8 @@ Parameters </td> <td> <div>Identifiers of folders that can match the filter.</div> + <div>If unset or empty, folders with any identifier match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_folder_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_folders</div> </td> </tr> @@ -88,7 +92,8 @@ Parameters <td> </td> <td> - <div>Names that folders must have to match the filter (see {@link Summary#name}).</div> + <div>Names that folders must have to match the filter (see <em>name</em>).</div> + <div>If unset or empty, folders with any name match the filter.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_names</div> </td> </tr> @@ -106,6 +111,8 @@ Parameters </td> <td> <div>Folders that must contain the folder for the folder to match the filter.</div> + <div>If unset or empty, folder in any folder match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_folder_info</span>.</div> </td> </tr> <tr> @@ -145,7 +152,7 @@ Parameters </ul> </td> <td> - <div>The <code>type</code> 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.</div> + <div>The <em>type</em> 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.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_type</div> </td> </tr> @@ -247,7 +254,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_host_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_host_info_module.rst index 6e4e11b30..cf4a17c78 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_host_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_host_info_module.rst @@ -5,7 +5,7 @@ vmware.vmware_rest.vcenter_host_info ************************************ -**Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the {@link FilterSpec}.** +**Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.** Version added: 0.1.0 @@ -17,7 +17,7 @@ Version added: 0.1.0 Synopsis -------- -- Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the {@link FilterSpec}. +- Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -55,6 +55,8 @@ Parameters </td> <td> <div>Clusters that must contain the hosts for the hosts to match the filter.</div> + <div>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 <em>standalone</em> is true, no hosts will match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_cluster_info</span>.</div> </td> </tr> <tr> @@ -70,7 +72,8 @@ Parameters <td> </td> <td> - <div>Connection states that a host must be in to match the filter (see {@link Summary#connectionState}.</div> + <div>Connection states that a host must be in to match the filter (see I()</div> + <div>If unset or empty, hosts in any connection state match the filter.</div> </td> </tr> <tr> @@ -87,6 +90,8 @@ Parameters </td> <td> <div>Datacenters that must contain the hosts for the hosts to match the filter.</div> + <div>If unset or empty, hosts in any datacenter match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_datacenter_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_datacenters</div> </td> </tr> @@ -104,6 +109,8 @@ Parameters </td> <td> <div>Folders that must contain the hosts for the hosts to match the filter.</div> + <div>If unset or empty, hosts in any folder match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_folder_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_folders</div> </td> </tr> @@ -121,6 +128,8 @@ Parameters </td> <td> <div>Identifiers of hosts that can match the filter.</div> + <div>If unset or empty, hosts with any identifier match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_host_info</span>.</div> </td> </tr> <tr> @@ -136,7 +145,8 @@ Parameters <td> </td> <td> - <div>Names that hosts must have to match the filter (see {@link Summary#name}).</div> + <div>Names that hosts must have to match the filter (see <em>name</em>).</div> + <div>If unset or empty, hosts with any name match the filter.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_names</div> </td> </tr> @@ -175,6 +185,7 @@ Parameters </td> <td> <div>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.</div> + <div>If unset Hosts can match filter independent of whether they are part of a cluster or not. If this field is true and <em>clusters</em> os not empty, no hosts will match the filter.</div> </td> </tr> <tr> @@ -275,7 +286,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_host_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_host_module.rst index 362cc5a84..e03c304aa 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_host_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_host_module.rst @@ -17,7 +17,7 @@ Version added: 0.1.0 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 {@link CreateSpec.ThumbprintVerification}. +- 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. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -54,6 +54,8 @@ Parameters </td> <td> <div>Host and cluster folder in which the new standalone host should be created.</div> + <div>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.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_folder_info</span>.</div> </td> </tr> <tr> @@ -73,6 +75,7 @@ Parameters </td> <td> <div>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.</div> + <div>If unset, forceAdd is default to false.</div> </td> </tr> <tr> @@ -87,7 +90,8 @@ Parameters <td> </td> <td> - <div>Identifier of the host to be disconnected. Required with <em>state=['absent', 'connect', 'disconnect']</em></div> + <div>Identifier of the host to be disconnected.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_host_info</span>. Required with <em>state=['absent', 'connect', 'disconnect']</em></div> </td> </tr> <tr> @@ -133,6 +137,7 @@ Parameters </td> <td> <div>The port of the host.</div> + <div>If unset, port 443 will be used.</div> </td> </tr> <tr> @@ -186,6 +191,7 @@ Parameters </td> <td> <div>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.</div> + <div>This field is optional and it is only relevant when the value of <em>thumbprint_verification</em> is THUMBPRINT.</div> </td> </tr> <tr> @@ -204,7 +210,7 @@ Parameters </ul> </td> <td> - <div>The <code>thumbprint_verification</code> defines the thumbprint verification schemes for a host's SSL certificate. Required with <em>state=['present']</em></div> + <div>The <em>thumbprint_verification</em> enumerated type defines the thumbprint verification schemes for a host's SSL certificate. Required with <em>state=['present']</em></div> </td> </tr> <tr> @@ -320,7 +326,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_network_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_network_info_module.rst index 7c822fef3..edf435da0 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_network_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_network_info_module.rst @@ -5,7 +5,7 @@ vmware.vmware_rest.vcenter_network_info *************************************** -**Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the {@link FilterSpec}.** +**Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec.** Version added: 0.1.0 @@ -17,7 +17,7 @@ Version added: 0.1.0 Synopsis -------- -- Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the {@link FilterSpec}. +- Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -55,6 +55,8 @@ Parameters </td> <td> <div>Datacenters that must contain the network for the network to match the filter.</div> + <div>If unset or empty, networks in any datacenter match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_datacenter_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_datacenters</div> </td> </tr> @@ -72,6 +74,8 @@ Parameters </td> <td> <div>Folders that must contain the network for the network to match the filter.</div> + <div>If unset or empty, networks in any folder match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_folder_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_folders</div> </td> </tr> @@ -88,7 +92,8 @@ Parameters <td> </td> <td> - <div>Names that networks must have to match the filter (see {@link Summary#name}).</div> + <div>Names that networks must have to match the filter (see <em>name</em>).</div> + <div>If unset or empty, networks with any name match the filter.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_names</div> </td> </tr> @@ -106,6 +111,8 @@ Parameters </td> <td> <div>Identifiers of networks that can match the filter.</div> + <div>If unset or empty, networks with any identifier match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_network_info</span>.</div> </td> </tr> <tr> @@ -139,7 +146,8 @@ Parameters <td> </td> <td> - <div>Types that networks must have to match the filter (see {@link Summary#type}).</div> + <div>Types that networks must have to match the filter (see <em>type</em>).</div> + <div>If unset, networks with any type match the filter.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_types</div> </td> </tr> @@ -241,7 +249,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_ovf_libraryitem_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_ovf_libraryitem_module.rst index bf991390a..76f36b677 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_ovf_libraryitem_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_ovf_libraryitem_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -300,7 +300,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_resourcepool_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_resourcepool_info_module.rst index 0e836a88b..c2a833d59 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_resourcepool_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_resourcepool_info_module.rst @@ -5,7 +5,7 @@ vmware.vmware_rest.vcenter_resourcepool_info ******************************************** -**Retrieves information about the resource pool indicated by {@param.name resourcePool}.** +**Retrieves information about the resource pool indicated by resourcePool.** Version added: 0.3.0 @@ -17,7 +17,7 @@ Version added: 0.3.0 Synopsis -------- -- Retrieves information about the resource pool indicated by {@param.name resourcePool}. +- Retrieves information about the resource pool indicated by resourcePool. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -55,6 +55,8 @@ Parameters </td> <td> <div>Clusters that must contain the resource pool for the resource pool to match the filter.</div> + <div>If unset or empty, resource pools in any cluster match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_cluster_info</span>.</div> </td> </tr> <tr> @@ -71,6 +73,8 @@ Parameters </td> <td> <div>Datacenters that must contain the resource pool for the resource pool to match the filter.</div> + <div>If unset or empty, resource pools in any datacenter match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_datacenter_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_datacenters</div> </td> </tr> @@ -88,6 +92,8 @@ Parameters </td> <td> <div>Hosts that must contain the resource pool for the resource pool to match the filter.</div> + <div>If unset or empty, resource pools in any host match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_host_info</span>.</div> </td> </tr> <tr> @@ -103,7 +109,8 @@ Parameters <td> </td> <td> - <div>Names that resource pools must have to match the filter (see {@link Info#name}).</div> + <div>Names that resource pools must have to match the filter (see <em>name</em>).</div> + <div>If unset or empty, resource pools with any name match the filter.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_names</div> </td> </tr> @@ -121,6 +128,8 @@ Parameters </td> <td> <div>Resource pools that must contain the resource pool for the resource pool to match the filter.</div> + <div>If unset or empty, resource pools in any resource pool match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_resourcepool_info</span>.</div> </td> </tr> <tr> @@ -135,7 +144,8 @@ Parameters <td> </td> <td> - <div>Identifier of the resource pool for which information should be retrieved. Required with <em>state=['get']</em></div> + <div>Identifier of the resource pool for which information should be retrieved.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_resourcepool_info</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -152,6 +162,8 @@ Parameters </td> <td> <div>Identifiers of resource pools that can match the filter.</div> + <div>If unset or empty, resource pools with any identifier match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_resourcepool_info</span>.</div> </td> </tr> <tr> @@ -270,7 +282,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 @@ -282,18 +294,15 @@ Examples - 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 }}' diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_resourcepool_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_resourcepool_module.rst index aee7c5235..6383e31ee 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_resourcepool_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_resourcepool_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -54,19 +54,26 @@ Parameters </td> <td> <div>Resource allocation for CPU.</div> + <div>if unset or empty, the CPU allocation of the resource pool will not be changed.</div> <div>Valid attributes are:</div> - <div>- <code>reservation</code> (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. (['present'])</div> - <div>- <code>expandable_reservation</code> (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. (['present'])</div> - <div>- <code>limit</code> (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. (['present'])</div> + <div>- <code>reservation</code> (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.</div> + <div>If unset or empty, <em>reservation</em> will be set to 0. (['present'])</div> + <div>- <code>expandable_reservation</code> (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.</div> + <div>If unset or empty, <em>expandable_reservation</em> will be set to true. (['present'])</div> + <div>- <code>limit</code> (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.</div> + <div>If unset or empty, <em>limit</em> will be set to -1. (['present'])</div> <div>- <code>shares</code> (dict): Shares are used in case of resource contention. (['present'])</div> <div>- Accepted keys:</div> - <div>- level (string): The <code>level</code> defines the possible values for the allocation level.</div> + <div>- level (string): This option defines the possible values for the allocation level.</div> <div>Accepted value for this field:</div> <div>- <code>CUSTOM</code></div> <div>- <code>HIGH</code></div> <div>- <code>LOW</code></div> <div>- <code>NORMAL</code></div> - <div>- shares (integer): When {@link #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.</div> + <div>- shares (integer): When <em>level</em> is set to CUSTOM, it is the number of shares allocated. Otherwise, this value is ignored.</div> + <div>There is no unit for this value. It is a relative measure based on the settings for other resource pools.</div> + <div></div> + <div>This field is optional and it is only relevant when the value of <em>level</em> is CUSTOM.</div> </td> </tr> <tr> @@ -82,19 +89,26 @@ Parameters </td> <td> <div>Resource allocation for CPU.</div> + <div>if unset or empty, the CPU allocation of the resource pool will not be changed.</div> <div>Valid attributes are:</div> - <div>- <code>reservation</code> (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. (['present'])</div> - <div>- <code>expandable_reservation</code> (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. (['present'])</div> - <div>- <code>limit</code> (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. (['present'])</div> + <div>- <code>reservation</code> (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.</div> + <div>If unset or empty, <em>reservation</em> will be set to 0. (['present'])</div> + <div>- <code>expandable_reservation</code> (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.</div> + <div>If unset or empty, <em>expandable_reservation</em> will be set to true. (['present'])</div> + <div>- <code>limit</code> (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.</div> + <div>If unset or empty, <em>limit</em> will be set to -1. (['present'])</div> <div>- <code>shares</code> (dict): Shares are used in case of resource contention. (['present'])</div> <div>- Accepted keys:</div> - <div>- level (string): The <code>level</code> defines the possible values for the allocation level.</div> + <div>- level (string): This option defines the possible values for the allocation level.</div> <div>Accepted value for this field:</div> <div>- <code>CUSTOM</code></div> <div>- <code>HIGH</code></div> <div>- <code>LOW</code></div> <div>- <code>NORMAL</code></div> - <div>- shares (integer): When {@link #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.</div> + <div>- shares (integer): When <em>level</em> is set to CUSTOM, it is the number of shares allocated. Otherwise, this value is ignored.</div> + <div>There is no unit for this value. It is a relative measure based on the settings for other resource pools.</div> + <div></div> + <div>This field is optional and it is only relevant when the value of <em>level</em> is CUSTOM.</div> </td> </tr> <tr> @@ -109,7 +123,8 @@ Parameters <td> </td> <td> - <div>Name of the resource pool. Required with <em>state=['present']</em></div> + <div>Name of the resource pool.</div> + <div>if unset or empty, the name of the resource pool will not be changed. Required with <em>state=['present']</em></div> </td> </tr> <tr> @@ -124,7 +139,8 @@ Parameters <td> </td> <td> - <div>Parent of the created resource pool. Required with <em>state=['present']</em></div> + <div>Parent of the created resource pool.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_resourcepool_info</span>. Required with <em>state=['present']</em></div> </td> </tr> <tr> @@ -139,7 +155,8 @@ Parameters <td> </td> <td> - <div>Identifier of the resource pool to be deleted. Required with <em>state=['absent', 'present']</em></div> + <div>Identifier of the resource pool to be deleted.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_resourcepool_info</span>. Required with <em>state=['absent', 'present']</em></div> </td> </tr> <tr> @@ -276,7 +293,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 @@ -288,50 +305,46 @@ Examples - 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: + expandable_reservation: true + limit: 40 + reservation: 0 + shares: level: NORMAL memory_allocation: - expandable_reservation: false - limit: 2000 - reservation: 0 - shares: + 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: + expandable_reservation: true + limit: -1 + reservation: 0 + shares: level: NORMAL memory_allocation: - expandable_reservation: false - limit: 1000 - reservation: 0 - shares: + expandable_reservation: false + limit: 1000 + reservation: 0 + shares: level: NORMAL diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_storage_policies_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_storage_policies_info_module.rst index ff58ffb3b..59c953224 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_storage_policies_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_storage_policies_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -55,6 +55,8 @@ Parameters </td> <td> <div>Identifiers of storage policies that can match the filter.</div> + <div>If unset or empty, storage policies with any identifiers match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_storage_policies</span>.</div> </td> </tr> <tr> @@ -173,7 +175,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_customization_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_customization_module.rst index 1305070a2..65b62d24d 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_customization_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_customization_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -56,21 +56,52 @@ Parameters <td> <div>Settings to be applied to the guest during the customization. This parameter is mandatory.</div> <div>Valid attributes are:</div> - <div>- <code>windows_config</code> (dict): Guest customization specification for a Windows guest operating system (['set'])</div> + <div>- <code>windows_config</code> (dict): Guest customization specification for a Windows guest operating system</div> + <div>If unset, ConfigurationSpec.linux-config or ConfigurationSpec.cloud-config must be set. Otherwise, an appropriate fault will be thrown. (['set'])</div> <div>- Accepted keys:</div> - <div>- reboot (string): The <code>reboot_option</code> specifies what should be done to the guest after the customization.</div> + <div>- reboot (string): This option specifies what should be done to the guest after the customization.</div> <div>Accepted value for this field:</div> <div>- <code>NO_REBOOT</code></div> <div>- <code>REBOOT</code></div> <div>- <code>SHUTDOWN</code></div> - <div>- sysprep (object): Customization settings like user details, administrator details, etc for the windows guest operating system. Exactly one of <code>#sysprep</code> or <code>#sysprep_xml</code> must be specified.</div> - <div>- 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 <code>#sysprep</code> or <code>#sysprep_xml</code> must be specified.</div> - <div>- <code>linux_config</code> (dict): Guest customization specification for a linux guest operating system (['set'])</div> + <div>- 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.</div> + <div>If unset, sysprep settings will not be applied to the windows guest operating system.</div> + <div>- 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.</div> + <div>If unset, sysprep settings will not be applied to the windows guest operating system.</div> + <div>- <code>linux_config</code> (dict): Guest customization specification for a linux guest operating system</div> + <div>If unset, ConfigurationSpec.windows-config or ConfigurationSpec.cloud-config must be set. Otherwise, an appropriate fault will be thrown. (['set'])</div> <div>- Accepted keys:</div> - <div>- 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 {@link HostnameGenerator} for various options.</div> + <div>- 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.</div> <div>- domain (string): The fully qualified domain name.</div> - <div>- 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 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.</div> - <div>- script_text (string): The script to run before and after Linux guest customization.<br> 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: <code> #!/bin/sh<br> if [ x$1 == x"precustomization" ]; then<br> echo "Do Precustomization tasks"<br> #code for pre-customization actions...<br> elif [ x$1 == x"postcustomization" ]; then<br> echo "Do Postcustomization tasks"<br> #code for post-customization actions...<br> fi<br> </code></div> + <div>- 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.</div> + <div>See the https://kb.vmware.com/kb/2145518 for a list of supported time zones for different versions in Linux.</div> + <div></div> + <div>If unset, time zone is not modified inside guest operating system.</div> + <div>- script_text (string): The script to run before and after Linux guest customization.</div> + <div>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.</div> + <div>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.</div> + <div></div> + <div>A Linux shell script example:</div> + <div></div> + <div>#!/bin/sh</div> + <div>if [ x$1 == x"precustomization" ]; then</div> + <div>echo "Do Precustomization tasks"</div> + <div>#code for pre-customization actions...</div> + <div>elif [ x$1 == x"postcustomization" ]; then</div> + <div>echo "Do Postcustomization tasks"</div> + <div>#code for post-customization actions...</div> + <div>fi</div> + <div></div> + <div></div> + <div>If unset, no script will be executed.</div> + <div>- <code>cloud_config</code> (dict): Guest customization specification with cloud configuration.</div> + <div>If unset, ConfigurationSpec.windows-config or ConfigurationSpec.linux-config must be set. Otherwise, an appropriate fault will be thrown. (['set'])</div> + <div>- Accepted keys:</div> + <div>- type (string): This option specifies different types of the cloud configuration.</div> + <div>Accepted value for this field:</div> + <div>- <code>CLOUDINIT</code></div> + <div>- cloudinit (object): cloud-init configuration</div> + <div>This field is optional and it is only relevant when the value of CloudConfiguration.type is CLOUDINIT.</div> </td> </tr> <tr> @@ -88,8 +119,10 @@ Parameters <td> <div>Global DNS settings constitute the DNS settings that are not specific to a particular virtual network adapter. This parameter is mandatory.</div> <div>Valid attributes are:</div> - <div>- <code>dns_suffix_list</code> (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. (['set'])</div> - <div>- <code>dns_servers</code> (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. (['set'])</div> + <div>- <code>dns_suffix_list</code> (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.</div> + <div>If unset, no DNS suffixes are set. (['set'])</div> + <div>- <code>dns_servers</code> (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.</div> + <div>If unset, no DNS servers are set. (['set'])</div> </td> </tr> <tr> @@ -106,15 +139,19 @@ Parameters <td> </td> <td> - <div>IP settings that are specific to a particular virtual network adapter. The {@link AdapterMapping} {@term structure} maps a network adapter's MAC address to its {@link 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.</div> + <div>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.</div> <div>Valid attributes are:</div> - <div>- <code>mac_address</code> (str): The MAC address of a network adapter being customized. (['set'])</div> + <div>- <code>mac_address</code> (str): The MAC address of a network adapter being customized.</div> + <div>If unset, the customization process maps the the settings from the list of <em>i_p_settings</em> 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'])</div> <div>- <code>adapter</code> (dict): The IP settings for the associated virtual network adapter. (['set'])</div> <div>This key is required with ['set'].</div> <div>- Accepted keys:</div> <div>- ipv4 (object): Specification to configure IPv4 address, subnet mask and gateway info for this virtual network adapter.</div> + <div>If unset, no IPv4 addresses are set.</div> <div>- ipv6 (object): Specification to configure IPv6 address, subnet mask and gateway info for this virtual network adapter.</div> + <div>If unset, no IPv6 addresses are set.</div> <div>- windows (object): Windows settings to be configured for this specific virtual Network adapter. This is valid only for Windows guest operating systems.</div> + <div>If unset, no specific Windows settings are set.</div> </td> </tr> <tr> @@ -138,6 +175,23 @@ Parameters <tr> <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>set</b> ←</div></li> + </ul> + </td> + <td> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>vcenter_hostname</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -238,7 +292,8 @@ Parameters <td> </td> <td> - <div>The unique identifier of the virtual machine that needs to be customized. This parameter is mandatory.</div> + <div>The unique identifier of the virtual machine that needs to be customized.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -249,7 +304,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_filesystem_directories_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_filesystem_directories_module.rst index 0b4e50174..b5bd50377 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_filesystem_directories_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_filesystem_directories_module.rst @@ -17,7 +17,7 @@ Version added: 2.0.0 Synopsis -------- -- Creates a directory in the guest operating system. <p> +- Creates a directory in the guest operating system. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -57,7 +57,8 @@ Parameters </ul> </td> <td> - <div>Whether any parent directories should be created. If any failure occurs, some parent directories could be left behind.</div> + <div>Whether any parent directories should be created. If any failure occurs, some parent directories could be left behind.</div> + <div>If unset parent directories are not created.</div> </td> </tr> <tr> @@ -75,16 +76,19 @@ Parameters <td> <div>The guest authentication data. This parameter is mandatory.</div> <div>Valid attributes are:</div> - <div>- <code>interactive_session</code> (bool): If {@term set}, theoperation will interact with the logged-in desktop session in the guest. This requires that the logged-on user matches the user specified by the {@link Credentials}. This is currently only supported for {@link Type#USERNAME_PASSWORD}. (['absent', 'create_temporary', 'move', 'present'])</div> + <div>- <code>interactive_session</code> (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'])</div> <div>This key is required with ['absent', 'create_temporary', 'move', 'present'].</div> <div>- <code>type</code> (str): Types of guest credentials (['absent', 'create_temporary', 'move', 'present'])</div> <div>This key is required with ['absent', 'create_temporary', 'move', 'present'].</div> <div>- Accepted values:</div> <div>- SAML_BEARER_TOKEN</div> <div>- USERNAME_PASSWORD</div> - <div>- <code>user_name</code> (str): For {@link Type#SAML_BEARER_TOKEN}, this is the guest user to be associated with the credentials. For {@link Type#USERNAME_PASSWORD} this is the guest username. (['absent', 'create_temporary', 'move', 'present'])</div> - <div>- <code>password</code> (str): password (['absent', 'create_temporary', 'move', 'present'])</div> - <div>- <code>saml_token</code> (str): SAML Bearer Token (['absent', 'create_temporary', 'move', 'present'])</div> + <div>- <code>user_name</code> (str): For SAML_BEARER_TOKEN, this is the guest user to be associated with the credentials. For USERNAME_PASSWORD this is the guest username.</div> + <div>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'])</div> + <div>- <code>password</code> (str): password</div> + <div>This field is optional and it is only relevant when the value of Credentials.type is USERNAME_PASSWORD. (['absent', 'create_temporary', 'move', 'present'])</div> + <div>- <code>saml_token</code> (str): SAML Bearer Token</div> + <div>This field is optional and it is only relevant when the value of Credentials.type is SAML_BEARER_TOKEN. (['absent', 'create_temporary', 'move', 'present'])</div> </td> </tr> <tr> @@ -115,6 +119,7 @@ Parameters </td> <td> <div>The complete path to the directory in which to create the new directory.</div> + <div>Directory If unset a guest-specific default will be used.</div> </td> </tr> <tr> @@ -164,6 +169,7 @@ Parameters </td> <td> <div>If true, all files and subdirectories are also deleted. If false, the directory must be empty for the operation to succeed.</div> + <div>If unset, any directory content is not deleted.</div> </td> </tr> <tr> @@ -322,7 +328,8 @@ Parameters <td> </td> <td> - <div>Virtual Machine to perform the operation on. This parameter is mandatory.</div> + <div>Virtual Machine to perform the operation on.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -333,7 +340,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_identity_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_identity_info_module.rst index 03b6b94b2..a123db8bb 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_identity_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_identity_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Identifier of the virtual machine. Required with <em>state=['get']</em></div> + <div>Identifier of the virtual machine.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module.rst index e7a0cffa1..6fd66d8d6 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Identifier of the virtual machine. Required with <em>state=['get']</em></div> + <div>Identifier of the virtual machine.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_networking_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_networking_info_module.rst index 35b462c0d..0683b64e2 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_networking_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_networking_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Virtual machine ID Required with <em>state=['get']</em></div> + <div>Virtual machine ID</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module.rst index c244570fa..9d54f8bcf 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Virtual machine ID Required with <em>state=['list']</em></div> + <div>Virtual machine ID</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['list']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module.rst index 92d358805..46aebcdb0 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Virtual machine ID Required with <em>state=['list']</em></div> + <div>Virtual machine ID</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['list']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_operations_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_operations_info_module.rst index 6f3ff17be..3faabfc53 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_operations_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_operations_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Identifier of the virtual machine. Required with <em>state=['get']</em></div> + <div>Identifier of the virtual machine.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_power_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_power_info_module.rst index d71e31a33..57c211d9e 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_power_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_power_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Identifier of the virtual machine. Required with <em>state=['get']</em></div> + <div>Identifier of the virtual machine.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_power_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_power_module.rst index 5d8bcffaf..84f3346b3 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_power_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_guest_power_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -182,7 +182,8 @@ Parameters <td> </td> <td> - <div>Identifier of the virtual machine. This parameter is mandatory.</div> + <div>Identifier of the virtual machine.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -193,7 +194,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 See Also diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module.rst index 73a0a7599..29762340b 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>Virtual SATA adapter identifier. Required with <em>state=['get']</em></div> + <div>Virtual SATA adapter identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_adapter_sata</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -192,7 +193,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -203,7 +205,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module.rst index a12f22dfd..945a6e42b 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>Virtual SATA adapter identifier. Required with <em>state=['absent']</em></div> + <div>Virtual SATA adapter identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_adapter_sata</span>. Required with <em>state=['absent']</em></div> </td> </tr> <tr> @@ -69,6 +70,7 @@ Parameters </td> <td> <div>SATA bus number.</div> + <div>If unset, the server will choose an available bus number; if none is available, the request will fail.</div> </td> </tr> <tr> @@ -99,6 +101,7 @@ Parameters </td> <td> <div>Address of the SATA adapter on the PCI bus.</div> + <div>If unset, the server will choose an available address when the virtual machine is powered on.</div> </td> </tr> <tr> @@ -152,7 +155,7 @@ Parameters </ul> </td> <td> - <div>The <code>type</code> defines the valid emulation types for a virtual SATA adapter.</div> + <div>The <em>type</em> enumerated type defines the valid emulation types for a virtual SATA adapter.</div> </td> </tr> <tr> @@ -258,7 +261,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -269,7 +273,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module.rst index 75c5402a6..52ae8f07f 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>Virtual SCSI adapter identifier. Required with <em>state=['get']</em></div> + <div>Virtual SCSI adapter identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -192,7 +193,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -203,7 +205,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module.rst index 1918f8288..aae1344b9 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>Virtual SCSI adapter identifier. Required with <em>state=['absent', 'present']</em></div> + <div>Virtual SCSI adapter identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi</span>. Required with <em>state=['absent', 'present']</em></div> </td> </tr> <tr> @@ -69,6 +70,7 @@ Parameters </td> <td> <div>SCSI bus number.</div> + <div>If unset, the server will choose an available bus number; if none is available, the request will fail.</div> </td> </tr> <tr> @@ -98,7 +100,8 @@ Parameters <td> </td> <td> - <div>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.</div> + <div>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.</div> + <div>If unset, the server will choose an available address when the virtual machine is powered on.</div> </td> </tr> <tr> @@ -136,7 +139,7 @@ Parameters </ul> </td> <td> - <div>The <code>sharing</code> defines the valid bus sharing modes for a virtual SCSI adapter.</div> + <div>The <em>sharing</em> enumerated type defines the valid bus sharing modes for a virtual SCSI adapter.</div> </td> </tr> <tr> @@ -175,7 +178,7 @@ Parameters </ul> </td> <td> - <div>The <code>type</code> defines the valid emulation types for a virtual SCSI adapter.</div> + <div>The <em>type</em> enumerated type defines the valid emulation types for a virtual SCSI adapter.</div> </td> </tr> <tr> @@ -281,7 +284,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -292,7 +296,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module.rst index 69799285c..3f2b048b5 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module.rst @@ -17,7 +17,7 @@ Version added: 0.1.0 Synopsis -------- -- Returns an ordered list of boot devices for the virtual machine. If the {@term list} is empty, the virtual machine uses a default boot sequence. +- Returns an ordered list of boot devices for the virtual machine. If the list is empty, the virtual machine uses a default boot sequence. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. Required with <em>state=['get']</em></div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_module.rst index 2599d0434..6aff2733f 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_module.rst @@ -17,7 +17,7 @@ Version added: 0.1.0 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 {@term list} is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of {@link Entry} for a given device type except {@link Device.Type#ETHERNET} in the {@term list}. +- 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. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -57,15 +57,19 @@ Parameters <td> <div>Ordered list of boot devices. This parameter is mandatory.</div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>type</code> defines the valid device types that may be used as bootable devices. (['set'])</div> + <div>- <code>type</code> (str): This option defines the valid device types that may be used as bootable devices. (['set'])</div> <div>This key is required with ['set'].</div> <div>- Accepted values:</div> <div>- CDROM</div> <div>- DISK</div> <div>- ETHERNET</div> <div>- FLOPPY</div> - <div>- <code>nic</code> (str): Virtual Ethernet device. Ethernet device to use as boot device for this entry. (['set'])</div> - <div>- <code>disks</code> (list): Virtual disk device. List of virtual disks in boot order. (['set'])</div> + <div>- <code>nic</code> (str): Virtual Ethernet device. Ethernet device to use as boot device for this entry.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is ETHERNET.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_ethernet</span>. (['set'])</div> + <div>- <code>disks</code> (list): Virtual disk device. List of virtual disks in boot order.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is DISK.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_disk</span>. (['set'])</div> </td> </tr> <tr> @@ -206,7 +210,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -217,7 +222,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_info_module.rst index 0d67914cc..0b8e28183 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. Required with <em>state=['get']</em></div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_module.rst index ab4919367..3d87bf1ec 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>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.</div> + <div>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.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -73,6 +74,7 @@ Parameters </td> <td> <div>Flag indicating whether to use EFI legacy boot mode.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -91,7 +93,8 @@ Parameters </ul> </td> <td> - <div>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.</div> + <div>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.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -110,7 +113,7 @@ Parameters </ul> </td> <td> - <div>The <code>network_protocol</code> defines the valid network boot protocols supported when booting a virtual machine with {@link Type#EFI} firmware over the network.</div> + <div>The <em>network_protocol</em> enumerated type defines the valid network boot protocols supported when booting a virtual machine with EFI firmware over the network.</div> </td> </tr> <tr> @@ -130,6 +133,7 @@ Parameters </td> <td> <div>Flag indicating whether the virtual machine should automatically retry the boot process after a failure.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -144,7 +148,8 @@ Parameters <td> </td> <td> - <div>Delay in milliseconds before retrying the boot process after a failure; applicable only when {@link Info#retry} is true.</div> + <div>Delay in milliseconds before retrying the boot process after a failure; applicable only when <em>retry</em> is true.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -198,7 +203,7 @@ Parameters </ul> </td> <td> - <div>The <code>type</code> defines the valid firmware types for a virtual machine.</div> + <div>The <em>type</em> enumerated type defines the valid firmware types for a virtual machine.</div> </td> </tr> <tr> @@ -304,7 +309,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -315,7 +321,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module.rst index bb3abbc97..ead0e0aa7 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>Virtual CD-ROM device identifier. Required with <em>state=['get']</em></div> + <div>Virtual CD-ROM device identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_cdrom</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -192,7 +193,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -203,7 +205,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_module.rst index 38d0c82b3..f83db83d7 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -58,6 +58,7 @@ Parameters </td> <td> <div>Flag indicating whether the guest can connect and disconnect the device.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -72,17 +73,20 @@ Parameters <td> </td> <td> - <div>Physical resource backing for the virtual CD-ROM device. Required with <em>state=['present']</em></div> + <div>Physical resource backing for the virtual CD-ROM device.</div> + <div>If unset, defaults to automatic detection of a suitable host device. Required with <em>state=['present']</em></div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>backing_type</code> defines the valid backing types for a virtual CD-ROM device. (['present'])</div> + <div>- <code>type</code> (str): This option defines the valid backing types for a virtual CD-ROM device. (['present'])</div> <div>This key is required with ['present'].</div> <div>- Accepted values:</div> <div>- CLIENT_DEVICE</div> <div>- HOST_DEVICE</div> <div>- ISO_FILE</div> - <div>- <code>iso_file</code> (str): Path of the image file that should be used as the virtual CD-ROM device backing. (['present'])</div> - <div>- <code>host_device</code> (str): Name of the device that should be used as the virtual CD-ROM device backing. (['present'])</div> - <div>- <code>device_access_type</code> (str): The <code>device_access_type</code> defines the valid device access types for a physical device packing of a virtual CD-ROM device. (['present'])</div> + <div>- <code>iso_file</code> (str): Path of the image file that should be used as the virtual CD-ROM device backing.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is ISO_FILE. (['present'])</div> + <div>- <code>host_device</code> (str): Name of the device that should be used as the virtual CD-ROM device backing.</div> + <div>If unset, the virtual CD-ROM device will be configured to automatically detect a suitable host device. (['present'])</div> + <div>- <code>device_access_type</code> (str): This option defines the valid device access types for a physical device packing of a virtual CD-ROM device. (['present'])</div> <div>- Accepted values:</div> <div>- EMULATION</div> <div>- PASSTHRU</div> @@ -101,7 +105,8 @@ Parameters <td> </td> <td> - <div>Virtual CD-ROM device identifier. Required with <em>state=['absent', 'connect', 'disconnect', 'present']</em></div> + <div>Virtual CD-ROM device identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_cdrom</span>. Required with <em>state=['absent', 'connect', 'disconnect', 'present']</em></div> </td> </tr> <tr> @@ -117,9 +122,12 @@ Parameters </td> <td> <div>Address for attaching the device to a virtual IDE adapter.</div> + <div>If unset, the server will choose an available address; if none is available, the request will fail.</div> <div>Valid attributes are:</div> - <div>- <code>primary</code> (bool): Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine. (['present'])</div> - <div>- <code>master</code> (bool): Flag specifying whether the device should be the master or slave device on the IDE adapter. (['present'])</div> + <div>- <code>primary</code> (bool): Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine.</div> + <div>If unset, the server will choose a adapter with an available connection. If no IDE connections are available, the request will be rejected. (['present'])</div> + <div>- <code>master</code> (bool): Flag specifying whether the device should be the master or slave device on the IDE adapter.</div> + <div>If unset, the server will choose an available connection type. If no IDE connections are available, the request will be rejected. (['present'])</div> </td> </tr> <tr> @@ -149,11 +157,13 @@ Parameters <td> </td> <td> - <div>Address for attaching the device to a virtual SATA adapter. Required with <em>state=['present']</em></div> + <div>Address for attaching the device to a virtual SATA adapter.</div> + <div>If unset, the server will choose an available address; if none is available, the request will fail. Required with <em>state=['present']</em></div> <div>Valid attributes are:</div> <div>- <code>bus</code> (int): Bus number of the adapter to which the device should be attached. (['present'])</div> <div>This key is required with ['present'].</div> - <div>- <code>unit</code> (int): Unit number of the device. (['present'])</div> + <div>- <code>unit</code> (int): Unit number of the device.</div> + <div>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'])</div> </td> </tr> <tr> @@ -191,6 +201,7 @@ Parameters </td> <td> <div>Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -229,7 +240,7 @@ Parameters </ul> </td> <td> - <div>The <code>host_bus_adapter_type</code> defines the valid types of host bus adapters that may be used for attaching a Cdrom to a virtual machine.</div> + <div>The <em>host_bus_adapter_type</em> enumerated type defines the valid types of host bus adapters that may be used for attaching a Cdrom to a virtual machine.</div> </td> </tr> <tr> @@ -335,7 +346,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -346,7 +358,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module.rst index 85cf99163..39768d877 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. Required with <em>state=['get']</em></div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_module.rst index e85791ff4..e6593b755 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>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.</div> + <div>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.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -68,7 +69,12 @@ Parameters <td> </td> <td> - <div>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 {@link Info#hotAddEnabled} is true, and may only be decreased if {@link Info#hotRemoveEnabled} is true.</div> + <div>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.</div> + <div>The supported range of CPU counts is constrained by the configured guest operating system and virtual hardware version of the virtual machine.</div> + <div></div> + <div>If the virtual machine is running, the number of CPU cores may only be increased if <em>hot_add_enabled</em> is true, and may only be decreased if <em>hot_remove_enabled</em> is true.</div> + <div></div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -87,7 +93,10 @@ Parameters </ul> </td> <td> - <div>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.</div> + <div>Flag indicating whether adding CPUs while the virtual machine is running is enabled.</div> + <div>This field may only be modified if the virtual machine is powered off.</div> + <div></div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -106,7 +115,10 @@ Parameters </ul> </td> <td> - <div>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.</div> + <div>Flag indicating whether removing CPUs while the virtual machine is running is enabled.</div> + <div>This field may only be modified if the virtual machine is powered off.</div> + <div></div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -247,7 +259,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -258,7 +271,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_info_module.rst index 6a36bc3a3..748e08588 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>Virtual disk identifier. Required with <em>state=['get']</em></div> + <div>Virtual disk identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_disk</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -192,7 +193,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -203,7 +205,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_module.rst index 4424d055c..e0c81c96c 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_module.rst @@ -17,7 +17,7 @@ Version added: 0.1.0 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. +- 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. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,13 +53,15 @@ Parameters <td> </td> <td> - <div>Existing physical resource backing for the virtual disk. Exactly one of <code>#backing</code> or <code>#new_vmdk</code> must be specified. Required with <em>state=['present']</em></div> + <div>Existing physical resource backing for the virtual disk. Exactly one of <em>backing</em> or <em>new_vmdk</em> must be specified.</div> + <div>If unset, the virtual disk will not be connected to an existing backing. Required with <em>state=['present']</em></div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>backing_type</code> defines the valid backing types for a virtual disk. (['present'])</div> + <div>- <code>type</code> (str): This option defines the valid backing types for a virtual disk. (['present'])</div> <div>This key is required with ['present'].</div> <div>- Accepted values:</div> <div>- VMDK_FILE</div> - <div>- <code>vmdk_file</code> (str): Path of the VMDK file backing the virtual disk. (['present'])</div> + <div>- <code>vmdk_file</code> (str): Path of the VMDK file backing the virtual disk.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is VMDK_FILE. (['present'])</div> </td> </tr> <tr> @@ -74,7 +76,8 @@ Parameters <td> </td> <td> - <div>Virtual disk identifier. Required with <em>state=['absent', 'present']</em></div> + <div>Virtual disk identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_disk</span>. Required with <em>state=['absent', 'present']</em></div> </td> </tr> <tr> @@ -90,9 +93,12 @@ Parameters </td> <td> <div>Address for attaching the device to a virtual IDE adapter.</div> + <div>If unset, the server will choose an available address; if none is available, the request will fail.</div> <div>Valid attributes are:</div> - <div>- <code>primary</code> (bool): Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine. (['present'])</div> - <div>- <code>master</code> (bool): Flag specifying whether the device should be the master or slave device on the IDE adapter. (['present'])</div> + <div>- <code>primary</code> (bool): Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine.</div> + <div>If unset, the server will choose a adapter with an available connection. If no IDE connections are available, the request will be rejected. (['present'])</div> + <div>- <code>master</code> (bool): Flag specifying whether the device should be the master or slave device on the IDE adapter.</div> + <div>If unset, the server will choose an available connection type. If no IDE connections are available, the request will be rejected. (['present'])</div> </td> </tr> <tr> @@ -122,13 +128,39 @@ Parameters <td> </td> <td> - <div>Specification for creating a new VMDK backing for the virtual disk. Exactly one of <code>#backing</code> or <code>#new_vmdk</code> must be specified.</div> + <div>Specification for creating a new VMDK backing for the virtual disk. Exactly one of <em>backing</em> or <em>new_vmdk</em> must be specified.</div> + <div>If unset, a new VMDK backing will not be created.</div> <div>Valid attributes are:</div> - <div>- <code>name</code> (str): Base name of the VMDK file. The name should not include the '.vmdk' file extension. (['present'])</div> - <div>- <code>capacity</code> (int): Capacity of the virtual disk backing in bytes. (['present'])</div> - <div>- <code>storage_policy</code> (dict): The <code>storage_policy_spec</code> {@term structure} contains information about the storage policy that is to be associated the with VMDK file. (['present'])</div> + <div>- <code>name</code> (str): Base name of the VMDK file. The name should not include the '.vmdk' file extension.</div> + <div>If unset, a name (derived from the name of the virtual machine) will be chosen by the server. (['present'])</div> + <div>- <code>capacity</code> (int): Capacity of the virtual disk backing in bytes.</div> + <div>If unset, defaults to a guest-specific capacity. (['present'])</div> + <div>- <code>storage_policy</code> (dict): The <em>storage_policy_spec</em> structure contains information about the storage policy that is to be associated the with VMDK file.</div> + <div>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'])</div> <div>- Accepted keys:</div> <div>- policy (string): Identifier of the storage policy which should be associated with the VMDK file.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_storage_policies</span>.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>nvme</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Address for attaching the device to a virtual NVMe adapter.</div> + <div>If unset, the server will choose an available address; if none is available, the request will fail. Required with <em>state=['present']</em></div> + <div>Valid attributes are:</div> + <div>- <code>bus</code> (int): Bus number of the adapter to which the device should be attached. (['present'])</div> + <div>This key is required with ['present'].</div> + <div>- <code>unit</code> (int): Unit number of the device.</div> + <div>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'])</div> </td> </tr> <tr> @@ -143,11 +175,13 @@ Parameters <td> </td> <td> - <div>Address for attaching the device to a virtual SATA adapter. Required with <em>state=['present']</em></div> + <div>Address for attaching the device to a virtual SATA adapter.</div> + <div>If unset, the server will choose an available address; if none is available, the request will fail. Required with <em>state=['present']</em></div> <div>Valid attributes are:</div> <div>- <code>bus</code> (int): Bus number of the adapter to which the device should be attached. (['present'])</div> <div>This key is required with ['present'].</div> - <div>- <code>unit</code> (int): Unit number of the device. (['present'])</div> + <div>- <code>unit</code> (int): Unit number of the device.</div> + <div>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'])</div> </td> </tr> <tr> @@ -162,11 +196,13 @@ Parameters <td> </td> <td> - <div>Address for attaching the device to a virtual SCSI adapter. Required with <em>state=['present']</em></div> + <div>Address for attaching the device to a virtual SCSI adapter.</div> + <div>If unset, the server will choose an available address; if none is available, the request will fail. Required with <em>state=['present']</em></div> <div>Valid attributes are:</div> <div>- <code>bus</code> (int): Bus number of the adapter to which the device should be attached. (['present'])</div> <div>This key is required with ['present'].</div> - <div>- <code>unit</code> (int): Unit number of the device. (['present'])</div> + <div>- <code>unit</code> (int): Unit number of the device.</div> + <div>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'])</div> </td> </tr> <tr> @@ -217,12 +253,13 @@ Parameters <td> <ul style="margin: 0; padding: 0"><b>Choices:</b> <li>IDE</li> + <li>NVME</li> <li>SATA</li> <li>SCSI</li> </ul> </td> <td> - <div>The <code>host_bus_adapter_type</code> defines the valid types of host bus adapters that may be used for attaching a virtual storage device to a virtual machine.</div> + <div>The <em>host_bus_adapter_type</em> enumerated type defines the valid types of host bus adapters that may be used for attaching a virtual storage device to a virtual machine.</div> </td> </tr> <tr> @@ -328,7 +365,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -339,7 +377,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module.rst index 74364d8ff..a90d2c37b 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -68,7 +68,8 @@ Parameters <td> </td> <td> - <div>Virtual Ethernet adapter identifier. Required with <em>state=['get']</em></div> + <div>Virtual Ethernet adapter identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_ethernet</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -192,7 +193,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -203,7 +205,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_module.rst index d2bebc4f4..dc7bb1bfc 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -58,6 +58,7 @@ Parameters </td> <td> <div>Flag indicating whether the guest can connect and disconnect the device.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -72,17 +73,21 @@ Parameters <td> </td> <td> - <div>Physical resource backing for the virtual Ethernet adapter. Required with <em>state=['present']</em></div> + <div>Physical resource backing for the virtual Ethernet adapter.</div> + <div>If unset, the system may try to find an appropriate backing. If one is not found, the request will fail. Required with <em>state=['present']</em></div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>backing_type</code> defines the valid backing types for a virtual Ethernet adapter. (['present'])</div> + <div>- <code>type</code> (str): This option defines the valid backing types for a virtual Ethernet adapter. (['present'])</div> <div>This key is required with ['present'].</div> <div>- Accepted values:</div> <div>- DISTRIBUTED_PORTGROUP</div> <div>- HOST_DEVICE</div> <div>- OPAQUE_NETWORK</div> <div>- STANDARD_PORTGROUP</div> - <div>- <code>network</code> (str): Identifier of the network that backs the virtual Ethernet adapter. (['present'])</div> - <div>- <code>distributed_port</code> (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. (['present'])</div> + <div>- <code>network</code> (str): Identifier of the network that backs the virtual Ethernet adapter.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is one of STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP, or OPAQUE_NETWORK.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_network_info</span>. (['present'])</div> + <div>- <code>distributed_port</code> (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.</div> + <div>May be used to specify a port when the network specified on the <em>network</em> 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'])</div> </td> </tr> <tr> @@ -112,7 +117,10 @@ Parameters <td> </td> <td> - <div>MAC address. This field may be modified at any time, and changes will be applied the next time the virtual machine is powered on.</div> + <div>MAC address.</div> + <div>This field may be modified at any time, and changes will be applied the next time the virtual machine is powered on.</div> + <div></div> + <div>If unset, the value is unchanged. Must be specified if <em>mac_type</em> is MANUAL. Must be unset if the MAC address type is not MANUAL.</div> </td> </tr> <tr> @@ -132,7 +140,7 @@ Parameters </ul> </td> <td> - <div>The <code>mac_address_type</code> defines the valid MAC address origins for a virtual Ethernet adapter.</div> + <div>The <em>mac_address_type</em> enumerated type defines the valid MAC address origins for a virtual Ethernet adapter.</div> </td> </tr> <tr> @@ -147,7 +155,8 @@ Parameters <td> </td> <td> - <div>Virtual Ethernet adapter identifier. Required with <em>state=['absent', 'connect', 'disconnect', 'present']</em></div> + <div>Virtual Ethernet adapter identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_ethernet</span>. Required with <em>state=['absent', 'connect', 'disconnect', 'present']</em></div> </td> </tr> <tr> @@ -162,7 +171,8 @@ Parameters <td> </td> <td> - <div>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.</div> + <div>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.</div> + <div>If unset, the server will choose an available address when the virtual machine is powered on.</div> </td> </tr> <tr> @@ -200,6 +210,7 @@ Parameters </td> <td> <div>Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -242,7 +253,7 @@ Parameters </ul> </td> <td> - <div>The <code>emulation_type</code> defines the valid emulation types for a virtual Ethernet adapter.</div> + <div>The <em>emulation_type</em> enumerated type defines the valid emulation types for a virtual Ethernet adapter.</div> </td> </tr> <tr> @@ -261,7 +272,10 @@ Parameters </ul> </td> <td> - <div>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.</div> + <div>Flag indicating whether Universal Pass-Through (UPT) compatibility should be enabled on this virtual Ethernet adapter.</div> + <div>This field may be modified at any time, and changes will be applied the next time the virtual machine is powered on.</div> + <div></div> + <div>If unset, the value is unchanged. Must be unset if the emulation type of the virtual Ethernet adapter is not VMXNET3.</div> </td> </tr> <tr> @@ -367,7 +381,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> <tr> @@ -386,7 +401,10 @@ Parameters </ul> </td> <td> - <div>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.</div> + <div>Flag indicating whether wake-on-LAN shoud be enabled on this virtual Ethernet adapter.</div> + <div>This field may be modified at any time, and changes will be applied the next time the virtual machine is powered on.</div> + <div></div> + <div>If unset, the value is unchanged.</div> </td> </tr> </table> @@ -397,7 +415,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module.rst index 5cc686804..acd1d7efc 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -53,7 +53,8 @@ Parameters <td> </td> <td> - <div>Virtual floppy drive identifier. Required with <em>state=['get']</em></div> + <div>Virtual floppy drive identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_floppy</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -192,7 +193,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -203,7 +205,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_module.rst index 641245488..1a04cbd9f 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -58,6 +58,7 @@ Parameters </td> <td> <div>Flag indicating whether the guest can connect and disconnect the device.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -72,16 +73,19 @@ Parameters <td> </td> <td> - <div>Physical resource backing for the virtual floppy drive. Required with <em>state=['present']</em></div> + <div>Physical resource backing for the virtual floppy drive.</div> + <div>If unset, defaults to automatic detection of a suitable host device. Required with <em>state=['present']</em></div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>backing_type</code> defines the valid backing types for a virtual floppy drive. (['present'])</div> + <div>- <code>type</code> (str): This option defines the valid backing types for a virtual floppy drive. (['present'])</div> <div>This key is required with ['present'].</div> <div>- Accepted values:</div> <div>- CLIENT_DEVICE</div> <div>- HOST_DEVICE</div> <div>- IMAGE_FILE</div> - <div>- <code>image_file</code> (str): Path of the image file that should be used as the virtual floppy drive backing. (['present'])</div> - <div>- <code>host_device</code> (str): Name of the device that should be used as the virtual floppy drive backing. (['present'])</div> + <div>- <code>image_file</code> (str): Path of the image file that should be used as the virtual floppy drive backing.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is IMAGE_FILE. (['present'])</div> + <div>- <code>host_device</code> (str): Name of the device that should be used as the virtual floppy drive backing.</div> + <div>If unset, the virtual floppy drive will be configured to automatically detect a suitable host device. (['present'])</div> </td> </tr> <tr> @@ -96,7 +100,8 @@ Parameters <td> </td> <td> - <div>Virtual floppy drive identifier. Required with <em>state=['absent', 'connect', 'disconnect', 'present']</em></div> + <div>Virtual floppy drive identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_floppy</span>. Required with <em>state=['absent', 'connect', 'disconnect', 'present']</em></div> </td> </tr> <tr> @@ -149,6 +154,7 @@ Parameters </td> <td> <div>Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -274,7 +280,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -285,7 +292,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_info_module.rst index cd5fa6f5d..a99fc6956 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. Required with <em>state=['get']</em></div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst index dbf7fc9a2..15fafb532 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. Required with <em>state=['get']</em></div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_module.rst index 1c18a0274..c42d8e5d2 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -57,7 +57,12 @@ Parameters </ul> </td> <td> - <div>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.</div> + <div>Flag indicating whether adding memory while the virtual machine is running should be enabled.</div> + <div>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.</div> + <div></div> + <div>This field may only be modified if the virtual machine is not powered on.</div> + <div></div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -90,7 +95,12 @@ Parameters <td> </td> <td> - <div>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 {@link Info#hotAddEnabled} is true, and the new memory size must satisfy the constraints specified by {@link Info#hotAddIncrementSizeMiB} and {@link Info#hotAddLimitMiB}.</div> + <div>New memory size in mebibytes.</div> + <div>The supported range of memory sizes is constrained by the configured guest operating system and virtual hardware version of the virtual machine.</div> + <div></div> + <div>If the virtual machine is running, this value may only be changed if <em>hot_add_enabled</em> is true, and the new memory size must satisfy the constraints specified by <em>hot_add_increment_size_mib</em> and I()</div> + <div></div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -213,7 +223,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -224,7 +235,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_module.rst index 7e057380b..142648ab0 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -94,7 +94,7 @@ Parameters </ul> </td> <td> - <div>The <code>upgrade_policy</code> defines the valid virtual hardware upgrade policies for a virtual machine.</div> + <div>The <em>upgrade_policy</em> enumerated type defines the valid virtual hardware upgrade policies for a virtual machine.</div> </td> </tr> <tr> @@ -127,7 +127,7 @@ Parameters </ul> </td> <td> - <div>The <code>version</code> defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)).</div> + <div>The <em>version</em> 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)).</div> </td> </tr> <tr> @@ -250,7 +250,7 @@ Parameters </ul> </td> <td> - <div>The <code>version</code> defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)).</div> + <div>The <em>version</em> 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)).</div> </td> </tr> <tr> @@ -266,7 +266,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -277,7 +278,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module.rst index d6526686a..216e1717e 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -68,7 +68,8 @@ Parameters <td> </td> <td> - <div>Virtual parallel port identifier. Required with <em>state=['get']</em></div> + <div>Virtual parallel port identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_parallel</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -192,7 +193,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -203,7 +205,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_module.rst index a5f5e06bd..cc8acbfec 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -58,6 +58,7 @@ Parameters </td> <td> <div>Flag indicating whether the guest can connect and disconnect the device.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -72,15 +73,18 @@ Parameters <td> </td> <td> - <div>Physical resource backing for the virtual parallel port. Required with <em>state=['present']</em></div> + <div>Physical resource backing for the virtual parallel port.</div> + <div>If unset, defaults to automatic detection of a suitable host device. Required with <em>state=['present']</em></div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>backing_type</code> defines the valid backing types for a virtual parallel port. (['present'])</div> + <div>- <code>type</code> (str): This option defines the valid backing types for a virtual parallel port. (['present'])</div> <div>This key is required with ['present'].</div> <div>- Accepted values:</div> <div>- FILE</div> <div>- HOST_DEVICE</div> - <div>- <code>file</code> (str): Path of the file that should be used as the virtual parallel port backing. (['present'])</div> - <div>- <code>host_device</code> (str): Name of the device that should be used as the virtual parallel port backing. (['present'])</div> + <div>- <code>file</code> (str): Path of the file that should be used as the virtual parallel port backing.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is FILE. (['present'])</div> + <div>- <code>host_device</code> (str): Name of the device that should be used as the virtual parallel port backing.</div> + <div>If unset, the virtual parallel port will be configured to automatically detect a suitable host device. (['present'])</div> </td> </tr> <tr> @@ -110,7 +114,8 @@ Parameters <td> </td> <td> - <div>Virtual parallel port identifier. Required with <em>state=['absent', 'connect', 'disconnect', 'present']</em></div> + <div>Virtual parallel port identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_parallel</span>. Required with <em>state=['absent', 'connect', 'disconnect', 'present']</em></div> </td> </tr> <tr> @@ -148,6 +153,7 @@ Parameters </td> <td> <div>Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -273,7 +279,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -284,7 +291,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_info_module.rst index acee8d334..2749aecf1 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -68,7 +68,8 @@ Parameters <td> </td> <td> - <div>Virtual serial port identifier. Required with <em>state=['get']</em></div> + <div>Virtual serial port identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_serial</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -192,7 +193,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -203,7 +205,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_module.rst index 13f4c1e94..e04e688ae 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -58,6 +58,7 @@ Parameters </td> <td> <div>Flag indicating whether the guest can connect and disconnect the device.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -72,9 +73,10 @@ Parameters <td> </td> <td> - <div>Physical resource backing for the virtual serial port. Required with <em>state=['present']</em></div> + <div>Physical resource backing for the virtual serial port.</div> + <div>If unset, defaults to automatic detection of a suitable host device. Required with <em>state=['present']</em></div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>backing_type</code> defines the valid backing types for a virtual serial port. (['present'])</div> + <div>- <code>type</code> (str): This option defines the valid backing types for a virtual serial port. (['present'])</div> <div>This key is required with ['present'].</div> <div>- Accepted values:</div> <div>- FILE</div> @@ -83,12 +85,23 @@ Parameters <div>- NETWORK_SERVER</div> <div>- PIPE_CLIENT</div> <div>- PIPE_SERVER</div> - <div>- <code>file</code> (str): Path of the file backing the virtual serial port. (['present'])</div> - <div>- <code>host_device</code> (str): Name of the device backing the virtual serial port. (['present'])</div> - <div>- <code>pipe</code> (str): Name of the pipe backing the virtual serial port. (['present'])</div> - <div>- <code>no_rx_loss</code> (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. (['present'])</div> - <div>- <code>network_location</code> (str): URI specifying the location of the network service backing the virtual serial port. <ul> <li>If {@link #type} is {@link BackingType#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.</li> <li>If {@link #type} is {@link BackingType#NETWORK_CLIENT}, this field is the location used by the virtual machine to connect to the remote server.</li> </ul> (['present'])</div> - <div>- <code>proxy</code> (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. (['present'])</div> + <div>- <code>file</code> (str): Path of the file backing the virtual serial port.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is FILE. (['present'])</div> + <div>- <code>host_device</code> (str): Name of the device backing the virtual serial port.</div> + <div></div> + <div></div> + <div>If unset, the virtual serial port will be configured to automatically detect a suitable host device. (['present'])</div> + <div>- <code>pipe</code> (str): Name of the pipe backing the virtual serial port.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is one of PIPE_SERVER or PIPE_CLIENT. (['present'])</div> + <div>- <code>no_rx_loss</code> (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.</div> + <div>If unset, defaults to false. (['present'])</div> + <div>- <code>network_location</code> (str): URI specifying the location of the network service backing the virtual serial port.</div> + <div>- If <em>type</em> 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.</div> + <div>- If <em>type</em> is NETWORK_CLIENT, this field is the location used by the virtual machine to connect to the remote server.</div> + <div></div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is one of NETWORK_SERVER or NETWORK_CLIENT. (['present'])</div> + <div>- <code>proxy</code> (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.</div> + <div>If unset, no proxy service should be used. (['present'])</div> </td> </tr> <tr> @@ -118,7 +131,8 @@ Parameters <td> </td> <td> - <div>Virtual serial port identifier. Required with <em>state=['absent', 'connect', 'disconnect', 'present']</em></div> + <div>Virtual serial port identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_serial</span>. Required with <em>state=['absent', 'connect', 'disconnect', 'present']</em></div> </td> </tr> <tr> @@ -156,6 +170,7 @@ Parameters </td> <td> <div>Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.</div> + <div>If unset, the value is unchanged.</div> </td> </tr> <tr> @@ -281,7 +296,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> <tr> @@ -300,7 +316,10 @@ Parameters </ul> </td> <td> - <div>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.</div> + <div>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.</div> + <div>This field may be modified at any time, and changes applied to a connected virtual serial port take effect immediately.</div> + <div></div> + <div>If unset, the value is unchanged.</div> </td> </tr> </table> @@ -311,7 +330,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_info_module.rst index 14cc074cc..512177c81 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -55,6 +55,8 @@ Parameters </td> <td> <div>Clusters that must contain the virtual machine for the virtual machine to match the filter.</div> + <div>If unset or empty, virtual machines in any cluster match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_cluster_info</span>.</div> </td> </tr> <tr> @@ -71,6 +73,8 @@ Parameters </td> <td> <div>Datacenters that must contain the virtual machine for the virtual machine to match the filter.</div> + <div>If unset or empty, virtual machines in any datacenter match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_datacenter_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_datacenters</div> </td> </tr> @@ -88,6 +92,8 @@ Parameters </td> <td> <div>Folders that must contain the virtual machine for the virtual machine to match the filter.</div> + <div>If unset or empty, virtual machines in any folder match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_folder_info</span>.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_folders</div> </td> </tr> @@ -105,6 +111,8 @@ Parameters </td> <td> <div>Hosts that must contain the virtual machine for the virtual machine to match the filter.</div> + <div>If unset or empty, virtual machines on any host match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_host_info</span>.</div> </td> </tr> <tr> @@ -120,7 +128,8 @@ Parameters <td> </td> <td> - <div>Names that virtual machines must have to match the filter (see {@link Info#name}).</div> + <div>Names that virtual machines must have to match the filter (see <em>name</em>).</div> + <div>If unset or empty, virtual machines with any name match the filter.</div> <div style="font-size: small; color: darkgreen"><br/>aliases: filter_names</div> </td> </tr> @@ -137,7 +146,8 @@ Parameters <td> </td> <td> - <div>Power states that a virtual machine must be in to match the filter (see {@link <em>info</em>#state}.</div> + <div>Power states that a virtual machine must be in to match the filter (see I()</div> + <div>If unset or empty, virtual machines in any power state match the filter.</div> </td> </tr> <tr> @@ -154,6 +164,8 @@ Parameters </td> <td> <div>Resource pools that must contain the virtual machine for the virtual machine to match the filter.</div> + <div>If unset or empty, virtual machines in any resource pool match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_resourcepool_info</span>.</div> </td> </tr> <tr> @@ -276,7 +288,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. Required with <em>state=['get']</em></div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> <tr> @@ -293,6 +306,8 @@ Parameters </td> <td> <div>Identifiers of virtual machines that can match the filter.</div> + <div>If unset or empty, virtual machines with any identifier match the filter.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>.</div> </td> </tr> </table> @@ -303,7 +318,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_libraryitem_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_libraryitem_info_module.rst index e244a4423..bcb66ccdc 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_libraryitem_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_libraryitem_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Identifier of the virtual machine. Required with <em>state=['get']</em></div> + <div>Identifier of the virtual machine.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_module.rst index dccbf0408..3911f62d6 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -54,6 +54,7 @@ Parameters </td> <td> <div>128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format.</div> + <div>If unset, will be generated.</div> </td> </tr> <tr> @@ -69,20 +70,26 @@ Parameters </td> <td> <div>Boot configuration.</div> + <div>If unset, guest-specific default values will be used.</div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>type</code> defines the valid firmware types for a virtual machine. (['present'])</div> + <div>- <code>type</code> (str): This option defines the valid firmware types for a virtual machine. (['present'])</div> <div>- Accepted values:</div> <div>- BIOS</div> <div>- EFI</div> - <div>- <code>efi_legacy_boot</code> (bool): Flag indicating whether to use EFI legacy boot mode. (['present'])</div> - <div>- <code>network_protocol</code> (str): The <code>network_protocol</code> defines the valid network boot protocols supported when booting a virtual machine with {@link Type#EFI} firmware over the network. (['present'])</div> + <div>- <code>efi_legacy_boot</code> (bool): Flag indicating whether to use EFI legacy boot mode.</div> + <div>If unset, defaults to value that is recommended for the guest OS and is supported for the virtual hardware version. (['present'])</div> + <div>- <code>network_protocol</code> (str): This option defines the valid network boot protocols supported when booting a virtual machine with EFI firmware over the network. (['present'])</div> <div>- Accepted values:</div> <div>- IPV4</div> <div>- IPV6</div> - <div>- <code>delay</code> (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. (['present'])</div> - <div>- <code>retry</code> (bool): Flag indicating whether the virtual machine should automatically retry the boot process after a failure. (['present'])</div> - <div>- <code>retry_delay</code> (int): Delay in milliseconds before retrying the boot process after a failure; applicable only when {@link Info#retry} is true. (['present'])</div> - <div>- <code>enter_setup_mode</code> (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. (['present'])</div> + <div>- <code>delay</code> (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.</div> + <div>If unset, default value is 0. (['present'])</div> + <div>- <code>retry</code> (bool): Flag indicating whether the virtual machine should automatically retry the boot process after a failure.</div> + <div>If unset, default value is false. (['present'])</div> + <div>- <code>retry_delay</code> (int): Delay in milliseconds before retrying the boot process after a failure; applicable only when <em>retry</em> is true.</div> + <div>If unset, default value is 10000. (['present'])</div> + <div>- <code>enter_setup_mode</code> (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.</div> + <div>If unset, the value is unchanged. (['present'])</div> </td> </tr> <tr> @@ -99,8 +106,9 @@ Parameters </td> <td> <div>Boot device configuration.</div> + <div>If unset, a server-specific boot sequence will be used.</div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>type</code> defines the valid device types that may be used as bootable devices. (['present'])</div> + <div>- <code>type</code> (str): This option defines the valid device types that may be used as bootable devices. (['present'])</div> <div>This key is required with ['present'].</div> <div>- Accepted values:</div> <div>- CDROM</div> @@ -123,35 +131,46 @@ Parameters </td> <td> <div>List of CD-ROMs.</div> + <div>If unset, no CD-ROM devices will be created.</div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>host_bus_adapter_type</code> defines the valid types of host bus adapters that may be used for attaching a Cdrom to a virtual machine. (['present'])</div> + <div>- <code>type</code> (str): This option defines the valid types of host bus adapters that may be used for attaching a Cdrom to a virtual machine. (['present'])</div> <div>- Accepted values:</div> <div>- IDE</div> <div>- SATA</div> - <div>- <code>ide</code> (dict): Address for attaching the device to a virtual IDE adapter. (['present'])</div> + <div>- <code>ide</code> (dict): Address for attaching the device to a virtual IDE adapter.</div> + <div>If unset, the server will choose an available address; if none is available, the request will fail. (['present'])</div> <div>- Accepted keys:</div> <div>- primary (boolean): Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine.</div> + <div>If unset, the server will choose a adapter with an available connection. If no IDE connections are available, the request will be rejected.</div> <div>- master (boolean): Flag specifying whether the device should be the master or slave device on the IDE adapter.</div> - <div>- <code>sata</code> (dict): Address for attaching the device to a virtual SATA adapter. (['present'])</div> + <div>If unset, the server will choose an available connection type. If no IDE connections are available, the request will be rejected.</div> + <div>- <code>sata</code> (dict): Address for attaching the device to a virtual SATA adapter.</div> + <div>If unset, the server will choose an available address; if none is available, the request will fail. (['present'])</div> <div>- Accepted keys:</div> <div>- bus (integer): Bus number of the adapter to which the device should be attached.</div> <div>- unit (integer): Unit number of the device.</div> - <div>- <code>backing</code> (dict): Physical resource backing for the virtual CD-ROM device. (['present'])</div> + <div>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.</div> + <div>- <code>backing</code> (dict): Physical resource backing for the virtual CD-ROM device.</div> + <div>If unset, defaults to automatic detection of a suitable host device. (['present'])</div> <div>- Accepted keys:</div> - <div>- type (string): The <code>backing_type</code> defines the valid backing types for a virtual CD-ROM device.</div> + <div>- type (string): This option defines the valid backing types for a virtual CD-ROM device.</div> <div>Accepted value for this field:</div> <div>- <code>CLIENT_DEVICE</code></div> <div>- <code>HOST_DEVICE</code></div> <div>- <code>ISO_FILE</code></div> <div>- iso_file (string): Path of the image file that should be used as the virtual CD-ROM device backing.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is ISO_FILE.</div> <div>- host_device (string): Name of the device that should be used as the virtual CD-ROM device backing.</div> - <div>- device_access_type (string): The <code>device_access_type</code> defines the valid device access types for a physical device packing of a virtual CD-ROM device.</div> + <div>If unset, the virtual CD-ROM device will be configured to automatically detect a suitable host device.</div> + <div>- device_access_type (string): This option defines the valid device access types for a physical device packing of a virtual CD-ROM device.</div> <div>Accepted value for this field:</div> <div>- <code>EMULATION</code></div> <div>- <code>PASSTHRU</code></div> <div>- <code>PASSTHRU_EXCLUSIVE</code></div> - <div>- <code>start_connected</code> (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. (['present'])</div> - <div>- <code>allow_guest_control</code> (bool): Flag indicating whether the guest can connect and disconnect the device. (['present'])</div> + <div>- <code>start_connected</code> (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.</div> + <div>Defaults to false if unset. (['present'])</div> + <div>- <code>allow_guest_control</code> (bool): Flag indicating whether the guest can connect and disconnect the device.</div> + <div>Defaults to false if unset. (['present'])</div> </td> </tr> <tr> @@ -167,11 +186,24 @@ Parameters </td> <td> <div>CPU configuration.</div> + <div>If unset, guest-specific default values will be used.</div> <div>Valid attributes are:</div> - <div>- <code>count</code> (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 {@link Info#hotAddEnabled} is true, and may only be decreased if {@link Info#hotRemoveEnabled} is true. (['present'])</div> - <div>- <code>cores_per_socket</code> (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. (['present'])</div> - <div>- <code>hot_add_enabled</code> (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. (['present'])</div> - <div>- <code>hot_remove_enabled</code> (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. (['present'])</div> + <div>- <code>count</code> (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.</div> + <div>The supported range of CPU counts is constrained by the configured guest operating system and virtual hardware version of the virtual machine.</div> + <div></div> + <div>If the virtual machine is running, the number of CPU cores may only be increased if <em>hot_add_enabled</em> is true, and may only be decreased if <em>hot_remove_enabled</em> is true.</div> + <div></div> + <div>If unset, the value is unchanged. (['present'])</div> + <div>- <code>cores_per_socket</code> (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.</div> + <div>If unset, the value is unchanged. (['present'])</div> + <div>- <code>hot_add_enabled</code> (bool): Flag indicating whether adding CPUs while the virtual machine is running is enabled.</div> + <div>This field may only be modified if the virtual machine is powered off.</div> + <div></div> + <div>If unset, the value is unchanged. (['present'])</div> + <div>- <code>hot_remove_enabled</code> (bool): Flag indicating whether removing CPUs while the virtual machine is running is enabled.</div> + <div>This field may only be modified if the virtual machine is powered off.</div> + <div></div> + <div>If unset, the value is unchanged. (['present'])</div> </td> </tr> <tr> @@ -187,6 +219,8 @@ Parameters </td> <td> <div>Identifier of the datastore on which the virtual machine's configuration state is stored.</div> + <div>If unset, <em>path</em> must also be unset and <em>datastore_path</em> must be set.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_datastore_info</span>.</div> </td> </tr> <tr> @@ -201,7 +235,8 @@ Parameters <td> </td> <td> - <div>Datastore path for the virtual machine's configuration file in the format "[datastore name] path". For example "[storage1] Test-VM/Test-VM.vmx".</div> + <div>Datastore path for the virtual machine's configuration file in the format "[datastore name] path". For example "[storage1] Test-VM/Test-VM.vmx".</div> + <div>If unset, both <em>datastore</em> and <em>path</em> must be set.</div> </td> </tr> <tr> @@ -221,6 +256,7 @@ Parameters </td> <td> <div>Indicates whether all NICs on the destination virtual machine should be disconnected from the newtwork</div> + <div>If unset, connection status of all NICs on the destination virtual machine will be the same as on the source virtual machine.</div> </td> </tr> <tr> @@ -237,35 +273,57 @@ Parameters </td> <td> <div>Individual disk relocation map.</div> + <div>If unset, all disks will migrate to the datastore specified in the <em>datastore</em> field of I()</div> + <div>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 <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_disk</span>.</div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>host_bus_adapter_type</code> defines the valid types of host bus adapters that may be used for attaching a virtual storage device to a virtual machine. (['present'])</div> + <div>- <code>type</code> (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'])</div> <div>- Accepted values:</div> <div>- IDE</div> + <div>- NVME</div> <div>- SATA</div> <div>- SCSI</div> - <div>- <code>ide</code> (dict): Address for attaching the device to a virtual IDE adapter. (['present'])</div> + <div>- <code>ide</code> (dict): Address for attaching the device to a virtual IDE adapter.</div> + <div>If unset, the server will choose an available address; if none is available, the request will fail. (['present'])</div> <div>- Accepted keys:</div> <div>- primary (boolean): Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine.</div> + <div>If unset, the server will choose a adapter with an available connection. If no IDE connections are available, the request will be rejected.</div> <div>- master (boolean): Flag specifying whether the device should be the master or slave device on the IDE adapter.</div> - <div>- <code>scsi</code> (dict): Address for attaching the device to a virtual SCSI adapter. (['present'])</div> + <div>If unset, the server will choose an available connection type. If no IDE connections are available, the request will be rejected.</div> + <div>- <code>scsi</code> (dict): Address for attaching the device to a virtual SCSI adapter.</div> + <div>If unset, the server will choose an available address; if none is available, the request will fail. (['present'])</div> <div>- Accepted keys:</div> <div>- bus (integer): Bus number of the adapter to which the device should be attached.</div> <div>- unit (integer): Unit number of the device.</div> - <div>- <code>sata</code> (dict): Address for attaching the device to a virtual SATA adapter. (['present'])</div> + <div>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.</div> + <div>- <code>sata</code> (dict): Address for attaching the device to a virtual SATA adapter.</div> + <div>If unset, the server will choose an available address; if none is available, the request will fail. (['present'])</div> <div>- Accepted keys:</div> <div>- bus (integer): Bus number of the adapter to which the device should be attached.</div> <div>- unit (integer): Unit number of the device.</div> - <div>- <code>backing</code> (dict): Existing physical resource backing for the virtual disk. Exactly one of <code>#backing</code> or <code>#new_vmdk</code> must be specified. (['present'])</div> + <div>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.</div> + <div>- <code>nvme</code> (dict): Address for attaching the device to a virtual NVMe adapter.</div> + <div>If unset, the server will choose an available address; if none is available, the request will fail. (['present'])</div> <div>- Accepted keys:</div> - <div>- type (string): The <code>backing_type</code> defines the valid backing types for a virtual disk.</div> + <div>- bus (integer): Bus number of the adapter to which the device should be attached.</div> + <div>- unit (integer): Unit number of the device.</div> + <div>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.</div> + <div>- <code>backing</code> (dict): Existing physical resource backing for the virtual disk. Exactly one of <em>backing</em> or <em>new_vmdk</em> must be specified.</div> + <div>If unset, the virtual disk will not be connected to an existing backing. (['present'])</div> + <div>- Accepted keys:</div> + <div>- type (string): This option defines the valid backing types for a virtual disk.</div> <div>Accepted value for this field:</div> <div>- <code>VMDK_FILE</code></div> <div>- vmdk_file (string): Path of the VMDK file backing the virtual disk.</div> - <div>- <code>new_vmdk</code> (dict): Specification for creating a new VMDK backing for the virtual disk. Exactly one of <code>#backing</code> or <code>#new_vmdk</code> must be specified. (['present'])</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is VMDK_FILE.</div> + <div>- <code>new_vmdk</code> (dict): Specification for creating a new VMDK backing for the virtual disk. Exactly one of <em>backing</em> or <em>new_vmdk</em> must be specified.</div> + <div>If unset, a new VMDK backing will not be created. (['present'])</div> <div>- Accepted keys:</div> - <div>- name (string): Base name of the VMDK file. The name should not include the '.vmdk' file extension.</div> + <div>- name (string): Base name of the VMDK file. The name should not include the '.vmdk' file extension.</div> + <div>If unset, a name (derived from the name of the virtual machine) will be chosen by the server.</div> <div>- capacity (integer): Capacity of the virtual disk backing in bytes.</div> - <div>- storage_policy (object): The <code>storage_policy_spec</code> {@term structure} contains information about the storage policy that is to be associated the with VMDK file.</div> + <div>If unset, defaults to a guest-specific capacity.</div> + <div>- storage_policy (object): The <em>storage_policy_spec</em> structure contains information about the storage policy that is to be associated the with VMDK file.</div> + <div>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.</div> </td> </tr> <tr> @@ -282,6 +340,8 @@ Parameters </td> <td> <div>Set of Disks to Remove.</div> + <div>If unset, all disks will be copied. If the same identifier is in <em>disks_to_update</em> InvalidArgument fault will be returned.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_disk</span>.</div> </td> </tr> <tr> @@ -297,6 +357,8 @@ Parameters </td> <td> <div>Map of Disks to Update.</div> + <div>If unset, all disks will copied to the datastore specified in the <em>datastore</em> field of I() If the same identifier is in <em>disks_to_remove</em> InvalidArgument fault will be thrown.</div> + <div>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 <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_disk</span>.</div> </td> </tr> <tr> @@ -313,18 +375,24 @@ Parameters </td> <td> <div>List of floppy drives.</div> + <div>If unset, no floppy drives will be created.</div> <div>Valid attributes are:</div> - <div>- <code>backing</code> (dict): Physical resource backing for the virtual floppy drive. (['present'])</div> + <div>- <code>backing</code> (dict): Physical resource backing for the virtual floppy drive.</div> + <div>If unset, defaults to automatic detection of a suitable host device. (['present'])</div> <div>- Accepted keys:</div> - <div>- type (string): The <code>backing_type</code> defines the valid backing types for a virtual floppy drive.</div> + <div>- type (string): This option defines the valid backing types for a virtual floppy drive.</div> <div>Accepted value for this field:</div> <div>- <code>CLIENT_DEVICE</code></div> <div>- <code>HOST_DEVICE</code></div> <div>- <code>IMAGE_FILE</code></div> <div>- image_file (string): Path of the image file that should be used as the virtual floppy drive backing.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is IMAGE_FILE.</div> <div>- host_device (string): Name of the device that should be used as the virtual floppy drive backing.</div> - <div>- <code>start_connected</code> (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. (['present'])</div> - <div>- <code>allow_guest_control</code> (bool): Flag indicating whether the guest can connect and disconnect the device. (['present'])</div> + <div>If unset, the virtual floppy drive will be configured to automatically detect a suitable host device.</div> + <div>- <code>start_connected</code> (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.</div> + <div>Defaults to false if unset. (['present'])</div> + <div>- <code>allow_guest_control</code> (bool): Flag indicating whether the guest can connect and disconnect the device.</div> + <div>Defaults to false if unset. (['present'])</div> </td> </tr> <tr> @@ -340,8 +408,10 @@ Parameters </td> <td> <div>Guest customization spec to apply to the virtual machine after the virtual machine is deployed.</div> + <div>If unset, the guest operating system is not customized after clone.</div> <div>Valid attributes are:</div> - <div>- <code>name</code> (str): Name of the customization specification. (['clone'])</div> + <div>- <code>name</code> (str): Name of the customization specification.</div> + <div>If unset, no guest customization is performed. (['clone'])</div> </td> </tr> <tr> @@ -539,7 +609,7 @@ Parameters </ul> </td> <td> - <div>The <code>guest_o_s</code> defines the valid guest operating system types used for configuring a virtual machine. Required with <em>state=['present']</em></div> + <div>The GuestOS enumerated type defines the valid guest operating system types used for configuring a virtual machine. Required with <em>state=['present']</em></div> </td> </tr> <tr> @@ -572,7 +642,7 @@ Parameters </ul> </td> <td> - <div>The <code>version</code> defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)).</div> + <div>The <em>version</em> 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)).</div> </td> </tr> <tr> @@ -588,9 +658,20 @@ Parameters </td> <td> <div>Memory configuration.</div> + <div>If unset, guest-specific default values will be used.</div> <div>Valid attributes are:</div> - <div>- <code>size_MiB</code> (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 {@link Info#hotAddEnabled} is true, and the new memory size must satisfy the constraints specified by {@link Info#hotAddIncrementSizeMiB} and {@link Info#hotAddLimitMiB}. (['present'])</div> - <div>- <code>hot_add_enabled</code> (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. (['present'])</div> + <div>- <code>size_MiB</code> (int): New memory size in mebibytes.</div> + <div>The supported range of memory sizes is constrained by the configured guest operating system and virtual hardware version of the virtual machine.</div> + <div></div> + <div>If the virtual machine is running, this value may only be changed if <em>hot_add_enabled</em> is true, and the new memory size must satisfy the constraints specified by <em>hot_add_increment_size_mib</em> and I()</div> + <div></div> + <div>If unset, the value is unchanged. (['present'])</div> + <div>- <code>hot_add_enabled</code> (bool): Flag indicating whether adding memory while the virtual machine is running should be enabled.</div> + <div>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.</div> + <div></div> + <div>This field may only be modified if the virtual machine is not powered on.</div> + <div></div> + <div>If unset, the value is unchanged. (['present'])</div> </td> </tr> <tr> @@ -605,7 +686,8 @@ Parameters <td> </td> <td> - <div>Name of the new virtual machine.</div> + <div>Virtual machine name.</div> + <div>If unset, the display name from the virtual machine's configuration file will be used.</div> </td> </tr> <tr> @@ -622,8 +704,9 @@ Parameters </td> <td> <div>List of Ethernet adapters.</div> + <div>If unset, no Ethernet adapters will be created.</div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>emulation_type</code> defines the valid emulation types for a virtual Ethernet adapter. (['present'])</div> + <div>- <code>type</code> (str): This option defines the valid emulation types for a virtual Ethernet adapter. (['present'])</div> <div>- Accepted values:</div> <div>- E1000</div> <div>- E1000E</div> @@ -631,27 +714,37 @@ Parameters <div>- VMXNET</div> <div>- VMXNET2</div> <div>- VMXNET3</div> - <div>- <code>upt_compatibility_enabled</code> (bool): Flag indicating whether Universal Pass-Through (UPT) compatibility is enabled on this virtual Ethernet adapter. (['present'])</div> - <div>- <code>mac_type</code> (str): The <code>mac_address_type</code> defines the valid MAC address origins for a virtual Ethernet adapter. (['present'])</div> + <div>- <code>upt_compatibility_enabled</code> (bool): Flag indicating whether Universal Pass-Through (UPT) compatibility is enabled on this virtual Ethernet adapter.</div> + <div>If unset, defaults to false. (['present'])</div> + <div>- <code>mac_type</code> (str): This option defines the valid MAC address origins for a virtual Ethernet adapter. (['present'])</div> <div>- Accepted values:</div> <div>- ASSIGNED</div> <div>- GENERATED</div> <div>- MANUAL</div> - <div>- <code>mac_address</code> (str): MAC address. (['present'])</div> - <div>- <code>pci_slot_number</code> (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. (['present'])</div> - <div>- <code>wake_on_lan_enabled</code> (bool): Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter. (['present'])</div> - <div>- <code>backing</code> (dict): Physical resource backing for the virtual Ethernet adapter. (['present'])</div> + <div>- <code>mac_address</code> (str): MAC address.</div> + <div>Workaround for PR1459647 (['present'])</div> + <div>- <code>pci_slot_number</code> (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.</div> + <div>If unset, the server will choose an available address when the virtual machine is powered on. (['present'])</div> + <div>- <code>wake_on_lan_enabled</code> (bool): Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter.</div> + <div>Defaults to false if unset. (['present'])</div> + <div>- <code>backing</code> (dict): Physical resource backing for the virtual Ethernet adapter.</div> + <div>If unset, the system may try to find an appropriate backing. If one is not found, the request will fail. (['present'])</div> <div>- Accepted keys:</div> - <div>- type (string): The <code>backing_type</code> defines the valid backing types for a virtual Ethernet adapter.</div> + <div>- type (string): This option defines the valid backing types for a virtual Ethernet adapter.</div> <div>Accepted value for this field:</div> <div>- <code>DISTRIBUTED_PORTGROUP</code></div> <div>- <code>HOST_DEVICE</code></div> <div>- <code>OPAQUE_NETWORK</code></div> <div>- <code>STANDARD_PORTGROUP</code></div> <div>- network (string): Identifier of the network that backs the virtual Ethernet adapter.</div> - <div>- 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.</div> - <div>- <code>start_connected</code> (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. (['present'])</div> - <div>- <code>allow_guest_control</code> (bool): Flag indicating whether the guest can connect and disconnect the device. (['present'])</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is one of STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP, or OPAQUE_NETWORK.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_network_info</span>.</div> + <div>- 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.</div> + <div>May be used to specify a port when the network specified on the <em>network</em> 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.</div> + <div>- <code>start_connected</code> (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.</div> + <div>Defaults to false if unset. (['present'])</div> + <div>- <code>allow_guest_control</code> (bool): Flag indicating whether the guest can connect and disconnect the device.</div> + <div>Defaults to false if unset. (['present'])</div> </td> </tr> <tr> @@ -667,6 +760,30 @@ Parameters </td> <td> <div>Map of NICs to update.</div> + <div>If unset, no NICs will be updated.</div> + <div>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 <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_ethernet</span>.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>nvme_adapters</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>List of NVMe adapters.</div> + <div>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.</div> + <div>Valid attributes are:</div> + <div>- <code>bus</code> (int): NVMe bus number.</div> + <div>If unset, the server will choose an available bus number; if none is available, the request will fail. (['present'])</div> + <div>- <code>pci_slot_number</code> (int): Address of the NVMe adapter on the PCI bus.</div> + <div>If unset, the server will choose an available address when the virtual machine is powered on. (['present'])</div> </td> </tr> <tr> @@ -683,17 +800,23 @@ Parameters </td> <td> <div>List of parallel ports.</div> + <div>If unset, no parallel ports will be created.</div> <div>Valid attributes are:</div> - <div>- <code>backing</code> (dict): Physical resource backing for the virtual parallel port. (['present'])</div> + <div>- <code>backing</code> (dict): Physical resource backing for the virtual parallel port.</div> + <div>If unset, defaults to automatic detection of a suitable host device. (['present'])</div> <div>- Accepted keys:</div> - <div>- type (string): The <code>backing_type</code> defines the valid backing types for a virtual parallel port.</div> + <div>- type (string): This option defines the valid backing types for a virtual parallel port.</div> <div>Accepted value for this field:</div> <div>- <code>FILE</code></div> <div>- <code>HOST_DEVICE</code></div> <div>- file (string): Path of the file that should be used as the virtual parallel port backing.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is FILE.</div> <div>- host_device (string): Name of the device that should be used as the virtual parallel port backing.</div> - <div>- <code>start_connected</code> (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. (['present'])</div> - <div>- <code>allow_guest_control</code> (bool): Flag indicating whether the guest can connect and disconnect the device. (['present'])</div> + <div>If unset, the virtual parallel port will be configured to automatically detect a suitable host device.</div> + <div>- <code>start_connected</code> (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.</div> + <div>Defaults to false if unset. (['present'])</div> + <div>- <code>allow_guest_control</code> (bool): Flag indicating whether the guest can connect and disconnect the device.</div> + <div>Defaults to false if unset. (['present'])</div> </td> </tr> <tr> @@ -709,6 +832,8 @@ Parameters </td> <td> <div>Map of parallel ports to Update.</div> + <div>If unset, no parallel ports will be updated.</div> + <div>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 <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_parallel</span>.</div> </td> </tr> <tr> @@ -724,6 +849,7 @@ Parameters </td> <td> <div>Path to the virtual machine's configuration file on the datastore corresponding to {@link #datastore).</div> + <div>If unset, <em>datastore</em> must also be unset and <em>datastore_path</em> must be set.</div> </td> </tr> <tr> @@ -739,12 +865,31 @@ Parameters </td> <td> <div>Virtual machine placement information.</div> + <div>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.</div> <div>Valid attributes are:</div> - <div>- <code>folder</code> (str): Virtual machine folder into which the virtual machine should be placed. (['clone', 'instant_clone', 'present', 'register', 'relocate'])</div> - <div>- <code>resource_pool</code> (str): Resource pool into which the virtual machine should be placed. (['clone', 'instant_clone', 'present', 'register', 'relocate'])</div> - <div>- <code>host</code> (str): Host onto which the virtual machine should be placed. If <code>#host</code> and <code>#resource_pool</code> are both specified, <code>#resource_pool</code> must belong to <code>#host</code>. If <code>#host</code> and <code>#cluster</code> are both specified, <code>#host</code> must be a member of <code>#cluster</code>. (['clone', 'present', 'register', 'relocate'])</div> - <div>- <code>cluster</code> (str): Cluster into which the virtual machine should be placed. If <code>#cluster</code> and <code>#resource_pool</code> are both specified, <code>#resource_pool</code> must belong to <code>#cluster</code>. If <code>#cluster</code> and <code>#host</code> are both specified, <code>#host</code> must be a member of <code>#cluster</code>. (['clone', 'present', 'register', 'relocate'])</div> - <div>- <code>datastore</code> (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. (['clone', 'instant_clone', 'present', 'relocate'])</div> + <div>- <code>folder</code> (str): Virtual machine folder into which the virtual machine should be placed.</div> + <div>If this field is unset, the virtual machine will stay in the current folder.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_folder_info</span>. (['clone', 'instant_clone', 'present', 'register', 'relocate'])</div> + <div>- <code>resource_pool</code> (str): Resource pool into which the virtual machine should be placed.</div> + <div>If this field is unset, the virtual machine will stay in the current resource pool.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_resourcepool_info</span>. (['clone', 'instant_clone', 'present', 'register', 'relocate'])</div> + <div>- <code>host</code> (str): Host onto which the virtual machine should be placed.</div> + <div>If <em>host</em> and <em>resource_pool</em> are both specified, <em>resource_pool</em> must belong to <em>host</em>.</div> + <div></div> + <div>If <em>host</em> and <em>cluster</em> are both specified, <em>host</em> must be a member of <em>cluster</em>.</div> + <div></div> + <div>If this field is unset, if <em>resource_pool</em> is unset, the virtual machine will remain on the current host. if <em>resource_pool</em> is set, and the target is a standalone host, the host is used. if <em>resource_pool</em> is set, and the target is a DRS cluster, a host will be picked by DRS. if <em>resource_pool</em> is set, and the target is a cluster without DRS, InvalidArgument will be thrown.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_host_info</span>. (['clone', 'present', 'register', 'relocate'])</div> + <div>- <code>cluster</code> (str): Cluster into which the virtual machine should be placed.</div> + <div>If <em>cluster</em> and <em>resource_pool</em> are both specified, <em>resource_pool</em> must belong to <em>cluster</em>.</div> + <div></div> + <div>If <em>cluster</em> and <em>host</em> are both specified, <em>host</em> must be a member of <em>cluster</em>.</div> + <div></div> + <div>If <em>resource_pool</em> or <em>host</em> is specified, it is recommended that this field be unset.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_cluster_info</span>. (['clone', 'present', 'register', 'relocate'])</div> + <div>- <code>datastore</code> (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.</div> + <div>If this field is unset, the virtual machine will remain on the current datastore.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_datastore_info</span>. (['clone', 'instant_clone', 'present', 'relocate'])</div> </td> </tr> <tr> @@ -763,7 +908,8 @@ Parameters </ul> </td> <td> - <div>Attempt to perform a {@link #powerOn} after clone.</div> + <div>Attempt to perform a <em>power_on</em> after clone.</div> + <div>If unset, the virtual machine will not be powered on.</div> </td> </tr> <tr> @@ -780,12 +926,15 @@ Parameters </td> <td> <div>List of SATA adapters.</div> + <div>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.</div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>type</code> defines the valid emulation types for a virtual SATA adapter. (['present'])</div> + <div>- <code>type</code> (str): This option defines the valid emulation types for a virtual SATA adapter. (['present'])</div> <div>- Accepted values:</div> <div>- AHCI</div> - <div>- <code>bus</code> (int): SATA bus number. (['present'])</div> - <div>- <code>pci_slot_number</code> (int): Address of the SATA adapter on the PCI bus. (['present'])</div> + <div>- <code>bus</code> (int): SATA bus number.</div> + <div>If unset, the server will choose an available bus number; if none is available, the request will fail. (['present'])</div> + <div>- <code>pci_slot_number</code> (int): Address of the SATA adapter on the PCI bus.</div> + <div>If unset, the server will choose an available address when the virtual machine is powered on. (['present'])</div> </td> </tr> <tr> @@ -802,16 +951,19 @@ Parameters </td> <td> <div>List of SCSI adapters.</div> + <div>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.</div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>type</code> defines the valid emulation types for a virtual SCSI adapter. (['present'])</div> + <div>- <code>type</code> (str): This option defines the valid emulation types for a virtual SCSI adapter. (['present'])</div> <div>- Accepted values:</div> <div>- BUSLOGIC</div> <div>- LSILOGIC</div> <div>- LSILOGICSAS</div> <div>- PVSCSI</div> - <div>- <code>bus</code> (int): SCSI bus number. (['present'])</div> - <div>- <code>pci_slot_number</code> (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. (['present'])</div> - <div>- <code>sharing</code> (str): The <code>sharing</code> defines the valid bus sharing modes for a virtual SCSI adapter. (['present'])</div> + <div>- <code>bus</code> (int): SCSI bus number.</div> + <div>If unset, the server will choose an available bus number; if none is available, the request will fail. (['present'])</div> + <div>- <code>pci_slot_number</code> (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.</div> + <div>If unset, the server will choose an available address when the virtual machine is powered on. (['present'])</div> + <div>- <code>sharing</code> (str): This option defines the valid bus sharing modes for a virtual SCSI adapter. (['present'])</div> <div>- Accepted values:</div> <div>- NONE</div> <div>- PHYSICAL</div> @@ -832,11 +984,14 @@ Parameters </td> <td> <div>List of serial ports.</div> + <div>If unset, no serial ports will be created.</div> <div>Valid attributes are:</div> - <div>- <code>yield_on_poll</code> (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. (['present'])</div> - <div>- <code>backing</code> (dict): Physical resource backing for the virtual serial port. (['present'])</div> + <div>- <code>yield_on_poll</code> (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.</div> + <div>If unset, defaults to false. (['present'])</div> + <div>- <code>backing</code> (dict): Physical resource backing for the virtual serial port.</div> + <div>If unset, defaults to automatic detection of a suitable host device. (['present'])</div> <div>- Accepted keys:</div> - <div>- type (string): The <code>backing_type</code> defines the valid backing types for a virtual serial port.</div> + <div>- type (string): This option defines the valid backing types for a virtual serial port.</div> <div>Accepted value for this field:</div> <div>- <code>FILE</code></div> <div>- <code>HOST_DEVICE</code></div> @@ -845,13 +1000,26 @@ Parameters <div>- <code>PIPE_CLIENT</code></div> <div>- <code>PIPE_SERVER</code></div> <div>- file (string): Path of the file backing the virtual serial port.</div> - <div>- host_device (string): Name of the device backing the virtual serial port. <p></div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is FILE.</div> + <div>- host_device (string): Name of the device backing the virtual serial port.</div> + <div></div> + <div></div> + <div>If unset, the virtual serial port will be configured to automatically detect a suitable host device.</div> <div>- pipe (string): Name of the pipe backing the virtual serial port.</div> - <div>- 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.</div> - <div>- network_location (string): URI specifying the location of the network service backing the virtual serial port. <ul> <li>If {@link #type} is {@link BackingType#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.</li> <li>If {@link #type} is {@link BackingType#NETWORK_CLIENT}, this field is the location used by the virtual machine to connect to the remote server.</li> </ul></div> - <div>- 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.</div> - <div>- <code>start_connected</code> (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. (['present'])</div> - <div>- <code>allow_guest_control</code> (bool): Flag indicating whether the guest can connect and disconnect the device. (['present'])</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is one of PIPE_SERVER or PIPE_CLIENT.</div> + <div>- 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.</div> + <div>If unset, defaults to false.</div> + <div>- network_location (string): URI specifying the location of the network service backing the virtual serial port.</div> + <div>- If <em>type</em> 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.</div> + <div>- If <em>type</em> is NETWORK_CLIENT, this field is the location used by the virtual machine to connect to the remote server.</div> + <div></div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is one of NETWORK_SERVER or NETWORK_CLIENT.</div> + <div>- 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.</div> + <div>If unset, no proxy service should be used.</div> + <div>- <code>start_connected</code> (bool): Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.</div> + <div>Defaults to false if unset. (['present'])</div> + <div>- <code>allow_guest_control</code> (bool): Flag indicating whether the guest can connect and disconnect the device.</div> + <div>Defaults to false if unset. (['present'])</div> </td> </tr> <tr> @@ -867,6 +1035,8 @@ Parameters </td> <td> <div>Map of serial ports to Update.</div> + <div>If unset, no serial ports will be updated.</div> + <div>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 <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_serial</span>.</div> </td> </tr> <tr> @@ -899,7 +1069,8 @@ Parameters <td> </td> <td> - <div>Virtual machine to InstantClone from. Required with <em>state=['clone', 'instant_clone']</em></div> + <div>Virtual machine to InstantClone from.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['clone', 'instant_clone']</em></div> </td> </tr> <tr> @@ -937,9 +1108,11 @@ Parameters <td> </td> <td> - <div>The <code>storage_policy_spec</code> {@term structure} contains information about the storage policy that is to be associated with the virtual machine home (which contains the configuration and log files). Required with <em>state=['present']</em></div> + <div>The <em>storage_policy_spec</em> structure contains information about the storage policy that is to be associated with the virtual machine home (which contains the configuration and log files).</div> + <div>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 <em>state=['present']</em></div> <div>Valid attributes are:</div> - <div>- <code>policy</code> (str): Identifier of the storage policy which should be associated with the virtual machine. (['present'])</div> + <div>- <code>policy</code> (str): Identifier of the storage policy which should be associated with the virtual machine.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_storage_policies</span>. (['present'])</div> <div>This key is required with ['present'].</div> </td> </tr> @@ -1045,7 +1218,8 @@ Parameters <td> </td> <td> - <div>Identifier of the virtual machine to be unregistered. Required with <em>state=['absent', 'relocate', 'unregister']</em></div> + <div>Identifier of the virtual machine to be unregistered.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['absent', 'relocate', 'unregister']</em></div> </td> </tr> </table> @@ -1056,7 +1230,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_power_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_power_info_module.rst index 21aad261c..41dd52a0a 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_power_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_power_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. Required with <em>state=['get']</em></div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_power_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_power_module.rst index 6292a17b5..bcc0a64b7 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_power_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_power_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -183,7 +183,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -194,7 +195,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 See Also diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module.rst index aa8dfa8ae..99a2e5ea8 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. Required with <em>state=['get']</em></div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module.rst index 2fbd6950a..0061dcaae 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module.rst @@ -5,7 +5,7 @@ vmware.vmware_rest.vcenter_vm_storage_policy_compliance ******************************************************* -**Returns the storage policy Compliance {@link Info} of a virtual machine after explicitly re-computing compliance check.** +**Returns the storage policy Compliance Compliance.Info of a virtual machine after explicitly re-computing compliance check.** Version added: 0.1.0 @@ -17,7 +17,7 @@ Version added: 0.1.0 Synopsis -------- -- Returns the storage policy Compliance {@link Info} of a virtual machine after explicitly re-computing compliance check. +- Returns the storage policy Compliance Compliance.Info of a virtual machine after explicitly re-computing compliance check. @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -55,6 +55,8 @@ Parameters </td> <td> <div>Identifiers of the virtual machine's virtual disks for which compliance should be checked.</div> + <div>If unset or empty, compliance check is invoked on all the associated disks.</div> + <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_disk</span>.</div> </td> </tr> <tr> @@ -196,7 +198,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> <tr> @@ -227,7 +230,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_info_module.rst index b157856e9..118f24ad0 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier Required with <em>state=['get']</em></div> + <div>Virtual machine identifier</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_module.rst index 9d2b8f4df..41476b453 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_storage_policy_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -54,6 +54,8 @@ Parameters </td> <td> <div>Storage policy or policies to be used when reconfiguring virtual machine diks.</div> + <div>if unset the current storage policy is retained.</div> + <div>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 <span class='module'>vmware.vmware_rest.vcenter_vm_hardware_disk</span>.</div> </td> </tr> <tr> @@ -194,7 +196,8 @@ Parameters <td> </td> <td> - <div>Virtual machine identifier. This parameter is mandatory.</div> + <div>Virtual machine identifier.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> <tr> @@ -210,14 +213,17 @@ Parameters <td> </td> <td> - <div>Storage policy to be used when reconfiguring the virtual machine home. This parameter is mandatory.</div> + <div>Storage policy to be used when reconfiguring the virtual machine home.</div> + <div>if unset the current storage policy is retained. This parameter is mandatory.</div> <div>Valid attributes are:</div> - <div>- <code>type</code> (str): The <code>policy_type</code> defines the choices for how to specify the policy to be associated with the virtual machine home's directory. (['present'])</div> + <div>- <code>type</code> (str): This option defines the choices for how to specify the policy to be associated with the virtual machine home's directory. (['present'])</div> <div>This key is required with ['present'].</div> <div>- Accepted values:</div> <div>- USE_DEFAULT_POLICY</div> <div>- USE_SPECIFIED_POLICY</div> - <div>- <code>policy</code> (str): Storage Policy identification. (['present'])</div> + <div>- <code>policy</code> (str): Storage Policy identification.</div> + <div>This field is optional and it is only relevant when the value of <em>type</em> is USE_SPECIFIED_POLICY.</div> + <div>When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_storage_policies</span>. (['present'])</div> </td> </tr> </table> @@ -228,7 +234,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_info_module.rst index 20b9bbecd..16ac1f9ae 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Identifier of the virtual machine. Required with <em>state=['get']</em></div> + <div>Identifier of the virtual machine.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_installer_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_installer_info_module.rst index eb3755e19..2040aabc2 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_installer_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_installer_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -161,7 +161,8 @@ Parameters <td> </td> <td> - <div>Identifier of the virtual machine. Required with <em>state=['get']</em></div> + <div>Identifier of the virtual machine.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. Required with <em>state=['get']</em></div> </td> </tr> </table> @@ -172,7 +173,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_installer_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_installer_module.rst index c3c89d45d..85465118d 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_installer_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_installer_module.rst @@ -17,7 +17,7 @@ Version added: 0.1.0 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 {@name vcenter.vm.Tools.Info#versionStatus} and {@name vcenter.vm.Tools.Info#runState} from {@link vcenter.vm.Tools#get} +- 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 @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -181,7 +181,8 @@ Parameters <td> </td> <td> - <div>Virtual machine ID This parameter is mandatory.</div> + <div>Virtual machine ID</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -192,7 +193,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_module.rst index edd59f366..113a7e709 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vm_tools_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -54,6 +54,7 @@ Parameters </td> <td> <div>Command line options passed to the installer to modify the installation procedure for Tools.</div> + <div>Set if any additional options are desired.</div> </td> </tr> <tr> @@ -108,7 +109,7 @@ Parameters </ul> </td> <td> - <div>The <code>upgrade_policy</code> defines when Tools are auto-upgraded for a virtual machine.</div> + <div>The <em>upgrade_policy</em> enumerated type defines when Tools are auto-upgraded for a virtual machine.</div> </td> </tr> <tr> @@ -214,7 +215,8 @@ Parameters <td> </td> <td> - <div>Identifier of the virtual machine. This parameter is mandatory.</div> + <div>Identifier of the virtual machine.</div> + <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_vm_info</span>. This parameter is mandatory.</div> </td> </tr> </table> @@ -225,7 +227,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module.rst index 8fd6cb24f..bf83dc6c8 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -172,7 +172,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module.rst index a49c22c22..bd523525d 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module.rst @@ -25,7 +25,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- vSphere 7.0.2 or greater +- vSphere 7.0.3 or greater - python >= 3.6 - aiohttp @@ -394,7 +394,7 @@ Notes ----- .. note:: - - Tested on vSphere 7.0.2 + - Tested on vSphere 7.0.3 diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vm_moid_lookup.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vm_moid_lookup.rst index 252d64d2e..1a5904c88 100644 --- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vm_moid_lookup.rst +++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vm_moid_lookup.rst @@ -48,7 +48,7 @@ Parameters <b>_terms</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> / <span style="color: red">required</span> </div> </td> @@ -73,10 +73,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_HOST</div> </td> <td> <div>The hostname or IP address of the vSphere vCenter.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_HOST</code> will be used instead.</div> </td> </tr> <tr> @@ -92,10 +92,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_PASSWORD</div> </td> <td> <div>The vSphere vCenter password.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PASSWORD</code> will be used instead.</div> </td> </tr> <tr> @@ -110,12 +110,12 @@ Parameters <td> </td> <td> + <div>env:VMWARE_REST_LOG_FILE</div> </td> <td> <div>You can use this optional parameter to set the location of a log file.</div> - <div>This file will be used to record the HTTP REST interaction.</div> - <div>The file will be stored on the host that run the module.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_REST_LOG_FILE</code> will be used instead.</div> + <div>This file will be used to record the HTTP REST interactions.</div> + <div>The file will be stored on the host that runs the module.</div> </td> </tr> <tr> @@ -131,10 +131,10 @@ Parameters <td> </td> <td> + <div>env:VMWARE_USER</div> </td> <td> <div>The vSphere vCenter username.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_USER</code> will be used instead.</div> </td> </tr> <tr> @@ -147,16 +147,13 @@ Parameters </div> </td> <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> + <b>Default:</b><br/><div style="color: blue">"yes"</div> </td> <td> + <div>env:VMWARE_VALIDATE_CERTS</div> </td> <td> - <div>Allows connection when SSL certificates are not valid. Set to <code>false</code> when certificates are not trusted.</div> - <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_VALIDATE_CERTS</code> will be used instead.</div> + <div>Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.</div> </td> </tr> </table> |