Модуль f5networks.f5_modules.bigip_routedomain — управление доменами маршрутизации на 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_routedomain.

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

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

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

Управление доменами маршрутизации в системе BIG-IP. Домен маршрутизации — это объект конфигурации BIG-IP, изолирующий сетевой трафик для определённого приложения в сети.

Параметры

Параметр	Комментарии
bwc_policy string	Контроллер пропускной способности для домена маршрутизации.
connection_limit integer	Максимальное количество одновременных подключений, разрешённых для домена маршрутизации. Значение `0` отключает ограничения на количество подключений.
description string	Задаёт описательный текст, идентифицирующий домен маршрутизации.
flow_eviction_policy string	Политика вытеснения, используемая для этого домена маршрутизации. Примените политику вытеснения, чтобы настроить обработку переполнения потоков и медленных потоков в домене маршрутизации.
fw_enforced_policy string	Задаёт политику AFM, применяемую к домену маршрутизации. Чтобы удалить применённую политику AFM, используйте в качестве значения `""` или `none`.
id integer	Уникальное целое число, идентифицирующее домен маршрутизации. Это поле обязательно при создании домена маршрутизации. В версии 2.5 это значение больше не используется для ссылки на домен маршрутизации при внесении в него изменений (например, при выполнении операций обновления и удаления). Вместо него используется параметр `name`. В версии 2.6 значение `name` станет обязательным параметром.
name string	Имя домена маршрутизации.
parent string	Задаёт домен маршрутизации, в котором система выполняет поиск, если не удаётся найти маршрут в настроенном домене.
partition string	Раздел, в котором требуется создать домен маршрутизации. После создания разделы нельзя обновить. По умолчанию: `"Common"`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
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` ← (по умолчанию)
routing_protocol list / elements=string	Протоколы динамической маршрутизации, используемые системой в домене маршрутизации. Варианты: `"none"` `"BFD"` `"BGP"` `"IS-IS"` `"OSPFv2"` `"OSPFv3"` `"PIM"` `"RIP"` `"RIPng"`
service_policy string	Политика служб, связываемая с доменом маршрутизации.
state string	Определяет, должен ли домен маршрутизации существовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
strict boolean	Определяет, применяет ли система ограничения междоменной маршрутизации. Варианты: `false` `true`
vlans list / elements=string	VLAN, используемые системой в домене маршрутизации.

Примечания

Примечание

Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется BIG-IP версии >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить конфигурацию BIG-IP на диск, добавьте как минимум одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Правила использования модуля для сохранения текущей конфигурации см. в документации к модулю.

Примеры

- name: Create a route domain
  bigip_routedomain:
    name: foo
    id: 1234
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Set VLANs on the route domain
  bigip_routedomain:
    name: bar
    state: present
    vlans:
      - net1
      - foo
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
bwc_policy string	Новый контроллер пропускной способности. Возвращается: при изменении Пример: `"/Common/foo"`
connection_limit integer	Новое ограничение количества подключений для домена маршрутизации. Возвращается: при изменении Пример: `100`
description string	Описание домена маршрутизации. Возвращается: при изменении Пример: `"route domain foo"`
flow_eviction_policy string	Новая политика вытеснения для этого домена маршрутизации. Возвращается: при изменении Пример: `"/Common/default-eviction-policy"`
fw_enforced_policy string	Задаёт политику AFM, применяемую к домену маршрутизации. Возвращается: при изменении Пример: `"/Common/afm-blocking-policy"`
id integer	Идентификатор изменённого домена маршрутизации. Возвращается: при изменении Пример: `2`
parent integer	Новый родительский домен маршрутизации. Возвращается: при изменении Пример: `0`
routing_protocol list / elements=string	Список протоколов маршрутизации, применённых к домену маршрутизации. Возвращается: при изменении Пример: `["bfd", "bgp"]`
service_policy string	Новая политика служб для этого домена маршрутизации. Возвращается: при изменении Пример: `"/Common-my-service-policy"`
strict string	Новая настройка строгой изоляции. Возвращается: при изменении Пример: `"enabled"`
vlans list / elements=string	Список новых VLAN, к которым применяется домен маршрутизации. Возвращается: при изменении Пример: `["/Common/http-tunnel", "/Common/socks-tunnel"]`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

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

© 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_routedomain_module.html