Spec-Zone.ru › Ansible 2.9

eos_static_route – Управление статическими маршрутами IP на устройствах сети Arista EOS

Новая в версии 2.5.

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

Обзор

  • Этот модуль обеспечивает декларативное управление статическими маршрутами IP на устройствах сети Arista EOS.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
address
- / обязательно
Сеть адреса с префиксом статического маршрута.

алиасы: prefix
admin_distance
-
По умолчанию:
1
Административное расстояние статического маршрута.
aggregate
-
Список определений статических маршрутов
auth_pass
строка
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass.
Этот параметр необходим только при использовании eAPI.
Дополнительную информацию см. в руководстве EOS Platform Options.
Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
логическое значение
    Варианты:
  • нет ←
  • да
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes.
Этот параметр необходим только при использовании eAPI.
Дополнительную информацию см. в руководстве EOS Platform Options.
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
next_hop
- / обязательно
IP-адрес следующего узла статического маршрута.
provider
словарь
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Этот параметр необходим только при использовании eAPI.
Дополнительную информацию см. в руководстве EOS Platform Options.
Объект словаря, содержащий данные подключения.
auth_pass
строка
Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
логическое значение
    Варианты:
  • нет ←
  • да
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
host
строка / обязательно
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
password
строка
Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
port
целое число
По умолчанию:
0
Указывает порт для создания соединения с удалённым устройством. Это значение относится к транспорту cli или eapi.
Значение порта по умолчанию соответствует общему порту транспорта, если оно не указано в задаче (cli=22, http=80, https=443).
ssh_keyfile
путь
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
transport
строка / обязательно
    Варианты:
  • cli ←
  • eapi
Настраивает транспортное соединение для подключения к удалённому устройству.
use_proxy
логическое значение
добавлено в 2.5
    Варианты:
  • нет
  • да ←
Если no, переменные окружения http_proxy и https_proxy будут проигнорированы.
use_ssl
логическое значение
    Варианты:
  • нет
  • да ←
Настраивает транспорт transport для использования SSL, если значение равно yes только тогда, когда transport=eapi. Если аргумент transport не равен eapi, это значение игнорируется.
username
строка
Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
validate_certs
логическое значение
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверенными сертификатами. Если аргумент transport не равен eapi, это значение игнорируется.
state
-
    Варианты:
  • present ←
  • absent
Состояние конфигурации статического маршрута.
vrf
-
добавлено в 2.9
По умолчанию:
"default"
VRF для статического маршрута.

Примечания

Примечание

  • Проверено на EOS 4.15
  • Для получения информации об использовании командной строки, eAPI и привилегированного режима см. Руководство по параметрам платформы EOS
  • Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по Ansible для сети
  • Для получения дополнительной информации об использовании Ansible для управления устройствами Arista EOS см. страницу интеграции Arista.

Примеры

- name: configure static route
  eos_static_route:
    address: 10.0.2.0/24
    next_hop: 10.8.38.1
    admin_distance: 2
- name: delete static route
  eos_static_route:
    address: 10.0.2.0/24
    next_hop: 10.8.38.1
    state: absent
- name: configure static routes using aggregate
  eos_static_route:
    aggregate:
      - { address: 10.0.1.0/24, next_hop: 10.8.38.1 }
      - { address: 10.0.3.0/24, next_hop: 10.8.38.1 }
- name: Delete static route using aggregate
  eos_static_route:
    aggregate:
      - { address: 10.0.1.0/24, next_hop: 10.8.38.1 }
      - { address: 10.0.3.0/24, next_hop: 10.8.38.1 }
    state: absent

Значения возврата

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

Ключ Возвращаемое значение Описание
commands
список
всегда
Список команд режима конфигурации для отправки на устройство

Пример:
['ip route 10.0.2.0/24 10.8.38.1 3', 'no ip route 10.0.2.0/24 10.8.38.1']


Статус

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

Поддержка Red Hat

Дополнительную информацию о поддержке данного модуля Red Hat можно найти в статье базы знаний Red Hat по этой ссылке.

Авторы

  • Trishna Guha (@trishnaguha)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.

© 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/eos_static_route_module.html

Spec-Zone.ru

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