203 lines
7.1 KiB
Python
203 lines
7.1 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
#
|
|
# Dell EMC OpenManage Ansible Modules
|
|
# Version 3.5.0
|
|
# Copyright (C) 2018-2021 Dell Inc. or its subsidiaries. All Rights Reserved.
|
|
|
|
# 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
|
|
|
|
DOCUMENTATION = """
|
|
---
|
|
module: idrac_syslog
|
|
short_description: Enable or disable the syslog on iDRAC
|
|
version_added: "2.1.0"
|
|
description:
|
|
- This module allows to enable or disable the iDRAC syslog.
|
|
extends_documentation_fragment:
|
|
- dellemc.openmanage.idrac_auth_options
|
|
- dellemc.openmanage.network_share_options
|
|
options:
|
|
syslog:
|
|
description: Enables or disables an iDRAC syslog.
|
|
choices: [Enabled, Disabled]
|
|
type: str
|
|
default: Enabled
|
|
requirements:
|
|
- "omsdk"
|
|
- "python >= 2.7.5"
|
|
author:
|
|
- "Felix Stephen (@felixs88)"
|
|
- "Anooja Vardhineni (@anooja-vardhineni)"
|
|
notes:
|
|
- This module requires 'Administrator' privilege for I(idrac_user).
|
|
- Run this module from a system that has direct access to Dell EMC iDRAC.
|
|
- This module supports C(check_mode).
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
---
|
|
- name: Enable iDRAC syslog
|
|
dellemc.openmanage.idrac_syslog:
|
|
idrac_ip: "192.168.0.1"
|
|
idrac_user: "user_name"
|
|
idrac_password: "user_password"
|
|
share_name: "192.168.0.2:/share"
|
|
share_password: "share_user_pwd"
|
|
share_user: "share_user_name"
|
|
share_mnt: "/mnt/share"
|
|
syslog: "Enabled"
|
|
|
|
- name: Disable iDRAC syslog
|
|
dellemc.openmanage.idrac_syslog:
|
|
idrac_ip: "192.168.0.1"
|
|
idrac_user: "user_name"
|
|
idrac_password: "user_password"
|
|
share_name: "192.168.0.2:/share"
|
|
share_password: "share_user_pwd"
|
|
share_user: "share_user_name"
|
|
share_mnt: "/mnt/share"
|
|
syslog: "Disabled"
|
|
"""
|
|
|
|
RETURN = r'''
|
|
---
|
|
msg:
|
|
description: Overall status of the syslog export operation.
|
|
returned: always
|
|
type: str
|
|
sample: "Successfully fetch the syslogs."
|
|
syslog_status:
|
|
description: Job details of the syslog operation.
|
|
returned: success
|
|
type: dict
|
|
sample: {
|
|
"@odata.context": "/redfish/v1/$metadata#DellJob.DellJob",
|
|
"@odata.id": "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_852940632485",
|
|
"@odata.type": "#DellJob.v1_0_2.DellJob",
|
|
"CompletionTime": "2020-03-27T02:27:45",
|
|
"Description": "Job Instance",
|
|
"EndTime": null,
|
|
"Id": "JID_852940632485",
|
|
"JobState": "Completed",
|
|
"JobType": "ImportConfiguration",
|
|
"Message": "Successfully imported and applied Server Configuration Profile.",
|
|
"MessageArgs": [],
|
|
"MessageArgs@odata.count": 0,
|
|
"MessageId": "SYS053",
|
|
"Name": "Import Configuration",
|
|
"PercentComplete": 100,
|
|
"StartTime": "TIME_NOW",
|
|
"Status": "Success",
|
|
"TargetSettingsURI": null,
|
|
"retval": true
|
|
}
|
|
error_info:
|
|
description: Details of the HTTP Error.
|
|
returned: on HTTP error
|
|
type: dict
|
|
sample: {
|
|
"error": {
|
|
"code": "Base.1.0.GeneralError",
|
|
"message": "A general error has occurred. See ExtendedInfo for more information.",
|
|
"@Message.ExtendedInfo": [
|
|
{
|
|
"MessageId": "GEN1234",
|
|
"RelatedProperties": [],
|
|
"Message": "Unable to process the request because an error occurred.",
|
|
"MessageArgs": [],
|
|
"Severity": "Critical",
|
|
"Resolution": "Retry the operation. If the issue persists, contact your system administrator."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
'''
|
|
|
|
|
|
import json
|
|
from ansible_collections.dellemc.openmanage.plugins.module_utils.dellemc_idrac import iDRACConnection
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.six.moves.urllib.error import URLError, HTTPError
|
|
from ansible.module_utils.urls import ConnectionError, SSLValidationError
|
|
|
|
try:
|
|
from omsdk.sdkfile import file_share_manager
|
|
from omsdk.sdkcreds import UserCredentials
|
|
except ImportError:
|
|
pass
|
|
|
|
|
|
def run_setup_idrac_syslog(idrac, module):
|
|
idrac.use_redfish = True
|
|
upd_share = file_share_manager.create_share_obj(share_path=module.params['share_name'],
|
|
mount_point=module.params['share_mnt'],
|
|
isFolder=True,
|
|
creds=UserCredentials(
|
|
module.params['share_user'],
|
|
module.params['share_password']))
|
|
if not upd_share.IsValid:
|
|
module.fail_json(msg="Unable to access the share. Ensure that the share name, "
|
|
"share mount, and share credentials provided are correct.")
|
|
idrac.config_mgr.set_liason_share(upd_share)
|
|
if module.check_mode:
|
|
if module.params['syslog'] == 'Enabled':
|
|
idrac.config_mgr.enable_syslog(apply_changes=False)
|
|
elif module.params['syslog'] == 'Disabled':
|
|
idrac.config_mgr.disable_syslog(apply_changes=False)
|
|
msg = idrac.config_mgr.is_change_applicable()
|
|
else:
|
|
if module.params['syslog'] == 'Enabled':
|
|
msg = idrac.config_mgr.enable_syslog()
|
|
elif module.params['syslog'] == 'Disabled':
|
|
msg = idrac.config_mgr.disable_syslog()
|
|
return msg
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec={
|
|
"idrac_ip": {"required": True, "type": 'str'},
|
|
"idrac_user": {"required": True, "type": 'str'},
|
|
"idrac_password": {"required": True, "type": 'str', "aliases": ['idrac_pwd'], "no_log": True},
|
|
"idrac_port": {"required": False, "default": 443, "type": 'int'},
|
|
"share_name": {"required": True, "type": 'str'},
|
|
"share_user": {"required": False, "type": 'str'},
|
|
"share_password": {"required": False, "type": 'str', "aliases": ['share_pwd'], "no_log": True},
|
|
"share_mnt": {"required": False, "type": 'str'},
|
|
"syslog": {"required": False, "choices": ['Enabled', 'Disabled'], "default": 'Enabled'}
|
|
},
|
|
supports_check_mode=True)
|
|
|
|
try:
|
|
with iDRACConnection(module.params) as idrac:
|
|
msg = run_setup_idrac_syslog(idrac, module)
|
|
changed = False
|
|
if msg.get('Status') == "Success":
|
|
changed = True
|
|
if msg.get('Message') == "No changes found to commit!":
|
|
changed = False
|
|
except HTTPError as err:
|
|
module.fail_json(msg=str(err), error_info=json.load(err))
|
|
except URLError as err:
|
|
module.exit_json(msg=str(err), unreachable=True)
|
|
except AttributeError as err:
|
|
if "NoneType" in str(err):
|
|
module.fail_json(msg="Unable to access the share. Ensure that the share name, "
|
|
"share mount, and share credentials provided are correct.")
|
|
except (RuntimeError, SSLValidationError, ConnectionError, KeyError,
|
|
ImportError, ValueError, TypeError) as e:
|
|
module.fail_json(msg=str(e))
|
|
module.exit_json(msg="Successfully fetch the syslogs.",
|
|
syslog_status=msg, changed=changed)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|