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 -		Варианты: present ← absent	Состояние конфигурации статического маршрута.

Примечания

Примечание

Проверено на VyOS 1.1.8 (helium).
Этот модуль работает с подключением network_cli. См. Выберите платформу VyOS.
Дополнительную информацию об использовании 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 по работе с сетями. [сеть]

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