dellemc.openmanage.dellemc_configure_idrac_services (2.1.5) — module

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==2.1.5

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 2.1.5

Description

This module is responsible for configuring the iDRAC services attributes.

Requirements

• omsdk
• python >= 2.7.5

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- name: Configure the iDRAC services attributes.
  dellemc.openmanage.dellemc_configure_idrac_services:
       idrac_ip:   "xx.xx.xx.xx"
       idrac_user: "xxxx"
       idrac_password:  "xxxxxxxx"
       share_name: "xx.xx.xx.xx:/share"
       share_password:  "xxxxxxxx"
       share_user: "xxxx"
       share_mnt: "/mnt/share"
       enable_web_server: "Enabled"
       http_port: 80
       https_port: 443
       ssl_encryption: "Auto_Negotiate"
       tls_protocol: "TLS_1_2_Only"
       timeout: "1800"
       snmp_enable: "Enabled"
       snmp_protocol: "SNMPv3"
       community_name: "public"
       alert_port: 162
       discovery_port: 161
       trap_format: "SNMPv3"
       ipmi_lan:
         community_name: "public"

Inputs

    
timeout:
    description: Timeout value.
    required: false
    type: str

idrac_ip:
    description: iDRAC IP Address.
    required: true
    type: str

ipmi_lan:
    description: Community name set on iDRAC for SNMP settings.
    required: false
    suboptions:
      community_name:
        description: This option is used by iDRAC when it sends out SNMP and IPMI traps.
          The community name is checked by the remote system to which the traps are sent.
        required: false
        type: str
    type: dict

http_port:
    description: HTTP access port.
    required: false
    type: int

share_mnt:
    description: Local mount path of the network share with read-write permission for
      ansible user. This option is mandatory for Network Share.
    required: false
    type: str

alert_port:
    default: 162
    description: The iDRAC port number that must be used for SNMP traps. The default value
      is 162, and the acceptable range is between 1 to 65535.
    required: false
    type: int

https_port:
    description: HTTPS access port.
    required: false
    type: int

idrac_port:
    default: 443
    description: iDRAC port.
    required: false
    type: int

idrac_user:
    description: iDRAC username.
    required: true
    type: str

share_name:
    description: Network share or a local path.
    required: true
    type: str

share_user:
    description: Network share user in the format 'user@domain' or 'domain\user' if user
      is part of a domain else 'user'. This option is mandatory for CIFS Network Share.
    required: false
    type: str

snmp_enable:
    choices:
    - Enabled
    - Disabled
    description: Whether to Enable or Disable SNMP protocol for iDRAC.
    required: false
    type: str

trap_format:
    choices:
    - SNMPv1
    - SNMPv2
    - SNMPv3
    description: SNMP trap format for iDRAC.
    required: false
    type: str

tls_protocol:
    choices:
    - TLS_1_0_and_Higher
    - TLS_1_1_and_Higher
    - TLS_1_2_Only
    description: Transport Layer Security for webserver.
    required: false
    type: str

snmp_protocol:
    choices:
    - All
    - SNMPv3
    description: Type of the SNMP protocol.
    required: false
    type: str

community_name:
    description: SNMP community name for iDRAC. It is used by iDRAC to validate SNMP queries
      received from remote systems requesting SNMP data access.
    required: false
    type: str

discovery_port:
    default: 161
    description: The SNMP agent port on the iDRAC. The default value is 161, and the acceptable
      range is between 1 to 65535.
    required: false
    type: int

idrac_password:
    aliases:
    - idrac_pwd
    description: iDRAC user password.
    required: true
    type: str

share_password:
    aliases:
    - share_pwd
    description: Network share user password. This option is mandatory for CIFS Network
      Share.
    required: false
    type: str

ssl_encryption:
    choices:
    - Auto_Negotiate
    - T_128_Bit_or_higher
    - T_168_Bit_or_higher
    - T_256_Bit_or_higher
    description: Secure Socket Layer encryption for webserver.
    required: false
    type: str

enable_web_server:
    choices:
    - Enabled
    - Disabled
    description: Whether to Enable or Disable webserver configuration for iDRAC.
    required: false
    type: str