wti.remote.cpm_dnsservices_config module – Set network DNS Services parameters in WTI OOB and PDU devices

Note

This module is part of the wti.remote collection (version 1.0.10).

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 wti.remote.

To use it in a playbook, specify: wti.remote.cpm_dnsservices_config.

New in wti.remote 2.10.0

Synopsis

  • Set network DNS Services parameters in WTI OOB and PDU devices

Parameters

Parameter

Comments

cpm_password

string / required

This is the Password of the WTI device to send the module. If the

cpm_username is blank, this parameter is presumed to be a User Token.

cpm_url

string / required

This is the URL of the WTI device to send the module.

cpm_username

string

This is the Username of the WTI device to send the module. If this value

is blank, then the cpm_password is presumed to be a User Token.

dnsservers

list / elements=string / required

Actual DNS Server to send to the WTI device.

index

list / elements=integer

Index in which DNS Server should be inserted. If not defined entry will start at position one.

use_https

boolean

Designates to use an https connection or http connection.

Choices:

  • false

  • true ← (default)

use_proxy

boolean

Flag to control if the lookup will observe HTTP proxy environment variables when present.

Choices:

  • false ← (default)

  • true

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used

on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Use groups/cpm in module_defaults to set common options used between CPM modules.

Examples

# Set Network DNS Services Parameters
- name: Set the an DNS Services Parameter for a WTI device
  cpm_dnsservices_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    dnsservers: "8.8.8.8"

# Set Network DNS Services Parameters using a User Token
- name: Set the an DNS Services Parameter for a WTI device
  cpm_dnsservices_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: ""
    cpm_password: "randomusertokenfromthewtidevice"
    use_https: true
    validate_certs: false
    dnsservers: "8.8.4.4"

# Sets multiple Network DNS Services Parameters
- name: Set the DNS Services Parameters a WTI device
  cpm_dnsservices_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    index:
      - 1
      - 2
    dnsservers:
      - "8.8.8.8"
      - "8.8.4.4"

Return Values

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

Key

Description

data

complex

The output JSON returned from the commands sent

Returned: always

dnsservices

dictionary

Current k/v pairs of interface info for the WTI device after module execution.

Returned: always

Sample: {"servers": [{"dnsserver1": [{"ip": "166.216.138.41"}], "dnsserver2": [{"ip": "166.216.138.42"}], "dnsserver3": [{"ip": "8.8.8.8"}], "dnsserver4": [{"ip": ""}]}]}

Authors

  • Western Telematic Inc. (@wtinetworkgear)