bigip_static_route – Управление статическими маршрутами на BIG-IP

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

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

Обзор

Управление статическими маршрутами на BIG-IP.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description -			Описание, которое идентифицирует маршрут.
destination -			Указывает IP-адрес для статической записи в таблице маршрутизации. При создании нового статического маршрута это значение обязательно. Это значение нельзя изменить после его установки.
gateway_address -			Указывает маршрутизатор, который система должна использовать для пересылки пакетов на хост или сеть назначения. Также известен как адрес маршрутизатора следующего перехода. Может быть адресом IPv4 или IPv6. Если это адрес IPv6, начинающийся с `FE80:`, адрес будет обрабатываться как адрес локальной подсети. Это требует, чтобы параметр `vlan` также был указан.
mtu -			Указывает определённое максимальное значение единицы передачи (MTU).
name - / обязательно			Имя статического маршрута.
netmask -			Маска подсети для статического маршрута. При создании нового статического маршрута это значение обязательно. Это значение может быть в формате IP или CIDR. Это значение нельзя изменить после его установки.
partition - добавлено в 2.6		Значение по умолчанию: "Общая"	Раздел устройства для управления ресурсами.
password - / обязательно			Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
pool -			Указывает пул, через который система пересылает пакеты в назначение.
provider - добавлено в 2.5		Значение по умолчанию: null	Объект словаря, содержащий данные подключения.
	password - / обязательно		Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server - / обязательно		Хост BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER`.
	server_port -	Значение по умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile -		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для переводов cli. Этот параметр можно опустить, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут будет превышен до завершения операции, модуль выдаст ошибку.
	transport - / обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для подключения к удалённому устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.
reject boolean		Варианты: нет да	Указывает, что система отбрасывает пакеты, отправленные в назначение.
route_domain -			Идентификатор домена маршрута системы. При создании нового статического маршрута, если это значение не указано, используется значение по умолчанию `0`. Это значение нельзя изменить после его установки.
server - / обязательно			Хост BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER`.
server_port - добавлено в 2.2		Значение по умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER_PORT`.
state -		Варианты: present ← absent	Когда `present`, гарантирует, что статический маршрут существует. Когда `absent`, гарантирует, что статического маршрута нет.
user - / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
validate_certs boolean добавлено в 2.0		Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.
vlan -			Указывает VLAN или туннель, через который система пересылает пакеты в назначение. Когда `gateway_address` является адресом локальной подсети IPv6, это значение обязательно.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
На хосте требуется пакет Python f5-sdk. Это так же просто, как pip install f5-sdk.
Требуется версия программного обеспечения BIG-IP ≥ 12.
Модули F5 обрабатывают только текущую конфигурацию продукта F5. Чтобы гарантировать сохранение конфигурации BIG-IP на диске, убедитесь, что вы включили по крайней мере одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create static route with gateway address
  bigip_static_route:
    destination: 10.10.10.10
    netmask: 255.255.255.255
    gateway_address: 10.2.2.3
    name: test-route
    password: secret
    server: lb.mydomain.come
    user: admin
    validate_certs: no
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
description строка	changed	Включена или выключена заставка. Пример: True
destination строка	changed	Включена или выключена заставка. Пример: True
gateway_address строка	changed	Включена или выключена заставка. Пример: True
netmask строка	changed	Маска сети назначения. Пример: 255.255.255.255
partition строка	changed	Раздел, на котором был создан статический маршрут. Пример: Common
pool строка	changed	Включена или выключена заставка. Пример: True
reject строка	changed	Включена или выключена заставка. Пример: True
route_domain целое число	changed	Домен маршрута статического маршрута. Пример: 1
vlan строка	changed	Включена или выключена заставка. Пример: True

Статус

Данный модуль гарантированно не будет иметь обратной совместимости в будущих изменениях интерфейса. [stableinterface]
Этот модуль поддерживается партнером Ansible. [certified]

Авторы

Tim Rupp (@caphrim007)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_static_route_module.html