[go: nahoru, domu]
Skip to content

Latest commit

 

History

History
238 lines (203 loc) · 9.12 KB

cisco.ios.ios_system_module.rst

File metadata and controls

238 lines (203 loc) · 9.12 KB
Raw

cisco.ios.ios_system

Module to manage the system attributes.

Version added: 1.0.0

Synopsis

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

Parameters

Parameter Choices/Defaults Comments
domain_name
list / elements=raw
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.
domain_search
list / elements=raw
Provides the list of domain suffixes to append to the hostname for the purpose of doing name resolution. This argument accepts a 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_enabled
boolean
    Choices:
  • no
  • yes
Administrative control for enabling or disabling DNS lookups. When this argument is set to True, lookups are performed and when it is set to False, lookups are not performed.
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
list / elements=raw
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
    Choices:
  • present ←
  • absent
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

Notes

Note

Examples

- name: Configure hostname and domain name
  cisco.ios.ios_system:
    hostname: ios01
    domain_name: test.example.com
    domain_search:
      - ansible.com
      - redhat.com
      - cisco.com

- name: Remove configuration
  cisco.ios.ios_system:
    state: absent

- name: Configure DNS lookup sources
  cisco.ios.ios_system:
    lookup_source: MgmtEth0/0/CPU0/0
    lookup_enabled: true

- name: Configure name servers
  cisco.ios.ios_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 Returned Description
commands
list
always
The list of configuration mode commands to send to the device

Sample:
['hostname ios01', 'ip domain name test.example.com']


Status

Authors

  • Peter Sprygada (@privateip)