Spec-Zone.ru › Ansible 2.10

f5networks.f5_modules.bigip_iapp_service – Управляет службами TCL iApp на BIG-IP

Примечание

Этот плагин входит в состав коллекции f5networks.f5_modules (версия 1.6.0).

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

Для использования в книге задач, укажите: f5networks.f5_modules.bigip_iapp_service.

Добавлено в версии 1.0.0: of f5networks.f5_modules

  • Обзор
  • Параметры
  • Примечания
  • Примеры

Обзор

  • Управляет службами TCL iApp на BIG-IP.
  • API, которое использует система для связи с BIG-IP, это /mgmt/tm/sys/application/service/.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
description
строка
Описание службы iApp.
Если этот параметр указан в задаче Ansible, он будет иметь приоритет перед любым аналогичным параметром в данных службы iApp, предоставленных в поле parameters.
device_group
строка
Группа устройств для службы iApp.
Если этот параметр указан в задаче Ansible, он будет иметь приоритет перед любым аналогичным параметром в данных службы iApp, предоставленных в поле parameters.
force
булево
    Варианты:
  • нет ←
  • да
Принудительно обновляет службу iApp, даже если параметры службы не изменились. Этот параметр особенно важен, если шаблон iApp, лежащий в основе службы, был обновлен на месте. Этот параметр эквивалентен переконфигурации iApp, если этот шаблон изменился.
metadata
список / элементы=необработанные
Метаданные, связанные со службой iApp.
Если этот параметр указан в задаче Ansible, он будет иметь приоритет перед любым аналогичным параметром в данных службы iApp, предоставленных в поле parameters.
name
строка / требуется
Имя службы iApp, которую вы хотите развернуть.
parameters
словарь
Хэш всех необходимых переменных шаблона для шаблона iApp. Если ваши параметры хранятся в файле (более распространенный случай), мы рекомендуем использовать либо поиск file, либо template, чтобы предоставить ожидаемые параметры.
Эти параметры обычно состоят из полей lists, tables, и variables.
partition
строка
Значение по умолчанию:
"Общие"
Раздел устройства для управления ресурсами.
provider
словарь
добавлено в 1.0.0 of f5networks.f5_modules
Объект словаря, содержащий данные подключения.
auth_provider
строка
Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства.
Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem
булево
    Варианты:
  • нет
  • да
Если yes, данные телеметрии TEEM не отправляются в F5.
Вы можете опустить этот параметр, установив переменную среды F5_TEEM.
password
строка / требуется
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

псевдонимы: pass, pwd
server
строка / требуется
Хост BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_SERVER.
server_port
целое число
Значение по умолчанию:
443
Порт сервера BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT.
timeout
целое число
Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку.
transport
строка
    Варианты:
  • rest ←
Настраивает транспортное соединение для использования при подключении к удаленному устройству.
user
строка / требуется
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве.
Вы можете опустить этот параметр, установив переменную среды F5_USER.
validate_certs
булево
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых вами лично, использующих самоподписанные сертификаты.
Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.
state
строка
    Варианты:
  • present ←
  • absent
Когда present, гарантирует создание и запуск службы iApp. Когда absent, гарантирует удаление службы iApp.
strict_updates
булево
    Варианты:
  • нет
  • да
Указывает, привязана ли служба приложения к шаблону, поэтому при обновлении шаблона служба приложения изменяется, отражая обновления.
Когда yes, запрещает любые обновления ресурсов, созданных службой iApp, если они не обновляются непосредственно через iApp.
Когда no, разрешает обновления за пределами iApp.
Если этот параметр указан в задаче Ansible, он будет иметь приоритет перед любым аналогичным параметром в данных службы iApp, предоставленных в поле parameters.
template
строка
Шаблон iApp, из которого следует создать новую службу. Этот шаблон должен существовать на вашем BIG-IP, прежде чем вы сможете успешно создать службу.
При создании новой службы этот параметр обязателен.
traffic_group
строка
Группа трафика для службы 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 сохранится на диске, убедитесь, что включена хотя бы одна задача, использующая модуль f5networks.f5_modules.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

Авторы

  • 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.10/collections/f5networks/f5_modules/bigip_iapp_service_module.html

Spec-Zone.ru

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