Spec-Zone.ru › Ansible 2.5

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

Новая версия 2.3.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Автор

Обзор

  • Этот модуль используется для настройки объекта 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)
    Варианты:
  • add
  • replace
  • delete
Операция исправления, используемая при использовании avi_api_update_method как patch.
avi_api_update_method
(добавлен в 2.5)
    Варианты:
  • put ←
  • patch
Метод по умолчанию для обновления объекта — HTTP PUT.
Установка в patch изменит это поведение на использование HTTP PATCH.
avi_credentials
(добавлен в 2.5)
Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
ca_certs
Список доверенных центров сертификации (корневых и промежуточных), используемых для проверки сертификатов.
controller По умолчанию:
IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER.
created_by
Имя создателя.
crl_check
    Варианты:
  • no
  • yes
При включении Avi проверит с помощью проверок CRL, не были ли отозваны сертификаты в цепочке доверия.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.
crls
Списки отзыва сертификатов.
ignore_peer_chain
    Варианты:
  • no
  • yes
При включении Avi не будет доверять промежуточным и корневым сертификатам, представленным клиентом.
Вместо этого для проверки доверия к сертификату клиента будут использоваться только сертификаты цепочки, настроенные в разделе центра сертификации.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
is_federated
(добавлен в 2.4)
    Варианты:
  • no
  • yes
Это поле описывает область репликации объекта.
Если поле установлено в false, объект виден внутри кластера контроллера и его связанных движков службы.
Если поле установлено в true, объект реплицируется по всей федерации.
Поле добавлено в 17.1.3.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
name
обязательно
Имя профиля pki.
password По умолчанию:
Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD.
state
    Варианты:
  • absent
  • present ←
Состояние, которое должно быть применено к сущности.
tenant По умолчанию:
admin
Имя арендатора, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref
Ссылка на объект типа арендатор.
tenant_uuid По умолчанию:
UUID арендатора, используемого для всех вызовов API Avi и контекста объекта.
url
URL контроллера Avi объекта.
username По умолчанию:
Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME.
uuid
Уникальный идентификатор объекта.
validate_only_leaf_crl
    Варианты:
  • no
  • yes
При включении 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
dict
success, changed
Объект PKIProfile (api/pkiprofile)



Статус

Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется обратной совместимостью.

Автор

  • Г. Растоги (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.5/modules/avi_pkiprofile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API