mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
ucs_storage_profile module and integration tests (#42205)
* ucs_storage_profile module and integration tests * Remove space in doc link to fix docs-build issue. * Added suboption documentation and argument spec supporting list suboptions. * Various small edits
This commit is contained in:
David Soper
Dag Wieers
parent
1754f533b5
commit
c527af58f1
3 changed files with 399 additions and 0 deletions
254
lib/ansible/modules/remote_management/ucs/ucs_storage_profile.py
Normal file
254
lib/ansible/modules/remote_management/ucs/ucs_storage_profile.py
Normal file
|
|
@ -0,0 +1,254 @@
|
|||
#!/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_storage_profile
|
||||
short_description: Configures storage profiles on Cisco UCS Manager
|
||||
description:
|
||||
- Configures storage profiles on Cisco UCS Manager.
|
||||
- Examples can be used with the L(UCS Platform Emulator,https://communities.cisco.com/ucspe).
|
||||
extends_documentation_fragment: ucs
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- If C(present), will verify that the storage profile is present and will create if needed.
|
||||
- If C(absent), will verify that the storage profile is absent and will delete if needed.
|
||||
choices: [ absent, present ]
|
||||
default: present
|
||||
name:
|
||||
description:
|
||||
- The name of the storage profile.
|
||||
- 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 profile is created.
|
||||
required: yes
|
||||
description:
|
||||
description:
|
||||
- The user-defined description of the storage profile.
|
||||
- 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 ]
|
||||
local_luns:
|
||||
description:
|
||||
- List of Local LUNs used by the storage profile.
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- The name of the local LUN.
|
||||
required: yes
|
||||
size:
|
||||
description:
|
||||
- Size of this LUN in GB.
|
||||
- The size can range from 1 to 10240 GB.
|
||||
default: '1'
|
||||
auto_deploy:
|
||||
description:
|
||||
- Whether the local LUN should be automatically deployed or not.
|
||||
choices: [ auto-deploy, no-auto-deploy ]
|
||||
default: auto-deploy
|
||||
expand_to_avail:
|
||||
description:
|
||||
- Specifies that this LUN can be expanded to use the entire available disk group.
|
||||
- For each service profile, only one LUN can use this option.
|
||||
- Expand To Available option is not supported for already deployed LUN.
|
||||
type: bool
|
||||
default: 'no'
|
||||
fractional_size:
|
||||
description:
|
||||
- Fractional size of this LUN in MB.
|
||||
default: '0'
|
||||
disk_policy_name:
|
||||
description:
|
||||
- The disk group configuration policy to be applied to this local LUN.
|
||||
state:
|
||||
description:
|
||||
- If C(present), will verify local LUN is present on profile.
|
||||
If C(absent), will verify local LUN is absent on profile.
|
||||
choices: [ absent, present ]
|
||||
default: present
|
||||
org_dn:
|
||||
description:
|
||||
- The distinguished name (dn) of the organization where the resource is assigned.
|
||||
default: org-root
|
||||
requirements:
|
||||
- ucsmsdk
|
||||
author:
|
||||
- Sindhu Sudhir (@sisudhir)
|
||||
- David Soper (@dsoper2)
|
||||
- CiscoUcs (@CiscoUcs)
|
||||
version_added: '2.7'
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Configure Storage Profile
|
||||
ucs_storage_profile:
|
||||
hostname: 172.16.143.150
|
||||
username: admin
|
||||
password: password
|
||||
name: DEE-StgProf
|
||||
local_luns:
|
||||
- name: Boot-LUN
|
||||
size: '60'
|
||||
disk_policy_name: DEE-DG
|
||||
- name: Data-LUN
|
||||
size: '200'
|
||||
disk_policy_name: DEE-DG
|
||||
|
||||
- name: Remove Storage Profile
|
||||
ucs_storage_profile:
|
||||
hostname: 172.16.143.150
|
||||
username: admin
|
||||
password: password
|
||||
name: DEE-StgProf
|
||||
state: absent
|
||||
|
||||
- name: Remove Local LUN from Storage Profile
|
||||
ucs_storage_profile:
|
||||
hostname: 172.16.143.150
|
||||
username: admin
|
||||
password: password
|
||||
name: DEE-StgProf
|
||||
local_luns:
|
||||
- name: Data-LUN
|
||||
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():
|
||||
local_lun = dict(
|
||||
name=dict(type='str', required=True),
|
||||
state=dict(type='str', default='present', choices=['present', 'absent']),
|
||||
size=dict(type='str', default='1'),
|
||||
auto_deploy=dict(type='str', default='auto-deploy', choices=['auto-deploy', 'no-auto-deploy']),
|
||||
expand_to_avail=dict(type='str', default='no', choices=['no', 'yes']),
|
||||
fractional_size=dict(type='str', default='0'),
|
||||
disk_policy_name=dict(type='str', default=''),
|
||||
)
|
||||
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=''),
|
||||
local_luns=dict(type='list', elements='dict', options=local_lun),
|
||||
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.lstorage.LstorageProfile import LstorageProfile
|
||||
from ucsmsdk.mometa.lstorage.LstorageDasScsiLun import LstorageDasScsiLun
|
||||
|
||||
ucs.result['changed'] = False
|
||||
try:
|
||||
mo_exists = False
|
||||
props_match = False
|
||||
# dn is <org_dn>/profile-<name>
|
||||
dn = module.params['org_dn'] + '/profile-' + 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()
|
||||
ucs.result['changed'] = True
|
||||
else:
|
||||
if mo_exists:
|
||||
# check top-level mo props
|
||||
kwargs = dict(descr=module.params['description'])
|
||||
if mo.check_prop_match(**kwargs):
|
||||
# top-level props match, check next level mo/props
|
||||
if not module.params.get('local_luns'):
|
||||
props_match = True
|
||||
else:
|
||||
# check local lun props
|
||||
for lun in module.params['local_luns']:
|
||||
child_dn = dn + '/das-scsi-lun-' + lun['name']
|
||||
mo_1 = ucs.login_handle.query_dn(child_dn)
|
||||
if lun['state'] == 'absent':
|
||||
if mo_1:
|
||||
props_match = False
|
||||
break
|
||||
else:
|
||||
if mo_1:
|
||||
kwargs = dict(size=str(lun['size']))
|
||||
kwargs['auto_deploy'] = lun['auto_deploy']
|
||||
kwargs['expand_to_avail'] = lun['expand_to_avail']
|
||||
kwargs['fractional_size'] = str(lun['fractional_size'])
|
||||
kwargs['local_disk_policy_name'] = lun['disk_policy_name']
|
||||
if mo_1.check_prop_match(**kwargs):
|
||||
props_match = True
|
||||
else:
|
||||
props_match = False
|
||||
break
|
||||
|
||||
if not props_match:
|
||||
if not module.check_mode:
|
||||
# create if mo does not already exist
|
||||
mo = LstorageProfile(
|
||||
parent_mo_or_dn=module.params['org_dn'],
|
||||
name=module.params['name'],
|
||||
descr=module.params['description'],
|
||||
)
|
||||
|
||||
if module.params.get('local_luns'):
|
||||
for lun in module.params['local_luns']:
|
||||
if lun['state'] == 'absent':
|
||||
child_dn = dn + '/das-scsi-lun-' + lun['name']
|
||||
mo_1 = ucs.login_handle.query_dn(child_dn)
|
||||
ucs.login_handle.remove_mo(mo_1)
|
||||
else:
|
||||
mo_1 = LstorageDasScsiLun(
|
||||
parent_mo_or_dn=mo,
|
||||
name=lun['name'],
|
||||
size=str(lun['size']),
|
||||
auto_deploy=lun['auto_deploy'],
|
||||
expand_to_avail=lun['expand_to_avail'],
|
||||
fractional_size=str(lun['fractional_size']),
|
||||
local_disk_policy_name=lun['disk_policy_name'],
|
||||
)
|
||||
|
||||
ucs.login_handle.add_mo(mo, True)
|
||||
ucs.login_handle.commit()
|
||||
ucs.result['changed'] = True
|
||||
|
||||
except Exception as e:
|
||||
err = True
|
||||
ucs.result['msg'] = "setup error: %s " % str(e)
|
||||
|
||||
if err:
|
||||
module.fail_json(**ucs.result)
|
||||
module.exit_json(**ucs.result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
7
test/integration/targets/ucs_storage_profile/aliases
Normal file
7
test/integration/targets/ucs_storage_profile/aliases
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# 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
|
||||
unsupported
|
||||
138
test/integration/targets/ucs_storage_profile/tasks/main.yml
Normal file
138
test/integration/targets/ucs_storage_profile/tasks/main.yml
Normal file
|
|
@ -0,0 +1,138 @@
|
|||
# Test code for the UCS modules
|
||||
# Copyright 2018, 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: Storage Profile absent
|
||||
ucs_storage_profile: &storage_profile_absent
|
||||
<<: *login_info
|
||||
name: DEE-StgProf
|
||||
state: absent
|
||||
|
||||
|
||||
# Test present (check_mode)
|
||||
- name: Storage Profile present (check_mode)
|
||||
ucs_storage_profile: &storage_profile_present
|
||||
<<: *login_info
|
||||
name: DEE-StgProf
|
||||
local_luns:
|
||||
- name: Boot-LUN
|
||||
size: '60'
|
||||
disk_policy_name: DEE-DG
|
||||
- name: Data-LUN
|
||||
size: '200'
|
||||
disk_policy_name: DEE-DG
|
||||
check_mode: yes
|
||||
register: cm_storage_profile_present
|
||||
|
||||
|
||||
# Present (normal mode)
|
||||
- name: Storage Profile present (normal mode)
|
||||
ucs_storage_profile: *storage_profile_present
|
||||
register: nm_storage_profile_present
|
||||
|
||||
|
||||
# Test present again (idempotent)
|
||||
- name: Storage Profile present again (check_mode)
|
||||
ucs_storage_profile: *storage_profile_present
|
||||
check_mode: yes
|
||||
register: cm_storage_profile_present_again
|
||||
|
||||
|
||||
# Present again (normal mode)
|
||||
- name: Storage Profile present again (normal mode)
|
||||
ucs_storage_profile: *storage_profile_present
|
||||
register: nm_storage_profile_present_again
|
||||
|
||||
|
||||
# Verfiy present
|
||||
- name: Verify Storage Profile present results
|
||||
assert:
|
||||
that:
|
||||
- cm_storage_profile_present.changed == nm_storage_profile_present.changed == true
|
||||
- cm_storage_profile_present_again.changed == nm_storage_profile_present_again.changed == false
|
||||
|
||||
|
||||
# Test change (check_mode)
|
||||
- name: Storage Profile change (check_mode)
|
||||
ucs_storage_profile: &storage_profile_change
|
||||
<<: *login_info
|
||||
name: DEE-StgProf
|
||||
local_luns:
|
||||
- name: Boot-LUN
|
||||
size: '60'
|
||||
disk_policy_name: DEE-DG
|
||||
- name: Data-LUN
|
||||
state: absent
|
||||
check_mode: yes
|
||||
register: cm_storage_profile_change
|
||||
|
||||
|
||||
# Change (normal mode)
|
||||
- name: Storage Profile change (normal mode)
|
||||
ucs_storage_profile: *storage_profile_change
|
||||
register: nm_storage_profile_change
|
||||
|
||||
|
||||
# Test change again (idempotent)
|
||||
- name: Storage Profile again (check_mode)
|
||||
ucs_storage_profile: *storage_profile_change
|
||||
check_mode: yes
|
||||
register: cm_storage_profile_change_again
|
||||
|
||||
|
||||
# Change again (normal mode)
|
||||
- name: Storage Profile change again (normal mode)
|
||||
ucs_storage_profile: *storage_profile_change
|
||||
register: nm_storage_profile_change_again
|
||||
|
||||
|
||||
# Verfiy change
|
||||
- name: Verify Storage Profile change results
|
||||
assert:
|
||||
that:
|
||||
- cm_storage_profile_change.changed == nm_storage_profile_change.changed == true
|
||||
- cm_storage_profile_change_again.changed == nm_storage_profile_change_again.changed == false
|
||||
|
||||
|
||||
# Teardown (clean environment)
|
||||
- name: Storage Profile absent (check_mode)
|
||||
ucs_storage_profile: *storage_profile_absent
|
||||
check_mode: yes
|
||||
register: cm_storage_profile_absent
|
||||
|
||||
|
||||
# Absent (normal mode)
|
||||
- name: Storage Profile absent (normal mode)
|
||||
ucs_storage_profile: *storage_profile_absent
|
||||
register: nm_storage_profile_absent
|
||||
|
||||
|
||||
# Test absent again (idempotent)
|
||||
- name: Storage Profile absent again (check_mode)
|
||||
ucs_storage_profile: *storage_profile_absent
|
||||
check_mode: yes
|
||||
register: cm_storage_profile_absent_again
|
||||
|
||||
|
||||
# Absent again (normal mode)
|
||||
- name: Storage Profile absent again (normal mode)
|
||||
ucs_storage_profile: *storage_profile_absent
|
||||
register: nm_storage_profile_absent_again
|
||||
|
||||
|
||||
# Verfiy absent
|
||||
- name: Verify Storage Profile absent results
|
||||
assert:
|
||||
that:
|
||||
- cm_storage_profile_absent.changed == nm_storage_profile_absent.changed == true
|
||||
- cm_storage_profile_absent_again.changed == nm_storage_profile_absent_again.changed == false
|
||||
Loading…
Reference in a new issue