nxos_gir - Вызвать плавное удаление или вставку (GIR) коммутатора.
Новое в версии 2.2.
Сводка
- Вызвать плавное удаление или вставку (GIR) коммутатора.
Параметры
| параметр | обязательный | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| auth_pass (добавлено в 2.4.4)
| нет | нет | Указывает пароль для использования при необходимости входа в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент не имеет эффекта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host | да | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| password | нет | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для использования при построении подключения к удаленному устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию будет соответствовать обычному порту транспорта, если он не указан в задаче. (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передавать все аргументы nxos в виде объекта dict. Все ограничения (обязательные, допустимые значения и т.д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом dict. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| state | да | present |
| Указывает желаемое состояние ресурса. |
| 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 | нет |
| Автоматически запускает коммутатор в режим обслуживания в случае указанного сбоя системы. | |
| system_mode_maintenance_shutdown | нет |
| Отключает все протоколы, домены vPC и интерфейсы, кроме интерфейса управления (используя команду shutdown). Этот параметр более диссонирует, чем system_mode_maintenance, (который использует команду isolate). | |
| system_mode_maintenance_timeout | нет | Поддерживает коммутатор в режиме обслуживания в течение указанного количества минут. Диапазон от 5 до 65535. | ||
| timeout (добавлено в 2.3)
| нет | 10 | Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при длительных командах (sh mac, sh bgp и т.д.). | |
| transport | да | cli | Настраивает транспортное соединение для использования при подключении к удаленному устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi. | |
| use_ssl | нет |
| Настраивает transport для использования SSL, если значение true только при transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. |
Примеры
# 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'] |
Примечания
Примечание
- Проверено на 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приведет к ошибке модуля, но режим системы все равно будет запущен.
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.
Информация о поддержке
Дополнительную информацию о поддержке этого модуля Red Hat см. в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочтите Справочная информация по сообществу и помощь в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_gir_module.html