community.network.avi_certificatemanagementprofile – Модуль для настройки объекта CertificateManagementProfile Avi RESTful
Примечание
Этот плагин является частью коллекции community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.avi_certificatemanagementprofile.
Обзор
- Этот модуль используется для конфигурации объекта CertificateManagementProfile.
- Дополнительные примеры см. на странице https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. | |
| avi_api_patch_op строка |
| Операция исправления, которая будет использоваться при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка значения в patch приведет к изменению этого поведения на использование HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в Avi-контроллер. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера Avi | ||
| csrftoken строка | Маркер csrftoken API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса. | ||
| password строка | Пароль пользователя Avi в контроллере Avi. | ||
| port строка | Порт контроллера Avi | ||
| session_id строка | Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с маркер csrftoken. | ||
| tenant строка | Значение по умолчанию: "admin" | Тенент контроллера Avi | |
| tenant_uuid строка | UUID-идентификатор арендатора контроллера Avi. | ||
| timeout строка | Значение по умолчанию: 300 | Таймаут запроса контроллера Avi. | |
| token строка | Токен API контроллера Avi. | ||
| username строка | Имя пользователя контроллера Avi. | ||
| avi_disable_session_cache_as_fact булево |
| Отключает кэширование информации о сеансе Avi в качестве факта. | |
| controller строка | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| name строка / обязательно | Имя профиля pki. | ||
| password строка | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| script_params строка | Список пользовательских параметров. | ||
| script_path строка / обязательно | Путь к скрипту certificatemanagementprofile. | ||
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | Значение по умолчанию: "admin" | Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Ссылка на объект типа арендатор. | ||
| tenant_uuid строка | Значение по умолчанию: "" | UUID-идентификатор арендатора, используемого для всех вызовов API Avi и контекста объекта. | |
| url строка | URL контроллера Avi для объекта. | ||
| username строка | Значение по умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid строка | Уникальный идентификатор объекта. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create CertificateManagementProfile object
community.network.avi_certificatemanagementprofile:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_certificatemanagementprofile
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменен | Объект CertificateManagementProfile (api/certificatemanagementprofile) |
Авторы
- Gaurav Rastogi (@grastogi23) <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.10/collections/community/network/avi_certificatemanagementprofile_module.html
