W3cubDocs

/Ansible

Vmware.Vmware_Rest

Collection version 4.8.1

Description
Developer Guide
Plugin Index

Description

VMware collection for Ansible

Author:

Ansible (https://github.com/ansible)

Supported ansible-core versions:

2.15.0 or newer

Developer Guide

Guidelines for VMware REST module development

Plugin Index

These are the plugins in the vmware.vmware_rest collection:

Modules

appliance_access_consolecli module – Set enabled state of the console-based controlled CLI (TTY1). DEPRECATED
appliance_access_consolecli_info module – Get enabled state of the console-based controlled CLI (TTY1). DEPRECATED
appliance_access_dcui module – Set enabled state of Direct Console User Interface (DCUI TTY2). DEPRECATED
appliance_access_dcui_info module – Get enabled state of Direct Console User Interface (DCUI TTY2). DEPRECATED
appliance_access_shell module – Set enabled state of BASH, that is, access to BASH from within the controlled CLI. DEPRECATED
appliance_access_shell_info module – Get enabled state of BASH, that is, access to BASH from within the controlled CLI. DEPRECATED
appliance_access_ssh module – Set enabled state of the SSH-based controlled CLI. DEPRECATED
appliance_access_ssh_info module – Get enabled state of the SSH-based controlled CLI. DEPRECATED
appliance_health_applmgmt_info module – Get health status of applmgmt services.
appliance_health_database_info module – Returns the health status of the database.
appliance_health_databasestorage_info module – Get database storage health.
appliance_health_load_info module – Get load health.
appliance_health_mem_info module – Get memory health.
appliance_health_softwarepackages_info module – Get information on available software updates available in the remote vSphere Update Manager repository
appliance_health_storage_info module – Get storage health.
appliance_health_swap_info module – Get swap health.
appliance_health_system_info module – Get overall health of system.
appliance_infraprofile_configs module – Exports the desired profile specification.
appliance_infraprofile_configs_info module – List all the profiles which are registered.
appliance_localaccounts_globalpolicy module – Set the global password policy.
appliance_localaccounts_globalpolicy_info module – Get the global password policy.
appliance_localaccounts_info module – Get the local user account information.
appliance_monitoring_info module – Get monitored item info
appliance_monitoring_query module – Get monitoring data.
appliance_networking module – Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
appliance_networking_dns_domains module – Set DNS search domains. DEPRECATED
appliance_networking_dns_domains_info module – Get list of DNS search domains. DEPRECATED
appliance_networking_dns_hostname module – Set the Fully Qualified Domain Name. DEPRECATED
appliance_networking_dns_hostname_info module – Get the Fully Qualified Doman Name. DEPRECATED
appliance_networking_dns_servers module – Set the DNS server configuration DEPRECATED
appliance_networking_dns_servers_info module – Get DNS server configuration. DEPRECATED
appliance_networking_firewall_inbound module – Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses DEPRECATED
appliance_networking_firewall_inbound_info module – Get the ordered list of firewall rules DEPRECATED
appliance_networking_info module – Get Networking information for all configured interfaces.
appliance_networking_interfaces_info module – Get information about a particular network interface.
appliance_networking_interfaces_ipv4 module – Set IPv4 network configuration for specific network interface.
appliance_networking_interfaces_ipv4_info module – Get IPv4 network configuration for specific NIC.
appliance_networking_interfaces_ipv6 module – Set IPv6 network configuration for specific interface.
appliance_networking_interfaces_ipv6_info module – Get IPv6 network configuration for specific interface.
appliance_networking_noproxy module – Sets servers for which no proxy configuration should be applied DEPRECATED
appliance_networking_noproxy_info module – Returns servers for which no proxy configuration will be applied. DEPRECATED
appliance_networking_proxy module – Configures which proxy server to use for the specified protocol DEPRECATED
appliance_networking_proxy_info module – Gets the proxy configuration for a specific protocol. DEPRECATED
appliance_ntp module – Set NTP servers DEPRECATED
appliance_ntp_info module – Get the NTP configuration status DEPRECATED
appliance_services module – Restarts a service
appliance_services_info module – Returns the state of a service.
appliance_shutdown module – Cancel pending shutdown action.
appliance_shutdown_info module – Get details about the pending shutdown action.
appliance_system_globalfips module – Enable/Disable Global FIPS mode for the appliance DEPRECATED
appliance_system_globalfips_info module – Get current appliance FIPS settings. DEPRECATED
appliance_system_storage module – Resize all partitions to 100 percent of disk size.
appliance_system_storage_info module – Get disk to partition mapping.
appliance_system_time_info module – Get system time.
appliance_system_time_timezone module – Set time zone. DEPRECATED
appliance_system_time_timezone_info module – Get time zone. DEPRECATED
appliance_system_version_info module – Get the version.
appliance_timesync module – Set time synchronization mode. DEPRECATED
appliance_timesync_info module – Get time synchronization mode. DEPRECATED
appliance_update_info module – Gets the current status of the appliance update.
appliance_vmon_service module – Lists details of services managed by vMon.
appliance_vmon_service_info module – Returns the state of a service.
content_configuration module – Updates the configuration
content_configuration_info module – Retrieves the current configuration values.
content_library_info module – Returns a given LibraryModel.
content_library_item_info module – Returns the ItemModel with the given identifier. DEPRECATED
content_library_subscriptions_info module – Returns information about the specified subscription of the published library.
content_locallibrary module – Creates a new local library. DEPRECATED
content_locallibrary_info module – Returns a given local library.
content_subscribedlibrary module – Creates a new subscribed library DEPRECATED
content_subscribedlibrary_info module – Returns a given subscribed library.
vcenter_cluster_info module – Retrieves information about the cluster corresponding to cluster. DEPRECATED
vcenter_datacenter module – Create a new datacenter in the vCenter inventory
vcenter_datacenter_info module – Retrieves information about the datacenter corresponding to datacenter.
vcenter_datastore_info module – Retrieves information about the datastore indicated by datastore.
vcenter_folder_info module – Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec.
vcenter_host module – Add a new standalone host in the vCenter inventory DEPRECATED
vcenter_host_info module – Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.
vcenter_network_info module – Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec.
vcenter_ovf_libraryitem module – Creates a library item in content library from a virtual machine or virtual appliance
vcenter_resourcepool module – Creates a resource pool.
vcenter_resourcepool_info module – Retrieves information about the resource pool indicated by resourcePool.
vcenter_storage_policies_info module – Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter
vcenter_vm module – Creates a virtual machine.
vcenter_vm_guest_customization module – Applies a customization specification on the virtual machine
vcenter_vm_guest_filesystem_directories module – Creates a directory in the guest operating system
vcenter_vm_guest_identity_info module – Return information about the guest.
vcenter_vm_guest_localfilesystem_info module – Returns details of the local file systems in the guest operating system.
vcenter_vm_guest_networking_info module – Returns information about the network configuration in the guest operating system.
vcenter_vm_guest_networking_interfaces_info module – Returns information about the networking interfaces in the guest operating system. DEPRECATED
vcenter_vm_guest_networking_routes_info module – Returns information about network routing in the guest operating system.
vcenter_vm_guest_operations_info module – Get information about the guest operation status.
vcenter_vm_guest_power module – Issues a request to the guest operating system asking it to perform a soft shutdown, standby (suspend) or soft reboot DEPRECATED
vcenter_vm_guest_power_info module – Returns information about the guest operating system power state.
vcenter_vm_hardware module – Updates the virtual hardware settings of a virtual machine.
vcenter_vm_hardware_adapter_sata module – Adds a virtual SATA adapter to the virtual machine.
vcenter_vm_hardware_adapter_sata_info module – Returns information about a virtual SATA adapter.
vcenter_vm_hardware_adapter_scsi module – Adds a virtual SCSI adapter to the virtual machine.
vcenter_vm_hardware_adapter_scsi_info module – Returns information about a virtual SCSI adapter.
vcenter_vm_hardware_boot module – Updates the boot-related settings of a virtual machine.
vcenter_vm_hardware_boot_device module – Sets the virtual devices that will be used to boot the virtual machine
vcenter_vm_hardware_boot_device_info module – Returns an ordered list of boot devices for the virtual machine
vcenter_vm_hardware_boot_info module – Returns the boot-related settings of a virtual machine.
vcenter_vm_hardware_cdrom module – Adds a virtual CD-ROM device to the virtual machine.
vcenter_vm_hardware_cdrom_info module – Returns information about a virtual CD-ROM device.
vcenter_vm_hardware_cpu module – Updates the CPU-related settings of a virtual machine.
vcenter_vm_hardware_cpu_info module – Returns the CPU-related settings of a virtual machine. DEPRECATED
vcenter_vm_hardware_disk module – Adds a thin provisioned virtual disk to the virtual machine
vcenter_vm_hardware_disk_info module – Returns information about a virtual disk.
vcenter_vm_hardware_ethernet module – Adds a virtual Ethernet adapter to the virtual machine.
vcenter_vm_hardware_ethernet_info module – Returns information about a virtual Ethernet adapter.
vcenter_vm_hardware_floppy module – Adds a virtual floppy drive to the virtual machine.
vcenter_vm_hardware_floppy_info module – Returns information about a virtual floppy drive.
vcenter_vm_hardware_info module – Returns the virtual hardware settings of a virtual machine.
vcenter_vm_hardware_memory module – Updates the memory-related settings of a virtual machine.
vcenter_vm_hardware_memory_info module – Returns the memory-related settings of a virtual machine. DEPRECATED
vcenter_vm_hardware_parallel module – Adds a virtual parallel port to the virtual machine.
vcenter_vm_hardware_parallel_info module – Returns information about a virtual parallel port.
vcenter_vm_hardware_serial module – Adds a virtual serial port to the virtual machine.
vcenter_vm_hardware_serial_info module – Returns information about a virtual serial port.
vcenter_vm_info module – Returns information about a virtual machine.
vcenter_vm_libraryitem_info module – Returns the information about the library item associated with the virtual machine. DEPRECATED
vcenter_vm_power module – Operate a boot, hard shutdown, hard reset or hard suspend on a guest. DEPRECATED
vcenter_vm_power_info module – Returns the power state information of a virtual machine.
vcenter_vm_storage_policy module – Updates the storage policy configuration of a virtual machine and/or its associated virtual hard disks.
vcenter_vm_storage_policy_compliance module – Returns the storage policy Compliance Compliance.Info of a virtual machine after explicitly re-computing compliance check.
vcenter_vm_storage_policy_compliance_info module – Returns the cached storage policy compliance information of a virtual machine.
vcenter_vm_storage_policy_info module – Returns Information about Storage Policy associated with a virtual machine’s home directory and/or its virtual hard disks.
vcenter_vm_tools module – Update the properties of VMware Tools.
vcenter_vm_tools_info module – Get the properties of VMware Tools.
vcenter_vm_tools_installer module – Connects the VMware Tools CD installer as a CD-ROM for the guest operating system
vcenter_vm_tools_installer_info module – Get information about the VMware Tools installer.
vcenter_vmtemplate_libraryitems module – Creates a library item in content library from a virtual machine
vcenter_vmtemplate_libraryitems_info module – Returns information about a virtual machine template contained in the library item specified by templateLibraryItem DEPRECATED

Lookup Plugins

cluster_moid lookup – Look up MoID for vSphere cluster objects using vCenter REST API DEPRECATED
datacenter_moid lookup – Look up MoID for vSphere datacenter objects using vCenter REST API DEPRECATED
datastore_moid lookup – Look up MoID for vSphere datastore objects using vCenter REST API DEPRECATED
folder_moid lookup – Look up MoID for vSphere folder objects using vCenter REST API DEPRECATED
host_moid lookup – Look up MoID for vSphere host objects using vCenter REST API DEPRECATED
network_moid lookup – Look up MoID for vSphere network objects using vCenter REST API DEPRECATED
resource_pool_moid lookup – Look up MoID for vSphere resource pool objects using vCenter REST API DEPRECATED
vm_moid lookup – Look up MoID for vSphere vm objects using vCenter REST API DEPRECATED