community.vmware.vmware_host_sriov module – Manage SR-IOV settings on host
Note
This module is part of the community.vmware collection (version 5.2.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.
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.
Parameters
Parameter |
Comments |
|---|---|
Name of the cluster from which all host systems will be used. This parameter is required if |
|
Name of the host system to work with. This parameter is required if User can specify specific host from the cluster. |
|
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 |
|
number of functions to activate on interface. 0 means SR-IOV disabled. number greater than 0 means SR-IOV enabled. |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
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 |
|
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 |
|
optional parameter, related to SR-IOV can be enabled only if Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
|
Interface name, like vmnic0. |
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 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 |
Description |
|---|---|
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 Returned: always Sample: |