Модуль f5networks.f5_modules.bigip_vlan – Управление VLAN в системе 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_vlan.

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

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

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

Управление VLAN в системе BIG-IP

Параметры

Параметр	Комментарии
cmp_hash string	Задаёт способ распределения трафика в VLAN. Выбранное значение определяет метод распределения трафика. Можно распределять трафик на основе `source-address` (IP-адреса источника), `destination-address` (IP-адреса назначения) или `default`, указывающего, что для хеша CMP по умолчанию используются порты L4. При создании новой VLAN, если этот параметр не указан, по умолчанию используется `default`. Варианты: `"default"` `"destination-address"` `"source-address"` `"dst-ip"` `"src-ip"` `"dest"` `"destination"` `"source"` `"dst"` `"src"`
dag_round_robin boolean	Указывает, следует ли распределять часть трафика без отслеживания состояния в VLAN по круговому алгоритму вместо использования статического хеша. К такому трафику относятся трафик L2 без IP, ICMP, некоторые протоколы UDP и т. д. При создании новой VLAN, если этот параметр не указан, по умолчанию используется значение (false). Варианты: `false` `true`
dag_tunnel string	Задаёт, как распределитель (DAG) направляет полученные инкапсулированные туннельные пакеты экземплярам TMM. Выберите `inner`, чтобы распределять пакеты на основе информации во внутренних заголовках. Выберите `outer`, чтобы распределять пакеты на основе информации во внешних заголовках, не проверяя внутренние заголовки. При создании новой VLAN, если этот параметр не указан, по умолчанию используется `outer`. Этот параметр не поддерживается в виртуальных версиях BIG-IP (VE). Варианты: `"inner"` `"outer"`
description string	Описание VLAN.
fail_safe boolean	Если задано значение `true`, указывает, что VLAN выполнит указанное `fail_safe_action`, если система обнаружит потерю трафика на интерфейсах этой VLAN. Варианты: `false` `true`
fail_safe_action string	Задаёт действие, которое выполняет система, если она не обнаруживает трафик в этой VLAN и истёк срок действия `fail_safe_timeout`. Варианты: `"reboot"` `"restart-all"` `"failover"`
fail_safe_timeout integer	Задаёт количество секунд, в течение которых система может работать без обнаружения сетевого трафика в этой VLAN, прежде чем выполнить `fail_safe_action`.
hw_syn_cookie boolean добавлено в f5networks.f5_modules 1.3.0	Включает режим аппаратных SYN-cookie для VLAN. Если задано значение `true`, защита аппаратными SYN-cookie на уровне VLAN активируется при достижении определённого порога трафика на поддерживаемых платформах. Варианты: `false` `true`
interfaces list / elements=dictionary	Интерфейсы, которые требуется добавить в VLAN. Список может включать интерфейсы с тегами и без тегов, как указано в параметре `tagging`. Этот параметр нельзя использовать одновременно с параметрами `untagged_interfaces` и `tagged_interfaces`.
interface string	Имя интерфейса
tagging string	Указывает, имеет ли интерфейс тег `tagged` или `untagged`. Варианты: `"tagged"` `"untagged"`
mtu integer	Задаёт максимальный размер блока передачи (MTU) для трафика в этой VLAN. При создании новой VLAN, если этот параметр не указан, используется значение по умолчанию `1500`. Значение должно находиться в диапазоне от 576 до 9198.
name string / обязательный	Управляемая VLAN. Если указана специальная VLAN `ALL` и значение `absent` для параметра `state`, будут удалены все VLAN.
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` ← (по умолчанию)
sflow_poll_interval integer	Задаёт максимальный интервал в секундах между двумя опросами.
sflow_sampling_rate integer	Задаёт соотношение числа наблюдаемых пакетов к числу сформированных выборок.
source_check boolean	Если задано значение `true`, система проверяет, что маршрут возврата для исходного пакета проходит через ту же VLAN, из которой пакет был отправлен. Система выполняет эту проверку, только если параметр `auto_last_hop` имеет значение `false`. Варианты: `false` `true`
state string	Состояние VLAN в системе. Если задано значение `present`, гарантируется существование VLAN с указанными атрибутами. Если задано значение `absent`, VLAN удаляется из системы. Варианты: `"absent"` `"present"` ← (по умолчанию)
tag integer	Номер тега VLAN. Номер тега может быть любым целым числом от 1 до 4094. Если значение не указано, система назначает номер тега автоматически.
tagged_interfaces псевдонимы: tagged_interface list / elements=string	Задаёт список интерфейсов и транков с тегами, которые требуется настроить для VLAN. Используйте интерфейсы или транки с тегами, если один интерфейс или транк необходимо назначить нескольким VLAN. Этот параметр нельзя использовать одновременно с параметрами `untagged_interfaces` и `interfaces`.
untagged_interfaces псевдонимы: untagged_interface list / elements=string	Задаёт список интерфейсов и транков без тегов, которые требуется настроить для VLAN. Этот параметр нельзя использовать одновременно с параметрами `tagged_interfaces` и `interfaces`.

Примечания

Примечание

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

Примеры

- name: Create VLAN
  bigip_vlan:
    name: net1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set VLAN tag
  bigip_vlan:
    name: net1
    tag: 2345
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add VLAN 2345 as tagged to interface 1.1
  bigip_vlan:
    tagged_interface: 1.1
    name: net1
    tag: 2345
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Add VLAN 1234 as tagged to interfaces 1.1 and 1.2
  bigip_vlan:
    tagged_interfaces:
      - 1.1
      - 1.2
    name: net1
    tag: 1234
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ	Описание
cmp_hash string	Новый метод распределения трафика. Возвращается: changed Пример: `"source-address"`
dag_tunnel string	Новая настройка туннеля DAG. Возвращается: changed Пример: `"outer"`
description string	Описание, заданное для VLAN. Возвращается: changed Пример: `"foo VLAN"`
fail_safe boolean	Новое значение параметра Fail Safe. Возвращается: changed Пример: `false`
fail_safe_action string	Новое значение параметра Fail Safe Action. Возвращается: changed Пример: `"reboot"`
fail_safe_timeout integer	Новое значение параметра Fail Safe Timeout. Возвращается: changed Пример: `90`
hw_syn_cookie boolean	Включает режим аппаратных syncookie для VLAN. Возвращается: changed Пример: `false`
interfaces list / elements=string	Интерфейсы, назначенные VLAN. Возвращается: changed Пример: `["1.1", "1.2"]`
partition string	Раздел, в котором была создана VLAN. Возвращается: changed Пример: `"Common"`
sflow_poll_interval integer	Новое значение интервала опроса sFlow. Возвращается: changed Пример: `10`
sflow_sampling_rate integer	Новое значение частоты выборки sFlow. Возвращается: changed Пример: `20`
source_check boolean	Новое значение параметра Source Check. Возвращается: changed Пример: `true`
tag integer	Идентификатор VLAN. Возвращается: changed Пример: `2345`

Авторы

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_vlan_module.html