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

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

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

Описание

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

Параметры

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

Примеры

# 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']

Статус

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

Поддержка

Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/nxos_gir_profile_management_module.html