ieisystem.inmanage.edit_dns module – Set dns information

Note

This module is part of the ieisystem.inmanage collection (version 3.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install ieisystem.inmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ieisystem.inmanage.edit_dns.

New in ieisystem.inmanage 1.0.0

Synopsis

  • Set dns information on ieisystem Server.

Requirements

The below requirements are needed on the host that executes this module.

  • Python 3.7+

  • inManage

Parameters

Parameter

Comments

dns_iface

string

DNS Interface, input like ‘eth0’, ‘eth1’, ‘bond0’.

Required when dns_manual=auto.

dns_manual

string

DNS Settings. Select whether the DNS interface will be configured manually or automatically.

Choices:

  • "manual"

  • "auto"

dns_priority

string

IP Priority.

Required when dns_manual=auto.

Choices:

  • "4"

  • "6"

dns_server1

string

DNS Server1 IPv4 or IPv6 address.

Required when dns_manual=manual.

dns_server2

string

DNS Server2 IPv4 or IPv6 address.

Required when dns_manual=manual.

dns_server3

string

DNS Server3 IPv4 or IPv6 address.

Required when dns_manual=manual.

dns_status

string

DNS status.

Choices:

  • "enable"

  • "disable"

domain_iface

string

Network Interface, input like ‘eth0_v4’, ‘eth0_v6’, ‘eth1_v4’, ‘eth1_v6’, ‘bond0_v4’, ‘bond0_v6’.

Required when domain_manual=auto.

domain_manual

string

Domain Settings. Select whether the domain interface will be configured manually or automatically.

Choices:

  • "manual"

  • "auto"

domain_name

string

Domain Name.

Required when domain_manual=manual.

host

string

Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.

host_cfg

string

Host Settings. Select whether the host name will be configured manually or automatically.

Choices:

  • "manual"

  • "auto"

host_name

string

Host Name.

Required when host_cfg=manual.

password

string

Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

provider

dictionary

A dict object containing connection details.

host

string

Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.

password

string

Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

username

string

Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

register_status1

string

BMC register status 1.

Only the M6 model supports this parameter.

Choices:

  • "enable"

  • "disable"

register_status2

string

BMC register status 2.

Only the M6 model supports this parameter.

Choices:

  • "enable"

  • "disable"

registration_method1

string

Registration method 1.

Only the M6 model supports this parameter.

Required when register_status1=enable.

Choices:

  • "nsupdate"

  • "dhcp"

  • "hostname"

registration_method2

string

Registration method 2.

Only the M6 model supports this parameter.

Required when register_status2=enable.

Choices:

  • "nsupdate"

  • "dhcp"

  • "hostname"

username

string

Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Notes

Note

  • Does not support check_mode.

Examples

- name: DNS test
  hosts: inmanage
  connection: local
  gather_facts: false
  vars:
    inmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set dns information"
    ieisystem.inmanage.edit_dns:
      dns_status: "disable"
      provider: "{{ inmanage }}"

  - name: "Set dns information"
    ieisystem.inmanage.edit_dns:
      dns_status: "enable"
      host_cfg: "manual"
      host_name: "123456789"
      domain_manual: "auto"
      domain_iface: "eth0_v4"
      dns_manual: "manual"
      dns_server1: "100.2.2.2"
      dns_server2: "100.2.2.3"
      dns_server3: "100.2.2.4"
      provider: "{{ inmanage }}"

  - name: "Set dns information"
    ieisystem.inmanage.edit_dns:
      dns_status: "enable"
      host_cfg: "manual"
      host_name: "123456789"
      domain_manual: "manual"
      domain_name: "test.com"
      dns_manual: "auto"
      dns_iface: "eth0"
      dns_priority: "4"
      provider: "{{ inmanage }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Check to see if a change was made on the device.

Returned: always

message

string

Messages returned after module execution.

Returned: always

state

string

Status after module execution.

Returned: always

Authors

  • WangBaoshan (@ieisystem)