cisco.ios.ios_system – Управление системными атрибутами на устройствах Cisco IOS

Примечание

Этот плагин входит в состав коллекции cisco.ios (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install cisco.ios

Для использования в playbook, укажите: cisco.ios.ios_system

Введено в версии 1.0.0: cisco.ios

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

Этот модуль предоставляет декларативное управление системными атрибутами узлов на устройствах Cisco IOS. Он предоставляет возможность настроить параметры хост-системы или удалить эти параметры из активной конфигурации устройства.

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
domain_name список / элементы=сырые			Настройка имени домена IP на удалённом устройстве на предоставленное значение. Значение должно быть в формате имени с точками и будет добавлено к `hostname`, чтобы создать полное доменное имя.
domain_search список / элементы=сырые			Предоставляет список суффиксов домена для добавления к имени хоста с целью разрешения имен. Этот аргумент принимает список имён и будет согласован с текущей активной конфигурацией на работающем узле.
hostname строка			Настройка параметра имени хоста устройства. Этот параметр принимает значение ASCII-строки.
lookup_enabled логическое		Варианты: нет да	Административный контроль для включения или отключения поиска DNS. Когда этот аргумент установлен в True, поиск выполняется, а когда в False, поиск не выполняется.
lookup_source строка			Предоставляет один или несколько источников интерфейсов для использования при выполнении поиска DNS. Интерфейс, указанный в `lookup_source`, должен быть валидным интерфейсом, настроенным на устройстве.
name_servers список / элементы=сырые			Список DNS-серверов по IP-адресу для использования при выполнении поиска разрешения имён. Этот аргумент принимает либо список DNS-серверов. См. примеры.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` Для получения дополнительной информации см. руководство IOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass строка		Указывает пароль для использования при необходимости входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`
	authorize логическое	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`
	port целое число		Указывает порт для использования при построении подключения к удалённому устройству.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`
state строка		Варианты: present ← absent	Состояние значений конфигурации в текущей активной конфигурации устройства. Если установлено present, значения должны быть настроены в активной конфигурации устройства, а если absent — значения не должны быть в активной конфигурации устройства.

Примечания

Примечание

Тестировалось на IOS 15.6
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

- 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: yes

- name: configure name servers
  cisco.ios.ios_system:
    name_servers:
    - 8.8.8.8
    - 8.8.4.4

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
commands список / элементы=строка	всегда	Список команд режима конфигурации для отправки на устройство Пример: ['hostname ios01', 'ip domain name test.example.com']

Авторы

Peter Sprygada (@privateip)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/ios/ios_system_module.html