Spec-Zone.ru › Ansible

Модуль community.network.avi_applicationprofile — Модуль для настройки объекта ApplicationProfile Avi RESTful

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

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

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробностей.

Для использования в playbook укажите: community.network.avi_applicationprofile.

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

Обзор

  • Этот модуль используется для конфигурации объекта ApplicationProfile
  • дополнительные примеры на https://github.com/avinetworks/devops

Псевдонимы: network.avi.avi_applicationprofile

Требования

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

  • avisdk
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

api_context

словарь

Контекст Avi API, включающий текущий идентификатор сеанса и маркер CSRF.

Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс.

api_version

строка

Версия Avi API для использования с Avi API и объектами.

Значение по умолчанию: "16.4.4"

avi_api_patch_op

строка

Операция исправления, используемая при использовании avi_api_update_method как исправление.

Возможные значения:

  • "add"
  • "replace"
  • "delete"

avi_api_update_method

строка

Метод обновления объекта по умолчанию — HTTP PUT.

Установка в «patch» переопределит это поведение, используя HTTP PATCH.

Возможные значения:

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

avi_credentials

словарь

Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в систему контроллера Avi.

api_version

строка

Версия контроллера Avi

Значение по умолчанию: "16.4.4"

controller

строка

IP-адрес или SQDN контроллера

csrftoken

строка

Маркер CSRF API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса

Значение по умолчанию: ""

password

строка

Пароль контроллера Avi

port

строка

Порт контроллера Avi

session_id

строка

Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken

Значение по умолчанию: ""

tenant

строка

Тенент контроллера Avi

Значение по умолчанию: "admin"

tenant_uuid

строка

UUID тенента контроллера Avi

Значение по умолчанию: ""

timeout

строка

Таймаут запроса контроллера Avi

Значение по умолчанию: 300

token

строка

Токен API контроллера Avi

Значение по умолчанию: ""

username

строка

Имя пользователя контроллера Avi

avi_disable_session_cache_as_fact

булево

Отключает кеширование информации о сеансе Avi в качестве факта.

Возможные значения:

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

cloud_config_cksum

строка

Контрольная сумма профилей приложений.

Внутренне устанавливается облачным соединителем.

Поле введено в 17.2.14, 18.1.5, 18.2.1.

controller

строка

IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER

created_by

строка

Имя создателя профиля приложения.

Поле введено в 17.2.14, 18.1.5, 18.2.1.

description

строка

Определяемое пользователем описание объекта.

dns_service_profile

строка

Указывает различные параметры, связанные с DNS-сервисом, для виртуальной службы.

END_OF_DOCUMENT_MARKER

dos_rl_profile

string

Определяет различные связанные с безопасностью параметры для виртуальной службы.

http_profile

string

Указывает параметры профиля прокси-сервера HTTP-приложения.

name

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

Имя профиля приложения.

password

string

Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD.

preserve_client_ip

boolean

Указывает, нужно ли сохранять IP-адрес клиента для подключения к бэкенду.

Несовместимо с многопоточным подключением.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

  • false
  • true

preserve_client_port

boolean

Указывает, нужно ли сохранить порт клиента при сохранении IP-адреса клиента для подключений к бэкенду.

Поле введено в 17.2.7.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

  • false
  • true

sip_service_profile

string

Указывает различные параметры, связанные с профилем SIP-службы для виртуальной службы.

Поле введено в 17.2.8, 18.1.3, 18.2.1.

state

string

Состояние, которое должно быть применено к сущности.

Варианты:

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

tcp_app_profile

string

Указывает параметры профиля прокси-сервера TCP-приложения.

tenant

string

Имя клиента, используемого для всех вызовов API Avi и контекста объекта.

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

tenant_ref

string

Ссылка на объект типа клиент.

tenant_uuid

string

UUID клиента, используемого для всех вызовов API Avi и контекста объекта.

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

type

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

Указывает, какой прокси-сервер прикладного уровня включен для виртуальной службы.

Варианты перечисления - APPLICATION_PROFILE_TYPE_L4, APPLICATION_PROFILE_TYPE_HTTP, APPLICATION_PROFILE_TYPE_SYSLOG, APPLICATION_PROFILE_TYPE_DNS,

APPLICATION_PROFILE_TYPE_SSL, APPLICATION_PROFILE_TYPE_SIP.

url

string

URL контроллера Avi для объекта.

username

string

Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME.

uuid

string

UUID профиля приложения.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Create an Application Profile for HTTP application enabled for SSL traffic
  community.network.avi_applicationprofile:
    controller: '{{ controller }}'
    username: '{{ username }}'
    password: '{{ password }}'
    http_profile:
      cache_config:
        age_header: true
        aggressive: false
        date_header: true
        default_expire: 600
        enabled: false
        heuristic_expire: false
        max_cache_size: 0
        max_object_size: 4194304
        mime_types_group_refs:
        - admin:System-Cacheable-Resource-Types
        min_object_size: 100
        query_cacheable: false
        xcache_header: true
      client_body_timeout: 0
      client_header_timeout: 10000
      client_max_body_size: 0
      client_max_header_size: 12
      client_max_request_size: 48
      compression_profile:
        compressible_content_ref: admin:System-Compressible-Content-Types
        compression: false
        remove_accept_encoding_header: true
        type: AUTO_COMPRESSION
      connection_multiplexing_enabled: true
      hsts_enabled: false
      hsts_max_age: 365
      http_to_https: false
      httponly_enabled: false
      keepalive_header: false
      keepalive_timeout: 30000
      max_bad_rps_cip: 0
      max_bad_rps_cip_uri: 0
      max_bad_rps_uri: 0
      max_rps_cip: 0
      max_rps_cip_uri: 0
      max_rps_unknown_cip: 0
      max_rps_unknown_uri: 0
      max_rps_uri: 0
      post_accept_timeout: 30000
      secure_cookie_enabled: false
      server_side_redirect_to_https: false
      spdy_enabled: false
      spdy_fwd_proxy_mode: false
      ssl_client_certificate_mode: SSL_CLIENT_CERTIFICATE_NONE
      ssl_everywhere_enabled: false
      websockets_enabled: true
      x_forwarded_proto_enabled: false
      xff_alternate_name: X-Forwarded-For
      xff_enabled: true
    name: System-HTTP
    tenant_ref: admin
    type: APPLICATION_PROFILE_TYPE_HTTP

Значения возврата

Общие значения возврата описаны в здесь, следующие поля уникальны для этого модуля:

Ключ

Описание

obj

словарь

Объект ApplicationProfile (api/applicationprofile)

Возвращается: успех, изменилось

Авторы

  • Gaurav Rastogi (@grastogi23)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (исходные коды)

© 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/community/network/avi_applicationprofile_module.html

Spec-Zone.ru

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