kaytus.ksmanage.edit_dns – Set dns information

Note

This plugin is part of the kaytus.ksmanage collection.

To install it use: ansible-galaxy collection install kaytus.ksmanage.

To use it in a playbook, specify: kaytus.ksmanage.edit_dns.

New in version 1.0.0: of kaytus.ksmanage

Synopsis

  • Set dns information on kaytus Server.

Requirements

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

  • Python 3.7+

  • inManage

Parameters

Parameter Choices/Defaults Comments
dns_iface
string
DNS Interface,input like 'eth0', 'eth1', 'bond0'.
Required when dns_manual=auto.
dns_manual
string
    Choices:
  • manual
  • auto
DNS Settings.
dns_priority
string
    Choices:
  • 4
  • 6
IP Priority.
Required when dns_manual=auto.
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
    Choices:
  • enable
  • disable
DNS status.
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
    Choices:
  • manual
  • auto
Domain Settings.
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
    Choices:
  • manual
  • auto
Host Settings.
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
    Choices:
  • enable
  • disable
BMC register status 1.
Only the M6 model supports this parameter.
register_status2
string
    Choices:
  • enable
  • disable
BMC register status 2.
Only the M6 model supports this parameter.
registration_method1
string
    Choices:
  • nsupdate
  • dhcp
  • hostname
Registration method 1.
Only the M6 model supports this parameter.
Required when register_status1=enable.
registration_method2
string
    Choices:
  • nsupdate
  • dhcp
  • hostname
Registration method 2.
Only the M6 model supports this parameter.
Required when register_status2=enable.
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: ksmanage
  connection: local
  gather_facts: no
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set dns information"
    kaytus.ksmanage.edit_dns:
      dns_status: "disable"
      provider: "{{ ksmanage }}"

  - name: "Set dns information"
    kaytus.ksmanage.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: "{{ ksmanage }}"

  - name: "Set dns information"
    kaytus.ksmanage.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: "{{ ksmanage }}"

Return Values

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

Key Returned Description
changed
boolean
always
Check to see if a change was made on the device.
message
string
always
Messages returned after module execution.
state
string
always
Status after module execution.


Authors

  • WangBaoshan (@ieisystem)