Spec-Zone.ru › Ansible 2.7

nxos_gir_profile_management – Создание профиля GIR в режиме технического обслуживания или нормальном режиме.

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

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

Обзор

  • Управление профилем в режиме технического обслуживания или нормальном режиме с помощью команд конфигурации, которые могут быть применены во время плавного удаления или плавного добавления.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
commands
-
Список команд, которые необходимо включить в профиль.
mode
- / обязательно
    Варианты:
  • technical_maintenance
  • normal
Настройка профиля в режиме технического обслуживания или нормальном режиме.
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 не будут проверяться. Это должно использоваться только на сайтах под личным контролем, использующих самозаверяющие сертификаты. Если параметр transport не nxapi, это значение игнорируется.
state
-
    Варианты:
  • present ←
  • absent
Указывает желаемое состояние ресурса.

Примечания

Примечание

  • Проверено на NXOSv 7.3.(0)D1(1) на VIRL
  • state=absent удаляет весь профиль.
  • Дополнительную информацию о работе с CLI и NX-API см. в руководстве NXOS Platform Options
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
  • Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

# Create a maintenance-mode profile
- nxos_gir_profile_management:
    mode: maintenance
    commands:
      - router eigrp 11
      - isolate

# Remove the maintenance-mode profile
- nxos_gir_profile_management:
    mode: maintenance
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ Возвращаемое значение Описание
changed
boolean
всегда
проверка, было ли внесено изменение на устройстве

Пример:
True
end_state
список
режим подробной информации
список записей профиля после выполнения модуля.

Пример:
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete', 'router eigrp 11', 'isolate']
existing
список
режим подробной информации
список существующих команд профиля.

Пример:
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete']
proposed
список
режим подробной информации
список команд, переданных в модуль.

Пример:
['router eigrp 11', 'isolate']
updates
список
всегда
команды, отправленные на устройство

Пример:
['configure maintenance profile maintenance-mode', 'router eigrp 11', 'isolate']


Состояние

  • Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается командой Ansible Network Team. [сеть]

Поддержка 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_profile_management_module.html

Spec-Zone.ru

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