community.network.avi_pkiprofile – Модуль для настройки объекта PKIProfile Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в плейбуке укажите: community.network.avi_pkiprofile.
Обзор
- Этот модуль используется для настройки объекта PKIProfile.
- Дополнительные примеры можно найти на 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 контроллера | ||
| csrftoken строка | CSRF-токен 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 в качестве факта. | |
| ca_certs строка | Список доверенных сертификатов центров сертификации (корневых и промежуточных), используемых для проверки сертификатов. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| created_by строка | Имя создателя. | ||
| crl_check булево |
| При включенном значении avi проверит, не были ли сертификаты в цепочке доверия отозваны с помощью проверок CRL. Значение по умолчанию, когда оно не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| crls строка | Списки отозванных сертификатов. | ||
| ignore_peer_chain булево |
| При включенном значении avi не будет доверять промежуточным и корневым сертификатам, представленным клиентом. Вместо этого для проверки доверия сертификата клиента будут использоваться только сертификаты цепочки, настроенные в разделе сертификата центра сертификации. Значение по умолчанию, когда оно не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| is_federated булево |
| Это поле описывает область репликации объекта. Если поле установлено в значение false, то объект виден внутри кластера контроллера и его связанных сервисных узлов. Если поле установлено в значение true, то объект реплицируется по всей федерации. Поле введено в версии 17.1.3. Значение по умолчанию, когда оно не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| name строка / обязательно | Имя профиля pki. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | По умолчанию: "admin" | Имя тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Это ссылка на объект типа тенент. | ||
| tenant_uuid строка | По умолчанию: "" | UUID тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| url строка | URL контроллера Avi для объекта. | ||
| username строка | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid строка | Уникальный идентификатор объекта. | ||
| validate_only_leaf_crl булево |
| При включенном значении avi будет проверять только статус отзыва листового сертификата с помощью CRL. Чтобы включить проверку для всей цепочки, отключите этот параметр и предоставьте все необходимые списки CRL. Значение по умолчанию, когда оно не указано в API или модуле, интерпретируется контроллером Avi как True. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create PKIProfile object
community.network.avi_pkiprofile:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_pkiprofile
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращенное значение | Описание |
|---|---|---|
| obj словарь | успех, изменен | Объект PKIProfile (api/pkiprofile) |
Авторы
- 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_pkiprofile_module.html
