cisco.nxos.nxos_gir_profile_management – Создание профиля режима обслуживания или нормального режима для GIR.

Примечание

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

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

Для использования в книге задач укажите: cisco.nxos.nxos_gir_profile_management.

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

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

Описание

Управление профилем режима обслуживания или нормального режима с помощью команд конфигурации, которые могут быть применены во время плавного удаления или плавного добавления.

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands список / элементы=строка			Список команд, которые должны быть включены в профиль.
mode строка / обязательный		Варианты: maintenance normal	Настройка профиля в режиме обслуживания или нормальном режиме.
provider словарь			Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Начиная с Ansible 2.6 рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удален в версии после 2022-06-01. Дополнительную информацию см. в руководстве NXOS Platform Options. Объект словаря, содержащий детали подключения.
	auth_pass строка		Указывает пароль для использования, если требуется вход в привилегированный режим на удалённом устройстве. Если authorize равен false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize булево	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт, используемый при построении подключения к удалённому устройству. Это значение применимо как для cli, так и для nxapi. Значение порта по умолчанию соответствует соответствующему общему порту транспорта, если не указан в задаче. (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать при выполнении длительных команд (sh mac, sh bgp и т.д.).
	transport строка	Варианты: cli ← nxapi	Настраивает транспортное подключение для использования при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy булево	Варианты: нет да ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl булево	Варианты: нет ← да	Настраивает транспорт transport на использование SSL, если значение равно `yes`, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs булево	Варианты: нет ← да	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов. Если аргумент transport не nxapi, это значение игнорируется.
state строка		Варианты: present ← absent	Укажите желаемое состояние ресурса.

Примечания

Примечание

Тестировалось на NXOSv 7.3.(0)D1(1) на VIRL
state=absent удаляет весь профиль.
Для получения информации об использовании CLI и NX-API обратитесь к руководству NXOS Platform Options
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство Руководство по Ansible для сети
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco здесь.

Примеры

# Create a maintenance-mode profile
- cisco.nxos.nxos_gir_profile_management:
    mode: maintenance
    commands:
    - router eigrp 11
    - isolate

# Remove the maintenance-mode profile
- cisco.nxos.nxos_gir_profile_management:
    mode: maintenance
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
changed булево	всегда	проверка, были ли внесены изменения на устройстве Пример: True
end_state список / элементы=строка	режим подробного вывода	список записей профиля после выполнения модуля. Пример: ['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete', 'router eigrp 11', 'isolate']
existing список / элементы=строка	режим подробного вывода	список существующих команд профиля. Пример: ['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete']
proposed список / элементы=строка	режим подробного вывода	список команд, переданных в модуль. Пример: ['router eigrp 11', 'isolate']
updates список / элементы=строка	всегда	команды, отправленные на устройство Пример: ['configure maintenance profile maintenance-mode', 'router eigrp 11', 'isolate']

Авторы

Gabriele Gerbino (@GGabriele)

© 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/nxos/nxos_gir_profile_management_module.html