Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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.
  • API, используемое системой для связи с BIG-IP, — это /mgmt/tm/sys/application/service/.

Параметры

Параметр

Комментарии

description

строка

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

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

device_group

строка

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

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

force

булево

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

Варианты:

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

metadata

список / элементы=любой

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

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

name

строка / обязательно

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

parameters

словарь

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

Эти параметры обычно содержат поля lists, tables, и variables.

partition

строка

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

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

provider

словарь

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

Объект словаря, содержащий сведения о подключении.

auth_provider

строка

Настраивает поставщика аутентификации для получения маркеров аутентификации с удалённого устройства.

Этот параметр действительно используется при работе с устройствами BIG-IQ.

no_f5_teem

булево

Если yes, данные телеметрии TEEM не отправляются в F5.

Вы можете опустить этот параметр, установив переменную среды F5_TELEMETRY_OFF.

Предыдущая используемая переменная F5_TEEM устарела, так как её название было запутанным.

Варианты:

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

password

псевдонимы: pass, pwd

строка / обязательно

Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

server

строка / обязательно

Хост BIG-IP или BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER.

server_port

целое число

Порт сервера BIG-IP.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

целое число

Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.

transport

строка

Настраивает транспортное соединение для подключения к удалённому устройству.

Варианты:

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

user

строка / обязательно

Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве.

Вы можете опустить этот параметр, установив переменную среды F5_USER.

validate_certs

булево

Если no, сертификаты SSL не будут проверены. Используйте это только на контролируемых вами сайтах с самоподписанными сертификатами.

Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Варианты:

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

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_iapp_service_module.html

Spec-Zone.ru

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