Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.network.avi_httppolicyset.

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

Описание

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

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

Требования

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

  • avisdk
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

api_context

словарь

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

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

api_version

строка

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

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

avi_api_patch_op

строка

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

Варианты:

  • "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 контроллера Avi

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

строка

Контрольная сумма конфигурации облака для пула.

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

controller

строка

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

created_by

строка

Имя создателя.

description

строка

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

http_request_policy

строка

Политика HTTP-запроса для виртуальной службы.

http_response_policy

строка

Политика HTTP-ответа для виртуальной службы.

END_OF_DOCUMENT_MARKER

http_security_policy

string

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

is_internal_policy

boolean

Логический флаг для установки is_internal_policy.

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

Варианты:

  • false
  • true

name

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

Имя набора политик HTTP.

password

string

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

state

string

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

Варианты:

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

tenant

string

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

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

tenant_ref

string

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

tenant_uuid

string

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

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

url

string

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

username

string

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

uuid

string

Uuid набора политик HTTP.

Примечания

Примечание

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

Примеры

- name: Create a HTTP Policy set two switch between testpool1 and testpool2
  community.network.avi_httppolicyset:
    controller: 10.10.27.90
    username: admin
    password: AviNetworks123!
    name: test-HTTP-Policy-Set
    tenant_ref: admin
    http_request_policy:
    rules:
      - index: 1
        enable: true
        name: test-test1
        match:
          path:
            match_case: INSENSITIVE
            match_str:
              - /test1
            match_criteria: EQUALS
        switching_action:
          action: HTTP_SWITCHING_SELECT_POOL
          status_code: HTTP_LOCAL_RESPONSE_STATUS_CODE_200
          pool_ref: "/api/pool?name=testpool1"
      - index: 2
        enable: true
        name: test-test2
        match:
          path:
            match_case: INSENSITIVE
            match_str:
              - /test2
            match_criteria: CONTAINS
        switching_action:
          action: HTTP_SWITCHING_SELECT_POOL
          status_code: HTTP_LOCAL_RESPONSE_STATUS_CODE_200
          pool_ref: "/api/pool?name=testpool2"
    is_internal_policy: false

Возвращаемые значения

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

Ключ

Описание

obj

словарь

Объект HTTPPolicySet (api/httppolicyset)

Возвращаемое значение: success, changed

Авторы

  • 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_httppolicyset_module.html

Spec-Zone.ru

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