nxos_gir – Выполнение плавного удаления или вставки (GIR) коммутатора
Описание
- Выполнение плавного удаления или вставки (GIR) коммутатора.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря с параметрами подключения. | ||
| auth_pass строка добавлен в 2.5.3 | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды 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 целое число | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при длительных командах (sh mac, sh bgp и т. д.). | |
| transport строка / обязательно |
| Настраивает транспортное подключение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy логическое значение добавлен в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут игнорироваться. | |
| use_ssl логическое значение |
| Настраивает transport на использование SSL, если установлено значение yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с использованием самозаверенных сертификатов. Если аргумент transport не nxapi, это значение игнорируется. | |
| state - / обязательно |
| Указывает желаемое состояние ресурса. | |
| 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 - |
| Автоматически переводит коммутатор в режим технического обслуживания в случае указанной системной ошибки. Обратите внимание, что не все причины перезагрузки применимы ко всем платформам. Также, если причина перезагрузки установлена в 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приведет к сбою модуля, но режим системы будет активирован все равно. - Дополнительную информацию об использовании CLI и NX-API см. в Руководстве по параметрам платформы NXOS
- Дополнительную информацию об использовании 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 строка | режим verbose | описание последнего режима системы Пример: normal |
| updates список | режим verbose | команды, отправленные на устройство Пример: ['terminal dont-ask', 'system mode maintenance timeout 10'] |
Статус
- Гарантия обратной совместимости интерфейса этого модуля отсутствует. [превью]
- Этот модуль поддерживается командой Ansible по работе с сетями. [сеть]
Поддержка 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.9/modules/nxos_gir_module.html