mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-04 23:39:09 -07:00
Unflatmap community.general (#5461)
* Move files. * Update imports and references. * Move wrongly placed files. * Reverse redirects, deprecate long → short name redirects. * Simplify contribution guidelines for new modules. * Rewrite BOTMETA. * Add changelog fragment. * Fix ignore.txt files.
This commit is contained in:
parent
2b0bebc8fc
commit
b531ecdc9b
1033 changed files with 4802 additions and 1989 deletions
187
plugins/modules/ilo_redfish_config.py
Normal file
187
plugins/modules/ilo_redfish_config.py
Normal file
|
@ -0,0 +1,187 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (c) 2021-2022 Hewlett Packard Enterprise, Inc. All rights reserved.
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ilo_redfish_config
|
||||
short_description: Sets or updates configuration attributes on HPE iLO with Redfish OEM extensions
|
||||
version_added: 4.2.0
|
||||
description:
|
||||
- Builds Redfish URIs locally and sends them to iLO to
|
||||
set or update a configuration attribute.
|
||||
- For use with HPE iLO operations that require Redfish OEM extensions.
|
||||
options:
|
||||
category:
|
||||
required: true
|
||||
type: str
|
||||
description:
|
||||
- Command category to execute on iLO.
|
||||
choices: ['Manager']
|
||||
command:
|
||||
required: true
|
||||
description:
|
||||
- List of commands to execute on iLO.
|
||||
type: list
|
||||
elements: str
|
||||
baseuri:
|
||||
required: true
|
||||
description:
|
||||
- Base URI of iLO.
|
||||
type: str
|
||||
username:
|
||||
description:
|
||||
- Username for authenticating to iLO.
|
||||
type: str
|
||||
password:
|
||||
description:
|
||||
- Password for authenticating to iLO.
|
||||
type: str
|
||||
auth_token:
|
||||
description:
|
||||
- Security token for authenticating to iLO.
|
||||
type: str
|
||||
timeout:
|
||||
description:
|
||||
- Timeout in seconds for HTTP requests to iLO.
|
||||
default: 10
|
||||
type: int
|
||||
attribute_name:
|
||||
required: true
|
||||
description:
|
||||
- Name of the attribute to be configured.
|
||||
type: str
|
||||
attribute_value:
|
||||
required: false
|
||||
description:
|
||||
- Value of the attribute to be configured.
|
||||
type: str
|
||||
author:
|
||||
- "Bhavya B (@bhavya06)"
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Disable WINS Registration
|
||||
community.general.ilo_redfish_config:
|
||||
category: Manager
|
||||
command: SetWINSReg
|
||||
baseuri: 15.X.X.X
|
||||
username: Admin
|
||||
password: Testpass123
|
||||
attribute_name: WINSRegistration
|
||||
|
||||
- name: Set Time Zone
|
||||
community.general.ilo_redfish_config:
|
||||
category: Manager
|
||||
command: SetTimeZone
|
||||
baseuri: 15.X.X.X
|
||||
username: Admin
|
||||
password: Testpass123
|
||||
attribute_name: TimeZone
|
||||
attribute_value: Chennai
|
||||
|
||||
- name: Set NTP Servers
|
||||
community.general.ilo_redfish_config:
|
||||
category: Manager
|
||||
command: SetNTPServers
|
||||
baseuri: 15.X.X.X
|
||||
username: Admin
|
||||
password: Testpass123
|
||||
attribute_name: StaticNTPServers
|
||||
attribute_value: X.X.X.X
|
||||
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
msg:
|
||||
description: Message with action result or error description
|
||||
returned: always
|
||||
type: str
|
||||
sample: "Action was successful"
|
||||
'''
|
||||
|
||||
CATEGORY_COMMANDS_ALL = {
|
||||
"Manager": ["SetTimeZone", "SetDNSserver", "SetDomainName", "SetNTPServers", "SetWINSReg"]
|
||||
}
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.ilo_redfish_utils import iLORedfishUtils
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.common.text.converters import to_native
|
||||
|
||||
|
||||
def main():
|
||||
result = {}
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
category=dict(required=True, choices=list(
|
||||
CATEGORY_COMMANDS_ALL.keys())),
|
||||
command=dict(required=True, type='list', elements='str'),
|
||||
baseuri=dict(required=True),
|
||||
username=dict(),
|
||||
password=dict(no_log=True),
|
||||
auth_token=dict(no_log=True),
|
||||
attribute_name=dict(required=True),
|
||||
attribute_value=dict(),
|
||||
timeout=dict(type='int', default=10)
|
||||
),
|
||||
required_together=[
|
||||
('username', 'password'),
|
||||
],
|
||||
required_one_of=[
|
||||
('username', 'auth_token'),
|
||||
],
|
||||
mutually_exclusive=[
|
||||
('username', 'auth_token'),
|
||||
],
|
||||
supports_check_mode=False
|
||||
)
|
||||
|
||||
category = module.params['category']
|
||||
command_list = module.params['command']
|
||||
|
||||
creds = {"user": module.params['username'],
|
||||
"pswd": module.params['password'],
|
||||
"token": module.params['auth_token']}
|
||||
|
||||
timeout = module.params['timeout']
|
||||
|
||||
root_uri = "https://" + module.params['baseuri']
|
||||
rf_utils = iLORedfishUtils(creds, root_uri, timeout, module)
|
||||
mgr_attributes = {'mgr_attr_name': module.params['attribute_name'],
|
||||
'mgr_attr_value': module.params['attribute_value']}
|
||||
changed = False
|
||||
|
||||
offending = [
|
||||
cmd for cmd in command_list if cmd not in CATEGORY_COMMANDS_ALL[category]]
|
||||
|
||||
if offending:
|
||||
module.fail_json(msg=to_native("Invalid Command(s): '%s'. Allowed Commands = %s" % (
|
||||
offending, CATEGORY_COMMANDS_ALL[category])))
|
||||
|
||||
if category == "Manager":
|
||||
resource = rf_utils._find_managers_resource()
|
||||
if not resource['ret']:
|
||||
module.fail_json(msg=to_native(resource['msg']))
|
||||
|
||||
dispatch = dict(
|
||||
SetTimeZone=rf_utils.set_time_zone,
|
||||
SetDNSserver=rf_utils.set_dns_server,
|
||||
SetDomainName=rf_utils.set_domain_name,
|
||||
SetNTPServers=rf_utils.set_ntp_server,
|
||||
SetWINSReg=rf_utils.set_wins_registration
|
||||
)
|
||||
|
||||
for command in command_list:
|
||||
result[command] = dispatch[command](mgr_attributes)
|
||||
if 'changed' in result[command]:
|
||||
changed |= result[command]['changed']
|
||||
|
||||
module.exit_json(ilo_redfish_config=result, changed=changed)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Add table
Add a link
Reference in a new issue