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

Примечание

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

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

Чтобы использовать его в плейбуке, укажите: cisco.ios.ios_system.

Добавлено в версии 1.0.0: модуля cisco.ios

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

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

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
domain_name список / элементы=сырые			Настройте имя домена IP на удаленном устройстве на предоставленное значение. Значение должно быть в виде имени с точками и будет добавлено к `hostname`, чтобы создать полностью квалифицированное имя домена.
domain_search список / элементы=сырые			Предоставляет список суффиксов домена, которые необходимо добавить к имени хоста для целей разрешения имен. Этот аргумент принимает список имен и будет согласован с текущей активной конфигурацией на работающем узле.
hostname строка			Настройте параметр имени хоста устройства. Этот параметр принимает значение ASCII-строки.
lookup_enabled булево		Варианты: no yes	Административный контроль включения или выключения поиска DNS. Когда этот аргумент установлен в True, поиск выполняется, а когда в False, поиск не выполняется.
lookup_source строка			Предоставляет один или несколько исходных интерфейсов для использования при выполнении поиска DNS. Интерфейс, указанный в `lookup_source`, должен быть допустимым интерфейсом, настроенным на устройстве.
name_servers список / элементы=сырые			Список DNS-серверов по IP-адресу для использования при выполнении поиска разрешения имен. Этот аргумент принимает либо список DNS-серверов. См. примеры.
provider словарь			Устарело Начиная с Ansible 2.5, мы рекомендуем использовать `connection: network_cli`. Для получения дополнительной информации см. руководство по параметрам платформы IOS IOS Platform Options. Объект словаря, содержащий сведения о соединении.
	auth_pass строка		Указывает пароль для использования при необходимости входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize булево	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/ios/ios_system_module.html