Spec-Zone.ru › Ansible 2.8

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, на котором основана служба, был обновлён на месте. Этот параметр эквивалентен повторной конфигурации 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
Объект словаря, содержащий данные подключения.
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
строка
    Варианты:
  • cli
  • rest ←
Настраивает транспортное соединение для подключения к удалённому устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве.
Вы можете опустить этот параметр, установив переменную окружения F5_USER.
validate_certs
булево
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами лично, использующих самозаверяющие сертификаты.
Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS.
server
строка / обязательно
Хост BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_SERVER.
server_port
целое число
добавлен в 2.2
Значение по умолчанию:
443
Порт сервера BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_SERVER_PORT.
state
строка
    Варианты:
  • present ←
  • absent
Когда 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.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве.
Вы можете опустить этот параметр, установив переменную окружения F5_USER.
validate_certs
булево
добавлен в 2.0
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами лично, использующих самозаверяющие сертификаты.
Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS.

Примечания

Примечание

  • Дополнительную информацию об использовании 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.8/modules/bigip_iapp_service_module.html

Spec-Zone.ru

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