community.vmware.vmware_dvswitch_nioc module – Manage distributed switch Network IO Control
Note
This module is part of the community.vmware collection (version 2.10.2).
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_dvswitch_nioc
.
Synopsis
This module can be used to manage distributed switch Network IO Control configurations.
Parameters
Parameter |
Comments |
---|---|
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 Environment variable support added in Ansible 2.6. |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. 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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 |
|
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 |
|
List of dicts containing. Default: |
|
The maximum allowed usage for a traffic class belonging to this resource pool per host physical NIC. Default: |
|
Resource name. Choices:
|
|
Ignored if NIOC version is set to version2 Amount of bandwidth resource that is guaranteed available to the host infrastructure traffic class. If the utilization is less than the reservation, the extra bandwidth is used for other host infrastructure traffic class types. Reservation is not allowed to exceed the value of limit, if limit is set. Unit is Mbits/sec. Ignored unless version is “version3”. Amount of bandwidth resource that is guaranteed available to the host infrastructure traffic class. Default: |
|
The number of shares allocated. Ignored unless |
|
The allocation level The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Choices:
|
|
Enable or disable NIOC on the distributed switch. Choices:
|
|
The name of the distributed switch. |
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to Choices:
|
|
Network IO control version. Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Enable NIOC
community.vmware.vmware_dvswitch_nioc:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
switch: dvSwitch
version: version3
resources:
- name: vmotion
limit: -1
reservation: 128
shares_level: normal
- name: vsan
limit: -1
shares_level: custom
shares: 99
reservation: 256
state: present
delegate_to: localhost
- name: Disable NIOC
community.vmware.vmware_dvswitch_nioc:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
switch: dvSwitch
state: absent
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
result of the changes Returned: success |
|
list of resources which were changed Returned: success Sample: |