cisco.nxos.nxos_system (7.0.0) — module

Manage the system attributes on Cisco NXOS devices

| "added in version" 1.0.0 of cisco.nxos"

Authors: Peter Sprygada (@privateip)

Install collection

Install with ansible-galaxy collection install cisco.nxos:==7.0.0


Add to requirements.yml

  collections:
    - name: cisco.nxos
      version: 7.0.0

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure hostname and domain-name
  cisco.nxos.nxos_system:
    hostname: nxos01
    domain_name: test.example.com
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove configuration
  cisco.nxos.nxos_system:
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure name servers
  cisco.nxos.nxos_system:
    name_servers:
      - 8.8.8.8
      - 8.8.4.4
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure name servers with VRF support
  cisco.nxos.nxos_system:
    name_servers:
      - {server: 8.8.8.8, vrf: mgmt}
      - {server: 8.8.4.4, vrf: mgmt}

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
    type: str

hostname:
    description:
    - Configure the device hostname parameter. This option takes an ASCII string value
      or keyword 'default'
    type: str

system_mtu:
    description:
    - Specifies the mtu, must be an integer or keyword 'default'.
    type: str

domain_name:
    description:
    - Configures the default domain name suffix to be used when referencing this node
      by its FQDN.  This argument accepts either a list of domain names or a list of dicts
      that configure the domain name and VRF name or keyword 'default'. See examples.
    elements: raw
    type: list

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 or a list of hashes that configure
      the name server and VRF name or keyword 'default'. See examples.
    elements: raw
    type: list

domain_lookup:
    description:
    - Enables or disables the DNS lookup feature in Cisco NXOS.  This argument accepts
      boolean values.  When enabled, the system will try to resolve hostnames using DNS
      and when disabled, hostnames will not be resolved.
    type: bool

domain_search:
    description:
    - Configures a list of domain name suffixes to search when performing DNS name resolution.
      This argument accepts either a list of domain names or a list of dicts that configure
      the domain name and VRF name or keyword 'default'. See examples.
    elements: raw
    type: list

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always
  sample:
  - hostname nxos01
  - ip domain-name test.example.com
  type: list