community.vmware.vmware_evc_mode module – Enable/Disable EVC mode on vCenter

Note

This module is part of the community.vmware collection (version 4.8.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.vmware.

To use it in a playbook, specify: community.vmware.vmware_evc_mode.

Synopsis

  • This module can be used to enable/disable EVC mode on vCenter.

Parameters

Parameter

Comments

cluster_name

aliases: cluster

string / required

The name of the cluster to enable or disable EVC mode on.

datacenter_name

aliases: datacenter

string / required

The name of the datacenter the cluster belongs to that you want to enable or disable EVC mode on.

evc_mode

string

Required for state=present.

The EVC mode to enable or disable on the cluster. (intel-broadwell, intel-nehalem, intel-merom, etc.).

hostname

string

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 VMWARE_HOST will be used instead.

password

aliases: pass, pwd

string

The password of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

port

integer

The port number of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Default: 443

proxy_host

string

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 VMWARE_PROXY_HOST will be used instead.

proxy_port

integer

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 VMWARE_PROXY_PORT will be used instead.

state

string

Add or remove EVC mode.

Choices:

  • "absent"

  • "present" ← (default)

username

aliases: admin, user

string

The username of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

validate_certs

boolean

Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • All modules requires API write access and hence is not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

Examples

- name: Enable EVC Mode
  community.vmware.vmware_evc_mode:
     hostname: "{{ groups['vcsa'][0] }}"
     username: "{{ vcenter_username }}"
     password: "{{ site_password }}"
     datacenter_name: "{{ datacenter_name }}"
     cluster_name: "{{ cluster_name }}"
     evc_mode: "intel-broadwell"
     state: present
  delegate_to: localhost
  register: enable_evc

- name: Disable EVC Mode
  community.vmware.vmware_evc_mode:
     hostname: "{{ groups['vcsa'][0] }}"
     username: "{{ vcenter_username }}"
     password: "{{ site_password }}"
     datacenter_name: "{{ datacenter_name }}"
     cluster_name: "{{ cluster_name }}"
     state: absent
  delegate_to: localhost
  register: disable_evc

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

result

string

information about performed operation

Returned: always

Sample: "EVC Mode for 'intel-broadwell' has been enabled."

Authors

  • Michael Tipton (@castawayegr)