avi_stringgroup - Модуль для настройки объекта StringGroup Avi RESTful
Новый в версии 2.4.
Обзор
- Этот модуль используется для настройки объекта StringGroup.
- Дополнительные примеры на странице https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
api_context
(добавлено в 2.5)
|
Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF.
Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
|
|
| api_version | Значение по умолчанию: "16.4.4" |
Версия API Avi, используемая для API Avi и объектов. |
|
avi_api_patch_op
(добавлено в 2.5)
|
|
Операция исправления, используемая при использовании avi_api_update_method в качестве исправления.
|
|
avi_api_update_method
(добавлено в 2.5)
|
|
Метод по умолчанию для обновления объекта — HTTP PUT.
Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH.
|
|
avi_credentials
(добавлено в 2.5)
|
Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
|
|
| controller | Значение по умолчанию: "" |
IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. |
| description | Определяемая пользователем информация об объекте. |
|
| kv | Настройка пары ключ-значение в группе строк. |
|
| name
обязательно
|
Имя группы строк. |
|
| password | Значение по умолчанию: "" |
Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. |
| state |
|
Состояние, которое должно быть применено к сущности. |
| tenant | Значение по умолчанию: "admin" |
Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. |
| tenant_ref | Ссылка на объект типа арендатор. |
|
| tenant_uuid | Значение по умолчанию: "" |
UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. |
|
type
обязательно
|
Тип группы строк.
Варианты перечисления — SG_TYPE_STRING, SG_TYPE_KEYVAL.
Значение по умолчанию, когда оно не указано в API или модуле, интерпретируется контроллером Avi как SG_TYPE_STRING.
|
|
| url | URL контроллера Avi объекта. |
|
| username | Значение по умолчанию: "" |
Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. |
| uuid | UUID группы строк. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Create a string group configuration
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
dict
|
success, changed |
Объект StringGroup (api/stringgroup)
|
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительная информация приведена на странице Поддержка и техническое обслуживание модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Gaurav Rastogi (grastogi@avinetworks.com)
Подсказка
Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/avi_stringgroup_module.html