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

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

Обзор
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус
- Информация о техническом обслуживании

Обзор

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

Параметры

параметр	обязательный	по умолчанию	варианты	комментарии
auth_pass (добавлен в 2.4.4)	нет	нет		Указывает пароль, используемый при необходимости для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент не действует. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
authorize (добавлен в 2.4.4)	нет		да нет	Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
commands	нет			Список команд, которые должны быть включены в профиль.
config	нет			Укажите строку конфигурации, которая будет использоваться для операций модуля.
host	да			Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
include_defaults	нет		true false	Указывает, следует ли извлекать полную рабочую конфигурацию для операций модуля.
mode	да		техническое обслуживание обычный	Настройка профиля в режиме технического обслуживания или обычном режиме.
password	нет			Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
port	нет	0 (использовать общий порт)		Указывает порт для подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует общему порту транспорта, если оно не указано в задаче. (cli=22, http=80, https=443).
provider	нет			Удобный метод, позволяющий передавать все аргументы nxos в виде объекта dict. Все ограничения (обязательные, варианты и т.д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом dict.
ssh_keyfile	нет			Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
state	нет	present	present absent	Указывает желаемое состояние ресурса.
timeout (добавлен в 2.3)	нет	10		Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать значения при длительных командах (sh mac, sh bgp и т.д.).
transport	да	cli		Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
use_ssl	нет		да нет	Настраивает transport для использования SSL, если значение true только в случае `transport=nxapi`, в противном случае это значение игнорируется.
username	нет			Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
validate_certs	нет		да нет	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с самозаверенными сертификатами. Если аргумент transport не nxapi, это значение игнорируется.

Примеры

# Create a maintenance-mode profile
- nxos_gir_profile_management:
    mode: maintenance
    commands:
      - router eigrp 11
      - isolate
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"
# Remove the maintenance-mode profile
- nxos_gir_profile_management:
    mode: maintenance
    state: absent
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

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

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

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

Примечания

Примечание

Проверено на NXOSv 7.3.(0)D1(1) на VIRL
state=absent удаляет весь профиль.

Статус

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

Информация о техническом обслуживании

Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этом knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

Для получения помощи в разработке модулей, если вы захотите, прочитайте Информация сообщества и участие, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_gir_profile_management_module.html