W3cubDocs

/Ansible

community.vmware.vmware_dvswitch_nioc – Manage distributed switch Network IO Control

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_dvswitch_nioc.

Synopsis

  • This module can be used to manage distributed switch Network IO Control configurations.

Requirements

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

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
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.
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.
resources
list / elements=dictionary
List of dicts containing.
limit
integer
Default:
-1
The maximum allowed usage for a traffic class belonging to this resource pool per host physical NIC.
name
string / required
    Choices:
  • faultTolerance
  • hbr
  • iSCSI
  • management
  • nfs
  • vdp
  • virtualMachine
  • vmotion
  • vsan
Resource name.
reservation
integer
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.
shares
integer
The number of shares allocated.
Ignored unless shares_level is "custom".
shares_level
string
    Choices:
  • low
  • normal
  • high
  • custom
The allocation level
The level is a simplified view of shares.
Levels map to a pre-determined set of numeric values for shares.
state
string
    Choices:
  • present ←
  • absent
Enable or disable NIOC on the distributed switch.
switch
string / required
The name of the distributed switch.

aliases: dvswitch
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.
version
string
    Choices:
  • version2
  • version3
Network IO control version.

Notes

Note

  • Tested on vSphere 6.7
  • 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 Returned Description
dvswitch_nioc_status
string
success
result of the changes
resources_changed
list / elements=string
success
list of resources which were changed

Sample:
['vmotion', 'vsan']


Authors

  • Joseph Andreatta (@vmwjoseph)

© 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_dvswitch_nioc_module.html