community.network.avi_vsdatascriptset модуль – Модуль для настройки объекта VSDataScriptSet Avi RESTful
Примечание
Этот модуль является частью коллекции community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в книге задач, укажите: community.network.avi_vsdatascriptset.
Описание
- Этот модуль используется для настройки объекта VSDataScriptSet
- Дополнительные примеры по адресу https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_vsdatascriptset
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст Avi API, содержащий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. |
api_version строка | Версия Avi API, используемая для Avi API и объектов. По умолчанию: |
avi_api_patch_op строка | Операция исправления, используемая при использовании avi_api_update_method как исправления. Варианты:
|
avi_api_update_method строка | Метод по умолчанию для обновления объекта — HTTP PUT. Установка на исправление переопределит это поведение для использования HTTP PATCH. Варианты:
|
avi_credentials словарь | Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в контроллер Avi. |
|
api_version строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера |
|
csrftoken строка |
CSRF-токен API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса По умолчанию: |
|
password строка |
Пароль контроллера Avi |
|
port строка |
Порт контроллера Avi |
|
session_id строка |
Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken По умолчанию: |
|
tenant строка |
Подписчик контроллера Avi По умолчанию: |
|
tenant_uuid строка |
UUID подписчика контроллера Avi По умолчанию: |
|
timeout строка |
Таймаут запроса контроллера Avi По умолчанию: |
|
token строка |
Токен API контроллера Avi По умолчанию: |
|
username строка |
Имя пользователя контроллера Avi |
avi_disable_session_cache_as_fact булево | Отключает кэширование информации о сеансе avi в качестве факта. Варианты:
|
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения |
created_by строка | Имя создателя. Поле добавлено в 17.1.11, 17.2.4. |
datascript строка | Сценарии данных для выполнения. |
description строка | Определяемое пользователем описание объекта. |
ipgroup_refs строка | UUID групп IP, которые могут быть указаны в объектах vsdatascriptset. Это ссылка на объект типа ipaddrgroup. |
name string / обязательно | Имя набора данных виртуальной службы. |
password строка | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения |
pool_group_refs строка | Идентификатор набора пулов, которые могут быть указаны в объектах vsdatascriptset. Это ссылка на объект типа poolgroup. |
pool_refs строка | Идентификатор пулов, которые могут быть указаны в объектах vsdatascriptset. Это ссылка на объект типа pool. |
protocol_parser_refs строка | Список парсеров протоколов, которые могут быть указаны в объектах vsdatascriptset. Это ссылка на объект типа protocolparser. Поле введено в версии 18.2.3. |
state строка | Состояние, которое должно быть применено к сущности. Варианты:
|
string_group_refs строка | Идентификатор наборов строк, которые могут быть указаны в объектах vsdatascriptset. Это ссылка на объект типа stringgroup. |
tenant строка | Имя клиента, используемое для всех вызовов API Avi и контекста объекта. По умолчанию: |
tenant_ref строка | Это ссылка на объект типа клиент. |
tenant_uuid строка | Идентификатор клиента, используемый для всех вызовов API Avi и контекста объекта. По умолчанию: |
url строка | URL контроллера Avi для объекта. |
username строка | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения |
uuid строка | Идентификатор набора данных виртуальной службы. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create VSDataScriptSet object
community.network.avi_vsdatascriptset:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_vsdatascriptset
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
obj словарь | Объект VSDataScriptSet (api/vsdatascriptset) Возвращается: success, changed |
Ссылки на сборку
© 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_vsdatascriptset_module.html