community.network.avi_pkiprofile – Модуль для настройки объекта PKIProfile Avi RESTful

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

Для его установки используйте: 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 строка		Варианты: add replace delete	Операция исправления, используемая при использовании avi_api_update_method как patch.
avi_api_update_method строка		Варианты: put ← patch	Метод по умолчанию для обновления объекта — HTTP PUT. Указание patch изменит поведение на использование HTTP PATCH.
avi_credentials словарь			Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в Avi Controller.
	api_version строка	По умолчанию: "16.4.4"	Версия контроллера Avi
	controller строка		IP-адрес или SQDN контроллера
	csrftoken строка		Маркер CSRF API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса
	password строка		Пароль пользователя Avi в контроллере Avi
	port строка		Порт контроллера Avi
	session_id строка		Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с маркер csrf
	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.
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_pkiprofile_module.html