vyos_static_route – Управление статическими маршрутами IP в устройствах сети Vyatta VyOS
Новая в версии 2.4.
Описание
- Этот модуль обеспечивает декларативное управление статическими маршрутами IP в устройствах сети Vyatta VyOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| admin_distance
-
|
Административное расстояние статического маршрута. |
||
| aggregate
-
|
Список определений статических маршрутов |
||
| mask
-
|
Маска сети префикса статического маршрута. |
||
| next_hop
-
|
IP-адрес следующего узла статического маршрута. |
||
| prefix
-
|
Префикс сети статического маршрута. Параметр mask должен быть проигнорирован, если prefix указан со значением mask prefix/mask. |
||
| provider
словарь
|
Устарело
Начиная с Ansible 2.5, рекомендуется использовать
connection: network_cli. Для получения дополнительной информации обратитесь к Руководству по сетям.
Объект словаря, содержащий данные подключения. |
||
| host
строка / обязательно
|
Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. |
||
| password
строка
|
Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. |
||
| port
целое число
|
По умолчанию: 22 |
Указывает порт для подключения к удаленному устройству. |
|
| ssh_keyfile
путь
|
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение - путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. |
||
| timeout
целое число
|
По умолчанию: 10 |
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. |
|
| username
строка
|
Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. |
||
| state
-
|
|
Состояние конфигурации статического маршрута. |
|
Примечания
Примечание
- Проверено на VYOS 1.1.7
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по Ansible для сетей
Примеры
- name: configure static route
vyos_static_route:
prefix: 192.168.2.0
mask: 24
next_hop: 10.0.0.1
- name: configure static route prefix/mask
vyos_static_route:
prefix: 192.168.2.0/16
next_hop: 10.0.0.1
- name: remove configuration
vyos_static_route:
prefix: 192.168.2.0
mask: 16
next_hop: 10.0.0.1
state: absent
- name: configure aggregates of static routes
vyos_static_route:
aggregate:
- { prefix: 192.168.2.0, mask: 24, next_hop: 10.0.0.1 }
- { prefix: 192.168.3.0, mask: 16, next_hop: 10.0.2.1 }
- { prefix: 192.168.3.0/16, next_hop: 10.0.2.1 }
- name: Remove static route collections
vyos_static_route:
aggregate:
- { prefix: 172.24.1.0/24, next_hop: 192.168.42.64 }
- { prefix: 172.24.3.0/24, next_hop: 192.168.42.64 }
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список |
всегда | Список команд режима конфигурации для отправки устройству
Пример:
['set protocols static route 192.168.2.0/16 next-hop 10.0.0.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.8/modules/vyos_static_route_module.html
