avi_pkiprofile – Модуль для настройки PKIProfile Avi RESTful объекта
Обзор
- Этот модуль используется для настройки объекта PKIProfile
- больше примеров на 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 как patch. | |
| avi_api_update_method - добавлен в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка на patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь добавлен в 2.5 | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version - | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера Avi | ||
| csrftoken - | Маркер API контроллера Avi csrftoken для повторного использования существующего сеанса с идентификатором сеанса | ||
| password - | Пароль контроллера 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 булево добавлен в 2.6 |
| Отключает кэширование информации о сеансе Avi в качестве факта. | |
| ca_certs - | Список доверенных центров сертификации (корневых и промежуточных), используемых для проверки сертификатов. | ||
| controller строка | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| created_by - | Имя создателя. | ||
| crl_check булево |
| При включении Avi проверит, не были ли сертификаты в цепочке доверия отозваны с помощью проверок CRL. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| crls - | Списки отозванных сертификатов (CRL). | ||
| ignore_peer_chain булево |
| При включении Avi не будет доверять промежуточным и корневым сертификатам, представленным клиентом. Вместо этого будут использоваться только сертификаты цепочки, настроенные в разделе центра сертификации, для проверки доверия к сертификату клиента. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| is_federated булево добавлен в 2.4 |
| Это поле описывает область репликации объекта. Если поле установлено в 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 см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create PKIProfile object
avi_pkiprofile:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_pkiprofile
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | success, changed | Объект PKIProfile (api/pkiprofile) |
Состояние
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается Сообществом Ansible. [community]
Авторы
- 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.9/modules/avi_pkiprofile_module.html
