Spec-Zone.ru › Ansible

f5networks.f5_modules.bigip_interface — модуль для управления физическими интерфейсами 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_interface.

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

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

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

  • Модуль для управления физическими интерфейсами BIG-IP.

Параметры

Параметр

Комментарии

bundle

строка

Включает или отключает возможность объединения.

Этот параметр поддерживается только на некоторых аппаратных платформах и интерфейсах.

Попытка включить этот параметр на VE или любой другой неподдерживаемой платформе/интерфейсе приведет к сбою выполнения модуля.

Варианты:

  • "enabled"
  • "disabled"
  • "not-supported"

bundle_speed

строка

Задает скорость объединения; этот параметр применим только, когда объединение имеет значение true.

Этот параметр поддерживается только на некоторых аппаратных платформах и интерфейсах.

Попытка включить этот параметр на VE или любой другой неподдерживаемой платформе/интерфейсе приведет к сбою выполнения модуля.

Варианты:

  • "100G"
  • "40G"
  • "not-supported"

description

строка

Описание, заданное пользователем.

enabled

логическое значение

Задает текущее состояние интерфейса.

Если задано true, интерфейс может передавать трафик.

Если задано false, интерфейсу запрещается передавать трафик.

Варианты:

  • false
  • true

flow_control

строка

Задает способ управления отправкой кадров PAUSE системой.

Если задано tx-rx, интерфейс обрабатывает кадры паузы от партнера, а также при необходимости генерирует кадры паузы.

Если задано tx, интерфейс игнорирует кадры паузы от партнера, но при необходимости генерирует кадры паузы.

Если задано rx, интерфейс обрабатывает кадры паузы от партнера, но не генерирует кадры паузы.

Если задано (none), управление потоком на интерфейсе отключено.

Варианты:

  • "none"
  • "rx"
  • "tx"
  • "tx-rx"

force_gigabit_fiber

логическое значение

Включает или отключает принудительное использование гигабитного оптоволоконного носителя.

Если для гигабитного оптоволоконного интерфейса задано true, настройка носителя будет принудительно применена, а автосогласование выполняться не будет.

Если задано false, будет выполнено автосогласование с объявлением только одного варианта гигабитного оптоволоконного подключения.

Варианты:

  • false
  • true

forward_error_correction

строка

Включает или отключает прямую коррекцию ошибок Reed-Solomon согласно IEEE 802.3bm Clause 91 для интерфейсов 100G. Не применимо для носителей LR4.

Этот параметр поддерживается только на некоторых аппаратных платформах и интерфейсах.

Попытка включить этот параметр на VE или любой другой неподдерживаемой платформе/интерфейсе приведет к сбою выполнения модуля.

Варианты:

  • "enabled"
  • "disabled"
  • "not-supported"
  • "auto"

lldp_admin

строка

Задает параметры LLDP на уровне интерфейса.

Если задано disabled, интерфейс не передает сообщения LLDP соседним устройствам и не принимает от них сообщения LLDP.

Если задано txonly, интерфейс передает сообщения LLDP соседним устройствам, но не принимает от них сообщения LLDP.

Если задано rxonly, интерфейс принимает сообщения LLDP от соседних устройств, но не передает им сообщения LLDP.

Если задано txrx, интерфейс передает сообщения LLDP соседним устройствам и принимает от них сообщения LLDP.

Варианты:

  • "disable"
  • "rxonly"
  • "txonly"
  • "txrx"

lldp_tlvmap

целое число

Задает содержимое отправляемого или принимаемого сообщения LLDP.

Каждый атрибут LLDP, заданный этим параметром, является необязательным и представлен в формате «тип, длина, значение» (TLV).

Три обязательных TLV, которые не учитываются при вычислении этого значения: Chassis ID, Port ID и TTL.

Для доступных необязательных атрибутов определены соответствующие числовые значения TLV.

Атрибут Port Description имеет значение TLV 8.

Атрибут System Name имеет значение TLV 16.

Атрибут System Description имеет значение TLV 32.

Атрибут System Capabilities имеет значение TLV 64.

Атрибут Management Address имеет значение TLV 128.

Атрибут Port VLAN ID имеет значение TLV 256.

Атрибут VLAN Name имеет значение TLV 512.

Атрибут Port and Protocol VLAN ID имеет значение TLV 1024.

Атрибут Protocol Identity имеет значение TLV 2048.

Атрибут MAC/PHY Config Status имеет значение TLV 4096.

Атрибут Link Aggregation имеет значение TLV 8192.

Атрибут Max Frame Size имеет значение TLV 32768.

Атрибут Product Model имеет значение TLV 65536.

Атрибут lldp_tlvmap — это числовое значение, равное сумме значений TLV выбранных атрибутов.

Если задать для lldp_tlvmap значение 0, все атрибуты интерфейса будут удалены.

Если задать для lldp_tlvmap значение 114680, все атрибуты будут добавлены в интерфейс.

media_fixed

строка

Задает параметры фиксированного (неподключаемого) интерфейса.

Используйте этот параметр только для комбинированного порта, чтобы указать тип носителя для фиксированного интерфейса, если он не является предпочтительным портом.

Варианты:

  • "100000-FD"
  • "100000LR4-FD"
  • "10000LR-FD"
  • "10000T-FD"
  • "1000SX-FD"
  • "100TX-FD"
  • "10T-HD"
  • "20000-FD"
  • "40000LR4-FD"
  • "100000AR4-FD"
  • "100000SR4-FD"
  • "10000SFPCU-FD"
  • "1000CX-FD"
  • "1000T-FD"
  • "100TX-HD"
  • "12000-FD"
  • "21000-FD"
  • "40000SR4-FD"
  • "100000CR4-FD"
  • "10000ER-FD"
  • "10000SR-FD"
  • "1000LX-FD"
  • "1000T-HD"
  • "10T-FD"
  • "16000-FD"
  • "40000-FD"
  • "42000-FD"
  • "auto"
  • "no-phy"

media_sfp

строка

Задает параметры интерфейса SFP (подключаемого).

Используйте этот параметр только для комбинированного порта, чтобы указать тип носителя для интерфейса SFP, если он не является предпочтительным портом.

Варианты:

  • "100000-FD"
  • "100000LR4-FD"
  • "10000LR-FD"
  • "10000T-FD"
  • "1000SX-FD"
  • "100TX-FD"
  • "10T-HD"
  • "20000-FD"
  • "40000LR4-FD"
  • "100000AR4-FD"
  • "100000SR4-FD"
  • "10000SFPCU-FD"
  • "1000CX-FD"
  • "1000T-FD"
  • "100TX-HD"
  • "12000-FD"
  • "21000-FD"
  • "40000SR4-FD"
  • "100000CR4-FD"
  • "10000ER-FD"
  • "10000SR-FD"
  • "1000LX-FD"
  • "1000T-HD"
  • "10T-FD"
  • "16000-FD"
  • "40000-FD"
  • "42000-FD"
  • "auto"
  • "no-phy"

name

строка / обязательный

Задает имя интерфейса, которым необходимо управлять.

port_fwd_mode

строка

Задает режим работы.

Варианты:

  • "l3"
  • "passive"
  • "virtual-wire"

prefer_port

строка

Указывает, какую сторону комбинированного порта использует интерфейс, если обе стороны могут обеспечить внешнее соединение.

Значение по умолчанию для комбинированного порта — sfp. Не используйте этот параметр для портов, не являющихся комбинированными.

Варианты:

  • "sfp"
  • "fixed"

provider

словарь

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

Объект dict, содержащий сведения о подключении.

auth_provider

строка

Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства.

Этот параметр используется при работе с устройствами BIG-IQ.

no_f5_teem

логическое значение

Если задано yes, телеметрические данные TEEM не отправляются в F5.

Этот параметр можно не указывать, задав переменную среды F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM объявлена устаревшей, поскольку ее название вводило в заблуждение.

Варианты:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

строка / обязательный

Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_PASSWORD.

server

строка / обязательный

Имя узла BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_SERVER.

server_port

целое число

Порт сервера BIG-IP.

Этот параметр можно не указывать, задав переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

целое число

Задает время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.

transport

строка

Настраивает транспортное подключение для соединения с удаленным устройством.

Варианты:

  • "rest" ← (по умолчанию)

user

строка / обязательный

Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве.

Этот параметр можно не указывать, задав переменную среды F5_USER.

validate_certs

логическое значение

Если задано no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самоподписанными сертификатами.

Этот параметр можно не указывать, задав переменную среды F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

sflow

словарь

Задает параметры sFlow для интерфейса.

poll_interval

целое число

Задает максимальный интервал между опросами в секундах.

Чтобы этот параметр вступил в силу, значение poll_interval_global должно быть равно false.

Допустимый диапазон: 0–4294967295.

poll_interval_global

логическое значение

Задает, переопределяет ли глобальный параметр интерфейса poll_interval параметр уровня объекта poll_interval.

Если задано true), параметр poll_interval не вступает в силу.

Варианты:

  • false
  • true

stp

логическое значение

Включает или отключает STP.

Варианты:

  • false
  • true

stp_auto_edge_port

логическое значение

Включает автоматическое определение граничного порта STP для интерфейса.

Если задано true, система отслеживает входящие пакеты STP, RSTP или MSTP на интерфейсе. Если в течение достаточного времени (около трех секунд) такие пакеты не поступают, интерфейсу автоматически присваивается статус граничного порта.

Если задано false, система никогда не присваивает интерфейсу статус граничного порта автоматически. Любая настройка STP, заданная отдельно для интерфейса, применяется ко всем экземплярам протокола связующего дерева.

Варианты:

  • false
  • true

stp_edge_port

логическое значение

Указывает, подключен ли интерфейс к конечной станции, а не к другому мосту связующего дерева.

Варианты:

  • false
  • true

stp_link_type

строка

Задает тип связи STP для интерфейса.

Варианты:

  • "auto"
  • "p2p"
  • "shared"

Примечания

Примечание

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

Примеры

- name: Update Interface Settings
  bigip_interface:
    name: 1.1
    stp: true
    stp_auto_edge_port: false
    stp_edge_port: true
    stp_link_type: shared
    description: my description
    flow_control: tx
    lldp_admin: txrx
    lldp_tlvmap: 8
    force_gigabit_fiber: false
    sflow:
      - poll_interval: 10
      - poll_interval_global: false
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Disable Interface
  bigip_interface:
    name: 1.1
    enabled: false
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Change sflow interface settings
  bigip_interface:
    name: 1.1
    sflow:
      - poll_interval: 0
      - poll_interval_global: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ

Описание

bundle

string

Включает или отключает поддержку объединения каналов.

Возвращается: при изменении

Пример: "not-supported"

bundle_speed

string

Скорость объединённого канала.

Возвращается: при изменении

Пример: "100G"

description

string

Описание, заданное пользователем.

Возвращается: при изменении

Пример: "my description"

enabled

boolean

Текущее состояние интерфейса.

Возвращается: при изменении

Пример: true

flow_control

string

Определяет, как система управляет отправкой кадров PAUSE.

Возвращается: при изменении

Пример: "tx"

force_gigabit_fiber

boolean

Включает или отключает принудительное использование гигабитного оптоволоконного носителя.

Возвращается: при изменении

Пример: true

forward_error_correction

string

Включает или отключает коррекцию ошибок при передаче данных (FEC).

Возвращается: при изменении

Пример: "auto"

lldp_admin

string

Параметры LLDP на уровне интерфейса.

Возвращается: при изменении

Пример: "txrx"

lldp_tlvmap

integer

Содержимое отправляемого или принимаемого сообщения LLDP.

Возвращается: при изменении

Пример: 136

media_fixed

string

Параметры для интерфейса с фиксированным типом среды передачи.

Возвращается: при изменении

Пример: "100000-FD"

media_sfp

string

Параметры интерфейса SFP.

Возвращается: при изменении

Пример: "100000-FD"

port_fwd_mode

string

Режим работы.

Возвращается: при изменении

Пример: "passive"

prefer_port

string

Сторона комбинированного порта, используемая интерфейсом.

Возвращается: при изменении

Пример: "fixed"

sflow

complex

Задаёт параметры sFlow для интерфейса.

Возвращается: при изменении

Пример: "hash/dictionary of values"

poll_interval

integer

Максимальный интервал в секундах между двумя опросами.

Возвращается: при изменении

Пример: 128

poll_interval_global

boolean

Переопределение глобальных параметров sFlow.

Возвращается: при изменении

Пример: true

stp

boolean

Включает или отключает STP.

Возвращается: при изменении

Пример: false

stp_auto_edge_port

boolean

Включает автоматическое определение граничного порта STP для интерфейса.

Возвращается: при изменении

Пример: true

stp_edge_port

boolean

Указывает, подключается ли интерфейс к конечной станции, а не к другому мосту связующего дерева.

Возвращается: при изменении

Пример: false

stp_link_type

string

Тип канала STP для интерфейса.

Возвращается: при изменении

Пример: "shared"

Авторы

  • 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_interface_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API