Модуль f5networks.f5_modules.bigip_profile_ftp — управление профилями FTP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_profile_ftp.

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

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

Описание

Управляет профилями FTP в системе BIG-IP.

Параметры

Параметр	Комментарии
allow_ftps boolean	Разрешает явное согласование FTPS. Варианты: `false` `true`
description string	Описание профиля.
inherit_parent_profile boolean	Позволяет каналу передачи данных FTP наследовать профиль TCP, используемый управляющим каналом. Если `false`, канал передачи данных использует только FastL4 (BigProto). Варианты: `false` `true`
log_profile string	Настраивает профиль журналирования ALG, управляющий ведением журналов.
log_publisher string	Настраивает издателя журналов, который обрабатывает запись событий для этого профиля.
name string / обязательный	Задает имя профиля.
parent string	Задает профиль, от которого этот профиль наследует настройки. При создании профиля, если этот параметр не указан, используется профиль `ftp`, поставляемый с системой.
partition string	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
port integer	Задает службу для порта канала передачи данных, используемого этим профилем FTP. Допустимый диапазон значений — от `0` до `65535` включительно.
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` ← (по умолчанию)
security boolean	Включает защищенный FTP-трафик для BIG-IP Application Security Manager. Этот параметр можно использовать, только если система лицензирована для BIG-IP ASM. Варианты: `false` `true`
state string	Если `state` равно `present`, обеспечивает наличие профиля FTP. Если `state` равно `absent`, обеспечивает удаление профиля FTP. Варианты: `"present"` ← (по умолчанию) `"absent"`
translate_extended boolean	Преобразует расширенные запросы RFC 2428 `EPSV` и `EPRT` в `PASV` и `PORT` при взаимодействии с серверами IPv4. Этот параметр можно использовать, только если система лицензирована для BIG-IP Application Security Manager (ASM). Варианты: `false` `true`

Примечания

Примечание

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

Примеры

- name: Create an ftp profile
  bigip_profile_ftp:
    name: foo
    parent: /Common/barfoo
    port: 2221
    allow_ftps: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify an ftp profile
  bigip_profile_ftp:
    name: foo
    log_profile: /Common/alg_log
    log_publisher: /Common/foo_publisher
    security: true
    description: my description
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove an ftp profile
  bigip_profile_ftp:
    name: foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
allow_ftps boolean	Разрешает явное согласование FTPS. Возвращается: changed Пример: `true`
description string	Описание профиля. Возвращается: changed Пример: `"Foo is bar"`
inherit_parent_profile boolean	Позволяет каналу передачи данных FTP наследовать профиль TCP, используемый управляющим каналом. Возвращается: changed Пример: `false`
log_profile string	Профиль журналирования ALG, управляющий ведением журналов. Возвращается: changed Пример: `"/Common/foo_log_profile"`
log_publisher list / elements=string	Имя издателя журналов, который обрабатывает запись событий для этого профиля. Возвращается: changed Пример: `["/Common/publisher_1"]`
parent string	Задает профиль, от которого этот профиль наследует настройки. Возвращается: changed Пример: `"/Common/ftp"`
port integer	Задает службу для порта канала передачи данных, используемого этим профилем FTP. Возвращается: changed Пример: `20`
security boolean	Включает защищенный FTP-трафик для BIG-IP Application Security Manager. Возвращается: changed Пример: `false`
translate_extended boolean	Преобразует расширенные запросы RFC 2428 при взаимодействии с серверами IPv4. Возвращается: changed Пример: `true`

Авторы

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