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 boolean		Варианты: нет ← да	Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli` и `become: yes`. Для получения дополнительной информации см. руководство IOS Platform Options. Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
domain_name -			Настройте имя домена IP на удаленном устройстве на предоставленное значение. Значение должно быть в форме с точками и будет добавлено к `hostname`, чтобы создать полное доменное имя.
domain_search -			Предоставляет список суффиксов домена, которые нужно добавить к имени хоста для целей разрешения имен. Этот аргумент принимает список имен и будет согласован с текущей активной конфигурацией на работающем узле.
hostname -			Настройте параметр имени хоста устройства. Этот параметр принимает значение ASCII-строки.
lookup_enabled boolean		Варианты: нет да	Административное управление включением или отключением DNS-поиска. Когда этот аргумент установлен в True, выполняется поиск, а когда в False, поиск не выполняется.
lookup_source -			Предоставляет один или несколько исходных интерфейсов для выполнения DNS-поиска. Интерфейс, предоставленный в `lookup_source`, должен быть валидным интерфейсом, настроенным на устройстве.
name_servers -			Список DNS-серверов по IP-адресу, которые нужно использовать для выполнения поиска разрешения имен. Этот аргумент принимает список DNS-серверов. Смотрите примеры.
provider -			Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации см. руководство IOS Platform Options. Объект типа dict, содержащий данные подключения.
	auth_pass -		Указывает пароль, который нужно использовать для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `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.7/modules/ios_system_module.html