Модуль f5networks.f5_modules.bigip_selfip — управление Self-IP-адресами в системе 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_selfip.

Новый в f5networks.f5_modules 1.0.0

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

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

Управление Self-IP-адресами в системе BIG-IP.

Параметры

Параметр	Комментарии
address string	IP-адреса нового Self-IP. При обновлении это значение игнорируется, поскольку изменить адреса после создания невозможно. Это значение обязательно при создании новых Self-IP. Поддерживаются IPv4 и IPv6.
allow_service list / elements=string	Настройка блокировки портов для Self-IP. По умолчанию для Self-IP действует политика «запретить всё». Её можно изменить, чтобы разрешить порты TCP и UDP, а также определённые протоколы. Список должен содержать значения `protocol`:`port`.
description string	Описание селектора трафика.
fw_enforced_policy string добавлен в f5networks.f5_modules 1.1.0	Указывает политику AFM, которую нужно назначить Self-IP.
name string / обязательный	Имя создаваемого Self-IP. Если этот параметр не указан, по умолчанию используется значение, заданное в параметре `address`.
netmask string	Маска подсети Self-IP. Это значение обязательно при создании нового Self-IP.
partition string	Раздел устройства, в котором следует управлять ресурсами. Для Self-IP можно задать разные разделы, однако используемый адрес не должен совпадать с адресом другого Self-IP. Таким образом, Self-IP не изолированы разделами, в отличие от других ресурсов BIG-IP. По умолчанию: `"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` ← (по умолчанию)
route_domain integer	Идентификатор домена маршрутизации системы. При создании нового Self-IP, если это значение не указано, используется значение по умолчанию `0`. После установки это значение изменить нельзя.
state string	Если `present`, гарантирует, что Self-IP существует с указанными атрибутами. Если `absent`, удаляет Self-IP из системы. Варианты: `"absent"` `"present"` ← (по умолчанию)
traffic_group string	Группа трафика для Self-IP в конфигурации балансировщика нагрузки с активными узлами и резервированием. При создании нового Self-IP, если это значение не указано, используется значение по умолчанию `/Common/traffic-group-local-only`.
vlan string	VLAN для новых Self-IP. Это значение обязательно при создании нового Self-IP.

Примечания

Примечание

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

Примеры

- name: Create Self IP
  bigip_selfip:
    address: 10.10.10.10
    name: self1
    netmask: 255.255.255.0
    vlan: vlan1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create Self IPv6
  bigip_selfip:
    address: fe80::10
    name: self2
    netmask: "ffff:ffff:ffff:ffff::"
    vlan: vlan1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
    delegate_to: localhost

- name: Create Self IP with a Route Domain
  bigip_selfip:
    name: self1
    address: 10.10.10.10
    netmask: 255.255.255.0
    vlan: vlan1
    route_domain: 10
    allow_service: default
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Delete Self IP
  bigip_selfip:
    name: self1
    state: absent
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Allow management web UI to be accessed on this Self IP
  bigip_selfip:
    name: self1
    state: absent
    allow_service:
      - tcp:443
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Allow HTTPS and SSH access to this Self IP
  bigip_selfip:
    name: self1
    state: absent
    allow_service:
      - tcp:443
      - tcp:22
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Allow all services access to this Self IP
  bigip_selfip:
    name: self1
    state: absent
    allow_service:
      - all
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Allow only GRE and IGMP protocols access to this Self IP
  bigip_selfip:
    name: self1
    state: absent
    allow_service:
      - gre:0
      - igmp:0
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Allow all TCP, but no other protocols access to this Self IP
  bigip_selfip:
    name: self1
    state: absent
    allow_service:
      - tcp:0
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
address string	Адрес Self-IP. Возвращается: changed Пример: `"192.0.2.10"`
allow_service list / elements=string	Службы, разрешённые через этот Self-IP. Возвращается: changed Пример: `["igmp:0", "tcp:22", "udp:53"]`
fw_enforced_policy string	Указывает политику AFM, назначенную Self-IP. Возвращается: changed Пример: `"/Common/afm-blocking-policy"`
name string	Имя Self-IP. Возвращается: created Пример: `"self1"`
netmask string	Маска подсети Self-IP. Возвращается: changed Пример: `"255.255.255.0"`
traffic_group string	Группа трафика, к которой относится Self-IP. Возвращается: changed Пример: `"traffic-group-local-only"`
vlan string	VLAN, настроенная для Self-IP. Возвращается: changed Пример: `"vlan1"`

Авторы

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