Модуль f5networks.f5_modules.bigip_snat_pool — управление пулами SNAT на 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_snat_pool.

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

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

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

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

Параметры

Параметр	Комментарии
description строка	Необязательное описание пула SNAT.
members псевдонимы: member список / элементы=строка	Список элементов, которые нужно добавить в пул SNAT. Если `state` имеет значение `present`, этот параметр обязателен, в противном случае он необязателен. Элементами могут быть IP-адреса или имена объектов преобразования SNAT.
name строка / обязательный	Имя пула SNAT.
partition строка	Раздел устройства, в котором выполняется управление ресурсами. По умолчанию: `"Common"`
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` ← (по умолчанию)
state строка	Должен ли пул SNAT существовать. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

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

Примеры

- name: Add the SNAT pool 'my-snat-pool'
  bigip_snat_pool:
    name: my-snat-pool
    state: present
    members:
      - 10.10.10.10
      - 20.20.20.20
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Change the SNAT pool's members to a single member
  bigip_snat_pool:
    name: my-snat-pool
    state: present
    member: 30.30.30.30
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove the SNAT pool 'my-snat-pool'
  bigip_snat_pool:
    name: johnd
    state: absent
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add the SNAT pool 'my-snat-pool' with a description
  bigip_snat_pool:
    name: my-snat-pool
    state: present
    members:
      - 10.10.10.10
      - 20.20.20.20
    description: A SNAT pool description
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ	Описание
members список / элементы=строка	Список элементов, входящих в пул SNAT. Возвращается: при изменении и успешном выполнении Пример: `["['10.10.10.10']"]`

Авторы

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