bigip_profile_tcp - Управление профилями TCP на BIG-IP
Новое в версии 2.6.
Обзор
- Управление профилями TCP на BIG-IP. Существует множество профилей TCP, каждый со своими настройками по отношению к стандартному профилю
tcp. Пользователи данного модуля должны понимать, что для многих настраиваемых параметров нет значения по умолчанию модуля. Вместо этого значение по умолчанию устанавливается самой системой BIG-IP, что в большинстве случаев приемлемо.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| idle_timeout | Указывает длительность простоя соединения (без трафика), после которой соединение может быть удалено. При создании нового профиля, если этот параметр не указан, удалённый узел выберет значение по умолчанию, подходящее для профиля, на основе его профиля parent. Если указано числовое значение, оно представляет количество секунд, в течение которых TCP-соединение может оставаться неактивным, прежде чем система удалит его. Если указано 0, или indefinite, система не удаляет TCP-соединения независимо от того, как долго они остаются бездействующими. | ||
| name обязательно | Указывает имя профиля. | ||
| parent | Указывает профиль, от которого данный профиль наследует настройки. При создании нового профиля, если этот параметр не указан, по умолчанию используется системный профиль tcp. | ||
| partition | По умолчанию: "Общие" | Раздел устройства для управления ресурсами. | |
| password обязательно | Пароль от учетной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, если переменная окружения F5_PASSWORD задана.псевдонимы: pass, pwd | ||
| provider (добавлен в 2.5) | Объект типа dict, содержащий данные подключения. | ||
| password обязательно | Пароль от учетной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, если переменная окружения F5_PASSWORD задана.псевдонимы: pass, pwd | ||
| server обязательно | Хост BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER задана. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER_PORT задана. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, если переменная окружения F5_USER задана. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверяющими сертификатами. Этот параметр можно опустить, если переменная окружения F5_VALIDATE_CERTS задана. | |
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации соединения с удаленным устройством. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| server обязательно | Хост BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER задана. | ||
| server_port (добавлен в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER_PORT задана. | |
| state |
| Когда present, гарантирует существование профиля.Когда absent, гарантирует удаление профиля. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, если переменная окружения F5_USER задана. | ||
| validate_certs bool (добавлен в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверяющими сертификатами. Этот параметр можно опустить, если переменная окружения F5_VALIDATE_CERTS задана. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- name: Create a TCP profile
bigip_profile_tcp:
name: foo
parent: f5-tcp-progressive
idle_timeout: 300
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| idle_timeout int | изменено | Новое время простоя для ресурса. Пример: 100 |
| parent строка | изменено | Новый родительский ресурс. Пример: f5-tcp-optimized |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в разделе Техническое обслуживание модулей и поддержка.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Tim Rupp (@caphrim007)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/bigip_profile_tcp_module.html