diff --git a/lib/ansible/modules/remote_management/redfish/idrac_redfish_command.py b/lib/ansible/modules/remote_management/redfish/idrac_redfish_command.py new file mode 100644 index 00000000000..16108bf43d1 --- /dev/null +++ b/lib/ansible/modules/remote_management/redfish/idrac_redfish_command.py @@ -0,0 +1,181 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# Copyright (c) 2018 Dell EMC Inc. +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + +ANSIBLE_METADATA = {'status': ['preview'], + 'supported_by': 'community', + 'metadata_version': '1.1'} + +DOCUMENTATION = ''' +--- +module: idrac_redfish_command +version_added: "2.8" +short_description: Manages Out-Of-Band controllers using iDRAC OEM Redfish APIs +description: + - Builds Redfish URIs locally and sends them to remote OOB controllers to + perform an action. + - For use with Dell iDRAC operations that require Redfish OEM extensions +options: + category: + required: true + description: + - Category to execute on OOB controller + command: + required: true + description: + - List of commands to execute on OOB controller + baseuri: + required: true + description: + - Base URI of OOB controller + username: + required: true + description: + - User for authentication with OOB controller + password: + required: true + description: + - Password for authentication with OOB controller + +author: "Jose Delarosa (@jose-delarosa)" +''' + +EXAMPLES = ''' + - name: Create BIOS configuration job (schedule BIOS setting update) + idrac_redfish_command: + category: Systems + command: CreateBiosConfigJob + baseuri: "{{ baseuri }}" + username: "{{ username }}" + password: "{{ password }}" +''' + +RETURN = ''' +msg: + description: Message with action result or error description + returned: always + type: string + sample: "Action was successful" +''' + +import re +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.redfish_utils import RedfishUtils, HEADERS +from ansible.module_utils._text import to_native + + +class IdracRedfishUtils(RedfishUtils): + + def create_bios_config_job(self): + result = {} + key = "Bios" + jobs = "Jobs" + + # Search for 'key' entry and extract URI from it + response = self.get_request(self.root_uri + self.systems_uri) + if response['ret'] is False: + return response + result['ret'] = True + data = response['data'] + + if key not in data: + return {'ret': False, 'msg': "Key %s not found" % key} + + bios_uri = data[key]["@odata.id"] + + # Extract proper URI + response = self.get_request(self.root_uri + bios_uri) + if response['ret'] is False: + return response + result['ret'] = True + data = response['data'] + set_bios_attr_uri = data["@Redfish.Settings"]["SettingsObject"][ + "@odata.id"] + + payload = {"TargetSettingsURI": set_bios_attr_uri} + response = self.post_request( + self.root_uri + self.manager_uri + "/" + jobs, + payload, HEADERS) + if response['ret'] is False: + return response + + response_output = response['resp'].__dict__ + job_id = response_output["headers"]["Location"] + job_id = re.search("JID_.+", job_id).group() + # Currently not passing job_id back to user but patch is coming + return {'ret': True, 'msg': "Config job %s created" % job_id} + + +CATEGORY_COMMANDS_ALL = { + "Systems": ["CreateBiosConfigJob"], + "Accounts": [], + "Manager": [] +} + + +def main(): + result = {} + module = AnsibleModule( + argument_spec=dict( + category=dict(required=True), + command=dict(required=True, type='list'), + baseuri=dict(required=True), + username=dict(required=True), + password=dict(required=True, no_log=True) + ), + supports_check_mode=False + ) + + category = module.params['category'] + command_list = module.params['command'] + + # admin credentials used for authentication + creds = {'user': module.params['username'], + 'pswd': module.params['password']} + + # Build root URI + root_uri = "https://" + module.params['baseuri'] + rf_uri = "/redfish/v1/" + rf_utils = IdracRedfishUtils(creds, root_uri) + + # Check that Category is valid + if category not in CATEGORY_COMMANDS_ALL: + module.fail_json(msg=to_native("Invalid Category '%s'. Valid Categories = %s" % (category, CATEGORY_COMMANDS_ALL.keys()))) + + # Check that all commands are valid + for cmd in command_list: + # Fail if even one command given is invalid + if cmd not in CATEGORY_COMMANDS_ALL[category]: + module.fail_json(msg=to_native("Invalid Command '%s'. Valid Commands = %s" % (cmd, CATEGORY_COMMANDS_ALL[category]))) + + # Organize by Categories / Commands + + if category == "Systems": + # execute only if we find a System resource + result = rf_utils._find_systems_resource(rf_uri) + if result['ret'] is False: + module.fail_json(msg=to_native(result['msg'])) + + for command in command_list: + if command == "CreateBiosConfigJob": + # execute only if we find a Managers resource + result = rf_utils._find_managers_resource(rf_uri) + if result['ret'] is False: + module.fail_json(msg=to_native(result['msg'])) + result = rf_utils.create_bios_config_job() + + # Return data back or fail with proper message + if result['ret'] is True: + del result['ret'] + module.exit_json(changed=True, msg='Action was successful') + else: + module.fail_json(msg=to_native(result['msg'])) + + +if __name__ == '__main__': + main()