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

Примечание

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

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

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

Для использования в книге задач укажите: community.network.avi_stringgroup.

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

Описание

Этот модуль используется для настройки объекта StringGroup
больше примеров на https://github.com/avinetworks/devops

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

Требования

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

avisdk

Параметры

Параметр	Комментарии
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 контроллера
csrftoken строка	Токен csrf контроллера Avi API для повторного использования существующей сессии с идентификатором сессии По умолчанию: `""`
password строка	Пароль пользователя Avi в контроллере 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`
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`
description строка	Пользовательское описание объекта.
kv строка	Настройка ключевых значений в группе строк.
name строка / обязательное	Имя группы строк.
password строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`

END_OF_DOCUMENT_MARKER

state string	Состояние, которое должно быть применено к сущности. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant string	Имя клиента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
tenant_ref string	Ссылка на объект типа клиент.
tenant_uuid string	UUID клиента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
type string / обязательно	Тип stringgroup. Варианты перечисления - SG_TYPE_STRING, SG_TYPE_KEYVAL. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как SG_TYPE_STRING.
url string	URL контроллера Avi объекта.
username string	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.
uuid string	Uuid группы строк.

Примечания

Примечание

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

Примеры

- name: Create a string group configuration
  community.network.avi_stringgroup:
    controller: '{{ controller }}'
    password: '{{ password }}'
    username: '{{ username }}'
    kv:
    - key: text/html
    - key: text/xml
    - key: text/plain
    - key: text/css
    - key: text/javascript
    - key: application/javascript
    - key: application/x-javascript
    - key: application/xml
    - key: application/pdf
    name: System-Compressible-Content-Types
    tenant_ref: admin
    type: SG_TYPE_STRING

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

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

Ключ	Описание
obj словарь	Объект StringGroup (api/stringgroup) Возвращается: 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_stringgroup_module.html