mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Ucs vnic template and integration tests (#35136)
* UCS vNIC templates and integration tests * docs updated * UCS vNIC template and integration test * Update docs and argument_spec for description, mtu, and target.
This commit is contained in:
David Soper
Dag Wieers
parent
3116585ae4
commit
9945d9a720
3 changed files with 454 additions and 0 deletions
317
lib/ansible/modules/remote_management/ucs/ucs_vnic_template.py
Normal file
317
lib/ansible/modules/remote_management/ucs/ucs_vnic_template.py
Normal file
|
|
@ -0,0 +1,317 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# 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 = r'''
|
||||
---
|
||||
module: ucs_vnic_template
|
||||
short_description: Configures vNIC templates on Cisco UCS Manager
|
||||
description:
|
||||
- Configures vNIC templates on Cisco UCS Manager.
|
||||
- Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).
|
||||
extends_documentation_fragment: ucs
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- If C(present), will verify vNIC templates are present and will create if needed.
|
||||
- If C(absent), will verify vNIC templates are absent and will delete if needed.
|
||||
choices: [present, absent]
|
||||
default: present
|
||||
name:
|
||||
description:
|
||||
- The name of the vNIC template.
|
||||
- This name can be between 1 and 16 alphanumeric characters.
|
||||
- "You cannot use spaces or any special characters other than - (hyphen), \"_\" (underscore), : (colon), and . (period)."
|
||||
- You cannot change this name after the template is created.
|
||||
required: yes
|
||||
description:
|
||||
description:
|
||||
- A user-defined description of the vNIC template.
|
||||
- Enter up to 256 characters.
|
||||
- "You can use any characters or spaces except the following:"
|
||||
- "` (accent mark), \ (backslash), ^ (carat), \" (double quote), = (equal sign), > (greater than), < (less than), or ' (single quote)."
|
||||
aliases: [ descr ]
|
||||
fabric:
|
||||
description:
|
||||
- The Fabric ID field specifying the fabric interconnect associated with vNICs created from this template.
|
||||
- If you want fabric failover enabled on vNICs created from this template, use of of the following:"
|
||||
- "A-B to use Fabric A by default with failover enabled."
|
||||
- "B-A to use Fabric B by default with failover enabled."
|
||||
- "Do not enable vNIC fabric failover under the following circumstances:"
|
||||
- "- If the Cisco UCS domain is running in Ethernet switch mode. vNIC fabric failover is not supported in that mode."
|
||||
- "- If you plan to associate one or more vNICs created from this template to a server with an adapter that does not support fabric failover."
|
||||
choices: [A, B, A-B, B-A]
|
||||
default: A
|
||||
redundancy_type:
|
||||
description:
|
||||
- The Redundancy Type used for vNIC redundancy pairs during fabric failover.
|
||||
- "This can be one of the following:"
|
||||
- "primary — Creates configurations that can be shared with the Secondary template."
|
||||
- "secondary — All shared configurations are inherited from the Primary template."
|
||||
- "none - Legacy vNIC template behavior. Select this option if you do not want to use redundancy."
|
||||
choices: [none, primary, secondary]
|
||||
default: none
|
||||
target:
|
||||
description:
|
||||
- The possible target for vNICs created from this template.
|
||||
- The target determines whether or not Cisco UCS Manager automatically creates a VM-FEX port profile with the appropriate settings for the vNIC template.
|
||||
- "This can be one of the following:"
|
||||
- "adapter — The vNICs apply to all adapters. No VM-FEX port profile is created if you choose this option."
|
||||
- "vm - The vNICs apply to all virtual machines. A VM-FEX port profile is created if you choose this option."
|
||||
default: adapter
|
||||
template_type:
|
||||
description:
|
||||
- The Template Type field.
|
||||
- "This can be one of the following:"
|
||||
- "initial-template — vNICs created from this template are not updated if the template changes."
|
||||
- "updating-template - vNICs created from this template are updated if the template changes."
|
||||
choices: [initial-template, updating-template]
|
||||
default: initial-template
|
||||
vlans_list:
|
||||
description:
|
||||
- List of VLANs used by the vNIC template.
|
||||
- "Each list element has the following suboptions:"
|
||||
- "= name"
|
||||
- " The name of the VLAN (required)."
|
||||
- "- native"
|
||||
- " Designates the VLAN as a native VLAN. Only one VLAN in the list can be a native VLAN."
|
||||
- " [choices: 'no', 'yes']"
|
||||
- " [Default: 'no']"
|
||||
cdn_source:
|
||||
description:
|
||||
- CDN Source field.
|
||||
- "This can be one of the following options:"
|
||||
- "vnic-name - Uses the vNIC template name of the vNIC instance as the CDN name. This is the default option."
|
||||
- "user-defined - Uses a user-defined CDN name for the vNIC template. If this option is chosen, cdn_name must also be provided."
|
||||
choices: [vnic-name, user-defined]
|
||||
default: vnic-name
|
||||
cdn_name:
|
||||
description:
|
||||
- CDN Name used when cdn_source is set to user-defined.
|
||||
mtu:
|
||||
description:
|
||||
- The MTU field.
|
||||
- The maximum transmission unit, or packet size, that vNICs created from this vNIC template should use.
|
||||
- Enter a string between '1500' and '9000'.
|
||||
- If the vNIC template has an associated QoS policy, the MTU specified here must be equal to or less than the MTU specified in the QoS system class.
|
||||
default: '1500'
|
||||
mac_pool:
|
||||
description:
|
||||
- The MAC address pool that vNICs created from this vNIC template should use.
|
||||
qos_policy:
|
||||
description:
|
||||
- The quality of service (QoS) policy that vNICs created from this vNIC template should use.
|
||||
network_control_policy:
|
||||
description:
|
||||
- The network control policy that vNICs created from this vNIC template should use.
|
||||
pin_group:
|
||||
description:
|
||||
- The LAN pin group that vNICs created from this vNIC template should use.
|
||||
stats_policy:
|
||||
description:
|
||||
- The statistics collection policy that vNICs created from this vNIC template should use.
|
||||
default: default
|
||||
org_dn:
|
||||
description:
|
||||
- Org dn (distinguished name)
|
||||
default: org-root
|
||||
requirements:
|
||||
- ucsmsdk
|
||||
author:
|
||||
- David Soper (@dsoper2)
|
||||
- CiscoUcs (@CiscoUcs)
|
||||
version_added: '2.5'
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Configure vNIC template
|
||||
ucs_vnic_template:
|
||||
hostname: 172.16.143.150
|
||||
username: admin
|
||||
password: password
|
||||
name: vNIC-A
|
||||
fabric: A
|
||||
vlans_list:
|
||||
- name: default
|
||||
native: 'yes'
|
||||
|
||||
- name: Configure vNIC template with failover
|
||||
ucs_vnic_template:
|
||||
hostname: 172.16.143.150
|
||||
username: admin
|
||||
password: password
|
||||
name: vNIC-A-B
|
||||
fabric: A-B
|
||||
vlans_list:
|
||||
- name: default
|
||||
native: 'yes'
|
||||
- name: finance
|
||||
|
||||
- name: Remove vNIC template
|
||||
ucs_vnic_template:
|
||||
hostname: 172.16.143.150
|
||||
username: admin
|
||||
password: password
|
||||
name: vNIC-A
|
||||
state: absent
|
||||
|
||||
- name: Remove another vNIC template
|
||||
ucs_vnic_template:
|
||||
hostname: 172.16.143.150
|
||||
username: admin
|
||||
password: password
|
||||
name: vNIC-A-B
|
||||
state: absent
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
#
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.remote_management.ucs import UCSModule, ucs_argument_spec
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = ucs_argument_spec
|
||||
argument_spec.update(
|
||||
org_dn=dict(type='str', default='org-root'),
|
||||
name=dict(type='str', required=True),
|
||||
description=dict(type='str', aliases=['descr'], default=''),
|
||||
fabric=dict(type='str', default='A', choices=['A', 'B', 'A-B', 'B-A']),
|
||||
redundancy_type=dict(type='str', default='none', choices=['none', 'primary', 'secondary']),
|
||||
target=dict(type='str', default='adapter', choices=['adapter', 'vm']),
|
||||
template_type=dict(type='str', default='initial-template', choices=['initial-template', 'updating-template']),
|
||||
vlans_list=dict(type='list'),
|
||||
cdn_source=dict(type='str', default='vnic-name', choices=['vnic-name', 'user-defined']),
|
||||
cdn_name=dict(type='str', default=''),
|
||||
mtu=dict(type='str', default='1500'),
|
||||
mac_pool=dict(type='str', default=''),
|
||||
qos_policy=dict(type='str', default=''),
|
||||
network_control_policy=dict(type='str', default=''),
|
||||
pin_group=dict(type='str', default=''),
|
||||
stats_policy=dict(type='str', default='default'),
|
||||
state=dict(type='str', default='present', choices=['present', 'absent']),
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec,
|
||||
supports_check_mode=True,
|
||||
)
|
||||
ucs = UCSModule(module)
|
||||
|
||||
err = False
|
||||
|
||||
# UCSModule creation above verifies ucsmsdk is present and exits on failure. Additional imports are done below.
|
||||
from ucsmsdk.mometa.vnic.VnicLanConnTempl import VnicLanConnTempl
|
||||
from ucsmsdk.mometa.vnic.VnicEtherIf import VnicEtherIf
|
||||
|
||||
changed = False
|
||||
try:
|
||||
mo_exists = False
|
||||
props_match = False
|
||||
# dn is <org_dn>/lan-conn-templ-<name>
|
||||
dn = module.params['org_dn'] + '/lan-conn-templ-' + module.params['name']
|
||||
|
||||
mo = ucs.login_handle.query_dn(dn)
|
||||
if mo:
|
||||
mo_exists = True
|
||||
|
||||
if module.params['state'] == 'absent':
|
||||
# mo must exist but all properties do not have to match
|
||||
if mo_exists:
|
||||
if not module.check_mode:
|
||||
ucs.login_handle.remove_mo(mo)
|
||||
ucs.login_handle.commit()
|
||||
changed = True
|
||||
else:
|
||||
# set default params for lists which can't be done in the argument_spec
|
||||
if module.params.get('vlans_list'):
|
||||
for vlan in module.params['vlans_list']:
|
||||
if not vlan.get('native'):
|
||||
vlan['native'] = 'no'
|
||||
# for target 'adapter', change to internal UCS Manager spelling 'adaptor'
|
||||
if module.params['target'] == 'adapter':
|
||||
module.params['target'] = 'adaptor'
|
||||
if mo_exists:
|
||||
# check top-level mo props
|
||||
kwargs = dict(descr=module.params['description'])
|
||||
kwargs['switch_id'] = module.params['fabric']
|
||||
kwargs['redundancy_pair_type'] = module.params['redundancy_type']
|
||||
kwargs['target'] = module.params['target']
|
||||
kwargs['templ_type'] = module.params['template_type']
|
||||
kwargs['cdn_source'] = module.params['cdn_source']
|
||||
kwargs['admin_cdn_name'] = module.params['cdn_name']
|
||||
kwargs['mtu'] = module.params['mtu']
|
||||
kwargs['ident_pool_name'] = module.params['mac_pool']
|
||||
kwargs['qos_policy_name'] = module.params['qos_policy']
|
||||
kwargs['nw_ctrl_policy_name'] = module.params['network_control_policy']
|
||||
kwargs['pin_to_group_name'] = module.params['pin_group']
|
||||
kwargs['stats_policy_name'] = module.params['stats_policy']
|
||||
if (mo.check_prop_match(**kwargs)):
|
||||
# top-level props match, check next level mo/props
|
||||
if not module.params.get('vlans_list'):
|
||||
props_match = True
|
||||
else:
|
||||
# check vlan props
|
||||
for vlan in module.params['vlans_list']:
|
||||
child_dn = dn + '/if-' + vlan['name']
|
||||
mo_1 = ucs.login_handle.query_dn(child_dn)
|
||||
if mo_1:
|
||||
kwargs = dict(default_net=vlan['native'])
|
||||
if (mo_1.check_prop_match(**kwargs)):
|
||||
props_match = True
|
||||
|
||||
if not props_match:
|
||||
if not module.check_mode:
|
||||
# create if mo does not already exist
|
||||
mo = VnicLanConnTempl(
|
||||
parent_mo_or_dn=module.params['org_dn'],
|
||||
name=module.params['name'],
|
||||
descr=module.params['description'],
|
||||
switch_id=module.params['fabric'],
|
||||
redundancy_pair_type=module.params['redundancy_type'],
|
||||
target=module.params['target'],
|
||||
templ_type=module.params['template_type'],
|
||||
cdn_source=module.params['cdn_source'],
|
||||
admin_cdn_name=module.params['cdn_name'],
|
||||
mtu=module.params['mtu'],
|
||||
ident_pool_name=module.params['mac_pool'],
|
||||
qos_policy_name=module.params['qos_policy'],
|
||||
nw_ctrl_policy_name=module.params['network_control_policy'],
|
||||
pin_to_group_name=module.params['pin_group'],
|
||||
stats_policy_name=module.params['stats_policy'],
|
||||
)
|
||||
|
||||
if module.params.get('vlans_list'):
|
||||
for vlan in module.params['vlans_list']:
|
||||
mo_1 = VnicEtherIf(
|
||||
parent_mo_or_dn=mo,
|
||||
name=vlan['name'],
|
||||
default_net=vlan['native'],
|
||||
)
|
||||
|
||||
ucs.login_handle.add_mo(mo, True)
|
||||
ucs.login_handle.commit()
|
||||
changed = True
|
||||
|
||||
except Exception as e:
|
||||
err = True
|
||||
ucs.result['msg'] = "setup error: %s " % str(e)
|
||||
|
||||
ucs.result['changed'] = changed
|
||||
if err:
|
||||
module.fail_json(**ucs.result)
|
||||
module.exit_json(**ucs.result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
6
test/integration/targets/ucs_vnic_template/aliases
Normal file
6
test/integration/targets/ucs_vnic_template/aliases
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
# Not enabled, but can be used with the UCS Platform Emulator or UCS hardware.
|
||||
# Example integration_config.yml:
|
||||
# ---
|
||||
# ucs_hostname: 172.16.143.136
|
||||
# ucs_username: admin
|
||||
# ucs_password: password
|
||||
131
test/integration/targets/ucs_vnic_template/tasks/main.yml
Normal file
131
test/integration/targets/ucs_vnic_template/tasks/main.yml
Normal file
|
|
@ -0,0 +1,131 @@
|
|||
# Test code for the UCS modules
|
||||
# Copyright 2017, David Soper (@dsoper2)
|
||||
|
||||
- name: Test that we have a UCS host, UCS username, and UCS password
|
||||
fail:
|
||||
msg: 'Please define the following variables: ucs_hostname, ucs_username and ucs_password.'
|
||||
when: ucs_hostname is not defined or ucs_username is not defined or ucs_password is not defined
|
||||
vars:
|
||||
login_info: &login_info
|
||||
hostname: "{{ ucs_hostname }}"
|
||||
username: "{{ ucs_username }}"
|
||||
password: "{{ ucs_password }}"
|
||||
|
||||
|
||||
# Setup (clean environment)
|
||||
- name: vNIC template absent
|
||||
ucs_vnic_template: &vnic_templates_absent
|
||||
<<: *login_info
|
||||
name: vNIC-A-B
|
||||
state: absent
|
||||
|
||||
|
||||
# Test present (check_mode)
|
||||
- name: vNIC template present (check_mode)
|
||||
ucs_vnic_template: &vnic_templates_present
|
||||
<<: *login_info
|
||||
name: vNIC-A-B
|
||||
fabric: A-B
|
||||
vlans_list:
|
||||
- name: default
|
||||
native: 'yes'
|
||||
- name: finance
|
||||
check_mode: yes
|
||||
register: cm_vnic_templates_present
|
||||
|
||||
|
||||
# Present (normal mode)
|
||||
- name: vNIC template present (normal mode)
|
||||
ucs_vnic_template: *vnic_templates_present
|
||||
register: nm_vnic_templates_present
|
||||
|
||||
|
||||
# Test present again (idempotent)
|
||||
- name: vNIC template present again (check_mode)
|
||||
ucs_vnic_template: *vnic_templates_present
|
||||
check_mode: yes
|
||||
register: cm_vnic_templates_present_again
|
||||
|
||||
|
||||
# Present again (normal mode)
|
||||
- name: vNIC template present again (normal mode)
|
||||
ucs_vnic_template: *vnic_templates_present
|
||||
register: nm_vnic_templates_present_again
|
||||
|
||||
|
||||
# Verfiy present
|
||||
- name: Verify vNIC template present results
|
||||
assert:
|
||||
that:
|
||||
- cm_vnic_templates_present.changed == nm_vnic_templates_present.changed == true
|
||||
- cm_vnic_templates_present_again.changed == nm_vnic_templates_present_again.changed == false
|
||||
|
||||
|
||||
# Test change (check_mode)
|
||||
- name: vNIC template description change (check_mode)
|
||||
ucs_vnic_template: &vnic_templates_change
|
||||
<<: *vnic_templates_present
|
||||
descr: Testing Ansible
|
||||
check_mode: yes
|
||||
register: cm_vnic_templates_descr_change
|
||||
|
||||
|
||||
# Change (normal mode)
|
||||
- name: vNIC template description change (normal mode)
|
||||
ucs_vnic_template: *vnic_templates_change
|
||||
register: nm_vnic_templates_descr_change
|
||||
|
||||
|
||||
# Test change again (idempotent)
|
||||
- name: vNIC template description again (check_mode)
|
||||
ucs_vnic_template: *vnic_templates_change
|
||||
check_mode: yes
|
||||
register: cm_vnic_templates_descr_change_again
|
||||
|
||||
|
||||
# Change again (normal mode)
|
||||
- name: vNIC template description change again (normal mode)
|
||||
ucs_vnic_template: *vnic_templates_change
|
||||
register: nm_vnic_templates_descr_change_again
|
||||
|
||||
|
||||
# Verfiy change
|
||||
- name: Verify vNIC template change results
|
||||
assert:
|
||||
that:
|
||||
- cm_vnic_templates_descr_change.changed == nm_vnic_templates_descr_change.changed == true
|
||||
- cm_vnic_templates_descr_change_again.changed == nm_vnic_templates_descr_change_again.changed == false
|
||||
|
||||
|
||||
# Teardown (clean environment)
|
||||
- name: vNIC template absent (check_mode)
|
||||
ucs_vnic_template: *vnic_templates_absent
|
||||
check_mode: yes
|
||||
register: cm_vnic_templates_absent
|
||||
|
||||
|
||||
# Absent (normal mode)
|
||||
- name: vNIC template absent (normal mode)
|
||||
ucs_vnic_template: *vnic_templates_absent
|
||||
register: nm_vnic_templates_absent
|
||||
|
||||
|
||||
# Test absent again (idempotent)
|
||||
- name: vNIC template absent again (check_mode)
|
||||
ucs_vnic_template: *vnic_templates_absent
|
||||
check_mode: yes
|
||||
register: cm_vnic_templates_absent_again
|
||||
|
||||
|
||||
# Absent again (normal mode)
|
||||
- name: vNIC template absent again (normal mode)
|
||||
ucs_vnic_template: *vnic_templates_absent
|
||||
register: nm_vnic_templates_absent_again
|
||||
|
||||
|
||||
# Verfiy absent
|
||||
- name: Verify vNIC template absent results
|
||||
assert:
|
||||
that:
|
||||
- cm_vnic_templates_absent.changed == nm_vnic_templates_absent.changed == true
|
||||
- cm_vnic_templates_absent_again.changed == nm_vnic_templates_absent_again.changed == false
|
||||
Loading…
Reference in a new issue