#!/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_chassis_fw
short_description: Configures Chassis Firmware Policy on Cisco UCS Manager
description:
- Configures Chassis Firmware Policy on Cisco UCS Manager.
extends_documentation_fragment: ucs
options:
  state:
    description:
    - If C(present), will verify Chassis Firmware Policy is present and will create if needed.
    - If C(absent), will verify Chassis Firmware Policy is absent and will delete if needed.
    choices: [present, absent]
    default: present
  name:
    description:
    - The name assigned to the Chassis Firmware Policy.
    - The Chassis Firmware Policy name is case sensitive.
    - 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 Chassis Firmware Policy is created.
    required: yes
  description:
    description:
    - A description of the Chassis Firmware Package Policy.
    - Cisco recommends including information about where and when to use the policy.
    - 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 ]
  chassis_package:
    description:
    - The version of the firmware package that will be applied to the Cisco UCS S3260 chassis.
    default: ''
  service_pack:
    description:
    - The version of the service pack that will be applied to the Cisco UCS S3260 chassis.
    - Setting Service Pack to <not set> removes the service pack from the chassis firmware package.
    default: ''
  excluded_components:
    description:
    - Components that should be excluded from the firmware package.
    - "iocard - Chassis Adaptor"
    - "chassis-board-controller - Chassis Board Controller"
    - "cmc - Chassis Management Controller"
    - "local-disk - Local Disk"
    - "sas-expander - SAS Expander"
    - "unspecified - no exclude"
    default: local-disk
requirements:
- ucsmsdk
author:
- Olli Walsdorf (@owalsdor)
- CiscoUcs (@CiscoUcs)
version_added: '2.5'
'''

EXAMPLES = r'''
- name: Add Chassis Firmware Package
  ucs_chassis_fw:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: s3260_fw32
    chassis_package: '3.2(2b)C'
- name: Remove Chassis Firmware Package
  ucs_chassis_fw:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: s3260_fw32
    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(
		name=dict(type='str', required=True),
		description=dict(type='str', default=''),
		chassis_package=dict(type='str', default=''),
		service_pack=dict(type='str', default=''),
		excluded_components=dict(type='str', default='local-disk', choices=['iocard', 'chassis-board-controller', 'cmc', 'local-disk', 'sas-expander']),
		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, so additional imports are done below.
	from ucsmsdk.mometa.firmware.FirmwareChassisPack import FirmwareChassisPack
	from ucsmsdk.mometa.firmware.FirmwareExcludeChassisComponent import FirmwareExcludeChassisComponent

	changed = False
	try:
		mo_exists = False
		props_match = False
		# dn is org-root/fw-chassis-pack-<name> for chassis firmware packages
		dn_base = 'org-root'
		dn = dn_base + '/fw-chassis-pack-' + 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:
			if mo_exists:
				# check top-level mo props
				kwargs = dict(name=module.params['name'])
				kwargs['chassis_bundle_version'] = module.params['chassis_package']
				kwargs['service_pack_bundle_version'] = module.params['service_pack']
				if (mo.check_prop_match(**kwargs)):
					props_match = True

			if not props_match:
				if not module.check_mode:
					# create if mo does not already exist
					mo = FirmwareChassisPack(
					parent_mo_or_dn=dn_base,
					name=module.params['name'],
					descr=module.params['description'],
					chassis_bundle_version=module.params['chassis_package'],
					service_pack_bundle_version=module.params['service_pack'],
					)
					#for component in module.params['excluded_components']:
					mo_1 = FirmwareExcludeChassisComponent(
					parent_mo_or_dn=mo,
					chassis_component=module.params['excluded_components']
					)
					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()