dellemc.openmanage.dellemc_configure_idrac_services (9.1.0) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 9.1.0

Description

This module allows to configure the iDRAC services related attributes.

Requirements

• omsdk >= 1.2.488
• python >= 3.9.6

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: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    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

    
ca_path:
    description:
    - The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
      the validation.
    type: path
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

timeout:
    description: Timeout value.
    type: str

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

ipmi_lan:
    description: Community name set on iDRAC for SNMP settings.
    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.
        type: str
    type: dict

http_port:
    description: HTTP access port.
    type: int

share_mnt:
    description:
    - (deprecated)Local mount path of the network share with read-write permission for
      ansible user. This option is mandatory for Network Share.
    - This option is deprecated and will be removed in the later version.
    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.
    type: int

https_port:
    description: HTTPS access port.
    type: int

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

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

share_name:
    description:
    - (deprecated)Network share or a local path.
    - This option is deprecated and will be removed in the later version.
    type: str

share_user:
    description:
    - (deprecated)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.
    - This option is deprecated and will be removed in the later version.
    type: str

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

trap_format:
    choices:
    - SNMPv1
    - SNMPv2
    - SNMPv3
    description: SNMP trap format for iDRAC.
    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.
    type: str

snmp_protocol:
    choices:
    - All
    - SNMPv3
    description: Type of the SNMP protocol.
    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.
    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.
    type: int

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

share_password:
    aliases:
    - share_pwd
    description:
    - (deprecated)Network share user password. This option is mandatory for CIFS Network
      Share.
    - This option is deprecated and will be removed in the later version.
    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.
    type: str

validate_certs:
    default: true
    description:
    - If C(false), the SSL certificates will not be validated.
    - Configure C(false) only on personally controlled sites where self-signed certificates
      are used.
    - Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
    type: bool
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

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

Outputs

error_info:
  description: Details of the HTTP Error.
  returned: on HTTP error
  sample:
    error:
      '@Message.ExtendedInfo':
      - Message: Unable to process the request because an error occurred.
        MessageArgs: []
        MessageId: GEN1234
        RelatedProperties: []
        Resolution: Retry the operation. If the issue persists, contact your system
          administrator.
        Severity: Critical
      code: Base.1.0.GeneralError
      message: A general error has occurred. See ExtendedInfo for more information.
  type: dict
msg:
  description: Overall status of iDRAC service attributes configuration.
  returned: always
  sample: Successfully configured the iDRAC services settings.
  type: str
service_status:
  description: Details of iDRAC services attributes configuration.
  returned: success
  sample:
    CompletionTime: '2020-04-02T02:43:28'
    Description: Job Instance
    EndTime: null
    Id: JID_12345123456
    JobState: Completed
    JobType: ImportConfiguration
    Message: Successfully imported and applied Server Configuration Profile.
    MessageArgs: []
    MessageId: SYS053
    Name: Import Configuration
    PercentComplete: 100
    StartTime: TIME_NOW
    Status: Success
    TargetSettingsURI: null
    retval: true
  type: dict