diff --git a/docs/vmware.vmware_rest.appliance_access_consolecli_info_module.rst b/docs/vmware.vmware_rest.appliance_access_consolecli_info_module.rst index 7f7f1ec99..0deef6706 100644 --- a/docs/vmware.vmware_rest.appliance_access_consolecli_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_access_consolecli_info_module.rst @@ -171,6 +171,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ integer +
+ 		On success +
Check if the Console CLI is enabled
+
+
Sample:
+
1
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_access_consolecli_module.rst b/docs/vmware.vmware_rest.appliance_access_consolecli_module.rst index 459f22bfa..3234237ee 100644 --- a/docs/vmware.vmware_rest.appliance_access_consolecli_module.rst +++ b/docs/vmware.vmware_rest.appliance_access_consolecli_module.rst @@ -209,6 +209,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Disable the Console CLI
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_access_dcui_info_module.rst b/docs/vmware.vmware_rest.appliance_access_dcui_info_module.rst index 5e5bc8cf7..81635394d 100644 --- a/docs/vmware.vmware_rest.appliance_access_dcui_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_access_dcui_info_module.rst @@ -171,6 +171,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ integer +
+ 		On success +
Check if the Direct Console User Interface is enabled
+
+
Sample:
+
1
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_access_dcui_module.rst b/docs/vmware.vmware_rest.appliance_access_dcui_module.rst index 5afaa6701..5f8abce2b 100644 --- a/docs/vmware.vmware_rest.appliance_access_dcui_module.rst +++ b/docs/vmware.vmware_rest.appliance_access_dcui_module.rst @@ -209,6 +209,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Disable the Direct Console User Interface
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_access_shell_info_module.rst b/docs/vmware.vmware_rest.appliance_access_shell_info_module.rst index a7cf3bfd4..1cb4dcdc5 100644 --- a/docs/vmware.vmware_rest.appliance_access_shell_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_access_shell_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Check if the Shell is enabled
+
+
Sample:
+
{'enabled': 0, 'timeout': 0}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_access_shell_module.rst b/docs/vmware.vmware_rest.appliance_access_shell_module.rst index 8027b5855..c7836791b 100644 --- a/docs/vmware.vmware_rest.appliance_access_shell_module.rst +++ b/docs/vmware.vmware_rest.appliance_access_shell_module.rst @@ -232,6 +232,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Disable the Shell
+
+
Sample:
+
{'enabled': 0, 'timeout': 0}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_access_ssh_info_module.rst b/docs/vmware.vmware_rest.appliance_access_ssh_info_module.rst index ac5044307..1f71fd38c 100644 --- a/docs/vmware.vmware_rest.appliance_access_ssh_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_access_ssh_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ integer +
+ 		On success +
Check is the SSH access is enabled
+
+
Sample:
+
1
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_access_ssh_module.rst b/docs/vmware.vmware_rest.appliance_access_ssh_module.rst index c06ca3050..7ea11cca3 100644 --- a/docs/vmware.vmware_rest.appliance_access_ssh_module.rst +++ b/docs/vmware.vmware_rest.appliance_access_ssh_module.rst @@ -210,6 +210,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ integer +
+ 		On success +
Ensure the SSH access ie enabled
+
+
Sample:
+
1
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_health_applmgmt_info_module.rst b/docs/vmware.vmware_rest.appliance_health_applmgmt_info_module.rst index b43e18eaf..0f99a32ea 100644 --- a/docs/vmware.vmware_rest.appliance_health_applmgmt_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_health_applmgmt_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Get the health state of applmgmt
+
+
Sample:
+
green
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_health_databasestorage_info_module.rst b/docs/vmware.vmware_rest.appliance_health_databasestorage_info_module.rst index eb80f44ad..d87c9ec82 100644 --- a/docs/vmware.vmware_rest.appliance_health_databasestorage_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_health_databasestorage_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Get the database storage heath status
+
+
Sample:
+
green
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_health_load_info_module.rst b/docs/vmware.vmware_rest.appliance_health_load_info_module.rst index 7e9743f79..656243016 100644 --- a/docs/vmware.vmware_rest.appliance_health_load_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_health_load_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Get the system load status
+
+
Sample:
+
green
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_health_mem_info_module.rst b/docs/vmware.vmware_rest.appliance_health_mem_info_module.rst index 82062c0d0..44cafb88c 100644 --- a/docs/vmware.vmware_rest.appliance_health_mem_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_health_mem_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Get the system mem status
+
+
Sample:
+
green
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_health_softwarepackages_info_module.rst b/docs/vmware.vmware_rest.appliance_health_softwarepackages_info_module.rst index f92c9861a..061d7f6b6 100644 --- a/docs/vmware.vmware_rest.appliance_health_softwarepackages_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_health_softwarepackages_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Get the health of the software package manager
+
+
Sample:
+
green
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_health_storage_info_module.rst b/docs/vmware.vmware_rest.appliance_health_storage_info_module.rst index b488c4be0..c354fe489 100644 --- a/docs/vmware.vmware_rest.appliance_health_storage_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_health_storage_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Get the health of the storage system
+
+
Sample:
+
green
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_health_swap_info_module.rst b/docs/vmware.vmware_rest.appliance_health_swap_info_module.rst index 131ce34b7..365d475b3 100644 --- a/docs/vmware.vmware_rest.appliance_health_swap_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_health_swap_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Get the health of the swap
+
+
Sample:
+
green
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_health_system_info_module.rst b/docs/vmware.vmware_rest.appliance_health_system_info_module.rst index 51a118072..b5a597654 100644 --- a/docs/vmware.vmware_rest.appliance_health_system_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_health_system_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Get the system health status
+
+
Sample:
+
green
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_infraprofile_configs_info_module.rst b/docs/vmware.vmware_rest.appliance_infraprofile_configs_info_module.rst index 0c4dda546..1387af2b8 100644 --- a/docs/vmware.vmware_rest.appliance_infraprofile_configs_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_infraprofile_configs_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
List infraprofile configs
+
+
Sample:
+
[{'info': 'ApplianceManagement', 'name': 'ApplianceManagement'}, {'info': 'ApplianceNetwork', 'name': 'ApplianceNetwork'}, {'info': 'Authentication & Authorization Management', 'name': 'AuthManagement'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_infraprofile_configs_module.rst b/docs/vmware.vmware_rest.appliance_infraprofile_configs_module.rst index 294509bfb..af0e71ed8 100644 --- a/docs/vmware.vmware_rest.appliance_infraprofile_configs_module.rst +++ b/docs/vmware.vmware_rest.appliance_infraprofile_configs_module.rst @@ -243,6 +243,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Export the ApplianceManagement profile
+
+
Sample:
+
{"action":"RESTART_SERVICE","productName":"VMware vCenter Server","creationTime":"2022-11-23T20:11:00+0000","version":"7.0.3.00800","profiles":{"ApplianceManagement":{"action":"RESTART_SERVICE","actionOn":{"VC_SERVICES":["applmgmt"],"SYSTEMD":["sendmail","rsyslog"]},"description":"Appliance Mangment Service","version":"7.0","config":{"/etc/applmgmt/appliance/appliance.conf":{"Is shell Enabled":true,"Shell Expiration Time":9,"TimeSync Mode (Host/NTP)":"NTP"},"/etc/ntp.conf":{"Time servers":"time.nist.gov"},"/etc/shadow":{"root":{"maximumDays":"90","warningDays":"7"},"bin":{"maximumDays":"90","warningDays":"7"},"daemon":{"maximumDays":"90","warningDays":"7"},"messagebus":{"maximumDays":"90","warningDays":"7"},"systemd-bus-proxy":{"maximumDays":"90","warningDays":"7"},"systemd-journal-gateway":{"maximumDays":"90","warningDays":"7"},"systemd-journal-remote":{"maximumDays":"90","warningDays":"7"},"systemd-journal-upload":{"maximumDays":"90","warningDays":"7"},"systemd-network":{"maximumDays":"90","warningDays":"7"},"systemd-resolve":{"maximumDays":"90","warningDays":"7"},"systemd-timesync":{"maximumDays":"90","warningDays":"7"},"nobody":{"maximumDays":"90","warningDays":"7"},"rpc":{"maximumDays":"90","warningDays":"7"},"sshd":{"maximumDays":"90","warningDays":"7"},"ntp":{"maximumDays":"90","warningDays":"7"},"smmsp":{"maximumDays":"90","warningDays":"7"},"apache":{"maximumDays":"90","warningDays":"7"},"tftp":{"maximumDays":"","warningDays":""},"named":{"maximumDays":"","warningDays":""},"vmdird":{"maximumDays":"90","warningDays":"7"},"sso-user":{"maximumDays":"90","warningDays":"7"},"dnsmasq":{"maximumDays":"","warningDays":""},"observability":{"maximumDays":"","warningDays":""},"vdtc":{"maximumDays":"","warningDays":""},"vmafdd-user":{"maximumDays":"90","warningDays":"7"},"vmcad-user":{"maximumDays":"90","warningDays":"7"},"pod":{"maximumDays":"","warningDays":""},"vmonapi":{"maximumDays":"","warningDays":""},"envoy":{"maximumDays":"","warningDays":""},"vpostgres":{"maximumDays":"","warningDays":"7"},"lookupsvc":{"maximumDays":"","warningDays":""},"cis-license":{"maximumDays":"","warningDays":""},"pschealth":{"maximumDays":"","warningDays":""},"netdumper":{"maximumDays":"","warningDays":""},"vapiEndpoint":{"maximumDays":"90","warningDays":"7"},"vpxd-svcs":{"maximumDays":"","warningDays":""},"certauth":{"maximumDays":"90","warningDays":"7"},"certmgr":{"maximumDays":"90","warningDays":"7"},"infraprofile":{"maximumDays":"","warningDays":""},"topologysvc":{"maximumDays":"90","warningDays":"7"},"trustmanagement":{"maximumDays":"","warningDays":""},"vpxd":{"maximumDays":"","warningDays":""},"analytics":{"maximumDays":"","warningDays":""},"eam":{"maximumDays":"90","warningDays":"7"},"sps":{"maximumDays":"","warningDays":""},"deploy":{"maximumDays":"","warningDays":""},"updatemgr":{"maximumDays":"","warningDays":""},"vlcm":{"maximumDays":"90","warningDays":"7"},"vmcam":{"maximumDays":"90","warningDays":"7"},"vsan-health":{"maximumDays":"90","warningDays":"7"},"vsm":{"maximumDays":"90","warningDays":"7"},"vsphere-ui":{"maximumDays":"90","warningDays":"7"},"vtsdbuser":{"maximumDays":"","warningDays":""},"vstatsuser":{"maximumDays":"","warningDays":""},"wcp":{"maximumDays":"","warningDays":"7"},"content-library":{"maximumDays":"90","warningDays":"7"},"imagebuilder":{"maximumDays":"90","warningDays":"7"},"perfcharts":{"maximumDays":"90","warningDays":"7"},"vpgmonusr":{"maximumDays":"","warningDays":"7"},"vtsdbmonusr":{"maximumDays":"","warningDays":"7"},"zuul":{"maximumDays":"90","warningDays":"7"},"Send Waring before this No of Days.":null,"Password validity (days)":null},"/etc/sysconfig/clock":{"Time zone":"\"Etc/UTC\"","UTC":"1"},"/usr/bin/systemctl/sshd.service":{"Enable SSH":"true"},"/etc/mail/sendmail.cf":{"SMTP Port":null,"Mail server":null},"/etc/vmware-syslog/syslog.conf":{"Port [2]":null,"Port [1]":null,"Port [0]":null,"Protocol [2]":null,"Remote Syslog Host [1]":null,"Protocol [1]":null,"Remote Syslog Host [0]":null,"Protocol [0]":null,"Remote Syslog Host [2]":null},"/etc/pam.d/system-auth":{"Deny Login after these many Unsuccessful Attempts.":null,"Unlock root after (seconds)":null,"On Error Login will be.":null,"Include Root user for SSH lockout.":null,"Unlock user after (seconds)":null}},"name":"ApplianceManagement"}}}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module.rst b/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module.rst index 9fee1571c..2c3cfec27 100644 --- a/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get the global policy of the local accounts
+
+
Sample:
+
{'max_days': 90, 'min_days': 1, 'warn_days': 7}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_module.rst b/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_module.rst index e402df540..c8127a9e8 100644 --- a/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_module.rst +++ b/docs/vmware.vmware_rest.appliance_localaccounts_globalpolicy_module.rst @@ -237,6 +237,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Update the global policy of the local accounts
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_localaccounts_info_module.rst b/docs/vmware.vmware_rest.appliance_localaccounts_info_module.rst index 9b9a1fdaa..f7af04602 100644 --- a/docs/vmware.vmware_rest.appliance_localaccounts_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_localaccounts_info_module.rst @@ -187,6 +187,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
List the local accounts
+
+
Sample:
+
[{'enabled': 1, 'fullname': 'root', 'has_password': 1, 'last_password_change': '2022-11-23T00:00:00.000Z', 'max_days_between_password_change': 90, 'min_days_between_password_change': 0, 'password_expires_at': '2023-02-21T00:00:00.000Z', 'roles': ['superAdmin'], 'warn_days_before_password_expiration': 7}, {'enabled': 0, 'has_password': 0, 'inactive_at': '2022-12-25T00:00:00.000Z', 'last_password_change': '2022-09-26T00:00:00.000Z', 'max_days_between_password_change': 90, 'min_days_between_password_change': 1, 'password_expires_at': '2022-12-25T00:00:00.000Z', 'roles': [''], 'warn_days_before_password_expiration': 7}, {'enabled': 0, 'has_password': 0, 'last_password_change': '2022-09-26T00:00:00.000Z', 'max_days_between_password_change': -1, 'min_days_between_password_change': -1, 'roles': [''], 'warn_days_before_password_expiration': -1}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_monitoring_info_module.rst b/docs/vmware.vmware_rest.appliance_monitoring_info_module.rst index 5bb09cf1d..ff263e4c8 100644 --- a/docs/vmware.vmware_rest.appliance_monitoring_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_monitoring_info_module.rst @@ -188,6 +188,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Get the list of the monitored items
+
+
Sample:
+
[{'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-1', 'id': 'disk.read.rate.dm-1', 'instance': 'dm-1', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-1', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-10', 'id': 'disk.read.rate.dm-10', 'instance': 'dm-10', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-10', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-11', 'id': 'disk.read.rate.dm-11', 'instance': 'dm-11', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-11', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-12', 'id': 'disk.read.rate.dm-12', 'instance': 'dm-12', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-12', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-13', 'id': 'disk.read.rate.dm-13', 'instance': 'dm-13', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-13', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-14', 'id': 'disk.read.rate.dm-14', 'instance': 'dm-14', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-14', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-15', 'id': 'disk.read.rate.dm-15', 'instance': 'dm-15', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-15', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-2', 'id': 'disk.read.rate.dm-2', 'instance': 'dm-2', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-2', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-3', 'id': 'disk.read.rate.dm-3', 'instance': 'dm-3', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-3', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-4', 'id': 'disk.read.rate.dm-4', 'instance': 'dm-4', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-4', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-5', 'id': 'disk.read.rate.dm-5', 'instance': 'dm-5', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-5', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-6', 'id': 'disk.read.rate.dm-6', 'instance': 'dm-6', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-6', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-7', 'id': 'disk.read.rate.dm-7', 'instance': 'dm-7', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-7', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-8', 'id': 'disk.read.rate.dm-8', 'instance': 'dm-8', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-8', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-9', 'id': 'disk.read.rate.dm-9', 'instance': 'dm-9', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-9', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-1', 'id': 'disk.write.rate.dm-1', 'instance': 'dm-1', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-1', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-10', 'id': 'disk.write.rate.dm-10', 'instance': 'dm-10', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-10', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-11', 'id': 'disk.write.rate.dm-11', 'instance': 'dm-11', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-11', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-12', 'id': 'disk.write.rate.dm-12', 'instance': 'dm-12', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-12', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-13', 'id': 'disk.write.rate.dm-13', 'instance': 'dm-13', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-13', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-14', 'id': 'disk.write.rate.dm-14', 'instance': 'dm-14', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-14', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-15', 'id': 'disk.write.rate.dm-15', 'instance': 'dm-15', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-15', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-2', 'id': 'disk.write.rate.dm-2', 'instance': 'dm-2', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-2', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-3', 'id': 'disk.write.rate.dm-3', 'instance': 'dm-3', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-3', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-4', 'id': 'disk.write.rate.dm-4', 'instance': 'dm-4', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-4', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-5', 'id': 'disk.write.rate.dm-5', 'instance': 'dm-5', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-5', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-6', 'id': 'disk.write.rate.dm-6', 'instance': 'dm-6', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-6', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-7', 'id': 'disk.write.rate.dm-7', 'instance': 'dm-7', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-7', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-8', 'id': 'disk.write.rate.dm-8', 'instance': 'dm-8', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-8', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-9', 'id': 'disk.write.rate.dm-9', 'instance': 'dm-9', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-9', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-1', 'id': 'disk.latency.rate.dm-1', 'instance': 'dm-1', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-1', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-10', 'id': 'disk.latency.rate.dm-10', 'instance': 'dm-10', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-10', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-11', 'id': 'disk.latency.rate.dm-11', 'instance': 'dm-11', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-11', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-12', 'id': 'disk.latency.rate.dm-12', 'instance': 'dm-12', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-12', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-13', 'id': 'disk.latency.rate.dm-13', 'instance': 'dm-13', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-13', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-14', 'id': 'disk.latency.rate.dm-14', 'instance': 'dm-14', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-14', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-15', 'id': 'disk.latency.rate.dm-15', 'instance': 'dm-15', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-15', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-2', 'id': 'disk.latency.rate.dm-2', 'instance': 'dm-2', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-2', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-3', 'id': 'disk.latency.rate.dm-3', 'instance': 'dm-3', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-3', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-4', 'id': 'disk.latency.rate.dm-4', 'instance': 'dm-4', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-4', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-5', 'id': 'disk.latency.rate.dm-5', 'instance': 'dm-5', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-5', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-6', 'id': 'disk.latency.rate.dm-6', 'instance': 'dm-6', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-6', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-7', 'id': 'disk.latency.rate.dm-7', 'instance': 'dm-7', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-7', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-8', 'id': 'disk.latency.rate.dm-8', 'instance': 'dm-8', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-8', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-9', 'id': 'disk.latency.rate.dm-9', 'instance': 'dm-9', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-9', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.swap.util', 'id': 'swap.util', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.swap.util', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.swap', 'id': 'storage.used.filesystem.swap', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.swap', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.swap', 'id': 'swap', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.swap', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.swap', 'id': 'storage.totalsize.filesystem.swap', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.swap', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.cpu', 'description': 'com.vmware.applmgmt.mon.descr.cpu.totalfrequency', 'id': 'cpu.totalfrequency', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.cpu.totalfrequency', 'units': 'com.vmware.applmgmt.mon.unit.mhz'}, {'category': 'com.vmware.applmgmt.mon.cat.cpu', 'description': 'com.vmware.applmgmt.mon.descr.cpu.systemload', 'id': 'cpu.systemload', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.cpu.systemload', 'units': 'com.vmware.applmgmt.mon.unit.load_per_min'}, {'category': 'com.vmware.applmgmt.mon.cat.memory', 'description': 'com.vmware.applmgmt.mon.descr.mem.util', 'id': 'mem.util', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.mem.util', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.memory', 'description': 'com.vmware.applmgmt.mon.descr.mem.total', 'id': 'mem.total', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.mem.total', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.memory', 'description': 'com.vmware.applmgmt.mon.descr.mem.usage', 'id': 'mem.usage', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.mem.usage', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.rx.error.eth0', 'id': 'net.rx.error.eth0', 'instance': 'eth0', 'name': 'com.vmware.applmgmt.mon.name.net.rx.error.eth0', 'units': 'com.vmware.applmgmt.mon.unit.errors_per_sample'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.rx.error.lo', 'id': 'net.rx.error.lo', 'instance': 'lo', 'name': 'com.vmware.applmgmt.mon.name.net.rx.error.lo', 'units': 'com.vmware.applmgmt.mon.unit.errors_per_sample'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.tx.error.eth0', 'id': 'net.tx.error.eth0', 'instance': 'eth0', 'name': 'com.vmware.applmgmt.mon.name.net.tx.error.eth0', 'units': 'com.vmware.applmgmt.mon.unit.errors_per_sample'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.tx.error.lo', 'id': 'net.tx.error.lo', 'instance': 'lo', 'name': 'com.vmware.applmgmt.mon.name.net.tx.error.lo', 'units': 'com.vmware.applmgmt.mon.unit.errors_per_sample'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_hourly_stats', 'id': 'storage.totalsize.directory.vcdb_hourly_stats', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_hourly_stats', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_daily_stats', 'id': 'storage.totalsize.directory.vcdb_daily_stats', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_daily_stats', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_monthly_stats', 'id': 'storage.totalsize.directory.vcdb_monthly_stats', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_monthly_stats', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_yearly_stats', 'id': 'storage.totalsize.directory.vcdb_yearly_stats', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_yearly_stats', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_stats', 'id': 'storage.totalsize.directory.vcdb_stats', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_stats', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.seat', 'id': 'storage.totalsize.filesystem.seat', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.seat', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.directory.vcdb_stats', 'id': 'storage.util.directory.vcdb_stats', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.util.directory.vcdb_stats', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_events', 'id': 'storage.totalsize.directory.vcdb_events', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_events', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.directory.vcdb_events', 'id': 'storage.util.directory.vcdb_events', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.util.directory.vcdb_events', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_alarms', 'id': 'storage.totalsize.directory.vcdb_alarms', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_alarms', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.directory.vcdb_alarms', 'id': 'storage.util.directory.vcdb_alarms', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.util.directory.vcdb_alarms', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.directory.vcdb_tasks', 'id': 'storage.totalsize.directory.vcdb_tasks', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.directory.vcdb_tasks', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.directory.vcdb_tasks', 'id': 'storage.util.directory.vcdb_tasks', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.util.directory.vcdb_tasks', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.seat', 'id': 'storage.used.filesystem.seat', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.seat', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.seat', 'id': 'storage.util.filesystem.seat', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.seat', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.db', 'id': 'storage.used.filesystem.db', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.db', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.db', 'id': 'storage.totalsize.filesystem.db', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.db', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.db', 'id': 'storage.util.filesystem.db', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.db', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.dblog', 'id': 'storage.used.filesystem.dblog', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.dblog', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.dblog', 'id': 'storage.totalsize.filesystem.dblog', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.dblog', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.dblog', 'id': 'storage.util.filesystem.dblog', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.dblog', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.root', 'id': 'storage.totalsize.filesystem.root', 'instance': '/', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.root', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.root', 'id': 'storage.util.filesystem.root', 'instance': '/', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.root', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.boot', 'id': 'storage.totalsize.filesystem.boot', 'instance': '/boot', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.boot', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.boot', 'id': 'storage.util.filesystem.boot', 'instance': '/boot', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.boot', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.archive', 'id': 'storage.totalsize.filesystem.archive', 'instance': '/storage/archive', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.archive', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.archive', 'id': 'storage.util.filesystem.archive', 'instance': '/storage/archive', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.archive', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.autodeploy', 'id': 'storage.totalsize.filesystem.autodeploy', 'instance': '/storage/autodeploy', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.autodeploy', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.autodeploy', 'id': 'storage.util.filesystem.autodeploy', 'instance': '/storage/autodeploy', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.autodeploy', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.core', 'id': 'storage.totalsize.filesystem.core', 'instance': '/storage/core', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.core', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.core', 'id': 'storage.util.filesystem.core', 'instance': '/storage/core', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.core', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.imagebuilder', 'id': 'storage.totalsize.filesystem.imagebuilder', 'instance': '/storage/imagebuilder', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.imagebuilder', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.imagebuilder', 'id': 'storage.util.filesystem.imagebuilder', 'instance': '/storage/imagebuilder', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.imagebuilder', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.lifecycle', 'id': 'storage.totalsize.filesystem.lifecycle', 'instance': '/storage/lifecycle', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.lifecycle', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.lifecycle', 'id': 'storage.util.filesystem.lifecycle', 'instance': '/storage/lifecycle', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.lifecycle', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.log', 'id': 'storage.totalsize.filesystem.log', 'instance': '/storage/log', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.log', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.log', 'id': 'storage.util.filesystem.log', 'instance': '/storage/log', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.log', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.lvm_snapshot', 'id': 'storage.totalsize.filesystem.lvm_snapshot', 'instance': '/storage/lvm_snapshot', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.lvm_snapshot', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.lvm_snapshot', 'id': 'storage.util.filesystem.lvm_snapshot', 'instance': '/storage/lvm_snapshot', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.lvm_snapshot', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.netdump', 'id': 'storage.totalsize.filesystem.netdump', 'instance': '/storage/netdump', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.netdump', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.netdump', 'id': 'storage.util.filesystem.netdump', 'instance': '/storage/netdump', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.netdump', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.updatemgr', 'id': 'storage.totalsize.filesystem.updatemgr', 'instance': '/storage/updatemgr', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.updatemgr', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.updatemgr', 'id': 'storage.util.filesystem.updatemgr', 'instance': '/storage/updatemgr', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.updatemgr', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.vtsdb', 'id': 'storage.totalsize.filesystem.vtsdb', 'instance': '/storage/vtsdb', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.vtsdb', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.vtsdb', 'id': 'storage.util.filesystem.vtsdb', 'instance': '/storage/vtsdb', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.vtsdb', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.totalsize.filesystem.vtsdblog', 'id': 'storage.totalsize.filesystem.vtsdblog', 'instance': '/storage/vtsdblog', 'name': 'com.vmware.applmgmt.mon.name.storage.totalsize.filesystem.vtsdblog', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.vtsdblog', 'id': 'storage.util.filesystem.vtsdblog', 'instance': '/storage/vtsdblog', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.vtsdblog', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.root', 'id': 'storage.used.filesystem.root', 'instance': '/', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.root', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.boot', 'id': 'storage.used.filesystem.boot', 'instance': '/boot', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.boot', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.archive', 'id': 'storage.used.filesystem.archive', 'instance': '/storage/archive', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.archive', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.autodeploy', 'id': 'storage.used.filesystem.autodeploy', 'instance': '/storage/autodeploy', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.autodeploy', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.core', 'id': 'storage.used.filesystem.core', 'instance': '/storage/core', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.core', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.imagebuilder', 'id': 'storage.used.filesystem.imagebuilder', 'instance': '/storage/imagebuilder', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.imagebuilder', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.lifecycle', 'id': 'storage.used.filesystem.lifecycle', 'instance': '/storage/lifecycle', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.lifecycle', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.log', 'id': 'storage.used.filesystem.log', 'instance': '/storage/log', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.log', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.lvm_snapshot', 'id': 'storage.used.filesystem.lvm_snapshot', 'instance': '/storage/lvm_snapshot', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.lvm_snapshot', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.netdump', 'id': 'storage.used.filesystem.netdump', 'instance': '/storage/netdump', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.netdump', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.updatemgr', 'id': 'storage.used.filesystem.updatemgr', 'instance': '/storage/updatemgr', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.updatemgr', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.vtsdb', 'id': 'storage.used.filesystem.vtsdb', 'instance': '/storage/vtsdb', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.vtsdb', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.used.filesystem.vtsdblog', 'id': 'storage.used.filesystem.vtsdblog', 'instance': '/storage/vtsdblog', 'name': 'com.vmware.applmgmt.mon.name.storage.used.filesystem.vtsdblog', 'units': 'com.vmware.applmgmt.mon.unit.kb'}, {'category': 'com.vmware.applmgmt.mon.cat.cpu', 'description': 'com.vmware.applmgmt.mon.descr.cpu.util', 'id': 'cpu.util', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.cpu.util', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.cpu', 'description': 'com.vmware.applmgmt.mon.descr.cpu.steal', 'id': 'cpu.steal', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.cpu.steal', 'units': 'com.vmware.applmgmt.mon.unit.percent'}, {'category': 'com.vmware.applmgmt.mon.cat.memory', 'description': 'com.vmware.applmgmt.mon.descr.swap.pageRate', 'id': 'swap.pageRate', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.swap.pageRate', 'units': 'com.vmware.applmgmt.mon.unit.pages_per_sec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.read.rate.dm-0', 'id': 'disk.read.rate.dm-0', 'instance': 'dm-0', 'name': 'com.vmware.applmgmt.mon.name.disk.read.rate.dm-0', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.write.rate.dm-0', 'id': 'disk.write.rate.dm-0', 'instance': 'dm-0', 'name': 'com.vmware.applmgmt.mon.name.disk.write.rate.dm-0', 'units': 'com.vmware.applmgmt.mon.unit.num_of_io_per_msec'}, {'category': 'com.vmware.applmgmt.mon.cat.disk', 'description': 'com.vmware.applmgmt.mon.descr.disk.latency.rate.dm-0', 'id': 'disk.latency.rate.dm-0', 'instance': 'dm-0', 'name': 'com.vmware.applmgmt.mon.name.disk.latency.rate.dm-0', 'units': 'com.vmware.applmgmt.mon.unit.msec_per_io'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.rx.activity.eth0', 'id': 'net.rx.activity.eth0', 'instance': 'eth0', 'name': 'com.vmware.applmgmt.mon.name.net.rx.activity.eth0', 'units': 'com.vmware.applmgmt.mon.unit.kb_per_sec'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.rx.activity.lo', 'id': 'net.rx.activity.lo', 'instance': 'lo', 'name': 'com.vmware.applmgmt.mon.name.net.rx.activity.lo', 'units': 'com.vmware.applmgmt.mon.unit.kb_per_sec'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.rx.packetRate.eth0', 'id': 'net.rx.packetRate.eth0', 'instance': 'eth0', 'name': 'com.vmware.applmgmt.mon.name.net.rx.packetRate.eth0', 'units': 'com.vmware.applmgmt.mon.unit.packets_per_sec'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.rx.packetRate.lo', 'id': 'net.rx.packetRate.lo', 'instance': 'lo', 'name': 'com.vmware.applmgmt.mon.name.net.rx.packetRate.lo', 'units': 'com.vmware.applmgmt.mon.unit.packets_per_sec'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.rx.drop.eth0', 'id': 'net.rx.drop.eth0', 'instance': 'eth0', 'name': 'com.vmware.applmgmt.mon.name.net.rx.drop.eth0', 'units': 'com.vmware.applmgmt.mon.unit.drops_per_sample'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.rx.drop.lo', 'id': 'net.rx.drop.lo', 'instance': 'lo', 'name': 'com.vmware.applmgmt.mon.name.net.rx.drop.lo', 'units': 'com.vmware.applmgmt.mon.unit.drops_per_sample'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.tx.activity.eth0', 'id': 'net.tx.activity.eth0', 'instance': 'eth0', 'name': 'com.vmware.applmgmt.mon.name.net.tx.activity.eth0', 'units': 'com.vmware.applmgmt.mon.unit.kb_per_sec'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.tx.activity.lo', 'id': 'net.tx.activity.lo', 'instance': 'lo', 'name': 'com.vmware.applmgmt.mon.name.net.tx.activity.lo', 'units': 'com.vmware.applmgmt.mon.unit.kb_per_sec'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.tx.packetRate.eth0', 'id': 'net.tx.packetRate.eth0', 'instance': 'eth0', 'name': 'com.vmware.applmgmt.mon.name.net.tx.packetRate.eth0', 'units': 'com.vmware.applmgmt.mon.unit.packets_per_sec'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.tx.packetRate.lo', 'id': 'net.tx.packetRate.lo', 'instance': 'lo', 'name': 'com.vmware.applmgmt.mon.name.net.tx.packetRate.lo', 'units': 'com.vmware.applmgmt.mon.unit.packets_per_sec'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.tx.drop.eth0', 'id': 'net.tx.drop.eth0', 'instance': 'eth0', 'name': 'com.vmware.applmgmt.mon.name.net.tx.drop.eth0', 'units': 'com.vmware.applmgmt.mon.unit.drops_per_sample'}, {'category': 'com.vmware.applmgmt.mon.cat.network', 'description': 'com.vmware.applmgmt.mon.descr.net.tx.drop.lo', 'id': 'net.tx.drop.lo', 'instance': 'lo', 'name': 'com.vmware.applmgmt.mon.name.net.tx.drop.lo', 'units': 'com.vmware.applmgmt.mon.unit.drops_per_sample'}, {'category': 'com.vmware.applmgmt.mon.cat.storage', 'description': 'com.vmware.applmgmt.mon.descr.storage.util.filesystem.swap', 'id': 'storage.util.filesystem.swap', 'instance': '', 'name': 'com.vmware.applmgmt.mon.name.storage.util.filesystem.swap', 'units': 'com.vmware.applmgmt.mon.unit.percent'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_monitoring_query_module.rst b/docs/vmware.vmware_rest.appliance_monitoring_query_module.rst index 3bf7eae49..27bf8352c 100644 --- a/docs/vmware.vmware_rest.appliance_monitoring_query_module.rst +++ b/docs/vmware.vmware_rest.appliance_monitoring_query_module.rst @@ -273,6 +273,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Query the monitoring backend
+
+
Sample:
+
[{'data': ['', '', '', '', '', '', '', '', '', '', '', '', ''], 'end_time': '2021-04-14T09:34:56.000Z', 'function': 'AVG', 'interval': 'MINUTES5', 'name': 'mem.total', 'start_time': '2021-04-14T08:34:56.000Z'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_dns_domains_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_dns_domains_info_module.rst index 98e06b9fa..e3437c6a8 100644 --- a/docs/vmware.vmware_rest.appliance_networking_dns_domains_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_dns_domains_info_module.rst @@ -172,6 +172,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Get DNS domains configuration
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_dns_domains_module.rst b/docs/vmware.vmware_rest.appliance_networking_dns_domains_module.rst index e82d48214..66baf0ef0 100644 --- a/docs/vmware.vmware_rest.appliance_networking_dns_domains_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_dns_domains_module.rst @@ -229,6 +229,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Add another domain configuration
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_dns_hostname_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_dns_hostname_info_module.rst index c156b6ea3..123c29bb7 100644 --- a/docs/vmware.vmware_rest.appliance_networking_dns_hostname_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_dns_hostname_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Get the hostname configuration
+
+
Sample:
+
vcenter.test
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_dns_hostname_module.rst b/docs/vmware.vmware_rest.appliance_networking_dns_hostname_module.rst index fb4f37206..e1deee534 100644 --- a/docs/vmware.vmware_rest.appliance_networking_dns_hostname_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_dns_hostname_module.rst @@ -208,6 +208,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Test the hostname configuration
+
+
Sample:
+
{'messages': [{'message': 'Hostname vcenter.test resolved using DNS to 192.168.123.8.', 'result': 'success'}], 'status': 'green'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_dns_servers_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_dns_servers_info_module.rst index 108d4cf24..7a28f961b 100644 --- a/docs/vmware.vmware_rest.appliance_networking_dns_servers_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_dns_servers_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get the DNS servers
+
+
Sample:
+
{'mode': 'dhcp', 'servers': ['192.168.123.1']}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_dns_servers_module.rst b/docs/vmware.vmware_rest.appliance_networking_dns_servers_module.rst index 3814757fe..d37c90071 100644 --- a/docs/vmware.vmware_rest.appliance_networking_dns_servers_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_dns_servers_module.rst @@ -265,6 +265,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Add another DNS server
+
+
Sample:
+
{'mode': 'is_static', 'servers': ['1.1.1.1', '192.168.123.1', '8.8.4.4']}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_info_module.rst index f41daa1ca..69031bfbc 100644 --- a/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_info_module.rst @@ -172,6 +172,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Get the firewall inbound configuration
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_module.rst b/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_module.rst index be49cc941..780a57ced 100644 --- a/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_firewall_inbound_module.rst @@ -230,6 +230,53 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ failed_when_result + +
+ integer +
+ 		On success +
Ensure the rules parameter is mandatory
+
+
+
+ msg + +
+ string +
+ 		On success +
Ensure the rules parameter is mandatory
+
+
Sample:
+
missing required arguments: rules
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_info_module.rst index bcd228ca6..21d75be2c 100644 --- a/docs/vmware.vmware_rest.appliance_networking_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get network information
+
+
Sample:
+
{'dns': {'hostname': 'vcenter.test', 'mode': 'DHCP', 'servers': ['192.168.123.1']}, 'interfaces': {'nic0': {'ipv4': {'address': '192.168.123.8', 'configurable': 1, 'default_gateway': '192.168.123.1', 'mode': 'STATIC', 'prefix': 24}, 'ipv6': {'addresses': [{'address': 'fe80::5054:ff:fe70:4823', 'origin': 'OTHER', 'prefix': 64, 'status': 'PREFERRED'}], 'autoconf': 1, 'configurable': 1, 'default_gateway': '', 'dhcp': 0}, 'mac': '52:54:00:70:48:23', 'name': 'nic0', 'status': 'up'}}, 'vcenter_base_url': 'https://vcenter.test:443'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_interfaces_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_interfaces_info_module.rst index 9239790cc..1865a43c6 100644 --- a/docs/vmware.vmware_rest.appliance_networking_interfaces_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_interfaces_info_module.rst @@ -193,6 +193,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
nic0
+
+
+ value + +
+ dictionary +
+ 		On success +
Get details about one network interfaces
+
+
Sample:
+
{'ipv4': {'address': '192.168.123.8', 'configurable': 1, 'default_gateway': '192.168.123.1', 'mode': 'STATIC', 'prefix': 24}, 'ipv6': {'addresses': [{'address': 'fe80::5054:ff:fe70:4823', 'origin': 'OTHER', 'prefix': 64, 'status': 'PREFERRED'}], 'autoconf': 1, 'configurable': 1, 'default_gateway': '', 'dhcp': 0}, 'mac': '52:54:00:70:48:23', 'name': 'nic0', 'status': 'up'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module.rst index bcf5fb229..ae06749e7 100644 --- a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_info_module.rst @@ -189,6 +189,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Collect the IPv4 network information
+
+
Sample:
+
{'address': '192.168.123.8', 'configurable': 1, 'default_gateway': '192.168.123.1', 'mode': 'STATIC', 'prefix': 24}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_module.rst b/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_module.rst index 45c7ff05d..fde23189d 100644 --- a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv4_module.rst @@ -283,6 +283,53 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ failed_when_result + +
+ integer +
+ 		On success +
Set the IPv4 network information of nic99 (which does not exist)
+
+
+
+ msg + +
+ string +
+ 		On success +
Set the IPv4 network information of nic99 (which does not exist)
+
+
Sample:
+
missing required arguments: mode
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module.rst index f0f390149..8a9991f6f 100644 --- a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_info_module.rst @@ -189,6 +189,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Collect the IPv6 network information
+
+
Sample:
+
{'addresses': [{'address': 'fe80::5054:ff:fe70:4823', 'origin': 'OTHER', 'prefix': 64, 'status': 'PREFERRED'}], 'autoconf': 1, 'configurable': 1, 'default_gateway': '', 'dhcp': 0}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_module.rst b/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_module.rst index bdc69d83b..5426cc20b 100644 --- a/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_interfaces_ipv6_module.rst @@ -289,6 +289,53 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ failed_when_result + +
+ integer +
+ 		On success +
Set the IPv6 network information of nic99 (which does not exist)
+
+
+
+ msg + +
+ string +
+ 		On success +
Set the IPv6 network information of nic99 (which does not exist)
+
+
Sample:
+
missing required arguments: addresses, autoconf, default_gateway, dhcp
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_module.rst b/docs/vmware.vmware_rest.appliance_networking_module.rst index c2f405a86..4562354b3 100644 --- a/docs/vmware.vmware_rest.appliance_networking_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_module.rst @@ -211,6 +211,51 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ dictionary +
+ 		On success +
moid of the resource
+
+
+
+ value + +
+ dictionary +
+ 		On success +
Set network information
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_noproxy_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_noproxy_info_module.rst index 3c50e91c8..51e1a82d7 100644 --- a/docs/vmware.vmware_rest.appliance_networking_noproxy_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_noproxy_info_module.rst @@ -172,6 +172,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Remove the noproxy entries
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_noproxy_module.rst b/docs/vmware.vmware_rest.appliance_networking_noproxy_module.rst index 275a1849a..fc47e40d4 100644 --- a/docs/vmware.vmware_rest.appliance_networking_noproxy_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_noproxy_module.rst @@ -214,6 +214,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Remove the noproxy entries
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_proxy_info_module.rst b/docs/vmware.vmware_rest.appliance_networking_proxy_info_module.rst index 649eac16f..a66d640fb 100644 --- a/docs/vmware.vmware_rest.appliance_networking_proxy_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_proxy_info_module.rst @@ -187,6 +187,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get the HTTP proxy configuration
+
+
Sample:
+
{'ftp': {'enabled': 0, 'port': -1, 'server': ''}, 'http': {'enabled': 0, 'port': -1, 'server': ''}, 'https': {'enabled': 0, 'port': -1, 'server': ''}}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_networking_proxy_module.rst b/docs/vmware.vmware_rest.appliance_networking_proxy_module.rst index 959481543..a7e04b6a1 100644 --- a/docs/vmware.vmware_rest.appliance_networking_proxy_module.rst +++ b/docs/vmware.vmware_rest.appliance_networking_proxy_module.rst @@ -339,6 +339,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Delete the HTTP proxy configuration
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_ntp_info_module.rst b/docs/vmware.vmware_rest.appliance_ntp_info_module.rst index 236749f52..b771d44c9 100644 --- a/docs/vmware.vmware_rest.appliance_ntp_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_ntp_info_module.rst @@ -175,6 +175,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Get the NTP configuration
+
+
Sample:
+
['time.nist.gov']
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_ntp_module.rst b/docs/vmware.vmware_rest.appliance_ntp_module.rst index 14c71f1db..fb87a4138 100644 --- a/docs/vmware.vmware_rest.appliance_ntp_module.rst +++ b/docs/vmware.vmware_rest.appliance_ntp_module.rst @@ -215,6 +215,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Test the NTP configuration
+
+
Sample:
+
[{'message': {'args': [], 'default_message': 'NTP Server is reachable.', 'id': 'com.vmware.appliance.ntp_sync.success'}, 'server': 'time.google.com', 'status': 'SERVER_REACHABLE'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_services_info_module.rst b/docs/vmware.vmware_rest.appliance_services_info_module.rst index c5229be69..90f8378c6 100644 --- a/docs/vmware.vmware_rest.appliance_services_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_services_info_module.rst @@ -189,6 +189,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
ntpd
+
+
+ value + +
+ dictionary +
+ 		On success +
Get information about ntpd
+
+
Sample:
+
{'description': 'ntpd.service', 'state': 'STARTED'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_services_module.rst b/docs/vmware.vmware_rest.appliance_services_module.rst index 73482d90b..484e5cd12 100644 --- a/docs/vmware.vmware_rest.appliance_services_module.rst +++ b/docs/vmware.vmware_rest.appliance_services_module.rst @@ -223,6 +223,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Restart the ntpd service
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_shutdown_info_module.rst b/docs/vmware.vmware_rest.appliance_shutdown_info_module.rst index ab1f83fb6..e6e0e0e5b 100644 --- a/docs/vmware.vmware_rest.appliance_shutdown_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_shutdown_info_module.rst @@ -176,6 +176,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get the ongoing shutdown
+
+
Sample:
+
{'action': 'reboot', 'reason': 'this is an example', 'shutdown_time': '2022-11-24T06:12:16.000Z'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_shutdown_module.rst b/docs/vmware.vmware_rest.appliance_shutdown_module.rst index 6622bf7e9..d2b16d3bf 100644 --- a/docs/vmware.vmware_rest.appliance_shutdown_module.rst +++ b/docs/vmware.vmware_rest.appliance_shutdown_module.rst @@ -242,6 +242,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Abort the reboot
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_system_storage_info_module.rst b/docs/vmware.vmware_rest.appliance_system_storage_info_module.rst index 376c6d31a..59d86c925 100644 --- a/docs/vmware.vmware_rest.appliance_system_storage_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_system_storage_info_module.rst @@ -172,6 +172,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Get the appliance storage information
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_system_storage_module.rst b/docs/vmware.vmware_rest.appliance_system_storage_module.rst index 894b90af7..4b32410f0 100644 --- a/docs/vmware.vmware_rest.appliance_system_storage_module.rst +++ b/docs/vmware.vmware_rest.appliance_system_storage_module.rst @@ -197,6 +197,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Resize the first partition and return the state of the partition before and after the operation
+
+
Sample:
+
{'lv_root_0': {'new_size': 104312832, 'old_size': 53985280}}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_system_time_info_module.rst b/docs/vmware.vmware_rest.appliance_system_time_info_module.rst index 264254aec..90b33a6b1 100644 --- a/docs/vmware.vmware_rest.appliance_system_time_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_system_time_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get the current time
+
+
Sample:
+
{'date': 'Wed 11-23-2022', 'seconds_since_epoch': None, 'time': '08:12:27 PM', 'timezone': 'UTC'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_system_time_timezone_info_module.rst b/docs/vmware.vmware_rest.appliance_system_time_timezone_info_module.rst index ef672120a..ce7397dff 100644 --- a/docs/vmware.vmware_rest.appliance_system_time_timezone_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_system_time_timezone_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Get the timezone configuration
+
+
Sample:
+
Etc/UTC
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_system_time_timezone_module.rst b/docs/vmware.vmware_rest.appliance_system_time_timezone_module.rst index 7b4335f56..f3c18e8df 100644 --- a/docs/vmware.vmware_rest.appliance_system_time_timezone_module.rst +++ b/docs/vmware.vmware_rest.appliance_system_time_timezone_module.rst @@ -206,6 +206,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Use the UTC timezone
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_system_version_info_module.rst b/docs/vmware.vmware_rest.appliance_system_version_info_module.rst index 573e38661..66fd273cd 100644 --- a/docs/vmware.vmware_rest.appliance_system_version_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_system_version_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get the VCSA version
+
+
Sample:
+
{'build': '20150588', 'install_time': '2022-09-26T19:22:25.765Z', 'product': 'VMware vCenter Server', 'releasedate': 'July 23, 2022', 'summary': 'Patch for VMware vCenter Server 7.0', 'type': 'vCenter Server with an embedded Platform Services Controller', 'version': '7.0.3.00800'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_timesync_info_module.rst b/docs/vmware.vmware_rest.appliance_timesync_info_module.rst index f85f2b09e..876f14b76 100644 --- a/docs/vmware.vmware_rest.appliance_timesync_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_timesync_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Get information regarding the clock synchronization
+
+
Sample:
+
NTP
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_timesync_module.rst b/docs/vmware.vmware_rest.appliance_timesync_module.rst index 050b045c1..600fb85b7 100644 --- a/docs/vmware.vmware_rest.appliance_timesync_module.rst +++ b/docs/vmware.vmware_rest.appliance_timesync_module.rst @@ -210,6 +210,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Ensure we use NTP
+
+
Sample:
+
NTP
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_update_info_module.rst b/docs/vmware.vmware_rest.appliance_update_info_module.rst index fe61ef82b..b288a6dbb 100644 --- a/docs/vmware.vmware_rest.appliance_update_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_update_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Check if the system is up to date
+
+
Sample:
+
{'state': 'UP_TO_DATE', 'version': '7.0.3.00800'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_vmon_service_info_module.rst b/docs/vmware.vmware_rest.appliance_vmon_service_info_module.rst index 6f6e216a3..d62a3bb74 100644 --- a/docs/vmware.vmware_rest.appliance_vmon_service_info_module.rst +++ b/docs/vmware.vmware_rest.appliance_vmon_service_info_module.rst @@ -189,6 +189,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Get information about a VMON service
+
+
Sample:
+
[{'key': 'analytics', 'value': {'description_key': 'cis.analytics.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.analytics.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'applmgmt', 'value': {'description_key': 'cis.applmgmt.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.applmgmt.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'certificateauthority', 'value': {'description_key': 'cis.certificateauthority.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'certificateathority.health.statuscode'}], 'name_key': 'cis.certificateauthority.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'certificatemanagement', 'value': {'description_key': 'cis.certificatemanagement.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'certificatemanagement.health.statuscode'}], 'name_key': 'cis.certificatemanagement.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'cis-license', 'value': {'description_key': 'cis.cis-license.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'The License Service is operational.', 'id': 'cis.license.health.ok'}], 'name_key': 'cis.cis-license.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'content-library', 'value': {'description_key': 'cis.content-library.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'Database server connection is GREEN.', 'id': 'com.vmware.vdcs.vsphere-cs-lib.db_health_green'}], 'name_key': 'cis.content-library.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'eam', 'value': {'description_key': 'cis.eam.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': '', 'id': 'cis.eam.statusOK'}], 'name_key': 'cis.eam.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'envoy', 'value': {'description_key': 'cis.envoy.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.envoy.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'hvc', 'value': {'description_key': 'cis.hvc.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'hvc.health.statuscode'}], 'name_key': 'cis.hvc.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'imagebuilder', 'value': {'description_key': 'cis.imagebuilder.ServiceDescription', 'name_key': 'cis.imagebuilder.ServiceName', 'startup_type': 'MANUAL', 'state': 'STOPPED'}}, {'key': 'infraprofile', 'value': {'description_key': 'cis.infraprofile.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'infraprofile.health.statuscode'}], 'name_key': 'cis.infraprofile.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'lookupsvc', 'value': {'description_key': 'cis.lookupsvc.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.lookupsvc.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'netdumper', 'value': {'description_key': 'cis.netdumper.ServiceDescription', 'name_key': 'cis.netdumper.ServiceName', 'startup_type': 'MANUAL', 'state': 'STOPPED'}}, {'key': 'observability-vapi', 'value': {'description_key': 'cis.observability-vapi.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'observability.health.statuscode'}], 'name_key': 'cis.observability-vapi.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'perfcharts', 'value': {'description_key': 'cis.perfcharts.ServiceDescription', 'health': 'HEALTHY_WITH_WARNINGS', 'health_messages': [{'args': [], 'default_message': 'health.statsReoptInitalizer.illegalStateEx', 'id': 'health.statsReoptInitalizer.illegalStateEx'}], 'name_key': 'cis.perfcharts.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'pschealth', 'value': {'description_key': 'cis.pschealth.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.pschealth.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'rbd', 'value': {'description_key': 'cis.rbd.ServiceDescription', 'name_key': 'cis.rbd.ServiceName', 'startup_type': 'MANUAL', 'state': 'STOPPED'}}, {'key': 'rhttpproxy', 'value': {'description_key': 'cis.rhttpproxy.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.rhttpproxy.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'sca', 'value': {'description_key': 'cis.sca.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.sca.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'sps', 'value': {'description_key': 'cis.sps.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.sps.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'statsmonitor', 'value': {'description_key': 'cis.statsmonitor.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'Appliance monitoring service is healthy.', 'id': 'com.vmware.applmgmt.mon.health.healthy'}], 'name_key': 'cis.statsmonitor.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'sts', 'value': {'description_key': 'cis.sts.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.sts.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'topologysvc', 'value': {'description_key': 'cis.topologysvc.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'topologysvc.health.statuscode'}], 'name_key': 'cis.topologysvc.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'trustmanagement', 'value': {'description_key': 'cis.trustmanagement.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['GREEN'], 'default_message': 'Health is GREEN', 'id': 'trustmanagement.health.statuscode'}], 'name_key': 'cis.trustmanagement.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'updatemgr', 'value': {'description_key': 'cis.updatemgr.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.updatemgr.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vapi-endpoint', 'value': {'description_key': 'cis.vapi-endpoint.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['2022-11-23T20:10:44UTC', '2022-11-23T20:10:46UTC'], 'default_message': 'Configuration health status is created between 2022-11-23T20:10:44UTC and 2022-11-23T20:10:46UTC.', 'id': 'com.vmware.vapi.endpoint.healthStatusProducedTimes'}], 'name_key': 'cis.vapi-endpoint.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vcha', 'value': {'description_key': 'cis.vcha.ServiceDescription', 'name_key': 'cis.vcha.ServiceName', 'startup_type': 'DISABLED', 'state': 'STOPPED'}}, {'key': 'vlcm', 'value': {'description_key': 'cis.vlcm.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.vlcm.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vmcam', 'value': {'description_key': 'cis.vmcam.ServiceDescription', 'name_key': 'cis.vmcam.ServiceName', 'startup_type': 'MANUAL', 'state': 'STOPPED'}}, {'key': 'vmonapi', 'value': {'description_key': 'cis.vmonapi.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.vmonapi.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vmware-postgres-archiver', 'value': {'description_key': 'cis.vmware-postgres-archiver.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'VMware Archiver service is healthy.', 'id': 'cis.vmware-postgres-archiver.health.healthy'}], 'name_key': 'cis.vmware-postgres-archiver.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vmware-vpostgres', 'value': {'description_key': 'cis.vmware-vpostgres.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'Service vmware-vpostgres is healthy.', 'id': 'cis.vmware-vpostgres.health.healthy'}], 'name_key': 'cis.vmware-vpostgres.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vpxd', 'value': {'description_key': 'cis.vpxd.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': ['vCenter Server', 'GREEN'], 'default_message': '{0} health is {1}', 'id': 'vc.health.statuscode'}, {'args': ['VirtualCenter Database', 'GREEN'], 'default_message': '{0} health is {1}', 'id': 'vc.health.statuscode'}], 'name_key': 'cis.vpxd.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vpxd-svcs', 'value': {'description_key': 'cis.vpxd-svcs.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'Tagging service is in a healthy state', 'id': 'cis.tagging.health.status'}], 'name_key': 'cis.vpxd-svcs.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vsan-health', 'value': {'description_key': 'cis.vsan-health.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.vsan-health.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vsm', 'value': {'description_key': 'cis.vsm.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.vsm.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vsphere-ui', 'value': {'description_key': 'cis.vsphere-ui.ServiceDescription', 'name_key': 'cis.vsphere-ui.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STOPPED'}}, {'key': 'vstats', 'value': {'description_key': 'cis.vstats.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.vstats.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'vtsdb', 'value': {'description_key': 'cis.vtsdb.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [{'args': [], 'default_message': 'Service vtsdb is healthy.', 'id': 'cis.vtsdb.health.healthy'}], 'name_key': 'cis.vtsdb.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}, {'key': 'wcp', 'value': {'description_key': 'cis.wcp.ServiceDescription', 'health': 'HEALTHY', 'health_messages': [], 'name_key': 'cis.wcp.ServiceName', 'startup_type': 'AUTOMATIC', 'state': 'STARTED'}}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.appliance_vmon_service_module.rst b/docs/vmware.vmware_rest.appliance_vmon_service_module.rst index a21a411d7..bbff189ba 100644 --- a/docs/vmware.vmware_rest.appliance_vmon_service_module.rst +++ b/docs/vmware.vmware_rest.appliance_vmon_service_module.rst @@ -231,6 +231,53 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
vpxd
+
+
+ value + +
+ dictionary +
+ 		On success +
Adjust vpxd configuration
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.content_configuration_info_module.rst b/docs/vmware.vmware_rest.content_configuration_info_module.rst index afdc3d632..ff6b937ce 100644 --- a/docs/vmware.vmware_rest.content_configuration_info_module.rst +++ b/docs/vmware.vmware_rest.content_configuration_info_module.rst @@ -172,6 +172,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get the vSphere content syncrhronization configuration
+
+
Sample:
+
{'automatic_sync_enabled': 1, 'automatic_sync_start_hour': 20, 'automatic_sync_stop_hour': 7, 'maximum_concurrent_item_syncs': 5}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.content_configuration_module.rst b/docs/vmware.vmware_rest.content_configuration_module.rst index 44ac13a46..52754ce8f 100644 --- a/docs/vmware.vmware_rest.content_configuration_module.rst +++ b/docs/vmware.vmware_rest.content_configuration_module.rst @@ -253,6 +253,53 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ dictionary +
+ 		On success +
moid of the resource
+
+
+
+ value + +
+ dictionary +
+ 		On success +
Turn on the autmatic syncrhronization
+
+
Sample:
+
{'automatic_sync_enabled': 1, 'automatic_sync_start_hour': 20, 'automatic_sync_stop_hour': 7, 'maximum_concurrent_item_syncs': 5}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.content_library_item_info_module.rst b/docs/vmware.vmware_rest.content_library_item_info_module.rst index 1713749a3..b45b08afa 100644 --- a/docs/vmware.vmware_rest.content_library_item_info_module.rst +++ b/docs/vmware.vmware_rest.content_library_item_info_module.rst @@ -270,6 +270,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Ensure the OVF is here
+
+
Sample:
+
[{'cached': 0, 'content_version': '2', 'creation_time': '2022-11-23T20:06:05.707Z', 'description': 'an OVF example', 'id': 'f6618d6b-301b-4202-aa9c-12eb0c7536b1', 'last_modified_time': '2022-11-23T20:06:06.062Z', 'last_sync_time': '2022-11-23T20:06:06.061Z', 'library_id': '8b4e355e-a463-44f1-9b04-d0786a49cc7d', 'metadata_version': '1', 'name': 'golden_image', 'security_compliance': 1, 'size': 0, 'source_id': '636ef270-b556-4972-924f-0d21b0f3bfce', 'type': 'ovf', 'version': '1'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.content_locallibrary_info_module.rst b/docs/vmware.vmware_rest.content_locallibrary_info_module.rst index 25bcee143..98f8192b9 100644 --- a/docs/vmware.vmware_rest.content_locallibrary_info_module.rst +++ b/docs/vmware.vmware_rest.content_locallibrary_info_module.rst @@ -210,6 +210,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
List all Local Content Library
+
+
Sample:
+
[{'creation_time': '2022-11-23T20:02:22.940Z', 'description': 'automated', 'id': 'a66d5c73-57f8-4a3a-9361-292a55f68516', 'last_modified_time': '2022-11-23T20:02:22.940Z', 'name': 'my_library_on_nfs', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:25.134Z', 'description': 'automated', 'id': '3393956a-43ed-4e7f-bd96-eb39bd604445', 'last_modified_time': '2022-11-23T20:02:25.134Z', 'name': 'my_library_on_nfs_0', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/3393956a-43ed-4e7f-bd96-eb39bd604445/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:26.342Z', 'description': 'automated', 'id': '87f66f86-c046-45a7-9563-d59ea220babf', 'last_modified_time': '2022-11-23T20:02:26.342Z', 'name': 'my_library_on_nfs_1', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/87f66f86-c046-45a7-9563-d59ea220babf/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:27.504Z', 'description': 'automated', 'id': 'f6c590c4-ae6d-4ad0-9362-378196e98a3c', 'last_modified_time': '2022-11-23T20:02:27.504Z', 'name': 'my_library_on_nfs_2', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/f6c590c4-ae6d-4ad0-9362-378196e98a3c/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:28.821Z', 'description': 'automated', 'id': 'e8917499-2a4c-4b70-b39b-ae0caaef89c3', 'last_modified_time': '2022-11-23T20:02:28.821Z', 'name': 'my_library_on_nfs_3', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/e8917499-2a4c-4b70-b39b-ae0caaef89c3/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:30.085Z', 'description': 'automated', 'id': '630ebdfe-8913-45d3-aaa8-9c2fdecbb76b', 'last_modified_time': '2022-11-23T20:02:30.085Z', 'name': 'my_library_on_nfs_4', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/630ebdfe-8913-45d3-aaa8-9c2fdecbb76b/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:31.482Z', 'description': 'automated', 'id': 'a046e2e5-bd55-4d04-9443-750a2ab35a6d', 'last_modified_time': '2022-11-23T20:02:31.482Z', 'name': 'my_library_on_nfs_5', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/a046e2e5-bd55-4d04-9443-750a2ab35a6d/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:32.846Z', 'description': 'automated', 'id': 'b94383b1-7877-4dbd-8c33-51abc39451ff', 'last_modified_time': '2022-11-23T20:02:32.846Z', 'name': 'my_library_on_nfs_6', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/b94383b1-7877-4dbd-8c33-51abc39451ff/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:34.218Z', 'description': 'automated', 'id': '8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00', 'last_modified_time': '2022-11-23T20:02:34.218Z', 'name': 'my_library_on_nfs_7', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:35.922Z', 'description': 'automated', 'id': '0b12c0b3-6c6d-448d-9033-e054a70183e7', 'last_modified_time': '2022-11-23T20:02:35.922Z', 'name': 'my_library_on_nfs_8', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/0b12c0b3-6c6d-448d-9033-e054a70183e7/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:37.796Z', 'description': 'automated', 'id': '46454797-bbe0-415a-9fe9-3cf2f74a14db', 'last_modified_time': '2022-11-23T20:02:37.796Z', 'name': 'my_library_on_nfs_9', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/46454797-bbe0-415a-9fe9-3cf2f74a14db/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, {'creation_time': '2022-11-23T20:02:38.976Z', 'description': 'automated', 'id': '209926aa-e3fe-46a5-95f2-501e82a5139b', 'last_modified_time': '2022-11-23T20:02:38.976Z', 'name': 'my_library_on_nfs_10', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/209926aa-e3fe-46a5-95f2-501e82a5139b/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.content_locallibrary_module.rst b/docs/vmware.vmware_rest.content_locallibrary_module.rst index ffe7d5297..c4219c9ea 100644 --- a/docs/vmware.vmware_rest.content_locallibrary_module.rst +++ b/docs/vmware.vmware_rest.content_locallibrary_module.rst @@ -557,6 +557,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ msg + +
+ string +
+ 		On success +
Delete all the local libraries
+
+
Sample:
+
All items completed
+
+
+ results + +
+ list +
+ 		On success +
Delete all the local libraries
+
+
Sample:
+
[{'_ansible_item_label': {'creation_time': '2022-11-23T20:02:22.940Z', 'description': 'automated', 'id': 'a66d5c73-57f8-4a3a-9361-292a55f68516', 'last_modified_time': '2022-11-23T20:02:22.940Z', 'name': 'my_library_on_nfs', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': 'a66d5c73-57f8-4a3a-9361-292a55f68516', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:22.940Z', 'description': 'automated', 'id': 'a66d5c73-57f8-4a3a-9361-292a55f68516', 'last_modified_time': '2022-11-23T20:02:22.940Z', 'name': 'my_library_on_nfs', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:25.134Z', 'description': 'automated', 'id': '3393956a-43ed-4e7f-bd96-eb39bd604445', 'last_modified_time': '2022-11-23T20:02:25.134Z', 'name': 'my_library_on_nfs_0', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/3393956a-43ed-4e7f-bd96-eb39bd604445/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '3393956a-43ed-4e7f-bd96-eb39bd604445', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:25.134Z', 'description': 'automated', 'id': '3393956a-43ed-4e7f-bd96-eb39bd604445', 'last_modified_time': '2022-11-23T20:02:25.134Z', 'name': 'my_library_on_nfs_0', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/3393956a-43ed-4e7f-bd96-eb39bd604445/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:26.342Z', 'description': 'automated', 'id': '87f66f86-c046-45a7-9563-d59ea220babf', 'last_modified_time': '2022-11-23T20:02:26.342Z', 'name': 'my_library_on_nfs_1', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/87f66f86-c046-45a7-9563-d59ea220babf/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '87f66f86-c046-45a7-9563-d59ea220babf', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:26.342Z', 'description': 'automated', 'id': '87f66f86-c046-45a7-9563-d59ea220babf', 'last_modified_time': '2022-11-23T20:02:26.342Z', 'name': 'my_library_on_nfs_1', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/87f66f86-c046-45a7-9563-d59ea220babf/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:27.504Z', 'description': 'automated', 'id': 'f6c590c4-ae6d-4ad0-9362-378196e98a3c', 'last_modified_time': '2022-11-23T20:02:27.504Z', 'name': 'my_library_on_nfs_2', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/f6c590c4-ae6d-4ad0-9362-378196e98a3c/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': 'f6c590c4-ae6d-4ad0-9362-378196e98a3c', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:27.504Z', 'description': 'automated', 'id': 'f6c590c4-ae6d-4ad0-9362-378196e98a3c', 'last_modified_time': '2022-11-23T20:02:27.504Z', 'name': 'my_library_on_nfs_2', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/f6c590c4-ae6d-4ad0-9362-378196e98a3c/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:28.821Z', 'description': 'automated', 'id': 'e8917499-2a4c-4b70-b39b-ae0caaef89c3', 'last_modified_time': '2022-11-23T20:02:28.821Z', 'name': 'my_library_on_nfs_3', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/e8917499-2a4c-4b70-b39b-ae0caaef89c3/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': 'e8917499-2a4c-4b70-b39b-ae0caaef89c3', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:28.821Z', 'description': 'automated', 'id': 'e8917499-2a4c-4b70-b39b-ae0caaef89c3', 'last_modified_time': '2022-11-23T20:02:28.821Z', 'name': 'my_library_on_nfs_3', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/e8917499-2a4c-4b70-b39b-ae0caaef89c3/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:30.085Z', 'description': 'automated', 'id': '630ebdfe-8913-45d3-aaa8-9c2fdecbb76b', 'last_modified_time': '2022-11-23T20:02:30.085Z', 'name': 'my_library_on_nfs_4', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/630ebdfe-8913-45d3-aaa8-9c2fdecbb76b/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '630ebdfe-8913-45d3-aaa8-9c2fdecbb76b', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:30.085Z', 'description': 'automated', 'id': '630ebdfe-8913-45d3-aaa8-9c2fdecbb76b', 'last_modified_time': '2022-11-23T20:02:30.085Z', 'name': 'my_library_on_nfs_4', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/630ebdfe-8913-45d3-aaa8-9c2fdecbb76b/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:31.482Z', 'description': 'automated', 'id': 'a046e2e5-bd55-4d04-9443-750a2ab35a6d', 'last_modified_time': '2022-11-23T20:02:31.482Z', 'name': 'my_library_on_nfs_5', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/a046e2e5-bd55-4d04-9443-750a2ab35a6d/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': 'a046e2e5-bd55-4d04-9443-750a2ab35a6d', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:31.482Z', 'description': 'automated', 'id': 'a046e2e5-bd55-4d04-9443-750a2ab35a6d', 'last_modified_time': '2022-11-23T20:02:31.482Z', 'name': 'my_library_on_nfs_5', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/a046e2e5-bd55-4d04-9443-750a2ab35a6d/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:32.846Z', 'description': 'automated', 'id': 'b94383b1-7877-4dbd-8c33-51abc39451ff', 'last_modified_time': '2022-11-23T20:02:32.846Z', 'name': 'my_library_on_nfs_6', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/b94383b1-7877-4dbd-8c33-51abc39451ff/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': 'b94383b1-7877-4dbd-8c33-51abc39451ff', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:32.846Z', 'description': 'automated', 'id': 'b94383b1-7877-4dbd-8c33-51abc39451ff', 'last_modified_time': '2022-11-23T20:02:32.846Z', 'name': 'my_library_on_nfs_6', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/b94383b1-7877-4dbd-8c33-51abc39451ff/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:34.218Z', 'description': 'automated', 'id': '8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00', 'last_modified_time': '2022-11-23T20:02:34.218Z', 'name': 'my_library_on_nfs_7', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:34.218Z', 'description': 'automated', 'id': '8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00', 'last_modified_time': '2022-11-23T20:02:34.218Z', 'name': 'my_library_on_nfs_7', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/8e3efb68-cb84-4ce0-a65a-6c94cc6e6e00/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:35.922Z', 'description': 'automated', 'id': '0b12c0b3-6c6d-448d-9033-e054a70183e7', 'last_modified_time': '2022-11-23T20:02:35.922Z', 'name': 'my_library_on_nfs_8', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/0b12c0b3-6c6d-448d-9033-e054a70183e7/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '0b12c0b3-6c6d-448d-9033-e054a70183e7', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:35.922Z', 'description': 'automated', 'id': '0b12c0b3-6c6d-448d-9033-e054a70183e7', 'last_modified_time': '2022-11-23T20:02:35.922Z', 'name': 'my_library_on_nfs_8', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/0b12c0b3-6c6d-448d-9033-e054a70183e7/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:37.796Z', 'description': 'automated', 'id': '46454797-bbe0-415a-9fe9-3cf2f74a14db', 'last_modified_time': '2022-11-23T20:02:37.796Z', 'name': 'my_library_on_nfs_9', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/46454797-bbe0-415a-9fe9-3cf2f74a14db/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '46454797-bbe0-415a-9fe9-3cf2f74a14db', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:37.796Z', 'description': 'automated', 'id': '46454797-bbe0-415a-9fe9-3cf2f74a14db', 'last_modified_time': '2022-11-23T20:02:37.796Z', 'name': 'my_library_on_nfs_9', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/46454797-bbe0-415a-9fe9-3cf2f74a14db/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:02:38.976Z', 'description': 'automated', 'id': '209926aa-e3fe-46a5-95f2-501e82a5139b', 'last_modified_time': '2022-11-23T20:02:38.976Z', 'name': 'my_library_on_nfs_10', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/209926aa-e3fe-46a5-95f2-501e82a5139b/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '209926aa-e3fe-46a5-95f2-501e82a5139b', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:02:38.976Z', 'description': 'automated', 'id': '209926aa-e3fe-46a5-95f2-501e82a5139b', 'last_modified_time': '2022-11-23T20:02:38.976Z', 'name': 'my_library_on_nfs_10', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/209926aa-e3fe-46a5-95f2-501e82a5139b/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'storage_uri': 'nfs://datastore.test/srv/share/content-library', 'type': 'OTHER'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}, {'_ansible_item_label': {'creation_time': '2022-11-23T20:06:02.958Z', 'description': 'automated', 'id': 'de0e9bff-3bae-45d0-a90c-6c2a01dfbe66', 'last_modified_time': '2022-11-23T20:06:02.958Z', 'name': 'local_library_001', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/de0e9bff-3bae-45d0-a90c-6c2a01dfbe66/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'datastore_id': 'datastore-1065', 'type': 'DATASTORE'}], 'type': 'LOCAL', 'version': '2'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': 'de0e9bff-3bae-45d0-a90c-6c2a01dfbe66', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'subscriptions': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:06:02.958Z', 'description': 'automated', 'id': 'de0e9bff-3bae-45d0-a90c-6c2a01dfbe66', 'last_modified_time': '2022-11-23T20:06:02.958Z', 'name': 'local_library_001', 'publish_info': {'authentication_method': 'NONE', 'persist_json_enabled': 0, 'publish_url': 'https://vcenter.test:443/cls/vcsp/lib/de0e9bff-3bae-45d0-a90c-6c2a01dfbe66/lib.json', 'published': 1, 'user_name': 'vcsp'}, 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'datastore_id': 'datastore-1065', 'type': 'DATASTORE'}], 'type': 'LOCAL', 'version': '2'}, 'value': {}}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.content_subscribedlibrary_info_module.rst b/docs/vmware.vmware_rest.content_subscribedlibrary_info_module.rst index 5d2ad75c1..4a90cfdab 100644 --- a/docs/vmware.vmware_rest.content_subscribedlibrary_info_module.rst +++ b/docs/vmware.vmware_rest.content_subscribedlibrary_info_module.rst @@ -187,6 +187,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
List Subscribed Content Library
+
+
Sample:
+
[{'creation_time': '2022-11-23T20:06:05.189Z', 'description': '', 'id': '8b4e355e-a463-44f1-9b04-d0786a49cc7d', 'last_modified_time': '2022-11-23T20:06:05.189Z', 'last_sync_time': '2022-11-23T20:06:07.717Z', 'name': 'sub_lib', 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'datastore_id': 'datastore-1065', 'type': 'DATASTORE'}], 'subscription_info': {'authentication_method': 'NONE', 'automatic_sync_enabled': 0, 'on_demand': 1, 'subscription_url': 'https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json'}, 'type': 'SUBSCRIBED', 'version': '4'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.content_subscribedlibrary_module.rst b/docs/vmware.vmware_rest.content_subscribedlibrary_module.rst index d7e6b92ad..17f25ebe8 100644 --- a/docs/vmware.vmware_rest.content_subscribedlibrary_module.rst +++ b/docs/vmware.vmware_rest.content_subscribedlibrary_module.rst @@ -539,6 +539,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ msg + +
+ string +
+ 		On success +
Delete all the subscribed libraries
+
+
Sample:
+
All items completed
+
+
+ results + +
+ list +
+ 		On success +
Delete all the subscribed libraries
+
+
Sample:
+
[{'_ansible_item_label': {'creation_time': '2022-11-23T20:06:05.189Z', 'description': '', 'id': '8b4e355e-a463-44f1-9b04-d0786a49cc7d', 'last_modified_time': '2022-11-23T20:06:05.189Z', 'last_sync_time': '2022-11-23T20:06:07.717Z', 'name': 'sub_lib', 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'datastore_id': 'datastore-1065', 'type': 'DATASTORE'}], 'subscription_info': {'authentication_method': 'NONE', 'automatic_sync_enabled': 0, 'on_demand': 1, 'subscription_url': 'https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json'}, 'type': 'SUBSCRIBED', 'version': '4'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'client_token': None, 'creation_time': None, 'description': None, 'id': None, 'last_modified_time': None, 'last_sync_time': None, 'library_id': '8b4e355e-a463-44f1-9b04-d0786a49cc7d', 'name': None, 'optimization_info': None, 'publish_info': None, 'server_guid': None, 'session_timeout': None, 'state': 'absent', 'storage_backings': None, 'subscription_info': None, 'type': None, 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'version': None}}, 'item': {'creation_time': '2022-11-23T20:06:05.189Z', 'description': '', 'id': '8b4e355e-a463-44f1-9b04-d0786a49cc7d', 'last_modified_time': '2022-11-23T20:06:05.189Z', 'last_sync_time': '2022-11-23T20:06:07.717Z', 'name': 'sub_lib', 'server_guid': '52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5', 'storage_backings': [{'datastore_id': 'datastore-1065', 'type': 'DATASTORE'}], 'subscription_info': {'authentication_method': 'NONE', 'automatic_sync_enabled': 0, 'on_demand': 1, 'subscription_url': 'https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json'}, 'type': 'SUBSCRIBED', 'version': '4'}, 'value': {}}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_cluster_info_module.rst b/docs/vmware.vmware_rest.vcenter_cluster_info_module.rst index 55338a216..879f9b5e6 100644 --- a/docs/vmware.vmware_rest.vcenter_cluster_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_cluster_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_cluster_info **Retrieves information about the cluster corresponding to cluster.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -267,6 +267,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
domain-c1006
+
+
+ value + +
+ dictionary +
+ 		On success +
Retrieve details about the first cluster
+
+
Sample:
+
{'name': 'my_cluster', 'resource_pool': 'resgroup-1007'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_datacenter_info_module.rst b/docs/vmware.vmware_rest.vcenter_datacenter_info_module.rst index de4819c58..fc896abe1 100644 --- a/docs/vmware.vmware_rest.vcenter_datacenter_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_datacenter_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_datacenter_info **Retrieves information about the datacenter corresponding to datacenter.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -233,8 +233,52 @@ Notes +Examples +-------- + +.. code-block:: yaml + + - name: Get a list of all the datacenters + register: existing_datacenters + vmware.vmware_rest.vcenter_datacenter_info: + + - name: collect a list of the datacenters + vmware.vmware_rest.vcenter_datacenter_info: + register: my_datacenters + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
collect a list of the datacenters
+
+
Sample:
+
[{'datacenter': 'datacenter-1001', 'name': 'my_dc'}]
+
+

Status diff --git a/docs/vmware.vmware_rest.vcenter_datacenter_module.rst b/docs/vmware.vmware_rest.vcenter_datacenter_module.rst index 4c93ae9ce..68c9d7bac 100644 --- a/docs/vmware.vmware_rest.vcenter_datacenter_module.rst +++ b/docs/vmware.vmware_rest.vcenter_datacenter_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_datacenter **Create a new datacenter in the vCenter inventory** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -247,8 +247,78 @@ Notes +Examples +-------- + +.. code-block:: yaml + + - name: Get a list of all the datacenters + register: existing_datacenters + vmware.vmware_rest.vcenter_datacenter_info: + - name: Force delete the existing DC + vmware.vmware_rest.vcenter_datacenter: + state: absent + datacenter: '{{ item.datacenter }}' + force: true + with_items: '{{ existing_datacenters.value }}' + until: + - _result is not failed + retries: 7 + - name: Create datacenter my_dc + vmware.vmware_rest.vcenter_datacenter: + name: my_dc + folder: '{{ my_datacenter_folder.folder }}' + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ msg + +
+ string +
+ 		On success +
Force delete the existing DC
+
+
Sample:
+
All items completed
+
+
+ results + +
+ list +
+ 		On success +
Force delete the existing DC
+
+
Sample:
+
[{'_ansible_item_label': {'datacenter': 'datacenter-1001', 'name': 'my_dc'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'attempts': 1, 'changed': 1, 'failed': 0, 'invocation': {'module_args': {'datacenter': 'datacenter-1001', 'folder': None, 'force': 1, 'name': None, 'session_timeout': None, 'state': 'absent', 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0}}, 'item': {'datacenter': 'datacenter-1001', 'name': 'my_dc'}, 'value': {}}]
+
+

Status diff --git a/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst b/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst index 89ddd7ec2..4fa040e6c 100644 --- a/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_datastore_info **Retrieves information about the datastore indicated by datastore.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -280,6 +280,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Build a list of all the datastores
+
+
Sample:
+
[{'capacity': 11542724608, 'datastore': 'datastore-1015', 'free_space': 10033823744, 'name': 'local', 'type': 'VMFS'}, {'capacity': 42314215424, 'datastore': 'datastore-1017', 'free_space': 40374927360, 'name': 'ro_datastore', 'type': 'NFS'}, {'capacity': 42314215424, 'datastore': 'datastore-1019', 'free_space': 40374927360, 'name': 'rw_datastore', 'type': 'NFS'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_folder_info_module.rst b/docs/vmware.vmware_rest.vcenter_folder_info_module.rst index 13c226035..99bcff22a 100644 --- a/docs/vmware.vmware_rest.vcenter_folder_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_folder_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_folder_info **Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -276,6 +276,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Build a list of all the folders with the type VIRTUAL_MACHINE and called vm
+
+
Sample:
+
[{'folder': 'group-v1002', 'name': 'vm', 'type': 'VIRTUAL_MACHINE'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_host_info_module.rst b/docs/vmware.vmware_rest.vcenter_host_info_module.rst index 3c55a54ca..cf4a17c78 100644 --- a/docs/vmware.vmware_rest.vcenter_host_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_host_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_host_info **Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -290,8 +290,48 @@ Notes +Examples +-------- + +.. code-block:: yaml + + - name: Get a list of the hosts + vmware.vmware_rest.vcenter_host_info: + register: my_hosts + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Get a list of the hosts
+
+
Sample:
+
[{'connection_state': 'CONNECTED', 'host': 'host-1013', 'name': 'esxi1.test', 'power_state': 'POWERED_ON'}]
+
+

Status diff --git a/docs/vmware.vmware_rest.vcenter_host_module.rst b/docs/vmware.vmware_rest.vcenter_host_module.rst index d0382d553..e03c304aa 100644 --- a/docs/vmware.vmware_rest.vcenter_host_module.rst +++ b/docs/vmware.vmware_rest.vcenter_host_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_host **Add a new standalone host in the vCenter inventory** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -330,8 +330,52 @@ Notes +Examples +-------- + +.. code-block:: yaml + + - name: Connect the host(s) + vmware.vmware_rest.vcenter_host: + hostname: "{{ lookup('env', 'ESXI1_HOSTNAME') }}" + user_name: "{{ lookup('env', 'ESXI1_USERNAME') }}" + password: "{{ lookup('env', 'ESXI1_PASSWORD') }}" + thumbprint_verification: NONE + folder: '{{ my_host_folder.folder }}' + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ string +
+ 		On success +
Connect the host(s)
+
+
Sample:
+
host-1013
+
+

Status diff --git a/docs/vmware.vmware_rest.vcenter_network_info_module.rst b/docs/vmware.vmware_rest.vcenter_network_info_module.rst index 9f6ab13f7..edf435da0 100644 --- a/docs/vmware.vmware_rest.vcenter_network_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_network_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_network_info **Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -266,6 +266,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Get a list of the networks
+
+
Sample:
+
[{'name': 'VM Network', 'network': 'network-1016', 'type': 'STANDARD_PORTGROUP'}, {'name': 'second_vswitch', 'network': 'network-1018', 'type': 'STANDARD_PORTGROUP'}, {'name': 'dvswitch1-DVUplinks-1020', 'network': 'dvportgroup-1021', 'type': 'DISTRIBUTED_PORTGROUP'}, {'name': 'my portrgoup', 'network': 'dvportgroup-1022', 'type': 'DISTRIBUTED_PORTGROUP'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_ovf_libraryitem_module.rst b/docs/vmware.vmware_rest.vcenter_ovf_libraryitem_module.rst index 652be2e9d..76f36b677 100644 --- a/docs/vmware.vmware_rest.vcenter_ovf_libraryitem_module.rst +++ b/docs/vmware.vmware_rest.vcenter_ovf_libraryitem_module.rst @@ -383,6 +383,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Create a new VM from the OVF and specify the host and folder
+
+
Sample:
+
{'error': {'errors': [], 'information': [], 'warnings': []}, 'resource_id': {'id': 'vm-1078', 'type': 'VirtualMachine'}, 'succeeded': 1}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_resourcepool_info_module.rst b/docs/vmware.vmware_rest.vcenter_resourcepool_info_module.rst index 86993fb8d..c2a833d59 100644 --- a/docs/vmware.vmware_rest.vcenter_resourcepool_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_resourcepool_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_resourcepool_info **Retrieves information about the resource pool indicated by resourcePool.** -Version added: 2.0.0 +Version added: 0.3.0 .. contents:: :local: @@ -286,8 +286,78 @@ Notes +Examples +-------- + +.. code-block:: yaml + + - name: Get the existing resource pools + vmware.vmware_rest.vcenter_resourcepool_info: + register: resource_pools + - name: Get the existing resource pool + vmware.vmware_rest.vcenter_resourcepool_info: + resource_pool: '{{ resource_pools.value[0].resource_pool }}' + register: my_resource_pool + - name: Create a generic resource pool + vmware.vmware_rest.vcenter_resourcepool: + name: my_resource_pool + parent: '{{ resource_pools.value[0].resource_pool }}' + register: my_resource_pool + - name: Read details from a specific resource pool + vmware.vmware_rest.vcenter_resourcepool_info: + resource_pool: '{{ my_resource_pool.id }}' + register: my_resource_pool + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
resgroup-1009
+
+
+ value + +
+ dictionary +
+ 		On success +
Read details from a specific resource pool
+
+
Sample:
+
{'cpu_allocation': {'expandable_reservation': 1, 'limit': -1, 'reservation': 0, 'shares': {'level': 'NORMAL'}}, 'memory_allocation': {'expandable_reservation': 0, 'limit': 1000, 'reservation': 0, 'shares': {'level': 'NORMAL'}}, 'name': 'my_resource_pool', 'resource_pools': []}
+
+

Status diff --git a/docs/vmware.vmware_rest.vcenter_resourcepool_module.rst b/docs/vmware.vmware_rest.vcenter_resourcepool_module.rst index aa40b2444..6383e31ee 100644 --- a/docs/vmware.vmware_rest.vcenter_resourcepool_module.rst +++ b/docs/vmware.vmware_rest.vcenter_resourcepool_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_resourcepool **Creates a resource pool.** -Version added: 2.0.0 +Version added: 0.3.0 .. contents:: :local: @@ -297,8 +297,106 @@ Notes +Examples +-------- + +.. code-block:: yaml + + - name: Get the existing resource pools + vmware.vmware_rest.vcenter_resourcepool_info: + register: resource_pools + - name: Create an Ad hoc resource pool + vmware.vmware_rest.vcenter_resourcepool: + name: my_resource_pool + parent: '{{ resource_pools.value[0].resource_pool }}' + cpu_allocation: + expandable_reservation: true + limit: 40 + reservation: 0 + shares: + level: NORMAL + memory_allocation: + expandable_reservation: false + limit: 2000 + reservation: 0 + shares: + level: NORMAL + register: my_resource_pool + - name: Remove a resource pool + vmware.vmware_rest.vcenter_resourcepool: + resource_pool: '{{ my_resource_pool.id }}' + state: absent + - name: Create a generic resource pool + vmware.vmware_rest.vcenter_resourcepool: + name: my_resource_pool + parent: '{{ resource_pools.value[0].resource_pool }}' + register: my_resource_pool + - name: Modify a resource pool + vmware.vmware_rest.vcenter_resourcepool: + resource_pool: '{{ my_resource_pool.id }}' + cpu_allocation: + expandable_reservation: true + limit: -1 + reservation: 0 + shares: + level: NORMAL + memory_allocation: + expandable_reservation: false + limit: 1000 + reservation: 0 + shares: + level: NORMAL + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
resgroup-1009
+
+
+ value + +
+ dictionary +
+ 		On success +
Create a generic resource pool
+
+
Sample:
+
{'cpu_allocation': {'expandable_reservation': 1, 'limit': -1, 'reservation': 0, 'shares': {'level': 'NORMAL'}}, 'memory_allocation': {'expandable_reservation': 1, 'limit': -1, 'reservation': 0, 'shares': {'level': 'NORMAL'}}, 'name': 'my_resource_pool', 'resource_pools': []}
+
+

Status diff --git a/docs/vmware.vmware_rest.vcenter_storage_policies_info_module.rst b/docs/vmware.vmware_rest.vcenter_storage_policies_info_module.rst index 18af89ddb..59c953224 100644 --- a/docs/vmware.vmware_rest.vcenter_storage_policies_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_storage_policies_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_storage_policies_info **Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter** -Version added: 2.0.0 +Version added: 0.3.0 .. contents:: :local: @@ -190,6 +190,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
List existing storage policies
+
+
Sample:
+
[{'description': 'Management Storage policy used for VMC large cluster', 'name': 'Management Storage Policy - Large', 'policy': 'cd8f7c94-3e11-67fc-17f5-4e96d91a5beb'}, {'description': 'Allow the datastore to determine the best placement strategy for storage objects', 'name': 'VVol No Requirements Policy', 'policy': 'f4e5bade-15a2-4805-bf8e-52318c4ce443'}, {'description': 'Management Storage policy used for smaller VMC Stretched Cluster configuration.', 'name': 'Management Storage Policy - Stretched Lite', 'policy': 'd109de24-c966-428f-8da2-d281e6671e35'}, {'description': "Sample storage policy for VMware's VM and virtual disk encryption", 'name': 'VM Encryption Policy', 'policy': '4d5f673c-536f-11e6-beb8-9e71128cae77'}, {'description': 'Management Storage policy used for encrypting VM', 'name': 'Management Storage policy - Encryption', 'policy': 'b1263970-8662-69e2-adc6-fa8ae01abecc'}, {'description': 'Management Storage policy used for VMC single node cluster', 'name': 'Management Storage Policy - Single Node', 'policy': 'a9423670-7455-11e8-adc0-fa7ae01bbebc'}, {'description': 'Storage policy used as default for Host-local PMem datastores', 'name': 'Host-local PMem Default Storage Policy', 'policy': 'c268da1b-b343-49f7-a468-b1deeb7078e0'}, {'description': 'Storage policy used as default for vSAN datastores', 'name': 'vSAN Default Storage Policy', 'policy': 'aa6d5a82-1c88-45da-85d3-3d74b91a5bad'}, {'description': 'Management Storage policy used for VMC regular cluster', 'name': 'Management Storage Policy - Regular', 'policy': 'bb7e6b13-2d99-46eb-96e4-3d85c91a5bde'}, {'description': 'Management Storage policy used for VMC regular cluster which requires THIN provisioning', 'name': 'Management Storage policy - Thin', 'policy': 'b6423670-8552-66e8-adc1-fa6ae01abeac'}, {'description': 'Management Storage policy used for VMC stretched cluster', 'name': 'Management Storage Policy - Stretched', 'policy': 'f31f2442-8247-4517-87c2-8d69d7a6c696'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_customization_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_customization_module.rst index 4ddfc2e87..65b62d24d 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_customization_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_guest_customization_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_guest_customization **Applies a customization specification on the virtual machine** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -337,6 +337,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Customize the VM
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_identity_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_identity_info_module.rst index fabcefc4e..a123db8bb 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_identity_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_guest_identity_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_guest_identity_info **Return information about the guest.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -200,6 +200,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get guest identity information
+
+
Sample:
+
{'family': 'LINUX', 'full_name': {'args': [], 'default_message': 'Red Hat Fedora (64-bit)', 'id': 'vmsg.guestos.fedora64Guest.label'}, 'host_name': 'localhost.localdomain', 'name': 'FEDORA_64'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module.rst index df70ced51..6fd66d8d6 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_guest_localfilesystem_info **Returns details of the local file systems in the guest operating system.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -204,6 +204,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get guest filesystem information
+
+
Sample:
+
{'/': {'capacity': 2515173376, 'free_space': 774787072, 'mappings': []}}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_networking_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_networking_info_module.rst index 6c409da3b..0683b64e2 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_networking_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_guest_networking_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_guest_networking_info **Returns information about the network configuration in the guest operating system.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -200,6 +200,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get guest networking information
+
+
Sample:
+
{'dns': {'ip_addresses': ['10.0.2.3'], 'search_domains': ['localdomain']}, 'dns_values': {'domain_name': 'localdomain', 'host_name': 'localhost.localdomain'}}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module.rst index 50969741b..9d54f8bcf 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_guest_networking_interfaces_info **Returns information about the networking interfaces in the guest operating system.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -200,6 +200,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Get guest network interfaces information
+
+
Sample:
+
[{'ip': {'ip_addresses': []}, 'mac_address': '00:50:56:b1:33:76', 'nic': '4000'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module.rst index aebfaa0b7..46aebcdb0 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_guest_networking_routes_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_guest_networking_routes_info **Returns information about network routing in the guest operating system.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -200,6 +200,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Get guest network routes information
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_power_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_power_info_module.rst index d9cb9cbb6..57c211d9e 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_power_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_guest_power_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_guest_power_info **Returns information about the guest operating system power state.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -221,6 +221,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Read the power status of the VM
+
+
Sample:
+
{'operations_ready': 0, 'state': 'NOT_RUNNING'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_guest_power_module.rst b/docs/vmware.vmware_rest.vcenter_vm_guest_power_module.rst index 0de0a6c99..84f3346b3 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_guest_power_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_guest_power_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_guest_power **Issues a request to the guest operating system asking it to perform a soft shutdown, standby (suspend) or soft reboot** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -251,6 +251,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Shut down the VM
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module.rst index 4ecd39c12..29762340b 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info **Returns information about a virtual SATA adapter.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -236,6 +236,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
15000
+
+
+ value + +
+ dictionary +
+ 		On success +
Get information about a specific controller
+
+
Sample:
+
{'bus': 0, 'label': 'SATA controller 0', 'pci_slot_number': 34, 'type': 'AHCI'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module.rst index ad9c35fdb..945a6e42b 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_adapter_sata **Adds a virtual SATA adapter to the virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -307,6 +307,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
15000
+
+
+ value + +
+ dictionary +
+ 		On success +
Create a SATA adapter at PCI slot 34
+
+
Sample:
+
{'bus': 0, 'label': 'SATA controller 0', 'pci_slot_number': 34, 'type': 'AHCI'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module.rst index 1c761b948..52ae8f07f 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_info **Returns information about a virtual SCSI adapter.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -232,6 +232,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
List the SCSI adapter of a given VM
+
+
Sample:
+
[{'adapter': '1000'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module.rst index 67b4f1749..aae1344b9 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi **Adds a virtual SCSI adapter to the virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -331,6 +331,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
1000
+
+
+ value + +
+ dictionary +
+ 		On success +
Create a SCSI adapter at PCI slot 35
+
+
Sample:
+
{'label': 'SCSI controller 0', 'pci_slot_number': 35, 'scsi': {'bus': 0, 'unit': 7}, 'sharing': 'NONE', 'type': 'PVSCSI'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module.rst index 5b0441205..3f2b048b5 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_boot_device_info **Returns an ordered list of boot devices for the virtual machine** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -205,6 +205,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Get information about the boot device
+
+
Sample:
+
[{'type': 'CDROM'}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_module.rst index f08697f36..6aff2733f 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_device_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_boot_device **Sets the virtual devices that will be used to boot the virtual machine** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -251,6 +251,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Set a boot device
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_info_module.rst index 417ada2fe..0b8e28183 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_boot_info **Returns the boot-related settings of a virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -199,6 +199,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Retrieve the boot information from the VM
+
+
Sample:
+
{'delay': 0, 'enter_setup_mode': 0, 'retry': 0, 'retry_delay': 10000, 'type': 'BIOS'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_module.rst index 7b1b9fd5a..3d87bf1ec 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_boot_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_boot **Updates the boot-related settings of a virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -350,6 +350,51 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ dictionary +
+ 		On success +
moid of the resource
+
+
+
+ value + +
+ dictionary +
+ 		On success +
Change a VM boot parameters
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module.rst index 92adb7f61..ead0e0aa7 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_cdrom_info **Returns information about a virtual CD-ROM device.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -232,6 +232,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
List the cdrom devices on the guest
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_module.rst index c9007a637..f83db83d7 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_cdrom_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_cdrom **Adds a virtual CD-ROM device to the virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -393,6 +393,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
16002
+
+
+ value + +
+ dictionary +
+ 		On success +
Attach an ISO image to a guest VM
+
+
Sample:
+
{'allow_guest_control': 0, 'backing': {'iso_file': '[ro_datastore] fedora.iso', 'type': 'ISO_FILE'}, 'label': 'CD/DVD drive 1', 'sata': {'bus': 0, 'unit': 2}, 'start_connected': 1, 'state': 'NOT_CONNECTED', 'type': 'SATA'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module.rst index 2d164be93..39768d877 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_cpu_info **Returns the CPU-related settings of a virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -200,6 +200,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Retrieve the CPU information from the VM
+
+
Sample:
+
{'cores_per_socket': 1, 'count': 1, 'hot_add_enabled': 0, 'hot_remove_enabled': 0}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_module.rst index 40c338d3c..e6593b755 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_cpu_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_cpu **Updates the CPU-related settings of a virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -299,6 +299,53 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ dictionary +
+ 		On success +
moid of the resource
+
+
+
+ value + +
+ dictionary +
+ 		On success +
Dedicate one core to the VM
+
+
Sample:
+
{'cores_per_socket': 1, 'count': 1, 'hot_add_enabled': 0, 'hot_remove_enabled': 0}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_info_module.rst index 6a9d4f30a..748e08588 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_disk_info **Returns information about a virtual disk.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -238,6 +238,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
2000
+
+
+ value + +
+ dictionary +
+ 		On success +
Retrieve disk information using the label
+
+
Sample:
+
{'backing': {'type': 'VMDK_FILE', 'vmdk_file': '[local] test_vm1/test_vm1.vmdk'}, 'capacity': 17179869184, 'label': 'Hard disk 1', 'scsi': {'bus': 0, 'unit': 0}, 'type': 'SCSI'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_module.rst index a038eaf59..e0c81c96c 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_disk_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_disk **Adds a virtual disk to the virtual machine** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -414,6 +414,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
16000
+
+
+ value + +
+ dictionary +
+ 		On success +
Create a new disk
+
+
Sample:
+
{'backing': {'type': 'VMDK_FILE', 'vmdk_file': '[local] test_vm1/test_vm1_1.vmdk'}, 'capacity': 320000, 'label': 'Hard disk 2', 'sata': {'bus': 0, 'unit': 0}, 'type': 'SATA'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module.rst index ad7bc981f..a90d2c37b 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_ethernet_info **Returns information about a virtual Ethernet adapter.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -237,6 +237,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Collect a list of the NIC for a given VM
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_module.rst index 9144a956b..48054ae87 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_ethernet_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_ethernet **Adds a virtual Ethernet adapter to the virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -500,6 +500,69 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ content generated by the update_return_section callback# task + +
+ - +
+ 		+
+
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
4000
+
+
+ value + +
+ dictionary +
+ 		On success +
Attach a VM to a dvswitch
+
+
Sample:
+
{'allow_guest_control': 0, 'backing': {'connection_cookie': 632732945, 'distributed_port': '2', 'distributed_switch_uuid': '50 31 d3 c4 2d 09 4f e3-0f d6 7f 30 3d fe d4 a0', 'network': 'dvportgroup-1022', 'type': 'DISTRIBUTED_PORTGROUP'}, 'label': 'Network adapter 1', 'mac_address': '00:50:56:b1:33:76', 'mac_type': 'ASSIGNED', 'pci_slot_number': 4, 'start_connected': 0, 'state': 'NOT_CONNECTED', 'type': 'VMXNET3', 'upt_compatibility_enabled': 0, 'wake_on_lan_enabled': 0}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module.rst index 3d1c61e1a..acd1d7efc 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_floppy_info **Returns information about a virtual floppy drive.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -232,6 +232,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
List the floppy disk drives
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_module.rst index b03bb53cf..1a04cbd9f 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_floppy_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_floppy **Adds a virtual floppy drive to the virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -327,6 +327,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
8000
+
+
+ value + +
+ dictionary +
+ 		On success +
Add a floppy disk drive
+
+
Sample:
+
{'allow_guest_control': 1, 'backing': {'auto_detect': 1, 'host_device': '', 'type': 'HOST_DEVICE'}, 'label': 'Floppy drive 1', 'start_connected': 0, 'state': 'NOT_CONNECTED'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_info_module.rst index 44f41103c..a99fc6956 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_info **Returns the virtual hardware settings of a virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -195,6 +195,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Collect the hardware information
+
+
Sample:
+
{'upgrade_policy': 'NEVER', 'upgrade_status': 'NONE', 'version': 'VMX_10'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst index d730587e2..15fafb532 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_memory_info **Returns the memory-related settings of a virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -200,6 +200,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Retrieve the memory information from the VM
+
+
Sample:
+
{'hot_add_enabled': 1, 'size_MiB': 1024}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_module.rst index 204302446..c42d8e5d2 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_memory_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_memory **Updates the memory-related settings of a virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -263,6 +263,51 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ dictionary +
+ 		On success +
moid of the resource
+
+
+
+ value + +
+ dictionary +
+ 		On success +
Increase the memory of a VM
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_module.rst index 8c6e79f32..142648ab0 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware **Updates the virtual hardware settings of a virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -296,6 +296,51 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ dictionary +
+ 		On success +
moid of the resource
+
+
+
+ value + +
+ dictionary +
+ 		On success +
Upgrade the VM hardware version
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module.rst index 58af7b4bb..216e1717e 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_parallel_info **Returns information about a virtual parallel port.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -232,6 +232,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ list +
+ 		On success +
Retrieve the parallel port information from the VM
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_module.rst index 4332a7a70..cc8acbfec 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_parallel_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_parallel **Adds a virtual parallel port to the virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -319,6 +319,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
10000
+
+
+ value + +
+ dictionary +
+ 		On success +
Turn on guest control on the parallel port
+
+
Sample:
+
{'allow_guest_control': 1, 'backing': {'auto_detect': 1, 'host_device': '', 'type': 'HOST_DEVICE'}, 'label': 'Parallel port 1', 'start_connected': 0, 'state': 'NOT_CONNECTED'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_info_module.rst index 90e23174a..2749aecf1 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_serial_info **Returns information about a virtual serial port.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -238,6 +238,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
9000
+
+
+ value + +
+ dictionary +
+ 		On success +
Get an existing serial port (label)
+
+
Sample:
+
{'allow_guest_control': 1, 'backing': {'auto_detect': 1, 'host_device': '', 'type': 'HOST_DEVICE'}, 'label': 'Serial port 1', 'start_connected': 0, 'state': 'NOT_CONNECTED', 'yield_on_poll': 0}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_module.rst b/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_module.rst index 576c6e25c..e04e688ae 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_hardware_serial_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_hardware_serial **Adds a virtual serial port to the virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -393,6 +393,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
9000
+
+
+ value + +
+ dictionary +
+ 		On success +
Create an existing serial port (label)
+
+
Sample:
+
{'allow_guest_control': 1, 'backing': {'auto_detect': 1, 'host_device': '', 'type': 'HOST_DEVICE'}, 'label': 'Serial port 1', 'start_connected': 0, 'state': 'NOT_CONNECTED', 'yield_on_poll': 0}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_info_module.rst index b3296f092..512177c81 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_info **Returns information about a virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -388,6 +388,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
vm-1049
+
+
+ value + +
+ dictionary +
+ 		On success +
Wait until my VM is off
+
+
Sample:
+
{'boot': {'delay': 0, 'enter_setup_mode': 0, 'retry': 0, 'retry_delay': 10000, 'type': 'BIOS'}, 'boot_devices': [], 'cdroms': {'16002': {'allow_guest_control': 0, 'backing': {'auto_detect': 1, 'device_access_type': 'EMULATION', 'type': 'HOST_DEVICE'}, 'label': 'CD/DVD drive 1', 'sata': {'bus': 0, 'unit': 2}, 'start_connected': 0, 'state': 'NOT_CONNECTED', 'type': 'SATA'}}, 'cpu': {'cores_per_socket': 1, 'count': 1, 'hot_add_enabled': 0, 'hot_remove_enabled': 0}, 'disks': {'16000': {'backing': {'type': 'VMDK_FILE', 'vmdk_file': '[local] test_vm1/rhel-8.5.vmdk'}, 'capacity': 16106127360, 'label': 'Hard disk 1', 'sata': {'bus': 0, 'unit': 0}, 'type': 'SATA'}, '16001': {'backing': {'type': 'VMDK_FILE', 'vmdk_file': '[local] test_vm1_1/second_disk.vmdk'}, 'capacity': 32000000000, 'label': 'Hard disk 2', 'sata': {'bus': 0, 'unit': 1}, 'type': 'SATA'}}, 'floppies': {}, 'guest_OS': 'RHEL_7_64', 'hardware': {'upgrade_policy': 'NEVER', 'upgrade_status': 'NONE', 'version': 'VMX_11'}, 'identity': {'bios_uuid': '4231943a-a1b5-9d24-1e05-d447e9ff0396', 'instance_uuid': '5031e081-01a7-d61a-31f8-4bc54057ec60', 'name': 'test_vm1'}, 'instant_clone_frozen': 0, 'memory': {'hot_add_enabled': 1, 'size_MiB': 1024}, 'name': 'test_vm1', 'nics': {'4000': {'allow_guest_control': 0, 'backing': {'network': 'network-1041', 'network_name': 'VM Network', 'type': 'STANDARD_PORTGROUP'}, 'label': 'Network adapter 1', 'mac_address': '00:50:56:b1:22:7d', 'mac_type': 'ASSIGNED', 'pci_slot_number': 160, 'start_connected': 0, 'state': 'NOT_CONNECTED', 'type': 'VMXNET3', 'upt_compatibility_enabled': 0, 'wake_on_lan_enabled': 0}}, 'nvme_adapters': {}, 'parallel_ports': {}, 'power_state': 'POWERED_OFF', 'sata_adapters': {'15000': {'bus': 0, 'label': 'SATA controller 0', 'pci_slot_number': 32, 'type': 'AHCI'}}, 'scsi_adapters': {}, 'serial_ports': {}}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_libraryitem_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_libraryitem_info_module.rst index 9379c8fdb..bcb66ccdc 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_libraryitem_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_libraryitem_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_libraryitem_info **Returns the information about the library item associated with the virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -200,6 +200,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get the information from the library
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_module.rst b/docs/vmware.vmware_rest.vcenter_vm_module.rst index 094961952..6612d5487 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm **Creates a virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -1385,6 +1385,69 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ content generated by the update_return_section callback# task + +
+ - +
+ 		+
+
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
vm-1104
+
+
+ value + +
+ dictionary +
+ 		On success +
Create an instant clone of a VM
+
+
Sample:
+
{'boot': {'delay': 0, 'enter_setup_mode': 0, 'retry': 0, 'retry_delay': 10000, 'type': 'BIOS'}, 'boot_devices': [], 'cdroms': {'16002': {'allow_guest_control': 0, 'backing': {'auto_detect': 1, 'device_access_type': 'EMULATION', 'type': 'HOST_DEVICE'}, 'label': 'CD/DVD drive 1', 'sata': {'bus': 0, 'unit': 2}, 'start_connected': 0, 'state': 'NOT_CONNECTED', 'type': 'SATA'}}, 'cpu': {'cores_per_socket': 1, 'count': 1, 'hot_add_enabled': 0, 'hot_remove_enabled': 0}, 'disks': {'16000': {'backing': {'type': 'VMDK_FILE', 'vmdk_file': '[local] test_vm2/test_vm2_2.vmdk'}, 'capacity': 16106127360, 'label': 'Hard disk 1', 'sata': {'bus': 0, 'unit': 0}, 'type': 'SATA'}, '16001': {'backing': {'type': 'VMDK_FILE', 'vmdk_file': '[local] test_vm2/test_vm2_1.vmdk'}, 'capacity': 32000000000, 'label': 'Hard disk 2', 'sata': {'bus': 0, 'unit': 1}, 'type': 'SATA'}}, 'floppies': {}, 'guest_OS': 'RHEL_7_64', 'hardware': {'upgrade_policy': 'NEVER', 'upgrade_status': 'NONE', 'version': 'VMX_11'}, 'identity': {'bios_uuid': '4231bf8b-3cb4-3a3f-1bfb-18c857ce95b6', 'instance_uuid': '5031b322-6030-a020-8e73-1a9ad0fd03ce', 'name': 'test_vm2'}, 'instant_clone_frozen': 0, 'memory': {'hot_add_enabled': 1, 'hot_add_increment_size_MiB': 128, 'hot_add_limit_MiB': 3072, 'size_MiB': 1024}, 'name': 'test_vm2', 'nics': {'4000': {'allow_guest_control': 0, 'backing': {'network': 'network-1095', 'network_name': 'VM Network', 'type': 'STANDARD_PORTGROUP'}, 'label': 'Network adapter 1', 'mac_address': '00:50:56:b1:26:0c', 'mac_type': 'ASSIGNED', 'pci_slot_number': 160, 'start_connected': 0, 'state': 'NOT_CONNECTED', 'type': 'VMXNET3', 'upt_compatibility_enabled': 0, 'wake_on_lan_enabled': 0}}, 'nvme_adapters': {}, 'parallel_ports': {}, 'power_state': 'POWERED_ON', 'sata_adapters': {'15000': {'bus': 0, 'label': 'SATA controller 0', 'pci_slot_number': 32, 'type': 'AHCI'}}, 'scsi_adapters': {}, 'serial_ports': {}}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_power_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_power_info_module.rst index 7abdb51af..41dd52a0a 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_power_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_power_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_power_info **Returns the power state information of a virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -200,6 +200,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get guest power information
+
+
Sample:
+
{'state': 'POWERED_ON'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_power_module.rst b/docs/vmware.vmware_rest.vcenter_vm_power_module.rst index eddfd6e78..bcc0a64b7 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_power_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_power_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_power **Operate a boot, hard shutdown, hard reset or hard suspend on a guest.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -273,6 +273,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ msg + +
+ string +
+ 		On success +
Turn off the VM
+
+
Sample:
+
All items completed
+
+
+ results + +
+ list +
+ 		On success +
Turn off the VM
+
+
Sample:
+
[{'_ansible_item_label': {'cpu_count': 1, 'memory_size_MiB': 128, 'name': 'vCLS-e89f3630-0f4d-4adb-bac5-1912e2b5d8ab', 'power_state': 'POWERED_OFF', 'vm': 'vm-1023'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 0, 'failed': 0, 'invocation': {'module_args': {'session_timeout': None, 'state': 'stop', 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'vm': 'vm-1023'}}, 'item': {'cpu_count': 1, 'memory_size_MiB': 128, 'name': 'vCLS-e89f3630-0f4d-4adb-bac5-1912e2b5d8ab', 'power_state': 'POWERED_OFF', 'vm': 'vm-1023'}, 'value': {'error_type': 'ALREADY_IN_DESIRED_STATE', 'messages': [{'args': [], 'default_message': 'Virtual machine is already powered off.', 'id': 'com.vmware.api.vcenter.vm.power.already_powered_off'}, {'args': [], 'default_message': 'The attempted operation cannot be performed in the current state (Powered off).', 'id': 'vmsg.InvalidPowerState.summary'}]}}, {'_ansible_item_label': {'cpu_count': 1, 'memory_size_MiB': 1080, 'name': 'test_vm1', 'power_state': 'POWERED_ON', 'vm': 'vm-1024'}, '_ansible_no_log': None, 'ansible_loop_var': 'item', 'changed': 0, 'failed': 0, 'invocation': {'module_args': {'session_timeout': None, 'state': 'stop', 'vcenter_hostname': 'vcenter.test', 'vcenter_password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'vcenter_rest_log_file': '/tmp/vmware_rest.log', 'vcenter_username': 'administrator@vsphere.local', 'vcenter_validate_certs': 0, 'vm': 'vm-1024'}}, 'item': {'cpu_count': 1, 'memory_size_MiB': 1080, 'name': 'test_vm1', 'power_state': 'POWERED_ON', 'vm': 'vm-1024'}, 'value': {}}]
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module.rst index 293e1bd56..99a2e5ea8 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_storage_policy_compliance_info **Returns the cached storage policy compliance information of a virtual machine.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -200,6 +200,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get VM storage policy compliance information
+
+
Sample:
+
{'disks': {'16000': {'check_time': '2022-11-23T19:53:45.594Z', 'failure_cause': [], 'policy': 'f4e5bade-15a2-4805-bf8e-52318c4ce443', 'status': 'NOT_APPLICABLE'}}, 'overall_compliance': 'NOT_APPLICABLE'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module.rst b/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module.rst index 3c3167291..0061dcaae 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_storage_policy_compliance_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_storage_policy_compliance **Returns the storage policy Compliance Compliance.Info of a virtual machine after explicitly re-computing compliance check.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: diff --git a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_storage_policy_info_module.rst index db25f7114..118f24ad0 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_storage_policy_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_storage_policy_info **Returns Information about Storage Policy associated with a virtual machine's home directory and/or its virtual hard disks.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -200,6 +200,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get VM storage policy
+
+
Sample:
+
{'disks': {}}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_module.rst b/docs/vmware.vmware_rest.vcenter_vm_storage_policy_module.rst index 417b90a42..41476b453 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_storage_policy_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_storage_policy_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_storage_policy **Updates the storage policy configuration of a virtual machine and/or its associated virtual hard disks.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -268,6 +268,51 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ dictionary +
+ 		On success +
moid of the resource
+
+
+
+ value + +
+ dictionary +
+ 		On success +
Adjust VM storage policy
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_tools_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_tools_info_module.rst index 1b093b0a9..16ac1f9ae 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_tools_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_tools_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_tools_info **Get the properties of VMware Tools.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -258,6 +258,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Wait until my VM is ready
+
+
Sample:
+
{'auto_update_supported': 0, 'install_attempt_count': 0, 'install_type': 'OPEN_VM_TOOLS', 'run_state': 'RUNNING', 'upgrade_policy': 'MANUAL', 'version': '10346', 'version_number': 10346, 'version_status': 'UNMANAGED'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_tools_installer_info_module.rst b/docs/vmware.vmware_rest.vcenter_vm_tools_installer_info_module.rst index 8f15499e2..2040aabc2 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_tools_installer_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_tools_installer_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_tools_installer_info **Get information about the VMware Tools installer.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -221,6 +221,38 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Get information about the vm-tools
+
+
Sample:
+
{'is_connected': 0}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_tools_installer_module.rst b/docs/vmware.vmware_rest.vcenter_vm_tools_installer_module.rst index f39f1ab88..85465118d 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_tools_installer_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_tools_installer_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_tools_installer **Connects the VMware Tools CD installer as a CD-ROM for the guest operating system** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -242,6 +242,36 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ value + +
+ dictionary +
+ 		On success +
Update the vm-tools
+
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vm_tools_module.rst b/docs/vmware.vmware_rest.vcenter_vm_tools_module.rst index f774a55c7..113a7e709 100644 --- a/docs/vmware.vmware_rest.vcenter_vm_tools_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vm_tools_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vm_tools **Update the properties of VMware Tools.** -Version added: 2.0.0 +Version added: 0.1.0 .. contents:: :local: @@ -266,6 +266,53 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ dictionary +
+ 		On success +
moid of the resource
+
+
+
+ value + +
+ dictionary +
+ 		On success +
Retrive vm-tools information
+
+
Sample:
+
{'auto_update_supported': 0, 'install_attempt_count': 0, 'install_type': 'OPEN_VM_TOOLS', 'run_state': 'RUNNING', 'upgrade_policy': 'MANUAL', 'version': '10346', 'version_number': 10346, 'version_status': 'UNMANAGED'}
+
+

+ Status ------ diff --git a/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module.rst b/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module.rst index 94ddf6d9f..bf83dc6c8 100644 --- a/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vmtemplate_libraryitems_info **Returns information about a virtual machine template contained in the library item specified by {@param.name templateLibraryItem}** -Version added: 2.0.0 +Version added: 2.2.0 .. contents:: :local: diff --git a/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module.rst b/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module.rst index 7feff4ee9..bd523525d 100644 --- a/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module.rst +++ b/docs/vmware.vmware_rest.vcenter_vmtemplate_libraryitems_module.rst @@ -8,7 +8,7 @@ vmware.vmware_rest.vcenter_vmtemplate_libraryitems **Creates a library item in content library from a virtual machine** -Version added: 2.0.0 +Version added: 2.2.0 .. contents:: :local: @@ -483,6 +483,55 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ id + +
+ string +
+ 		On success +
moid of the resource
+
+
Sample:
+
9c6df1f5-faba-490c-a8e6-edb72f787ab8
+
+
+ value + +
+ dictionary +
+ 		On success +
Create a VM template on the library
+
+
Sample:
+
{'cpu': {'cores_per_socket': 1, 'count': 1}, 'disks': {'16000': {'capacity': 16106127360, 'disk_storage': {'datastore': 'datastore-1122'}}, '16001': {'capacity': 32000000000, 'disk_storage': {'datastore': 'datastore-1122'}}}, 'guest_OS': 'RHEL_7_64', 'memory': {'size_MiB': 1024}, 'nics': {'4000': {'backing_type': 'STANDARD_PORTGROUP', 'mac_type': 'ASSIGNED', 'network': 'network-1123'}}, 'vm_home_storage': {'datastore': 'datastore-1122'}, 'vm_template': 'vm-1132'}
+
+

+ Status ------