ansible.builtin.vmware_cluster_drs (v2.9.24) — module

Install Ansible via pip

Install with pip install ansible==2.9.24

Description

Manages DRS on VMware vSphere clusters.

All values and VMware object names are case sensitive.

Requirements

• Tested on ESXi 5.5 and 6.5.
• PyVmomi installed.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Enable DRS
  vmware_cluster_drs:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter
    cluster_name: cluster
    enable_drs: yes
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Enable DRS and set default VM behavior to partially automated
  vmware_cluster_drs:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: no
    datacenter_name: DC0
    cluster_name: "{{ cluster_name }}"
    enable_drs: True
    drs_default_vm_behavior: partiallyAutomated
  delegate_to: localhost

Inputs

    
port:
    default: 443
    description:
    - The port number of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable C(VMWARE_PORT)
      will be used instead.
    - Environment variable support added in Ansible 2.6.
    type: int

hostname:
    description:
    - The hostname or IP address of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable C(VMWARE_HOST)
      will be used instead.
    - Environment variable support added in Ansible 2.6.
    type: str

password:
    aliases:
    - pass
    - pwd
    description:
    - The password of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD)
      will be used instead.
    - Environment variable support added in Ansible 2.6.
    type: str

username:
    aliases:
    - admin
    - user
    description:
    - The username of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable C(VMWARE_USER)
      will be used instead.
    - Environment variable support added in Ansible 2.6.
    type: str

datacenter:
    aliases:
    - datacenter_name
    description:
    - The name of the datacenter.
    required: true
    type: str

enable_drs:
    default: 'no'
    description:
    - Whether to enable DRS.
    type: bool

proxy_host:
    description:
    - Address of a proxy that will receive all HTTPS requests and relay them.
    - The format is a hostname or a IP.
    - If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_HOST)
      will be used instead.
    - This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
    required: false
    type: str

proxy_port:
    description:
    - Port of the HTTP proxy that will receive all HTTPS requests and relay them.
    - If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_PORT)
      will be used instead.
    required: false
    type: int

cluster_name:
    description:
    - The name of the cluster to be managed.
    required: true
    type: str

validate_certs:
    default: true
    description:
    - Allows connection when SSL certificates are not valid. Set to C(false) when certificates
      are not trusted.
    - If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS)
      will be used instead.
    - Environment variable support added in Ansible 2.6.
    - If set to C(true), please make sure Python >= 2.7.9 is installed on the given machine.
    type: bool

drs_vmotion_rate:
    choices:
    - 1
    - 2
    - 3
    - 4
    - 5
    default: 3
    description:
    - Threshold for generated ClusterRecommendations.
    type: int

drs_default_vm_behavior:
    choices:
    - fullyAutomated
    - manual
    - partiallyAutomated
    default: fullyAutomated
    description:
    - Specifies the cluster-wide default DRS behavior for virtual machines.
    - If set to C(partiallyAutomated), vCenter generates recommendations for virtual machine
      migration and for the placement with a host, then automatically implements placement
      recommendations at power on.
    - If set to C(manual), then vCenter generates recommendations for virtual machine
      migration and for the placement with a host, but does not implement the recommendations
      automatically.
    - If set to C(fullyAutomated), then vCenter automates both the migration of virtual
      machines and their placement with a host at power on.
    type: str

drs_enable_vm_behavior_overrides:
    default: true
    description:
    - Whether DRS Behavior overrides for individual virtual machines are enabled.
    - If set to C(True), overrides C(drs_default_vm_behavior).
    type: bool