Spec-Zone.ru › Ansible 2.6

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

Новая в версии 2.4.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • f5-sdk >= 3.0.9

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
force
bool
    Варианты:
  • no ←
  • yes
Принудительно обновляет службу iApp, даже если параметры службы не изменились. Этот параметр особенно важен, если шаблон iApp, на котором основана служба, был обновлён. Этот параметр эквивалентен повторной конфигурации iApp, если шаблон был изменён.
name
обязательно
Имя службы iApp, которую необходимо развернуть.
parameters
Хеш всех необходимых переменных шаблона для шаблона iApp. Если параметры хранятся в файле (более распространённый случай), рекомендуется использовать поиск по `file` или `template`, чтобы предоставить ожидаемые параметры.
Эти параметры обычно содержат поля lists, tables, и variables.
partition
(добавлено в 2.5)
По умолчанию:
"Common"
Раздел устройства для управления ресурсами.
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 установлена.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если переменная среды F5_USER установлена.
validate_certs
bool
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверяться. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами. Можно опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена.
timeout По умолчанию:
10
Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
ssh_keyfile
Указывает файл ключа SSH для аутентификации соединения с удалённым устройством. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
transport
обязательно
    Варианты:
  • rest
  • cli ←
Настраивает транспортное соединение для подключения к удалённому устройству.
server
обязательно
Хост BIG-IP. Можно опустить этот параметр, если переменная среды F5_SERVER установлена.
server_port
(добавлено в 2.2)
По умолчанию:
443
Порт сервера BIG-IP. Можно опустить этот параметр, если переменная среды F5_SERVER_PORT установлена.
state
    Варианты:
  • present ←
  • absent
При значении present, гарантирует создание и запуск службы iApp. При значении absent, гарантирует удаление службы iApp.
strict_updates
bool

(добавлено в 2.5)
    Варианты:
  • no
  • yes ←
Указывает, связана ли служба прикладного уровня с шаблоном, поэтому при обновлении шаблона служба прикладного уровня меняется для отражения обновлений.
При значении yes, запрещает любые обновления ресурсов, созданных службой iApp, если они не обновляются непосредственно через iApp.
При значении no, разрешает обновления вне iApp.
Если этот параметр указан в задаче Ansible, он имеет приоритет над любым аналогичным параметром в полезной нагрузке сервера iApp, указанной в поле parameters.
template
Шаблон iApp, на основе которого создаётся новая служба. Этот шаблон должен существовать на BIG-IP, прежде чем вы сможете успешно создать службу. Этот параметр обязателен, если параметр state имеет значение present.
traffic_group
(добавлено в 2.5)
Группа трафика для службы iApp. При создании новой службы, если это значение не указано, используется значение по умолчанию /Common/traffic-group-1.
Если этот параметр указан в задаче Ansible, он имеет приоритет над любым аналогичным параметром в полезной нагрузке сервера iApp, указанной в поле parameters.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если переменная среды F5_USER установлена.
validate_certs
bool

(добавлено в 2.0)
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверяться. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами. Можно опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.

Примеры

- 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

Статус

Этот модуль помечен как stableinterface, что означает, что авторы этого модуля гарантируют, что не будут вноситься несовместимые изменения в интерфейс.

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

  • 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.6/modules/bigip_iapp_service_module.html

Spec-Zone.ru

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