bigip_iapp_service – Управляет службами TCL iApp на BIG-IP
Новая версия с 2.4.
Краткое описание
- Управляет службами TCL iApp на BIG-IP.
- Если вы ищете API, с которым взаимодействует BIG-IP, то используется
/mgmt/tm/sys/application/service/.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description - добавлен в 2.7 | Описание службы iApp. Если этот параметр указан в задаче Ansible, он будет иметь приоритет над аналогичным параметром в полезной нагрузке службы iApp, предоставленной в поле parameters. | ||
| device_group - добавлен в 2.7 | Группа устройств для службы iApp. Если этот параметр указан в задаче Ansible, он будет иметь приоритет над аналогичным параметром в полезной нагрузке службы iApp, предоставленной в поле parameters. | ||
| force boolean |
| Принудительно обновляет службу iApp, даже если параметры службы не изменились. Этот параметр особенно важен, если шаблон iApp, на котором основана служба, был обновлён на месте. Этот параметр эквивалентен повторной конфигурации iApp, если этот шаблон был изменён. | |
| metadata - добавлен в 2.7 | Метаданные, связанные со службой iApp. Если этот параметр указан в задаче Ansible, он будет иметь приоритет над аналогичным параметром в полезной нагрузке службы iApp, предоставленной в поле parameters. | ||
| name - / обязательно | Имя службы iApp, которую вы хотите развернуть. | ||
| parameters - | Хэш всех необходимых переменных шаблона для шаблона iApp. Если ваши параметры хранятся в файле (более распространённый случай), рекомендуется использовать поиск file или template, чтобы предоставить ожидаемые параметры.Эти параметры обычно содержат поля lists, tables, и variables. | ||
| partition - добавлен в 2.5 | По умолчанию: "Общие" | Раздел устройств для управления ресурсами. | |
| password - / обязательно | Пароль для учётной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_PASSWORD. псевдонимы: pass, pwd | ||
| provider - добавлен в 2.5 | По умолчанию: null | Объект словаря, содержащий данные подключения. | |
| 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 - | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | |
| transport - / обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых вами лично, с самозаверяющимися сертификатами.Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
| server - / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_SERVER. | ||
| server_port - добавлен в 2.2 | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_SERVER_PORT. | |
| state - |
| Когда present, гарантирует, что служба iApp создана и запущена. Когда absent, гарантирует, что служба iApp была удалена. | |
| strict_updates boolean добавлен в 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. | ||
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения F5_USER. | ||
| validate_certs boolean добавлен в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых вами лично, с самозаверяющимися сертификатами.Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk. - Требуется версия ПО 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') }}"
password: secret
server: lb.mydomain.com
state: present
user: admin
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
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Configure a service using parameters in YAML
bigip_iapp_service:
name: tests
template: web_frontends
password: admin
server: "{{ inventory_hostname }}"
server_port: "{{ bigip_port }}"
validate_certs: "{{ validate_certs }}"
state: present
user: admin
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
delegate_to: localhost
- name: Re-configure a service whose underlying iApp was updated in place
bigip_iapp_service:
name: tests
template: web_frontends
password: admin
force: yes
server: "{{ inventory_hostname }}"
server_port: "{{ bigip_port }}"
validate_certs: "{{ validate_certs }}"
state: present
user: admin
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
delegate_to: localhost
- name: Try to remove the iApp template before the associated Service is removed
bigip_iapp_template:
name: web_frontends
state: absent
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
password: admin
server: "{{ inventory_hostname }}"
server_port: "{{ bigip_port }}"
validate_certs: "{{ validate_certs }}"
state: present
user: admin
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
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
Статус
- Этот модуль гарантированно не будет иметь изменений интерфейса, несовместимых со старыми версиями, в дальнейшем. [stableinterface]
- Этот модуль поддерживается партнером Ansible. [certified]
Авторы
- 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.7/modules/bigip_iapp_service_module.html