ansible.netcommon.net_system (3.1.3) — module

Install collection

Install with ansible-galaxy collection install ansible.netcommon:==3.1.3

Add to requirements.yml

  collections:
    - name: ansible.netcommon
      version: 3.1.3

Description

This module provides declarative management of node system attributes on network devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure hostname and domain name
  ansible.netcommon.net_system:
    hostname: ios01
    domain_name: test.example.com
    domain_search:
    - ansible.com
    - redhat.com
    - cisco.com

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: domain search on single domain
  ansible.netcommon.net_system:
    domain_search: ansible.com

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: remove configuration
  ansible.netcommon.net_system:
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure DNS lookup sources
  ansible.netcommon.net_system:
    lookup_source: MgmtEth0/0/CPU0/0

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure name servers
  ansible.netcommon.net_system:
    name_servers:
    - 8.8.8.8
    - 8.8.4.4

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the configuration values in the device's current active configuration.  When
      set to I(present), the values should be configured in the device active configuration
      and when set to I(absent) the values should not be in the device active configuration

hostname:
    description:
    - Configure the device hostname parameter. This option takes an ASCII string value.

domain_name:
    description:
    - Configure the IP domain name on the remote device to the provided value. Value should
      be in the dotted name form and will be appended to the C(hostname) to create a fully-qualified
      domain name.

name_servers:
    description:
    - List of DNS name servers by IP address to use to perform name resolution lookups.  This
      argument accepts either a list of DNS servers See examples.

domain_search:
    description:
    - Provides the list of domain suffixes to append to the hostname for the purpose of
      doing name resolution. This argument accepts a name or list of names and will be
      reconciled with the current active configuration on the running node.

lookup_source:
    description:
    - Provides one or more source interfaces to use for performing DNS lookups.  The interface
      provided in C(lookup_source) must be a valid interface configured on the device.

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always, except for the platforms that use Netconf transport to manage
    the device.
  sample:
  - hostname ios01
  - ip domain name test.example.com
  type: list