dellemc.openmanage.idrac_network (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 iDRAC network settings.

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 iDRAC network settings
  dellemc.openmanage.idrac_network:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       ca_path: "/path/to/ca_cert.pem"
       register_idrac_on_dns: Enabled
       dns_idrac_name: None
       auto_config: None
       static_dns: None
       setup_idrac_nic_vlan: Enabled
       vlan_id: 0
       vlan_priority: 1
       enable_nic: Enabled
       nic_selection: Dedicated
       failover_network: T_None
       auto_detect: Disabled
       auto_negotiation: Enabled
       network_speed: T_1000
       duplex_mode: Full
       nic_mtu: 1500
       ip_address: "192.168.0.1"
       enable_dhcp: Enabled
       enable_ipv4: Enabled
       static_dns_1: "192.168.0.1"
       static_dns_2: "192.168.0.1"
       dns_from_dhcp: Enabled
       static_gateway: None
       static_net_mask: None

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

nic_mtu:
    description: Maximum Transmission Unit of the NIC.
    type: int

timeout:
    default: 30
    description: The socket level timeout in seconds.
    type: int
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

vlan_id:
    description: Enter the VLAN ID.  The VLAN ID must be a number from 1 through 4094.
    type: int

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

share_mnt:
    description:
    - (deprecated)Local mount path of the network share with read-write permission for
      ansible user. This option is mandatory for network shares.
    - This option is deprecated and will be removed in the later version.
    type: str

enable_nic:
    choices:
    - Enabled
    - Disabled
    description: Allows to enable or disable the Network Interface Controller (NIC) used
      by iDRAC.
    type: str

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

idrac_user:
    description:
    - iDRAC username.
    - If the username is not provided, then the environment variable C(IDRAC_USERNAME)
      is used.
    - 'Example: export IDRAC_USERNAME=username'
    required: true
    type: str

ip_address:
    description: Enter a valid iDRAC static IPv4 address.
    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 name. Use the format 'user@domain' or 'domain\user'
      if user is part of a domain. This option is mandatory for CIFS share.
    - This option is deprecated and will be removed in the later version.
    type: str

static_dns:
    description: Enter the static DNS domain name.
    type: str

auto_config:
    choices:
    - Enabled
    - Disabled
    description: Allows to enable or disable auto-provisioning to automatically acquire
      domain name from DHCP.
    type: str

auto_detect:
    choices:
    - Enabled
    - Disabled
    description: Allows to auto detect the available NIC types used by iDRAC.
    type: str

duplex_mode:
    choices:
    - Full
    - Half
    description: Select the type of data transmission for the NIC.
    type: str

enable_dhcp:
    choices:
    - Enabled
    - Disabled
    description: Allows to enable or disable Dynamic Host Configuration Protocol (DHCP)
      in iDRAC.
    type: str

enable_ipv4:
    choices:
    - Enabled
    - Disabled
    description: Allows to enable or disable IPv4 configuration.
    type: str

static_dns_1:
    description: Enter the preferred static DNS server IPv4 address.
    type: str

static_dns_2:
    description: Enter the preferred static DNS server IPv4 address.
    type: str

dns_from_dhcp:
    choices:
    - Enabled
    - Disabled
    description: Allows to enable DHCP to obtain DNS server address.
    type: str

network_speed:
    choices:
    - T_10
    - T_100
    - T_1000
    description: Select the network speed for the selected NIC.
    type: str

nic_selection:
    choices:
    - Dedicated
    - LOM1
    - LOM2
    - LOM3
    - LOM4
    description: Select one of the available NICs.
    type: str

vlan_priority:
    description: Enter the priority for the VLAN ID. The priority value must be a number
      from 0 through 7.
    type: int

dns_idrac_name:
    description: Name of the DNS to register iDRAC.
    type: str

idrac_password:
    aliases:
    - idrac_pwd
    description:
    - iDRAC user password.
    - If the password is not provided, then the environment variable C(IDRAC_PASSWORD)
      is used.
    - 'Example: export IDRAC_PASSWORD=password'
    required: true
    type: str

share_password:
    aliases:
    - share_pwd
    description:
    - (deprecated)Network share user password. This option is mandatory for CIFS share.
    - This option is deprecated and will be removed in the later version.
    type: str

static_gateway:
    description: Enter the static IPv4 gateway address to iDRAC.
    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

static_net_mask:
    description: Enter the static IP subnet mask to iDRAC.
    type: str

auto_negotiation:
    choices:
    - Enabled
    - Disabled
    description: Allows iDRAC to automatically set the duplex mode and network speed.
    type: str

failover_network:
    choices:
    - ALL
    - LOM1
    - LOM2
    - LOM3
    - LOM4
    - T_None
    description: Select one of the remaining LOMs. If a network fails, the traffic is
      routed through the failover network.
    type: str

setup_idrac_nic_vlan:
    choices:
    - Enabled
    - Disabled
    description: Allows to configure VLAN on iDRAC.
    type: str

register_idrac_on_dns:
    choices:
    - Enabled
    - Disabled
    description: Registers iDRAC on a Domain Name System (DNS).
    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: Successfully configured the idrac network settings.
  returned: always
  sample: Successfully configured the idrac network settings.
  type: str
network_status:
  description: Status of the Network settings operation job.
  returned: success
  sample:
    '@odata.context': /redfish/v1/$metadata#DellJob.DellJob
    '@odata.id': /redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_856418531008
    '@odata.type': '#DellJob.v1_0_2.DellJob'
    CompletionTime: '2020-03-31T03:04:15'
    Description: Job Instance
    EndTime: null
    Id: JID_856418531008
    JobState: Completed
    JobType: ImportConfiguration
    Message: Successfully imported and applied Server Configuration Profile.
    MessageArgs: []
    MessageArgs@odata.count: 0
    MessageId: SYS053
    Name: Import Configuration
    PercentComplete: 100
    StartTime: TIME_NOW
    Status: Success
    TargetSettingsURI: null
    retval: true
  type: dict