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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_pass строка			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` и `become: yes` с `become_pass`. Для получения дополнительной информации см. руководство IOS Platform Options. Указывает пароль, используемый при необходимости для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент не выполняет никаких действий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
authorize логическое		Варианты: no ← yes	Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` и `become: yes`. Для получения дополнительной информации см. руководство IOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
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 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 целое число	Значение по умолчанию: 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
Дополнительную информацию об использовании 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. [сеть]

Поддержка 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.9/modules/ios_system_module.html