W3cubDocs

/Ansible

Community.Vmware

Collection version 5.7.2

Description
Developer Guide
Plugin Index

Description

Author:

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

Supported ansible-core versions:

2.17.0 or newer

Developer Guide

Guidelines for VMware module development

Plugin Index

These are the plugins in the community.vmware collection:

Modules

vcenter_domain_user_group_info module – Gather user or group information of a domain
vcenter_extension module – Register/deregister vCenter Extensions
vcenter_extension_info module – Gather info vCenter extensions
vcenter_folder module – Manage folders on given datacenter DEPRECATED
vcenter_license module – Manage VMware vCenter license keys
vcenter_root_password_expiration module – root password expiration of vCSA
vcenter_standard_key_provider module – Add, reconfigure or remove Standard Key Provider on vCenter server
vmware_about_info module – Provides information about VMware server to which user is connecting to
vmware_all_snapshots_info module – Gathers information about all snapshots across virtual machines in a specified vmware datacenter
vmware_category module – Manage VMware categories
vmware_category_info module – Gather info about VMware tag categories
vmware_cfg_backup module – Backup / Restore / Reset ESXi host configuration
vmware_cluster module – Manage VMware vSphere clusters DEPRECATED
vmware_cluster_dpm module – Manage Distributed Power Management (DPM) on VMware vSphere clusters DEPRECATED
vmware_cluster_drs module – Manage Distributed Resource Scheduler (DRS) on VMware vSphere clusters DEPRECATED
vmware_cluster_drs_recommendations module – Apply DRS Recommendations DEPRECATED
vmware_cluster_ha module – Manage High Availability (HA) on VMware vSphere clusters DEPRECATED
vmware_cluster_info module – Gather info about clusters available in given vCenter DEPRECATED
vmware_cluster_vcls module – Override the default vCLS (vSphere Cluster Services) VM disk placement for this cluster. DEPRECATED
vmware_cluster_vsan module – Manages virtual storage area network (vSAN) configuration on VMware vSphere clusters
vmware_content_deploy_ovf_template module – Deploy Virtual Machine from ovf template stored in content library. DEPRECATED
vmware_content_deploy_template module – Deploy Virtual Machine from template stored in content library. DEPRECATED
vmware_content_library_info module – Gather information about VMWare Content Library
vmware_content_library_manager module – Create, update and delete VMware content library DEPRECATED
vmware_custom_attribute module – Manage custom attributes definitions
vmware_custom_attribute_manager module – Manage custom attributes from VMware for the given vSphere object
vmware_datacenter module – Manage VMware vSphere Datacenters
vmware_datacenter_info module – Gather information about VMware vSphere Datacenters
vmware_datastore module – Configure Datastores
vmware_datastore_cluster module – Manage VMware vSphere datastore clusters
vmware_datastore_cluster_manager module – Manage VMware vSphere datastore cluster’s members
vmware_datastore_info module – Gather info about datastores available in given vCenter
vmware_datastore_maintenancemode module – Place a datastore into maintenance mode
vmware_deploy_ovf module – Deploys a VMware virtual machine from an OVF or OVA file, placed on file system or HTTP server
vmware_drs_group module – Creates vm/host group in a given cluster.
vmware_drs_group_info module – Gathers info about DRS VM/Host groups on the given cluster
vmware_drs_group_manager module – Manage VMs and Hosts in DRS group.
vmware_drs_override module – Configure DRS behavior for a specific VM in vSphere
vmware_drs_rule_info module – Gathers info about DRS rule on the given cluster
vmware_dvs_host module – Add or remove a host from distributed virtual switch
vmware_dvs_portgroup module – Create or remove a Distributed vSwitch portgroup.
vmware_dvs_portgroup_find module – Find portgroup(s) in a VMware environment
vmware_dvs_portgroup_info module – Gathers info DVS portgroup configurations
vmware_dvswitch module – Create or remove a Distributed Switch
vmware_dvswitch_info module – Gathers info dvswitch configurations
vmware_dvswitch_lacp module – Manage LACP configuration on a Distributed Switch
vmware_dvswitch_nioc module – Manage distributed switch Network IO Control
vmware_dvswitch_pvlans module – Manage Private VLAN configuration of a Distributed Switch
vmware_dvswitch_uplink_pg module – Manage uplink portgroup configuration of a Distributed Switch
vmware_evc_mode module – Enable/Disable EVC mode on vCenter
vmware_export_ovf module – Exports a VMware virtual machine to an OVF file, device files and a manifest file
vmware_first_class_disk module – Manage VMware vSphere First Class Disks
vmware_first_class_disk_info module – Gather info about VMware vSphere First Class Disks
vmware_folder_info module – Provides information about folders in a datacenter
vmware_guest module – Manages virtual machines in vCenter
vmware_guest_boot_info module – Gather info about boot options for the given virtual machine
vmware_guest_boot_manager module – Manage boot options for the given virtual machine
vmware_guest_controller module – Manage disk or USB controllers related to virtual machine in given vCenter infrastructure
vmware_guest_cross_vc_clone module – Cross-vCenter VM/template clone
vmware_guest_custom_attribute_defs module – Manage custom attributes definitions for virtual machine from VMware
vmware_guest_custom_attributes module – Manage custom attributes from VMware for the given virtual machine
vmware_guest_customization_info module – Gather info about VM customization specifications
vmware_guest_disk module – Manage disks related to virtual machine in given vCenter infrastructure
vmware_guest_disk_info module – Gather info about disks of given virtual machine
vmware_guest_file_operation module – Files operation in a VMware guest operating system without network
vmware_guest_find module – Find the folder path(s) for a virtual machine by name or UUID
vmware_guest_info module – Gather info about a single VM
vmware_guest_instant_clone module – Instant Clone VM
vmware_guest_move module – Moves virtual machines in vCenter
vmware_guest_network module – Manage network adapters of specified virtual machine in given vCenter infrastructure
vmware_guest_powerstate module – Manages power states of virtual machines in vCenter DEPRECATED
vmware_guest_register_operation module – VM inventory registration operation
vmware_guest_screenshot module – Create a screenshot of the Virtual Machine console.
vmware_guest_sendkey module – Send USB HID codes to the Virtual Machine’s keyboard.
vmware_guest_serial_port module – Manage serial ports on an existing VM
vmware_guest_snapshot module – Manages virtual machines snapshots in vCenter
vmware_guest_snapshot_info module – Gather info about virtual machine’s snapshots in vCenter
vmware_guest_storage_policy module – Set VM Home and disk(s) storage policy profiles.
vmware_guest_tools_info module – Gather info about VMware tools installed in VM
vmware_guest_tools_upgrade module – Module to upgrade VMTools
vmware_guest_tools_wait module – Wait for VMware tools to become available
vmware_guest_tpm module – Add or remove vTPM device for specified VM.
vmware_guest_vgpu module – Modify vGPU video card profile of the specified virtual machine in the given vCenter infrastructure
vmware_guest_vgpu_info module – Gather information about vGPU profiles of the specified virtual machine in the given vCenter infrastructure
vmware_guest_video module – Modify video card configurations of specified virtual machine in given vCenter infrastructure
vmware_host module – Add, remove, or move an ESXi host to, from, or within vCenter DEPRECATED
vmware_host_acceptance module – Manage the host acceptance level of an ESXi host
vmware_host_acceptance_info module – Gather host acceptance level of ESXi hosts
vmware_host_active_directory module – Joins an ESXi host system to an Active Directory domain or leaves it
vmware_host_auto_start module – Manage the auto power ON or OFF for vm on ESXi host
vmware_host_capability_info module – Gathers info about an ESXi host’s capability information
vmware_host_config_info module – Gathers info about an ESXi host’s advance configuration information
vmware_host_config_manager module – Manage advanced system settings of an ESXi host
vmware_host_custom_attributes module – Manage custom attributes from VMware for the given ESXi host
vmware_host_datastore module – Manage a datastore on ESXi host
vmware_host_disk_info module – Gathers information about disks attached to given ESXi host/s.
vmware_host_dns module – Manage DNS configuration of an ESXi host system
vmware_host_dns_info module – Gathers info about an ESXi host’s DNS configuration information
vmware_host_facts module – Gathers facts about remote ESXi hostsystem
vmware_host_feature_info module – Gathers info about an ESXi host’s feature capability information
vmware_host_firewall_info module – Gathers info about an ESXi host’s firewall configuration information
vmware_host_firewall_manager module – Manage firewall configurations about an ESXi host
vmware_host_graphics module – Manage Host Graphic Settings
vmware_host_hyperthreading module – Enables/Disables Hyperthreading optimization for an ESXi host system
vmware_host_ipv6 module – Enables/Disables IPv6 support for an ESXi host system
vmware_host_iscsi module – Manage the iSCSI configuration of ESXi host
vmware_host_iscsi_info module – Gather iSCSI configuration information of ESXi host
vmware_host_kernel_manager module – Manage kernel module options on ESXi hosts
vmware_host_lockdown module – Manage administrator permission for the local administrative account for the ESXi host
vmware_host_lockdown_exceptions module – Manage Lockdown Mode Exception Users
vmware_host_logbundle module – Fetch logbundle file from ESXi
vmware_host_logbundle_info module – Gathers manifest info for logbundle
vmware_host_ntp module – Manage NTP server configuration of an ESXi host
vmware_host_ntp_info module – Gathers info about NTP configuration on an ESXi host
vmware_host_package_info module – Gathers info about available packages on an ESXi host
vmware_host_passthrough module – Manage PCI device passthrough settings on host
vmware_host_powermgmt_policy module – Manages the Power Management Policy of an ESXI host system
vmware_host_powerstate module – Manages power states of host systems in vCenter
vmware_host_scanhba module – Rescan host HBA’s and optionally refresh the storage system
vmware_host_scsidisk_info module – Gather information about SCSI disk attached to the given ESXi
vmware_host_service_info module – Gathers info about an ESXi host’s services
vmware_host_service_manager module – Manage services on a given ESXi host
vmware_host_snmp module – Configures SNMP on an ESXi host system
vmware_host_sriov module – Manage SR-IOV settings on host
vmware_host_ssl_info module – Gather info of ESXi host system about SSL
vmware_host_tcpip_stacks module – Manage the TCP/IP Stacks configuration of ESXi host
vmware_host_user_manager module – Manage users of ESXi
vmware_host_vmhba_info module – Gathers info about vmhbas available on the given ESXi host
vmware_host_vmnic_info module – Gathers info about vmnics available on the given ESXi host
vmware_local_role_info module – Gather info about local roles on an ESXi host or vCenter
vmware_local_role_manager module – Manage local roles on an ESXi host or vCenter
vmware_local_user_info module – Gather info about users on the given ESXi host
vmware_local_user_manager module – Manage local users on an ESXi host
vmware_maintenancemode module – Place a host into maintenance mode DEPRECATED
vmware_migrate_vmk module – Migrate a VMK interface from VSS to VDS
vmware_object_custom_attributes_info module – Gather custom attributes of an object
vmware_object_rename module – Renames VMware objects
vmware_object_role_permission module – Manage local roles on an ESXi host or vCenter
vmware_object_role_permission_info module – Gather information about object’s permissions
vmware_portgroup module – Create a VMware portgroup
vmware_portgroup_info module – Gathers info about an ESXi host’s Port Group configuration
vmware_recommended_datastore module – Returns the recommended datastore from a SDRS-enabled datastore cluster
vmware_resource_pool module – Add/remove resource pools to/from vCenter
vmware_resource_pool_info module – Gathers info about resource pool information
vmware_sdrs_vm_overrides_info module – Check for VM overrides in a SDRS datastore cluster
vmware_tag module – Manage VMware tags
vmware_tag_info module – Manage VMware tag info
vmware_tag_manager module – Manage association of VMware tags with VMware objects
vmware_target_canonical_info module – Return canonical (NAA) from an ESXi host system
vmware_vasa module – Manage VMware Virtual Volumes storage provider
vmware_vasa_info module – Gather information about vSphere VASA providers.
vmware_vc_infraprofile_info module – List and Export VMware vCenter infra profile configs.
vmware_vcenter_settings module – Configures general settings on a vCenter server
vmware_vcenter_settings_info module – Gather info vCenter settings
vmware_vcenter_statistics module – Configures statistics on a vCenter server
vmware_vm_config_option module – Return supported guest ID list and VM recommended config option for specific guest OS
vmware_vm_host_drs_rule module – Creates vm/host group in a given cluster
vmware_vm_info module – Return basic info pertaining to a VMware machine guest
vmware_vm_shell module – Run commands in a VMware guest operating system
vmware_vm_storage_policy module – Create vSphere storage policies
vmware_vm_storage_policy_info module – Gather information about vSphere storage profile defined storage policy information.
vmware_vm_vm_drs_rule module – Configure VMware DRS Affinity rule for virtual machines in the given cluster
vmware_vm_vss_dvs_migrate module – Migrates a virtual machine from a standard vswitch to distributed
vmware_vmkernel module – Manages a VMware VMkernel Adapter of an ESXi host.
vmware_vmkernel_info module – Gathers VMKernel info about an ESXi host
vmware_vmotion module – Move a virtual machine using vMotion, and/or its vmdks using storage vMotion.
vmware_vsan_cluster module – Configure VSAN clustering on an ESXi host
vmware_vsan_hcl_db module – Manages the vSAN Hardware Compatibility List (HCL) database
vmware_vsan_health_info module – Gather information about a VMware vSAN cluster’s health
vmware_vsan_release_catalog module – Uploads the vSAN Release Catalog
vmware_vspan_session module – Create or remove a Port Mirroring session.
vmware_vswitch module – Manage a VMware Standard Switch to an ESXi host.
vmware_vswitch_info module – Gathers info about an ESXi host’s vswitch configurations
vsan_health_silent_checks module – Silence vSAN health checks
vsphere_copy module – Copy a file to a VMware datastore
vsphere_file module – Manage files on a vCenter datastore

Connection Plugins

vmware_tools connection – Execute tasks inside a VM via VMware Tools

Httpapi Plugins

vmware httpapi – HttpApi Plugin for VMware REST API

Inventory Plugins

vmware_host_inventory inventory – VMware ESXi hostsystem inventory source DEPRECATED
vmware_vm_inventory inventory – VMware Guest inventory source DEPRECATED