mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-14 21:19:12 -07:00
c80baf7c58
* Extend CPU data example and output results Add "Get CPU Model example" and output result from "Get CPU inventory". Also add example for output of the "Inventory information" to make it easier to use the examples for Ansible beginners. +label: docsite_pr * Remove white space from blank line
290 lines
9.7 KiB
Python
290 lines
9.7 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright (c) 2017-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: redfish_facts
|
|
version_added: "2.7"
|
|
short_description: Manages Out-Of-Band controllers using Redfish APIs
|
|
description:
|
|
- Builds Redfish URIs locally and sends them to remote OOB controllers to
|
|
get information back.
|
|
- Information retrieved is placed in a location specified by the user.
|
|
options:
|
|
category:
|
|
required: false
|
|
description:
|
|
- List of categories to execute on OOB controller
|
|
default: ['Systems']
|
|
command:
|
|
required: false
|
|
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
|
|
version_added: "2.8"
|
|
password:
|
|
required: true
|
|
description:
|
|
- Password for authentication with OOB controller
|
|
|
|
author: "Jose Delarosa (@jose-delarosa)"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Get CPU inventory
|
|
redfish_facts:
|
|
category: Systems
|
|
command: GetCpuInventory
|
|
baseuri: "{{ baseuri }}"
|
|
username: "{{ username }}"
|
|
password: "{{ password }}"
|
|
- debug:
|
|
msg: "{{ redfish_facts.cpu.entries | to_nice_json }}"
|
|
|
|
- name: Get CPU model
|
|
redfish_facts:
|
|
category: Systems
|
|
command: GetCpuInventory
|
|
baseuri: "{{ baseuri }}"
|
|
username: "{{ username }}"
|
|
password: "{{ password }}"
|
|
- debug:
|
|
msg: "{{ redfish_facts.cpu.entries.0.Model }}"
|
|
|
|
- name: Get fan inventory
|
|
redfish_facts:
|
|
category: Chassis
|
|
command: GetFanInventory
|
|
baseuri: "{{ baseuri }}"
|
|
username: "{{ username }}"
|
|
password: "{{ password }}"
|
|
|
|
- name: Get default inventory information
|
|
redfish_facts:
|
|
baseuri: "{{ baseuri }}"
|
|
username: "{{ username }}"
|
|
password: "{{ password }}"
|
|
- debug:
|
|
msg: "{{ redfish_facts | to_nice_json }}"
|
|
|
|
- name: Get several inventories
|
|
redfish_facts:
|
|
category: Systems
|
|
command: GetNicInventory,GetBiosAttributes
|
|
baseuri: "{{ baseuri }}"
|
|
username: "{{ username }}"
|
|
password: "{{ password }}"
|
|
|
|
- name: Get default system inventory and user information
|
|
redfish_facts:
|
|
category: Systems,Accounts
|
|
baseuri: "{{ baseuri }}"
|
|
username: "{{ username }}"
|
|
password: "{{ password }}"
|
|
|
|
- name: Get default system, user and firmware information
|
|
redfish_facts:
|
|
category: ["Systems", "Accounts", "Update"]
|
|
baseuri: "{{ baseuri }}"
|
|
username: "{{ username }}"
|
|
password: "{{ password }}"
|
|
|
|
- name: Get Manager NIC inventory information
|
|
redfish_facts:
|
|
category: Manager
|
|
command: GetManagerNicInventory
|
|
baseuri: "{{ baseuri }}"
|
|
username: "{{ username }}"
|
|
password: "{{ password }}"
|
|
|
|
- name: Get all information available in the Manager category
|
|
redfish_facts:
|
|
category: Manager
|
|
command: all
|
|
baseuri: "{{ baseuri }}"
|
|
username: "{{ username }}"
|
|
password: "{{ password }}"
|
|
|
|
- name: Get all information available in all categories
|
|
redfish_facts:
|
|
category: all
|
|
command: all
|
|
baseuri: "{{ baseuri }}"
|
|
username: "{{ username }}"
|
|
password: "{{ password }}"
|
|
'''
|
|
|
|
RETURN = '''
|
|
result:
|
|
description: different results depending on task
|
|
returned: always
|
|
type: dict
|
|
sample: List of CPUs on system
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.redfish_utils import RedfishUtils
|
|
|
|
CATEGORY_COMMANDS_ALL = {
|
|
"Systems": ["GetSystemInventory", "GetCpuInventory",
|
|
"GetNicInventory", "GetStorageControllerInventory",
|
|
"GetDiskInventory", "GetBiosAttributes", "GetBootOrder"],
|
|
"Chassis": ["GetFanInventory", "GetPsuInventory"],
|
|
"Accounts": ["ListUsers"],
|
|
"Update": ["GetFirmwareInventory"],
|
|
"Manager": ["GetManagerNicInventory", "GetLogs"],
|
|
}
|
|
|
|
CATEGORY_COMMANDS_DEFAULT = {
|
|
"Systems": "GetSystemInventory",
|
|
"Chassis": "GetFanInventory",
|
|
"Accounts": "ListUsers",
|
|
"Update": "GetFirmwareInventory",
|
|
"Manager": "GetManagerNicInventory"
|
|
}
|
|
|
|
|
|
def main():
|
|
result = {}
|
|
resource = {}
|
|
category_list = []
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
category=dict(type='list', default=['Systems']),
|
|
command=dict(type='list'),
|
|
baseuri=dict(required=True),
|
|
username=dict(required=True),
|
|
password=dict(required=True, no_log=True),
|
|
),
|
|
supports_check_mode=False
|
|
)
|
|
|
|
# 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 = RedfishUtils(creds, root_uri)
|
|
|
|
# Build Category list
|
|
if "all" in module.params['category']:
|
|
for entry in CATEGORY_COMMANDS_ALL:
|
|
category_list.append(entry)
|
|
else:
|
|
# one or more categories specified
|
|
category_list = module.params['category']
|
|
|
|
for category in category_list:
|
|
command_list = []
|
|
# Build Command list for each Category
|
|
if category in CATEGORY_COMMANDS_ALL:
|
|
if not module.params['command']:
|
|
# True if we don't specify a command --> use default
|
|
command_list.append(CATEGORY_COMMANDS_DEFAULT[category])
|
|
elif "all" in module.params['command']:
|
|
for entry in range(len(CATEGORY_COMMANDS_ALL[category])):
|
|
command_list.append(CATEGORY_COMMANDS_ALL[category][entry])
|
|
# one or more commands
|
|
else:
|
|
command_list = module.params['command']
|
|
# Verify 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="Invalid Command: %s" % cmd)
|
|
else:
|
|
# Fail if even one category given is invalid
|
|
module.fail_json(msg="Invalid Category: %s" % category)
|
|
|
|
# Organize by Categories / Commands
|
|
if category == "Systems":
|
|
# execute only if we find a Systems resource
|
|
resource = rf_utils._find_systems_resource(rf_uri)
|
|
if resource['ret'] is False:
|
|
module.fail_json(msg=resource['msg'])
|
|
|
|
for command in command_list:
|
|
if command == "GetSystemInventory":
|
|
result["system"] = rf_utils.get_multi_system_inventory()
|
|
elif command == "GetCpuInventory":
|
|
result["cpu"] = rf_utils.get_multi_cpu_inventory()
|
|
elif command == "GetNicInventory":
|
|
result["nic"] = rf_utils.get_multi_nic_inventory(category)
|
|
elif command == "GetStorageControllerInventory":
|
|
result["storage_controller"] = rf_utils.get_multi_storage_controller_inventory()
|
|
elif command == "GetDiskInventory":
|
|
result["disk"] = rf_utils.get_multi_disk_inventory()
|
|
elif command == "GetBiosAttributes":
|
|
result["bios_attribute"] = rf_utils.get_multi_bios_attributes()
|
|
elif command == "GetBootOrder":
|
|
result["boot_order"] = rf_utils.get_multi_boot_order()
|
|
|
|
elif category == "Chassis":
|
|
# execute only if we find Chassis resource
|
|
resource = rf_utils._find_chassis_resource(rf_uri)
|
|
if resource['ret'] is False:
|
|
module.fail_json(msg=resource['msg'])
|
|
|
|
for command in command_list:
|
|
if command == "GetFanInventory":
|
|
result["fan"] = rf_utils.get_fan_inventory()
|
|
elif command == "GetPsuInventory":
|
|
result["psu"] = rf_utils.get_psu_inventory()
|
|
|
|
elif category == "Accounts":
|
|
# execute only if we find an Account service resource
|
|
resource = rf_utils._find_accountservice_resource(rf_uri)
|
|
if resource['ret'] is False:
|
|
module.fail_json(msg=resource['msg'])
|
|
|
|
for command in command_list:
|
|
if command == "ListUsers":
|
|
result["user"] = rf_utils.list_users()
|
|
|
|
elif category == "Update":
|
|
# execute only if we find UpdateService resources
|
|
resource = rf_utils._find_updateservice_resource(rf_uri)
|
|
if resource['ret'] is False:
|
|
module.fail_json(msg=resource['msg'])
|
|
|
|
for command in command_list:
|
|
if command == "GetFirmwareInventory":
|
|
result["firmware"] = rf_utils.get_firmware_inventory()
|
|
|
|
elif category == "Manager":
|
|
# execute only if we find a Manager service resource
|
|
resource = rf_utils._find_managers_resource(rf_uri)
|
|
if resource['ret'] is False:
|
|
module.fail_json(msg=resource['msg'])
|
|
|
|
for command in command_list:
|
|
if command == "GetManagerNicInventory":
|
|
result["manager_nics"] = rf_utils.get_multi_nic_inventory(resource_type=category)
|
|
elif command == "GetLogs":
|
|
result["log"] = rf_utils.get_logs()
|
|
|
|
# Return data back
|
|
module.exit_json(ansible_facts=dict(redfish_facts=result))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|