Spec-Zone.ru › Ansible 2.6

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

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

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Поддержка
    • Автор

Краткое описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
provider
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Этот параметр требуется только при использовании NX-API.
Дополнительная информация представлена в руководстве по параметрам платформы NXOS NXOS Platform Options.
Объект словаря, содержащий данные подключения.
host
обязательно
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта.
port Значение по умолчанию:
"0 (использовать стандартный порт)"
Указывает порт для использования при установлении подключения к удалённому устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию соответствует соответствующему общему порту транспорта, если он не указан в задаче (cli=22, http=80, https=443).
username
Настройка имени пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
password
Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для cli или nxapi транспортов. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
authorize
bool

(добавлен в 2.5.3)
    Варианты:
  • нет ←
  • да
Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
auth_pass
(добавлен в 2.5.3)
Значение по умолчанию:
"none"
Указывает пароль для использования при переходе в привилегированный режим на удалённом устройстве. Если authorize — ложь, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
timeout
(добавлен в 2.3)
Значение по умолчанию:
10
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.).
ssh_keyfile
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
transport
обязательно
Значение по умолчанию:
"cli"
Настройка транспорта подключения при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству по протоколу cli (ssh) или nxapi.
use_ssl
bool
    Варианты:
  • нет ←
  • да
Настройка транспорта transport на использование SSL, если установлено значение true, только когда transport=nxapi, в противном случае это значение игнорируется.
validate_certs
bool
    Варианты:
  • нет
  • да
Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, при использовании самозаверяемых сертификатов. Если аргумент transport не nxapi, это значение игнорируется.
use_proxy
bool

(добавлен в 2.5)
    Варианты:
  • нет
  • да ←
Если no, переменные окружения http_proxy и https_proxy будут проигнорированы.
state
обязательно
    Варианты:
  • present ←
  • absent
Указывает желаемое состояние ресурса.
system_mode_maintenance
bool
    Варианты:
  • нет
  • да
При system_mode_maintenance=true, он помещает все включенные протоколы в режим технического обслуживания (используя команду isolate). При system_mode_maintenance=false, он помещает все включенные протоколы в нормальный режим (используя команду no isolate).
system_mode_maintenance_dont_generate_profile
bool
    Варианты:
  • нет
  • да
При 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
Автоматически запускает коммутатор в режим технического обслуживания в случае указанного сбоя системы.
system_mode_maintenance_shutdown
bool
    Варианты:
  • нет
  • да
Отключает все протоколы, домены 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 Network Guide
  • Дополнительную информацию об использовании 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 Team. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых командой Ansible Network Team, см. в разделе здесь.

Поддержка

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API