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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
provider -			Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр требуется только при использовании NX-API. Дополнительная информация в руководстве по платформе NXOS NXOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass - добавлен в 2.5.3	По умолчанию: "none"	Указывает пароль, который нужно использовать для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот параметр не учитывается. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлен в 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"	Настраивает транспортное соединение для подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy boolean добавлен в 2.5	Варианты: нет да ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут игнорироваться.
	use_ssl boolean	Варианты: нет ← да	Настраивает transport на использование SSL, если значение true, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username -		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: нет да	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверенными сертификатами. Если транспорт не nxapi, это значение игнорируется.
state - / обязательно		Варианты: present ← absent	Указывает желаемое состояние ресурса.
system_mode_maintenance boolean		Варианты: нет да	При `system_mode_maintenance=true`, все включённые протоколы переводятся в режим технического обслуживания (используя команду isolate). При `system_mode_maintenance=false`, все включённые протоколы переводятся в обычный режим (используя команду no isolate).
system_mode_maintenance_dont_generate_profile boolean		Варианты: нет да	При `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 boolean		Варианты: нет да	Выключает все протоколы, домены 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 приведет к сбою модуля, но режим системы будет всё равно запущен.
Дополнительную информацию о работе с CLI и NX-API см. в руководстве NXOS Platform Options.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Сетевое руководство Ansible
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.

Примеры

# 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.7/modules/nxos_gir_module.html