Модуль community.network.avi_pkiprofile – Модуль для настройки объекта PKIProfile Avi RESTful
Примечание
Этот модуль входит в коллекцию community.network (версия 5.0.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в плейбуке укажите: community.network.avi_pkiprofile.
Описание
- Этот модуль используется для настройки объекта PKIProfile
- Дополнительные примеры на https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_pkiprofile
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст API Avi, который включает текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. |
api_version строка | Версия 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 Controller. |
|
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 в качестве факта. Варианты:
|
ca_certs строка | Список доверенных центров сертификации (корневые и промежуточные), используемых для проверки сертификата. |
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения |
created_by строка | Имя создателя. |
crl_check булево | При включении Avi проверит с помощью проверок CRL, что сертификаты в цепочке доверия не были отозваны. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты:
|
crls строка | Списки отозванных сертификатов. |
ignore_peer_chain boolean | При включении Avi не будет доверять промежуточным и корневым сертификатам, представленным клиентом. Вместо этого, для проверки подлинности сертификата клиента будут использоваться только цепочки сертификатов, настроенные в разделе сертификационного центра. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты:
|
is_federated boolean | Это поле описывает область репликации объекта. Если поле установлено в false, объект виден внутри кластера контроллера и его связанных сервисных узлов. Если поле установлено в true, объект реплицируется по всей федерации. Поле добавлено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты:
|
name string / обязательно | Имя профиля pki. |
password string | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды |
state string | Состояние, которое должно быть применено к сущности. Варианты:
|
tenant string | Имя клиента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
tenant_ref string | Ссылка на объект типа клиент. |
tenant_uuid string | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
url string | URL контроллера Avi для объекта. |
username string | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды |
uuid string | Уникальный идентификатор объекта. |
validate_only_leaf_crl boolean | При включении 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) Возвращаемое значение: 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_pkiprofile_module.html
