nxos_gir – Выполнить плавное удаление или вставку (GIR) коммутатора

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

Описание
Параметры
Примечания
Примеры
Значения возврата
Статус

Описание

Выполнить плавное удаление или вставку (GIR) коммутатора.

Параметры

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

Примечания

Примечание

Проверено на NXOSv 7.3.(0)D1(1) в среде VIRL
state имеет эффект только в сочетании с system_mode_maintenance_timeout или system_mode_maintenance_on_reload_reset_reason.
Использование system_mode_maintenance и system_mode_maintenance_dont_generate_profile приведет к сбою модуля, но режим системы всё равно будет активирован.
Дополнительную информацию об использовании командной строки и NX-API см. в руководстве NXOS Platform Options.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Сетевое руководство Ansible.
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco .

Примеры

# Trigger system maintenance mode
- nxos_gir:
    system_mode_maintenance: true
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"
# Trigger system normal mode
- nxos_gir:
    system_mode_maintenance: false
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"
# Configure on-reload reset-reason for maintenance mode
- nxos_gir:
    system_mode_maintenance_on_reload_reset_reason: manual_reload
    state: present
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"
# Add on-reload reset-reason for maintenance mode
- nxos_gir:
    system_mode_maintenance_on_reload_reset_reason: hw_error
    state: present
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"
# Remove on-reload reset-reason for maintenance mode
- nxos_gir:
    system_mode_maintenance_on_reload_reset_reason: manual_reload
    state: absent
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"
# Set timeout for maintenance mode
- nxos_gir:
    system_mode_maintenance_timeout: 30
    state: present
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"
# Remove timeout for maintenance mode
- nxos_gir:
    system_mode_maintenance_timeout: 30
    state: absent
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

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

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

Ключ	Возвращаемое значение	Описание
changed boolean	всегда	проверка, были ли внесены изменения на устройстве Пример: True
final_system_mode строка	режим подробной информации	описание последнего режима системы Пример: normal
updates список	режим подробной информации	команды, отправленные устройству Пример: ['terminal dont-ask', 'system mode maintenance timeout 10']

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке данного модуля Red Hat см. в статье базы знаний 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.8/modules/nxos_gir_module.html