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 используется в качестве целевого адреса для протокола. | ||
| port | По умолчанию: 22 | Указывает порт для подключения к удаленному устройству. | |
| username | Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернет ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| 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 по сетевым вопросам. См. Поддержка и обслуживание модулей для получения дополнительной информации.
Список других модулей, поддерживаемых командой Ansible по сетевым вопросам, см. в данном разделе.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.6/modules/vyos_static_route_module.html
