Модуль f5networks.f5_modules.bigip_static_route — управление статическими маршрутами на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать коллекцию в плейбуке, укажите: f5networks.f5_modules.bigip_static_route.

Добавлено в f5networks.f5_modules 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
description string	Текстовое описание маршрута.
destination string	IP-адрес статической записи в таблице маршрутизации. При создании нового статического маршрута это значение обязательно. После задания это значение нельзя изменить.
gateway_address string	Маршрутизатор, который система использует для пересылки пакетов узлу назначения или в сеть назначения. Также известен как адрес маршрутизатора следующего перехода. Может быть адресом IPv4 или IPv6. Если адрес IPv6 начинается с `FE80:`, он рассматривается как локальный адрес канала. В этом случае также необходимо указать параметр `vlan`.
mtu string	Задает максимальный размер блока передачи (MTU).
name string / обязательный	Имя статического маршрута.
netmask string	Маска сети статического маршрута. При создании нового статического маршрута это значение обязательно. Значение можно указать в формате IP или CIDR. После задания это значение нельзя изменить.
partition string	Раздел устройства, в котором выполняется управление ресурсами. По умолчанию: `"Common"`
pool string	Пул, через который система пересылает пакеты к месту назначения.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Словарь с параметрами подключения.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если значение `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, поскольку ее название было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server string / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задает время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечет до завершения операции, модуль завершится с ошибкой.
transport string	Настраивает транспортное соединение для подключения к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs boolean	Если значение `no`, сертификаты SSL не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
reject boolean	Указывает системе отбрасывать пакеты, отправленные к месту назначения. Варианты: `false` `true`
route_domain integer	Идентификатор домена маршрутизации системы. При создании нового статического маршрута, если это значение не указано, используется значение по умолчанию `0`. После задания это значение нельзя изменить.
state string	Если задано значение `present`, гарантирует наличие статического маршрута. Если задано значение `absent`, гарантирует отсутствие статического маршрута. Варианты: `"present"` ← (по умолчанию) `"absent"`
vlan string	VLAN или туннель, через который система пересылает пакеты к месту назначения. Если `gateway_address` является локальным адресом канала IPv6, это значение обязательно.

Примечания

Примечание

Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 изменяют только работающую конфигурацию продукта F5. Чтобы настройки BIG-IP сохранялись на диске, обязательно включите хотя бы одну задачу, использующую модуль f5networks.f5_modules.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
    provider:
      password: secret
      server: lb.mydomain.come
      user: admin
      validate_certs: false
  delegate_to: localhost

Возвращаемые значения

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

Ключ	Описание
description string	Текстовое описание маршрута. Возвращается: changed Пример: `"Route tho DMZ"`
destination string	IP-адрес статической записи в таблице маршрутизации. Возвращается: changed Пример: `"0.0.0.0/0"`
gateway_address string	Маршрутизатор, который система использует для пересылки пакетов узлу назначения или в сеть назначения. Возвращается: changed Пример: `"10.2.2.3"`
netmask string	Маска сети назначения. Возвращается: changed Пример: `"255.255.255.255"`
partition string	Раздел, в котором создан статический маршрут. Возвращается: changed Пример: `"Common"`
pool string	Указывает, включен ли баннер. Возвращается: changed Пример: `"True"`
reject boolean	Указывает системе отбрасывать пакеты, отправленные к месту назначения. Возвращается: changed Пример: `true`
route_domain integer	Идентификатор домена маршрутизации системы. Возвращается: changed Пример: `1`
vlan string	VLAN или туннель, через который система пересылает пакеты к месту назначения. Возвращается: changed Пример: `"/Common/vlan1"`

Авторы

Tim Rupp (@caphrim007)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_static_route_module.html