bigip_iapp_service – Управляет службами TCL iApp на BIG-IP
Новая в версии 2.4.
Описание
- Управляет службами TCL iApp на BIG-IP.
- Если вы ищете API, с которым взаимодействуют на BIG-IP, используемый API —
/mgmt/tm/sys/application/service/.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description строка добавлен в 2.7 | Описание службы iApp. Если этот параметр указан в задаче Ansible, он будет иметь приоритет над аналогичными настройками в содержимом службы iApp, предоставленном в поле parameters. | ||
| device_group строка добавлен в 2.7 | Группа устройств для службы iApp. Если этот параметр указан в задаче Ansible, он будет иметь приоритет над аналогичными настройками в содержимом службы iApp, предоставленном в поле parameters. | ||
| force булево |
| Принудительно обновляет службу iApp, даже если параметры службы не изменились. Этот параметр особенно важен, если шаблон iApp, лежащий в основе службы, был обновлен in-place. Этот параметр эквивалентен повторной настройке iApp, если этот шаблон был изменён. | |
| metadata список добавлен в 2.7 | Метаданные, связанные со службой iApp. Если этот параметр указан в задаче Ansible, он будет иметь приоритет над аналогичными настройками в содержимом службы iApp, предоставленном в поле parameters. | ||
| name строка / обязательно | Имя службы iApp, которую вы хотите развернуть. | ||
| parameters словарь | Хэш всех необходимых переменных шаблона для шаблона iApp. Если ваши параметры хранятся в файле (более распространённый сценарий), рекомендуется использовать поиск file или template, чтобы предоставить ожидаемые параметры.Эти параметры обычно состоят из полей lists, tables, и variables. | ||
| partition строка добавлен в 2.5 | Значение по умолчанию: "Общие" | Раздел устройства для управления ресурсами. | |
| provider словарь добавлен в 2.5 | Объект словаря, содержащий данные подключения. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации с удалённого устройства. Этот параметр используется в работе с устройствами BIG-IQ. | ||
| password строка / обязательно | Пароль для учётной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Можно опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число | Значение по умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Можно опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs булево |
| Если no, сертификаты SSL не проверяются. Используйте только на управляемых вами сайтах с самоподписанными сертификатами.Можно опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| state строка |
| Когда present, гарантирует, что служба iApp создана и запущена. Когда absent, гарантирует, что служба iApp удалена. | |
| strict_updates булево добавлен в 2.5 |
| Указывает, связана ли служба прикладного уровня с шаблоном, так что при обновлении шаблона служба прикладного уровня изменяется для отражения обновлений. Когда yes, запрещает любые обновления ресурсов, созданных службой iApp, если они не обновляются напрямую через iApp.Когда no, разрешает обновления за пределами iApp.Если этот параметр указан в задаче Ansible, он будет иметь приоритет над аналогичными настройками в содержимом службы iApp, предоставленном в поле parameters. | |
| template строка | Шаблон iApp, из которого следует создать новую службу. Этот шаблон должен существовать на вашем BIG-IP, прежде чем вы сможете успешно создать службу. При создании новой службы этот параметр обязателен. | ||
| traffic_group строка добавлен в 2.5 | Группа трафика для службы iApp. При создании новой службы, если это значение не указано, будет использовано значение по умолчанию /Common/traffic-group-1. Если этот параметр указан в задаче Ansible, он будет иметь приоритет над аналогичными настройками в содержимом службы iApp, предоставленном в поле parameters. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, включите хотя бы одну задачу, использующую модуль bigip_config, для сохранения рабочей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения рабочей конфигурации.
Примеры
- name: Create HTTP iApp service from iApp template
bigip_iapp_service:
name: foo-service
template: f5.http
parameters: "{{ lookup('file', 'f5.http.parameters.json') }}"
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Upgrade foo-service to v1.2.0rc4 of the f5.http template
bigip_iapp_service:
name: foo-service
template: f5.http.v1.2.0rc4
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Configure a service using parameters in YAML
bigip_iapp_service:
name: tests
template: web_frontends
state: present
parameters:
variables:
- name: var__vs_address
value: 1.1.1.1
- name: pm__apache_servers_for_http
value: 2.2.2.1:80
- name: pm__apache_servers_for_https
value: 2.2.2.2:80
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Re-configure a service whose underlying iApp was updated in place
bigip_iapp_service:
name: tests
template: web_frontends
force: yes
state: present
parameters:
variables:
- name: var__vs_address
value: 1.1.1.1
- name: pm__apache_servers_for_http
value: 2.2.2.1:80
- name: pm__apache_servers_for_https
value: 2.2.2.2:80
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Try to remove the iApp template before the associated Service is removed
bigip_iapp_template:
name: web_frontends
state: absent
provider:
user: admin
password: secret
server: lb.mydomain.com
register: result
failed_when:
- result is not success
- "'referenced by one or more applications' not in result.msg"
- name: Configure a service using more complicated parameters
bigip_iapp_service:
name: tests
template: web_frontends
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
parameters:
variables:
- name: var__vs_address
value: 1.1.1.1
- name: pm__apache_servers_for_http
value: 2.2.2.1:80
- name: pm__apache_servers_for_https
value: 2.2.2.2:80
lists:
- name: irules__irules
value:
- foo
- bar
tables:
- name: basic__snatpool_members
- name: net__snatpool_members
- name: optimizations__hosts
- name: pool__hosts
columnNames:
- name
rows:
- row:
- internal.company.bar
- name: pool__members
columnNames:
- addr
- port
- connection_limit
rows:
- row:
- "none"
- 80
- 0
- name: server_pools__servers
delegate_to: localhost
- name: Override metadata that may or may not exist in parameters
bigip_iapp_service:
name: foo-service
template: f5.http
parameters: "{{ lookup('file', 'f5.http.parameters.json') }}"
metadata:
- persist: yes
name: data 1
- persist: yes
name: data 2
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Статус
- Этот модуль гарантирует обратную совместимость изменений интерфейса в дальнейшем. [stableinterface]
- Этот модуль поддерживается партнером Ansible. [certified]
Авторы
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_iapp_service_module.html