ansible.netcommon.net_system module – (deprecated, removed after 2022-06-01) Manage the system attributes on network devices

Note

This module is part of the ansible.netcommon collection (version 3.1.1).

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 ansible.netcommon.

To use it in a playbook, specify: ansible.netcommon.net_system.

New in version 1.0.0: of ansible.netcommon

DEPRECATED

Removed in

major release after 2022-06-01

Why

Updated modules released with more functionality

Alternative

Use platform-specific “[netos]_system” module

Synopsis

  • 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.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

domain_name

string

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 hostname to create a fully-qualified domain name.

string

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.

hostname

string

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

lookup_source

string

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

name_servers

string

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.

state

string

State of the configuration values in the device’s current active configuration. When set to present, the values should be configured in the device active configuration and when set to absent the values should not be in the device active configuration

Choices:

  • present ← (default)

  • absent

Notes

Note

Examples

- 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

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

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

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

- name: configure name servers
  ansible.netcommon.net_system:
    name_servers:
    - 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

commands

list / elements=string

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”]

Status

  • This module will be removed in a major release after 2022-06-01. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Ricardo Carrillo Cruz (@rcarrillocruz)