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

Новая версия 2.3.

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Краткое описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_pass строка			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` и `become: yes` с `become_pass`. Дополнительную информацию см. в руководстве IOS Platform Options. Указывает пароль, используемый для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент не оказывает никакого влияния. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
authorize логическое значение		Варианты: нет ← да	Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` и `become: yes`. Дополнительную информацию см. в руководстве IOS Platform Options. Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
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 целое число	Значение по умолчанию: 22	Указывает порт для подключения к удаленному устройству.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение является путем к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	Значение по умолчанию: 10	Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль возвращает ошибку.
	username строка		Настройка имени пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
state -		Варианты: present ← absent	Состояние значений конфигурации в текущей активной конфигурации устройства. При установке в present значения должны быть настроены в активной конфигурации устройства, а при установке в absent — не должны присутствовать в активной конфигурации устройства.

Примечания

Примечание

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

Примеры

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

- name: remove configuration
  ios_system:
    state: absent

- name: configure DNS lookup sources
  ios_system:
    lookup_source: MgmtEth0/0/CPU0/0
    lookup_enabled: yes

- name: configure name servers
  ios_system:
    name_servers:
      - 8.8.8.8
      - 8.8.4.4

Возвращаемые значения

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

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

Статус

Гарантируется, что у данного модуля не будет обратной совместимости. [превью]
Этот модуль поддерживается командой Ansible Network Team. [сетевой]

Поддержка Red Hat

Дополнительную информацию о поддержке данного модуля Red Hat см. в этой статье базы знаний Red Hat: статья базы знаний Red Hat.

Авторы

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.8/modules/ios_system_module.html