VMware: Add new module vmware_dvswitch_nioc (#44147)
Signed-off-by: Joseph Andreatta <joseph@vmware.com> Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Joseph Andreatta
Abhijeet Kasurde
parent
0868fec8bd
commit
0a27ad6ea0
3 changed files with 505 additions and 0 deletions
399
lib/ansible/modules/cloud/vmware/vmware_dvswitch_nioc.py
Normal file
399
lib/ansible/modules/cloud/vmware/vmware_dvswitch_nioc.py
Normal file
|
|
@ -0,0 +1,399 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright: (c) 2018, VMware, Inc.
|
||||
# Copyright: (c) 2019, Abhijeet Kasurde <akasurde@redhat.com>
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
ANSIBLE_METADATA = {
|
||||
'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'
|
||||
}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: vmware_dvswitch_nioc
|
||||
short_description: Manage distributed switch Network IO Control
|
||||
description:
|
||||
- This module can be used to manage distributed switch Network IO Control configurations.
|
||||
version_added: "2.9"
|
||||
author:
|
||||
- Joseph Andreatta (@vmwjoseph)
|
||||
notes:
|
||||
- Tested on vSphere 6.7
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
- PyVmomi
|
||||
options:
|
||||
switch:
|
||||
description:
|
||||
- The name of the distributed switch.
|
||||
required: True
|
||||
aliases: ['dvswitch']
|
||||
type: str
|
||||
version:
|
||||
description:
|
||||
- Network IO control version.
|
||||
choices:
|
||||
- 'version2'
|
||||
- 'version3'
|
||||
required: False
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
- Enable or disable NIOC on the distributed switch.
|
||||
default: 'present'
|
||||
choices: ['present', 'absent']
|
||||
required: False
|
||||
type: str
|
||||
resources:
|
||||
description:
|
||||
- 'List of dicts containing
|
||||
{ name: Resource name is one of the following: "faultTolerance", "hbr", "iSCSI", "management", "nfs", "vdp",
|
||||
"virtualMachine", "vmotion", "vsan"
|
||||
limit: The maximum allowed usage for a traffic class belonging to this resource pool per host physical NIC.
|
||||
reservation: (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.
|
||||
shares_level: The allocation level ("low", "normal", "high", "custom"). The level is a simplified view
|
||||
of shares. Levels map to a pre-determined set of numeric values for shares.
|
||||
shares: Ignored unless shares_level is "custom". The number of shares allocated.
|
||||
reservation: Ignored unless version is "version3". Amount of bandwidth resource that is guaranteed
|
||||
available to the host infrastructure traffic class.
|
||||
}'
|
||||
required: False
|
||||
type: list
|
||||
extends_documentation_fragment: vmware.documentation
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
dvswitch_nioc_status:
|
||||
description:
|
||||
- result of the changes
|
||||
returned: success
|
||||
type: str
|
||||
resources_changed:
|
||||
description:
|
||||
- list of resources which were changed
|
||||
returned: success
|
||||
type: list
|
||||
sample: [ "vmotion", "vsan" ]
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Enable NIOC
|
||||
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
|
||||
vmware_dvswitch_nioc:
|
||||
hostname: '{{ vcenter_hostname }}'
|
||||
username: '{{ vcenter_username }}'
|
||||
password: '{{ vcenter_password }}'
|
||||
switch: dvSwitch
|
||||
state: absent
|
||||
delegate_to: localhost
|
||||
'''
|
||||
|
||||
try:
|
||||
from pyVmomi import vim, vmodl
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils._text import to_native
|
||||
from ansible.module_utils.vmware import PyVmomi, find_datacenter_by_name, find_dvs_by_name, vmware_argument_spec, wait_for_task
|
||||
|
||||
|
||||
class VMwareDVSwitchNIOC(PyVmomi):
|
||||
|
||||
def __init__(self, module):
|
||||
super(VMwareDVSwitchNIOC, self).__init__(module)
|
||||
self.dvs = None
|
||||
self.resource_changes = list()
|
||||
self.switch = module.params['switch']
|
||||
self.version = module.params.get('version')
|
||||
self.state = module.params['state']
|
||||
self.resources = module.params.get('resources')
|
||||
self.result = {
|
||||
'changed': False,
|
||||
'dvswitch_nioc_status': 'Unchanged',
|
||||
'resources_changed': list(),
|
||||
}
|
||||
|
||||
def process_state(self):
|
||||
nioc_states = {
|
||||
'absent': {
|
||||
'present': self.state_disable_nioc,
|
||||
'absent': self.state_exit,
|
||||
},
|
||||
'present': {
|
||||
'version': self.state_update_nioc_version,
|
||||
'update': self.state_update_nioc_resources,
|
||||
'present': self.state_exit,
|
||||
'absent': self.state_enable_nioc,
|
||||
}
|
||||
}
|
||||
nioc_states[self.state][self.check_nioc_state()]()
|
||||
self.state_exit()
|
||||
|
||||
def state_exit(self):
|
||||
self.module.exit_json(**self.result)
|
||||
|
||||
def state_disable_nioc(self):
|
||||
self.result['changed'] = True
|
||||
if not self.module.check_mode:
|
||||
self.set_nioc_enabled(False)
|
||||
self.result['dvswitch_nioc_status'] = 'Disabled NIOC'
|
||||
|
||||
def state_enable_nioc(self):
|
||||
self.result['changed'] = True
|
||||
if not self.module.check_mode:
|
||||
self.set_nioc_enabled(True)
|
||||
self.set_nioc_version()
|
||||
self.result['dvswitch_nioc_status'] = "Enabled NIOC with version %s" % self.version
|
||||
|
||||
# Check resource state and apply all required changes
|
||||
if self.check_resources() == 'update':
|
||||
self.set_nioc_resources(self.resource_changes)
|
||||
|
||||
def state_update_nioc_version(self):
|
||||
self.result['changed'] = True
|
||||
if not self.module.check_mode:
|
||||
self.set_nioc_version()
|
||||
self.result['dvswitch_nioc_status'] = "Set NIOC to version %s" % self.version
|
||||
|
||||
# Check resource state and apply all required changes
|
||||
if self.check_resources() == 'update':
|
||||
self.set_nioc_resources(self.resource_changes)
|
||||
|
||||
def state_update_nioc_resources(self):
|
||||
self.result['changed'] = True
|
||||
if not self.module.check_mode:
|
||||
self.result['dvswitch_nioc_status'] = "Resource configuration modified"
|
||||
self.set_nioc_resources(self.resource_changes)
|
||||
|
||||
def set_nioc_enabled(self, state):
|
||||
try:
|
||||
self.dvs.EnableNetworkResourceManagement(enable=state)
|
||||
except vim.fault.DvsFault as dvs_fault:
|
||||
self.module.fail_json(msg='DvsFault while setting NIOC enabled=%r: %s' % (state, to_native(dvs_fault.msg)))
|
||||
except vim.fault.DvsNotAuthorized as auth_fault:
|
||||
self.module.fail_json(msg='Not authorized to set NIOC enabled=%r: %s' % (state, to_native(auth_fault.msg)))
|
||||
except vmodl.fault.NotSupported as support_fault:
|
||||
self.module.fail_json(msg='NIOC not supported by DVS: %s' % to_native(support_fault.msg))
|
||||
except vmodl.RuntimeFault as runtime_fault:
|
||||
self.module.fail_json(msg='RuntimeFault while setting NIOC enabled=%r: %s' % (state, to_native(runtime_fault.msg)))
|
||||
|
||||
def set_nioc_version(self):
|
||||
upgrade_spec = vim.DistributedVirtualSwitch.ConfigSpec()
|
||||
upgrade_spec.configVersion = self.dvs.config.configVersion
|
||||
if not self.version:
|
||||
self.version = 'version2'
|
||||
upgrade_spec.networkResourceControlVersion = self.version
|
||||
|
||||
try:
|
||||
task = self.dvs.ReconfigureDvs_Task(spec=upgrade_spec)
|
||||
wait_for_task(task)
|
||||
except vmodl.RuntimeFault as runtime_fault:
|
||||
self.module.fail_json(msg="RuntimeFault when setting NIOC version: %s " % to_native(runtime_fault.msg))
|
||||
|
||||
def check_nioc_state(self):
|
||||
self.dvs = find_dvs_by_name(self.content, self.switch)
|
||||
|
||||
if self.dvs is None:
|
||||
self.module.fail_json(msg='DVS %s was not found.' % self.switch)
|
||||
else:
|
||||
if not self.dvs.config.networkResourceManagementEnabled:
|
||||
return 'absent'
|
||||
if self.version and self.dvs.config.networkResourceControlVersion != self.version:
|
||||
return 'version'
|
||||
|
||||
# NIOC is enabled and the correct version, so return the state of the resources
|
||||
return self.check_resources()
|
||||
|
||||
def check_resources(self):
|
||||
self.dvs = find_dvs_by_name(self.content, self.switch)
|
||||
if self.dvs is None:
|
||||
self.module.fail_json(msg="DVS named '%s' was not found" % self.switch)
|
||||
|
||||
for resource in self.resources:
|
||||
if self.check_resource_state(resource) == 'update':
|
||||
self.resource_changes.append(resource)
|
||||
self.result['resources_changed'].append(resource['name'])
|
||||
|
||||
if len(self.resource_changes) > 0:
|
||||
return 'update'
|
||||
return 'present'
|
||||
|
||||
def check_resource_state(self, resource):
|
||||
resource_cfg = self.find_netioc_by_key(resource['name'])
|
||||
if resource_cfg is None:
|
||||
self.module.fail_json(msg="NetIOC resource named '%s' was not found" % resource['name'])
|
||||
|
||||
rc = {
|
||||
"limit": resource_cfg.allocationInfo.limit,
|
||||
"shares_level": resource_cfg.allocationInfo.shares.level
|
||||
}
|
||||
if resource_cfg.allocationInfo.shares.level == 'custom':
|
||||
rc["shares"] = resource_cfg.allocationInfo.shares.shares
|
||||
if self.dvs.config.networkResourceControlVersion == "version3":
|
||||
rc["reservation"] = resource_cfg.allocationInfo.reservation
|
||||
|
||||
for k, v in rc.items():
|
||||
if k in resource and v != resource[k]:
|
||||
return 'update'
|
||||
return 'valid'
|
||||
|
||||
def set_nioc_resources(self, resources):
|
||||
if self.dvs.config.networkResourceControlVersion == 'version3':
|
||||
self._update_version3_resources(resources)
|
||||
elif self.dvs.config.networkResourceControlVersion == 'version2':
|
||||
self._update_version2_resources(resources)
|
||||
|
||||
def _update_version3_resources(self, resources):
|
||||
allocations = list()
|
||||
|
||||
for resource in resources:
|
||||
allocation = vim.DistributedVirtualSwitch.HostInfrastructureTrafficResource()
|
||||
allocation.allocationInfo = vim.DistributedVirtualSwitch.HostInfrastructureTrafficResource.ResourceAllocation()
|
||||
allocation.key = resource['name']
|
||||
if 'limit' in resource:
|
||||
allocation.allocationInfo.limit = resource['limit']
|
||||
if 'reservation' in resource:
|
||||
allocation.allocationInfo.reservation = resource['reservation']
|
||||
if 'shares_level' in resource:
|
||||
allocation.allocationInfo.shares = vim.SharesInfo()
|
||||
allocation.allocationInfo.shares.level = resource['shares_level']
|
||||
if 'shares' in resource and resource['shares_level'] == 'custom':
|
||||
allocation.allocationInfo.shares.shares = resource['shares']
|
||||
elif resource['shares_level'] == 'custom':
|
||||
self.module.fail_json(
|
||||
msg="Resource %s, shares_level set to custom but shares not specified" % resource['name']
|
||||
)
|
||||
|
||||
allocations.append(allocation)
|
||||
|
||||
spec = vim.DistributedVirtualSwitch.ConfigSpec()
|
||||
spec.configVersion = self.dvs.config.configVersion
|
||||
spec.infrastructureTrafficResourceConfig = allocations
|
||||
|
||||
task = self.dvs.ReconfigureDvs_Task(spec)
|
||||
wait_for_task(task)
|
||||
|
||||
def _update_version2_resources(self, resources):
|
||||
allocations = list()
|
||||
|
||||
for resource in resources:
|
||||
resource_cfg = self.find_netioc_by_key(resource['name'])
|
||||
allocation = vim.DVSNetworkResourcePoolConfigSpec()
|
||||
allocation.allocationInfo = vim.DVSNetworkResourcePoolAllocationInfo()
|
||||
allocation.key = resource['name']
|
||||
allocation.configVersion = resource_cfg.configVersion
|
||||
if 'limit' in resource:
|
||||
allocation.allocationInfo.limit = resource['limit']
|
||||
if 'shares_level' in resource:
|
||||
allocation.allocationInfo.shares = vim.SharesInfo()
|
||||
allocation.allocationInfo.shares.level = resource['shares_level']
|
||||
if 'shares' in resource and resource['shares_level'] == 'custom':
|
||||
allocation.allocationInfo.shares.shares = resource['shares']
|
||||
|
||||
allocations.append(allocation)
|
||||
|
||||
self.dvs.UpdateNetworkResourcePool(allocations)
|
||||
|
||||
def find_netioc_by_key(self, resource_name):
|
||||
config = None
|
||||
if self.dvs.config.networkResourceControlVersion == "version3":
|
||||
config = self.dvs.config.infrastructureTrafficResourceConfig
|
||||
elif self.dvs.config.networkResourceControlVersion == "version2":
|
||||
config = self.dvs.networkResourcePool
|
||||
|
||||
for obj in config:
|
||||
if obj.key == resource_name:
|
||||
return obj
|
||||
return None
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = vmware_argument_spec()
|
||||
|
||||
argument_spec.update(
|
||||
dict(
|
||||
switch=dict(required=True, type='str', aliases=['dvswitch']),
|
||||
version=dict(type='str', choices=['version2', 'version3']),
|
||||
state=dict(default='present', choices=['present', 'absent'], type='str'),
|
||||
resources=dict(
|
||||
type='list',
|
||||
default=list(),
|
||||
elements='dict',
|
||||
options=dict(
|
||||
name=dict(
|
||||
type='str',
|
||||
required=True,
|
||||
choices=[
|
||||
'faultTolerance',
|
||||
'hbr',
|
||||
'iSCSI',
|
||||
'management',
|
||||
'nfs',
|
||||
'vdp',
|
||||
'virtualMachine',
|
||||
'vmotion',
|
||||
'vsan'
|
||||
]
|
||||
),
|
||||
limit=dict(type='int', default=-1),
|
||||
shares_level=dict(
|
||||
type='str',
|
||||
required=False,
|
||||
choices=[
|
||||
'low',
|
||||
'normal',
|
||||
'high',
|
||||
'custom'
|
||||
]
|
||||
),
|
||||
shares=dict(type='int', required=False),
|
||||
reservation=dict(type='int', default=0)
|
||||
)
|
||||
),
|
||||
)
|
||||
)
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
|
||||
|
||||
try:
|
||||
vmware_dvswitch_nioc = VMwareDVSwitchNIOC(module)
|
||||
vmware_dvswitch_nioc.process_state()
|
||||
except vmodl.RuntimeFault as runtime_fault:
|
||||
module.fail_json(msg=to_native(runtime_fault.msg))
|
||||
except vmodl.MethodFault as method_fault:
|
||||
module.fail_json(msg=to_native(method_fault.msg))
|
||||
except Exception as e:
|
||||
module.fail_json(msg=to_native(e))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
3
test/integration/targets/vmware_dvswitch_nioc/aliases
Normal file
3
test/integration/targets/vmware_dvswitch_nioc/aliases
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
cloud/vcenter
|
||||
shippable/vcenter/group1
|
||||
needs/target/prepare_vmware_tests
|
||||
103
test/integration/targets/vmware_dvswitch_nioc/tasks/main.yml
Normal file
103
test/integration/targets/vmware_dvswitch_nioc/tasks/main.yml
Normal file
|
|
@ -0,0 +1,103 @@
|
|||
# Test code for the vmware_dvswitch_nioc module.
|
||||
# Copyright: (c) 2018, VMware, Inc.
|
||||
# Copyright: (c) 2019, Abhijeet Kasurde <akasurde@redhat.com>
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
- when: vcsim is not defined
|
||||
block:
|
||||
- import_role:
|
||||
name: prepare_vmware_tests
|
||||
|
||||
- name: Add distributed vSwitch
|
||||
vmware_dvswitch:
|
||||
validate_certs: False
|
||||
hostname: "{{ vcenter_hostname }}"
|
||||
username: "{{ vcenter_username }}"
|
||||
password: "{{ vcenter_password }}"
|
||||
datacenter_name: "{{ dc1 }}"
|
||||
state: present
|
||||
switch_name: dvswitch_0001
|
||||
mtu: 9000
|
||||
uplink_quantity: 2
|
||||
discovery_proto: lldp
|
||||
discovery_operation: both
|
||||
register: dvs_result_0001
|
||||
|
||||
- debug:
|
||||
var: dvs_result_0001
|
||||
|
||||
- name: ensure distributed vswitch is present
|
||||
assert:
|
||||
that:
|
||||
- dvs_result_0001 is changed
|
||||
|
||||
- &enable_nioc
|
||||
name: Enable NIOC
|
||||
vmware_dvswitch_nioc:
|
||||
hostname: "{{ vcenter_server }}"
|
||||
username: "{{ vcenter_user }}"
|
||||
password: "{{ vcenter_pass }}"
|
||||
switch: dvswitch_0001
|
||||
version: version3
|
||||
validate_certs: no
|
||||
resources:
|
||||
- name: vmotion
|
||||
limit: -1
|
||||
reservation: 128
|
||||
shares_level: normal
|
||||
- name: vsan
|
||||
limit: -1
|
||||
shares_level: custom
|
||||
shares: 99
|
||||
reservation: 256
|
||||
state: present
|
||||
register: enable_nioc_result
|
||||
|
||||
- debug:
|
||||
var: enable_nioc_result
|
||||
|
||||
- name: Check if nioc is enabled
|
||||
assert:
|
||||
that:
|
||||
- enable_nioc_result.changed
|
||||
|
||||
- <<: *enable_nioc
|
||||
name: Change nioc settings again and make sure it does not change
|
||||
register: enable_nioc_result_2
|
||||
|
||||
- name: Check if nioc changes are not made
|
||||
assert:
|
||||
that:
|
||||
- not enable_nioc_result_2.changed
|
||||
|
||||
- &disable_nioc
|
||||
name: Disable NIOC
|
||||
vmware_dvswitch_nioc:
|
||||
hostname: "{{ vcenter_server }}"
|
||||
username: "{{ vcenter_user }}"
|
||||
password: "{{ vcenter_pass }}"
|
||||
switch: dvswitch_0001
|
||||
validate_certs: no
|
||||
state: absent
|
||||
register: disable_nioc_result
|
||||
|
||||
- debug:
|
||||
var: disable_nioc_result
|
||||
|
||||
- name: Check if nioc is disabled
|
||||
assert:
|
||||
that:
|
||||
- disable_nioc_result.changed
|
||||
|
||||
- <<: *disable_nioc
|
||||
name: Disable NIOC again
|
||||
register: disable_nioc_result_2
|
||||
|
||||
- debug:
|
||||
var: disable_nioc_result_2
|
||||
|
||||
- name: Check if nioc is not disabled since it is already disabled
|
||||
assert:
|
||||
that:
|
||||
- not disable_nioc_result_2.changed
|
||||
Loading…
Reference in a new issue