1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Redfish: implementing ResetToDefaults (#8164)

Fixing #8163

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>
This commit is contained in:
Boris Glimcher 2024-04-03 07:47:00 -04:00 committed by GitHub
parent 48b5a7a80a
commit e4e091acca
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 67 additions and 0 deletions

View file

@ -0,0 +1,2 @@
minor_changes:
- redfish_command - add command ``ResetToDefaults`` to reset manager to default state (https://github.com/ansible-collections/community.general/issues/8163).

View file

@ -1149,6 +1149,54 @@ class RedfishUtils(object):
return response return response
return {'ret': True, 'changed': True} return {'ret': True, 'changed': True}
def manager_reset_to_defaults(self, command):
return self.reset_to_defaults(command, self.manager_uri,
'#Manager.ResetToDefaults')
def reset_to_defaults(self, command, resource_uri, action_name):
key = "Actions"
reset_type_values = ['ResetAll',
'PreserveNetworkAndUsers',
'PreserveNetwork']
if command not in reset_type_values:
return {'ret': False, 'msg': 'Invalid Command (%s)' % command}
# read the resource and get the current power state
response = self.get_request(self.root_uri + resource_uri)
if response['ret'] is False:
return response
data = response['data']
# get the reset Action and target URI
if key not in data or action_name not in data[key]:
return {'ret': False, 'msg': 'Action %s not found' % action_name}
reset_action = data[key][action_name]
if 'target' not in reset_action:
return {'ret': False,
'msg': 'target URI missing from Action %s' % action_name}
action_uri = reset_action['target']
# get AllowableValues
ai = self._get_all_action_info_values(reset_action)
allowable_values = ai.get('ResetType', {}).get('AllowableValues', [])
# map ResetType to an allowable value if needed
if allowable_values and command not in allowable_values:
return {'ret': False,
'msg': 'Specified reset type (%s) not supported '
'by service. Supported types: %s' %
(command, allowable_values)}
# define payload
payload = {'ResetType': command}
# POST to Action URI
response = self.post_request(self.root_uri + action_uri, payload)
if response['ret'] is False:
return response
return {'ret': True, 'changed': True}
def _find_account_uri(self, username=None, acct_id=None): def _find_account_uri(self, username=None, acct_id=None):
if not any((username, acct_id)): if not any((username, acct_id)):
return {'ret': False, 'msg': return {'ret': False, 'msg':

View file

@ -281,6 +281,12 @@ options:
- BIOS attributes that needs to be verified in the given server. - BIOS attributes that needs to be verified in the given server.
type: dict type: dict
version_added: 6.4.0 version_added: 6.4.0
reset_to_defaults_mode:
description:
- Mode to apply when reseting to default.
type: str
choices: [ ResetAll, PreserveNetworkAndUsers, PreserveNetwork ]
version_added: 8.6.0
author: author:
- "Jose Delarosa (@jose-delarosa)" - "Jose Delarosa (@jose-delarosa)"
@ -714,6 +720,13 @@ EXAMPLES = '''
command: PowerReboot command: PowerReboot
resource_id: BMC resource_id: BMC
- name: Factory reset manager to defaults
community.general.redfish_command:
category: Manager
command: ResetToDefaults
resource_id: BMC
reset_to_defaults_mode: ResetAll
- name: Verify BIOS attributes - name: Verify BIOS attributes
community.general.redfish_command: community.general.redfish_command:
category: Systems category: Systems
@ -764,6 +777,7 @@ CATEGORY_COMMANDS_ALL = {
"UpdateAccountServiceProperties"], "UpdateAccountServiceProperties"],
"Sessions": ["ClearSessions", "CreateSession", "DeleteSession"], "Sessions": ["ClearSessions", "CreateSession", "DeleteSession"],
"Manager": ["GracefulRestart", "ClearLogs", "VirtualMediaInsert", "Manager": ["GracefulRestart", "ClearLogs", "VirtualMediaInsert",
"ResetToDefaults",
"VirtualMediaEject", "PowerOn", "PowerForceOff", "PowerForceRestart", "VirtualMediaEject", "PowerOn", "PowerForceOff", "PowerForceRestart",
"PowerGracefulRestart", "PowerGracefulShutdown", "PowerReboot"], "PowerGracefulRestart", "PowerGracefulShutdown", "PowerReboot"],
"Update": ["SimpleUpdate", "MultipartHTTPPushUpdate", "PerformRequestedOperations"], "Update": ["SimpleUpdate", "MultipartHTTPPushUpdate", "PerformRequestedOperations"],
@ -825,6 +839,7 @@ def main():
) )
), ),
strip_etag_quotes=dict(type='bool', default=False), strip_etag_quotes=dict(type='bool', default=False),
reset_to_defaults_mode=dict(choices=['ResetAll', 'PreserveNetworkAndUsers', 'PreserveNetwork']),
bios_attributes=dict(type="dict") bios_attributes=dict(type="dict")
), ),
required_together=[ required_together=[
@ -1017,6 +1032,8 @@ def main():
result = rf_utils.virtual_media_insert(virtual_media, category) result = rf_utils.virtual_media_insert(virtual_media, category)
elif command == 'VirtualMediaEject': elif command == 'VirtualMediaEject':
result = rf_utils.virtual_media_eject(virtual_media, category) result = rf_utils.virtual_media_eject(virtual_media, category)
elif command == 'ResetToDefaults':
result = rf_utils.manager_reset_to_defaults(module.params['reset_to_defaults_mode'])
elif category == "Update": elif category == "Update":
# execute only if we find UpdateService resources # execute only if we find UpdateService resources