W3cubDocs

/Ansible

community.vmware.vmware_host_sriov – Manage SR-IOV settings on host

Note

This plugin is part of the community.vmware collection (version 1.15.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_host_sriov.

New in version 1.0.0: of community.vmware

Synopsis

  • This module can be used to configure, enable or disable SR-IOV functions on ESXi host.
  • Module does not reboot the host after changes, but puts it in output “rebootRequired” state.
  • User can specify an ESXi hostname or Cluster name. In case of cluster name, all ESXi hosts are updated.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
cluster_name
string
Name of the cluster from which all host systems will be used.
This parameter is required if esxi_hostname is not specified.
esxi_hostname
string
Name of the host system to work with.
This parameter is required if cluster_name is not specified.
User can specify specific host from the cluster.
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.
Environment variable support added in Ansible 2.6.
num_virt_func
integer / required
number of functions to activate on interface.
0 means SR-IOV disabled.
number greater than 0 means SR-IOV enabled.
password
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.
Environment variable support added in Ansible 2.6.

aliases: pass, pwd
port
integer
Default:
443
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.
Environment variable support added in Ansible 2.6.
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.
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
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.
sriov_on
boolean
    Choices:
  • no
  • yes
optional parameter, related to num_virt_func.
SR-IOV can be enabled only if num_virt_func > 0.
username
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.
Environment variable support added in Ansible 2.6.

aliases: admin, user
validate_certs
boolean
    Choices:
  • no
  • yes ←
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.
Environment variable support added in Ansible 2.6.
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
vmnic
string / required
Interface name, like vmnic0.

Notes

Note

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

Examples

- name: enable SR-IOV on vmnic0 with 8 functions
  community.vmware.vmware_host_sriov:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi1 }}"
    vmnic: vmnic0
    sriov_on: true
    num_virt_func: 8

- name: enable SR-IOV on already enabled interface vmnic0
  community.vmware.vmware_host_sriov:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi1 }}"
    vmnic: vmnic0
    sriov_on: true
    num_virt_func: 8

- name: enable SR-IOV on vmnic0 with big number of functions
  community.vmware.vmware_host_sriov:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi1 }}"
    vmnic: vmnic0
    sriov_on: true
    num_virt_func: 100
  ignore_errors: true

- name: disable SR-IOV on vmnic0
  community.vmware.vmware_host_sriov:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi1 }}"
    vmnic: vmnic0
    sriov_on: false
    num_virt_func: 0

Return Values

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

Key Returned Description
host_sriov_diff
dictionary
always
contains info about SR-IOV status on vmnic before, after and requested changes
sometimes vCenter slowly update info, as result "after" contains same info as "before" need to run again in check_mode or reboot host, as ESXi requested

Sample:
{'changed': True, 'diff': {'after': {'host_test': {'maxVirtualFunctionSupported': 63, 'numVirtualFunction': 0, 'numVirtualFunctionRequested': 8, 'rebootRequired': True, 'sriovActive': False, 'sriovCapable': True, 'sriovEnabled': True}}, 'before': {'host_test': {'maxVirtualFunctionSupported': 63, 'numVirtualFunction': 0, 'numVirtualFunctionRequested': 0, 'rebootRequired': False, 'sriovActive': False, 'sriovCapable': True, 'sriovEnabled': False}}, 'changes': {'host_test': {'numVirtualFunction': 8, 'rebootRequired': True, 'sriovEnabled': True}}}}


Authors

  • Viktor Tsymbalyuk (@victron)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_host_sriov_module.html