Spec-Zone.ru › Ansible 2.10

cisco.nxos.nxos_static_route – (deprecated, removed after 2022-06-01) Управляет конфигурацией статических маршрутов

Примечание

Этот плагин входит в состав коллекции cisco.nxos (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install cisco.nxos.

Для использования в плейбуке укажите: cisco.nxos.nxos_static_route.

В версии 1.0.0: модуля cisco.nxos

  • УСТАРЕВШИЙ
  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

УСТАРЕВШИЙ

Удалили в

главной версии после 2022-06-01

Почему

Выпущены обновленные модули с большей функциональностью

Альтернатива

nxos_static_routes

Обзор

  • Управляет конфигурацией статических маршрутов

Примечание

Для этого модуля существует соответствующий плагин действия.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aggregate
список / элементы=словарь
Список определений статических маршрутов
next_hop
строка / обязательно
Адрес или интерфейс следующего узла статического маршрута. Если интерфейс, то должно быть полное имя интерфейса.
pref
строка
Предпочтение или административное расстояние маршрута (диапазон 1-255) или ключевое слово 'default'.

псевдонимы: admin_distance
prefix
строка / обязательно
Префикс назначения статического маршрута.
route_name
строка
Имя маршрута или ключевое слово 'default'. Используется с параметром name в командной строке.
state
строка
    Варианты:
  • present
  • absent
Управление состоянием ресурса.
tag
строка
Значение тега маршрута (числовое) или ключевое слово 'default'.
track
целое число
Значение трассировки (диапазон 1 - 512). Трассировка должна быть уже настроена на устройстве перед добавлением маршрута.
vrf
строка
VRF для статического маршрута.
next_hop
строка
Адрес или интерфейс следующего узла статического маршрута. Если интерфейс, то должно быть полное имя интерфейса.
pref
строка
Предпочтение или административное расстояние маршрута (диапазон 1-255) или ключевое слово 'default'.

псевдонимы: admin_distance
prefix
строка
Префикс назначения статического маршрута.

псевдонимы: адрес
provider
словарь
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.
Этот параметр будет удален в релизе после 2022-06-01.
Дополнительную информацию можно найти в руководстве NXOS Platform Options.
Объект словаря, содержащий сведения о подключении.
auth_pass
строка
Указывает пароль для использования, если требуется вход в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
булево
    Варианты:
  • нет ←
  • да
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
host
строка
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
password
строка
Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_PASSWORD.
port
целое число
Указывает порт для создания подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует общепринятому порту транспорта, если он не указан в задаче (cli=22, http=80, https=443).
ssh_keyfile
строка
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.).
transport
строка
    Варианты:
  • cli ←
  • nxapi
Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
use_proxy
булево
    Варианты:
  • нет
  • да ←
Если no, переменные окружения http_proxy и https_proxy будут проигнорированы.
use_ssl
булево
    Варианты:
  • нет ←
  • да
Настраивает transport для использования SSL, если установлено значение yes только при transport=nxapi, в противном случае это значение игнорируется.
username
строка
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_USERNAME.
validate_certs
булево
    Варианты:
  • нет ←
  • да
Если no, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах под собственным контролем, использующих самозаверяющие сертификаты. Если аргумент transport не равен nxapi, это значение игнорируется.
route_name
строка
Имя маршрута или ключевое слово 'default'. Используется с параметром name в командной строке.
state
строка
    Варианты:
  • present ←
  • absent
Управление состоянием ресурса.
tag
строка
Значение тега маршрута (числовое) или ключевое слово 'default'.
track
целое число
Значение трассировки (диапазон 1 - 512). Трассировка должна быть уже настроена на устройстве перед добавлением маршрута.
vrf
строка
По умолчанию:
"default"
VRF для статического маршрута.

Примечания

Примечание

  • Проверено на NXOSv 7.3.(0)D1(1) на VIRL
  • Если vrf не задан, vrf устанавливается по умолчанию.
  • Если state=absent, маршрут будет удалён, независимо от не обязательных параметров.
  • Дополнительную информацию по использованию CLI и NX-API см. в руководстве по параметрам платформы NXOS
  • Дополнительную информацию по использованию Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
  • Дополнительную информацию по использованию Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

- cisco.nxos.nxos_static_route:
    prefix: 192.168.20.64/24
    next_hop: 192.0.2.3
    route_name: testing
    pref: 100

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

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

Ключ Возвращаемое значение Описание
commands
список / элементы=строка
всегда
команды, отправленные устройству

Пример:
['ip route 192.168.20.0/24 192.0.2.3 name testing 100']


Статус

  • Этот модуль будет удалён в релизе следующего основного выпуска после 2022-06-01. [устарел]
  • Для получения дополнительной информации см. УСТАРЕЛО.

Авторы

  • 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.10/collections/cisco/nxos/nxos_static_route_module.html

Spec-Zone.ru

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