nxos_gir_profile_management - Создание профиля GIR в режиме технического обслуживания или нормальном режиме.

Новое в версии 2.2.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Поддержка
- Автор

Описание

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

Параметры

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

Примечания

Примечание

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

Примеры

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

# Remove the maintenance-mode profile
- nxos_gir_profile_management:
    mode: maintenance
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
changed boolean	всегда	проверка, были ли внесены изменения на устройстве Пример: 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']

Статус

Этот модуль помечен как превью, что означает, что интерфейс не гарантируется обратной совместимости.

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible Network Team. Подробности см. в разделе Поддержка и техническое обслуживание модулей.

Для списка других модулей, которые также поддерживаются командой Ansible Network, см. здесь.

Поддержка

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

Автор

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.6/modules/nxos_gir_profile_management_module.html