/ home / community / community.general / 8.5.0 / module / idrac_redfish_config

community.general.idrac_redfish_config (8.5.0) — module

Manages servers through iDRAC using Dell Redfish APIs

Authors: Jose Delarosa (@jose-delarosa)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

For use with Dell iDRAC operations that require Redfish OEM extensions

Builds Redfish URIs locally and sends them to remote iDRAC controllers to set or update a configuration attribute.

Usage examples

Scanned by Steampunk Spotter

  - name: Enable NTP and set NTP server and Time zone attributes in iDRAC
    community.general.idrac_redfish_config:
      category: Manager
      command: SetManagerAttributes
      resource_id: iDRAC.Embedded.1
      manager_attributes:
        NTPConfigGroup.1.NTPEnable: "Enabled"
        NTPConfigGroup.1.NTP1: "{{ ntpserver1 }}"
        Time.1.Timezone: "{{ timezone }}"
      baseuri: "{{ baseuri }}"
      username: "{{ username}}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Enable Syslog and set Syslog servers in iDRAC
    community.general.idrac_redfish_config:
      category: Manager
      command: SetManagerAttributes
      resource_id: iDRAC.Embedded.1
      manager_attributes:
        SysLog.1.SysLogEnable: "Enabled"
        SysLog.1.Server1: "{{ syslog_server1 }}"
        SysLog.1.Server2: "{{ syslog_server2 }}"
      baseuri: "{{ baseuri }}"
      username: "{{ username}}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Configure SNMP community string, port, protocol and trap format
    community.general.idrac_redfish_config:
      category: Manager
      command: SetManagerAttributes
      resource_id: iDRAC.Embedded.1
      manager_attributes:
        SNMP.1.AgentEnable: "Enabled"
        SNMP.1.AgentCommunity: "public_community_string"
        SNMP.1.TrapFormat: "SNMPv1"
        SNMP.1.SNMPProtocol: "All"
        SNMP.1.DiscoveryPort: 161
        SNMP.1.AlertPort: 162
      baseuri: "{{ baseuri }}"
      username: "{{ username}}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Enable CSIOR
    community.general.idrac_redfish_config:
      category: Manager
      command: SetLifecycleControllerAttributes
      resource_id: iDRAC.Embedded.1
      manager_attributes:
        LCAttributes.1.CollectSystemInventoryOnRestart: "Enabled"
      baseuri: "{{ baseuri }}"
      username: "{{ username}}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Set Power Supply Redundancy Policy to A/B Grid Redundant
    community.general.idrac_redfish_config:
      category: Manager
      command: SetSystemAttributes
      resource_id: iDRAC.Embedded.1
      manager_attributes:
        ServerPwr.1.PSRedPolicy: "A/B Grid Redundant"
      baseuri: "{{ baseuri }}"
      username: "{{ username}}"
      password: "{{ password }}"

Inputs

    
baseuri:
    description:
    - Base URI of iDRAC.
    required: true
    type: str

command:
    description:
    - List of commands to execute on iDRAC.
    - V(SetManagerAttributes), V(SetLifecycleControllerAttributes) and V(SetSystemAttributes)
      are mutually exclusive commands when O(category) is V(Manager).
    elements: str
    required: true
    type: list

timeout:
    default: 10
    description:
    - Timeout in seconds for HTTP requests to iDRAC.
    type: int

category:
    description:
    - Category to execute on iDRAC.
    required: true
    type: str

password:
    description:
    - Password for authenticating to iDRAC.
    type: str

username:
    description:
    - Username for authenticating to iDRAC.
    type: str

auth_token:
    description:
    - Security token for authenticating to iDRAC.
    type: str
    version_added: 2.3.0
    version_added_collection: community.general

resource_id:
    description:
    - ID of the System, Manager or Chassis to modify.
    required: false
    type: str
    version_added: 0.2.0
    version_added_collection: community.general

manager_attributes:
    default: {}
    description:
    - Dictionary of iDRAC attribute name and value pairs to update.
    required: false
    type: dict
    version_added: 0.2.0
    version_added_collection: community.general

Outputs

msg:
  description: Message with action result or error description
  returned: always
  sample: Action was successful
  type: str