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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
provider		Значение по умолчанию: None	Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект типа dict, содержащий данные подключения.
	username		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации 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 или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	timeout (добавлено в 2.3)	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т.д.).
	use_ssl	Варианты: yes no ←	Настраивает транспорт transport на использование SSL, если значение равно true только при `transport=nxapi`, иначе это значение игнорируется.
	password	Значение по умолчанию: None	Указывает пароль для аутентификации подключения к удаленному устройству. Этот параметр часто используется для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_PASSWORD`.
	validate_certs	Варианты: yes no Значение по умолчанию: None	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверяющими сертификатами. Если параметр transport не равен nxapi, это значение игнорируется.
	port	Значение по умолчанию: 0 (использовать стандартный порт)	Указывает порт для подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта будет установлено по умолчанию на соответствующий стандартный порт транспорта, если оно не указано в задаче (cli=22, http=80, https=443).
	transport обязательно	Значение по умолчанию: cli	Настраивает транспорт для подключения к удаленному устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi.
state обязательно		Варианты: present ← absent	Указывает требуемое состояние ресурса.
system_mode_maintenance		Варианты: true false Значение по умолчанию: None	При значении `system_mode_maintenance=true`, все включенные протоколы переводятся в режим технического обслуживания (с помощью команды isolate). При значении `system_mode_maintenance=false`, все включенные протоколы переводятся в нормальный режим (с помощью команды no isolate).
system_mode_maintenance_dont_generate_profile		Варианты: true false Значение по умолчанию: None	При значении `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 Значение по умолчанию: None	Автоматически переводит коммутатор в режим технического обслуживания в случае указанной системной ошибки.
system_mode_maintenance_shutdown		Варианты: true false Значение по умолчанию: None	Отключает все протоколы, домены vPC и интерфейсы, кроме интерфейса управления (используя команду shutdown). Этот параметр более деструктивен, чем `system_mode_maintenance`, который использует команду isolate.
system_mode_maintenance_timeout		Значение по умолчанию: None	Удерживает коммутатор в режиме технического обслуживания в течение указанного количества минут. Диапазон от 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 приведет к ошибке модуля, но режим системы всё равно будет запущен.
Дополнительную информацию о работе с CLI и NX-API см. в руководстве NXOS Platform Options
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco на сайте Cisco integration.

Примеры

# 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 string	режим подробного отображения	описание последнего режима системы Пример: normal
updates list	режим подробного отображения	команды, отправленные на устройство Пример: ['terminal dont-ask', 'system mode maintenance timeout 10']

Статус

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

Поддержка

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