Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_iapp_service — управление службами TCL iApp на BIG-IP

Примечание

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

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

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

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

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

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры

Краткое описание

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

Параметры

Параметр

Комментарии

description

string

Описание службы iApp.

Если этот параметр указан в задаче Ansible, он имеет приоритет над аналогичной настройкой в данных службы iApp, переданных в поле parameters.

device_group

string

Группа устройств для службы iApp.

Если этот параметр указан в задаче Ansible, он имеет приоритет над аналогичной настройкой в данных службы iApp, переданных в поле parameters.

force

boolean

Принудительно обновляет службу iApp, даже если ее параметры не изменились. Этот параметр особенно важен, если шаблон iApp, на основе которого создана служба, был обновлен на месте. Если шаблон изменился, этот параметр эквивалентен повторной настройке iApp.

Варианты:

  • false ← (по умолчанию)
  • true

metadata

list / elements=any

Метаданные, связанные со службой iApp.

Если этот параметр указан в задаче Ansible, он имеет приоритет над аналогичной настройкой в данных службы iApp, переданных в поле parameters.

name

string / обязательный

Имя службы iApp, которую требуется развернуть.

parameters

dictionary

Словарь всех обязательных переменных шаблона iApp. Если параметры хранятся в файле (что встречается чаще всего), рекомендуется использовать подстановки file или template для передачи необходимых параметров.

Обычно эти параметры включают поля lists, tables и variables.

partition

string

Раздел устройства, в котором следует управлять ресурсами.

По умолчанию: "Common"

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 ← (по умолчанию)

state

string

Если present, обеспечивает создание и запуск службы iApp. Если absent, обеспечивает удаление службы iApp.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

strict_updates

boolean

Указывает, привязана ли служба приложения к шаблону, чтобы при обновлении шаблона служба приложения изменялась соответствующим образом.

Если true, любые изменения ресурсов, созданных службой iApp, запрещены, если они не вносятся непосредственно через iApp.

Если false, изменения вне iApp разрешены.

Если этот параметр указан в задаче Ansible, он имеет приоритет над аналогичной настройкой в данных службы iApp, переданных в поле parameters.

Варианты:

  • false
  • true

template

string

Шаблон iApp, на основе которого создается новая служба. Чтобы успешно создать службу, этот шаблон должен существовать на BIG-IP.

При создании новой службы этот параметр обязателен.

traffic_group

string

Группа трафика для службы 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: true
    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: true
        name: data 1
      - persist: true
        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–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_iapp_service_module.html

Spec-Zone.ru

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