Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_snat_translation — управление трансляциями 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_translation.

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

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

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

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

Параметры

Параметр

Комментарии

address

псевдонимы: ip

строка

Задает IP-адрес трансляции SNAT. Если state равно present, enabled или disabled, этот параметр обязателен.

После задания этого параметра его нельзя изменить.

arp

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

Если true, указывает, что NAT отправляет ARP-запросы.

Варианты:

  • false
  • true

connection_limit

целое число

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

Допустимый диапазон значений: 0 - 65535.

description

строка

Описание трансляции SNAT. none or '' задает пустое описание по умолчанию.

ip_idle_timeout

строка

Задает время, в течение которого соединения с IP-адресом, инициированные с использованием адреса SNAT, могут оставаться неактивными до автоматического отключения. indefinite предотвращает истечение времени ожидания соединения.

Допустимый диапазон значений — 0 - 4294967295 секунд. Указание indefinite задает максимальное значение.

name

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

Имя трансляции SNAT.

partition

строка

Раздел устройства, в котором будут управляться ресурсы.

Обязателен при состоянии absent, если используется раздел, отличный от 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. Если absent, удаляет трансляцию SNAT, если она существует. present создает трансляцию SNAT и включает ее. Если enabled, включает трансляцию SNAT, если она существует. Если disabled, при необходимости создает трансляцию SNAT и задает состояние disabled.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
  • "enabled"
  • "disabled"

tcp_idle_timeout

строка

Задает время, в течение которого TCP-соединения, инициированные с использованием адреса SNAT, могут оставаться неактивными до автоматического отключения. indefinite предотвращает истечение времени ожидания соединения.

Допустимый диапазон значений — 0 - 4294967295 секунд. Указание indefinite задает максимальное значение.

traffic_group

строка

Группа трафика для адреса трансляции SNAT. При создании нового адреса, если это значение не указано, по умолчанию используется /Common/traffic-group-1.

udp_idle_timeout

строка

Задает время, в течение которого UDP-соединения, инициированные с использованием адреса SNAT, могут оставаться неактивными до автоматического отключения. indefinite предотвращает истечение времени ожидания соединения.

Допустимый диапазон значений — 0 - 4294967295 секунд. Указание indefinite задает максимальное значение.

Примечания

Примечание

  • Дополнительные сведения об использовании 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 SNAT translation 'my-snat-translation'
  bigip_snat_translation:
    name: my-snat-pool
    state: present
    address: 10.10.10.10
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Modify a SNAT translation 'my-snat-translation'
  bigip_snat_translation:
    name: my-snat-pool
    state: present
    address: 10.10.10.10
    arp: false
    connection_limit: 300
    ip_idle_timeout: 1800
    tcp_idle_timeout: 1800
    udp_idle_timeout: 1800
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Disable a SNAT translation 'my-snat-translation'
  bigip_snat_translation:
    name: my-snat-pool
    state: disabled
    address: 10.10.10.10
    arp: false
    connection_limit: 300
    ip_idle_timeout: 1800
    tcp_idle_timeout: 1800
    udp_idle_timeout: 1800
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Enable a SNAT translation 'my-snat-translation'
  bigip_snat_translation:
    name: my-snat-pool
    state: enabled
    address: 10.10.10.10
    arp: false
    connection_limit: 300
    ip_idle_timeout: 1800
    tcp_idle_timeout: 1800
    udp_idle_timeout: 1800
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Create using partition other then /Common on a SNAT translation 'my-new-snat-translation'
  bigip_snat_translation:
    name: my-new-snat-pool
    state: enabled
    address: 10.10.10.10
    arp: false
    connection_limit: 300
    ip_idle_timeout: 1800
    partition: ansible
    tcp_idle_timeout: 1800
    udp_idle_timeout: 1800
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Modify using traffic group other then /Common/traffic-group-1 on a SNAT translation 'my-new-snat-translation'
  bigip_snat_translation:
    name: my-new-snat-pool
    state: enabled
    address: 10.10.10.10
    arp: false
    connection_limit: 300
    ip_idle_timeout: 1800
    partition: ansible
    tcp_idle_timeout: 1800
    traffic_group: /Common/ansible
    udp_idle_timeout: 1800
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ

Описание

address

строка

IP-адрес, используемый для трансляции SNAT.

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

Пример: "10.10.10.10"

arp

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

Отправляет ли трансляция SNAT ARP-запросы.

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

Пример: true

connection_limit

целое число

Новое ограничение количества соединений виртуального адреса.

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

Пример: 1000

description

строка

Описание трансляции SNAT.

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

Пример: "My snat-translation"

ip_idle_timeout

строка

Значение времени ожидания неактивности IP для трансляции SNAT.

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

Пример: "300"

state

строка

Новое состояние трансляции SNAT.

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

Пример: "disabled"

tcp_idle_timeout

строка

Значение времени ожидания неактивности TCP для трансляции SNAT.

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

Пример: "1800"

traffic_group

строка

Назначенная группа трафика.

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

Пример: "/Common/traffic-group-1"

udp_idle_timeout

строка

Значение времени ожидания неактивности UDP для трансляции SNAT.

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

Пример: "indefinite"

Авторы

  • Greg Crosby (@crosbygw)
  • 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_translation_module.html

Spec-Zone.ru

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