community.network.avi_pkiprofile 模块 – 用于设置 PKIProfile Avi RESTful 对象的模块

注意

此模块是 community.network 集合（版本 5.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.network。您需要满足其他要求才能使用此模块，请参阅 要求了解详细信息。

要在 playbook 中使用它，请指定：community.network.avi_pkiprofile。

注意

community.network 集合已弃用，并将从 Ansible 12 中删除。有关详细信息，请参阅讨论主题。

已弃用

在以下版本中删除：

版本 6.0.0

原因：

此集合及其中的所有内容均未维护且已弃用。

替代方案：

未知。

概要

别名：network.avi.avi_pkiprofile

要求

执行此模块的主机需要满足以下要求。

  • avisdk

参数

参数

注释

api_context

字典

Avi API 上下文，包括当前会话 ID 和 CSRF 令牌。

这允许用户执行单点登录并重用会话。

api_version

字符串

用于 Avi API 和对象的 Avi API 版本。

默认值： "16.4.4"

avi_api_patch_op

字符串

当使用 avi_api_update_method 作为 patch 时要使用的 Patch 操作。

选项

  • "add"

  • "replace"

  • "delete"

avi_api_update_method

字符串

对象更新的默认方法是 HTTP PUT。

设置为 patch 将覆盖该行为以使用 HTTP PATCH。

选项

  • "put" ← (默认)

  • "patch"

avi_credentials

字典

Avi 凭证字典，可用于代替枚举 Avi 控制器登录详细信息。

api_version

字符串

Avi 控制器版本

默认值： "16.4.4"

controller

字符串

Avi 控制器 IP 或 SQDN

csrftoken

字符串

Avi 控制器 API csrftoken，用于重用具有会话 ID 的现有会话

默认值： ""

password

字符串

Avi 控制器密码

port

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API 会话 ID，用于重用具有 csrftoken 的现有会话

默认值： ""

tenant

字符串

Avi 控制器租户

默认值： "admin"

tenant_uuid

字符串

Avi 控制器租户 UUID

默认值： ""

timeout

字符串

Avi 控制器请求超时

默认值： 300

token

字符串

Avi 控制器 API 令牌

默认值： ""

username

字符串

Avi 控制器用户名

avi_disable_session_cache_as_fact

布尔值

它禁用将 avi 会话信息缓存为事实。

选项

  • false ← (默认)

  • true

ca_certs

字符串

用于证书验证的受信任的证书颁发机构（根证书和中间证书）列表。

controller

字符串

控制器的 IP 地址或主机名。默认值为环境变量 AVI_CONTROLLER。

created_by

字符串

创建者名称。

crl_check

布尔值

启用后，avi 将通过 crl 检查来验证信任链中的证书是否已被吊销。

在 API 或模块中未指定时的默认值由 Avi 控制器解释为 True。

选项

  • false

  • true

crls

字符串

证书吊销列表。

ignore_peer_chain

布尔值

启用后，avi 将不信任客户端提供的中间证书和根证书。

相反，只有在证书颁发机构部分配置的链式证书才用于验证客户端证书的信任。

在 API 或模块中未指定时的默认值由 Avi 控制器解释为 False。

选项

  • false

  • true

is_federated

布尔值

此字段描述对象的复制范围。

如果该字段设置为 false，则该对象在控制器集群及其关联的服务引擎中可见。

如果该字段设置为 true，则该对象会在联邦中复制。

该字段在 17.1.3 中引入。

在 API 或模块中未指定时的默认值由 Avi 控制器解释为 False。

选项

  • false

  • true

name

字符串 / 必需

pki 配置文件的名称。

password

字符串

Avi 控制器中 Avi 用户的密码。默认值为环境变量 AVI_PASSWORD。

state

字符串

应在实体上应用的状态。

选项

  • "absent"

  • "present" ← (默认)

tenant

字符串

用于所有 Avi API 调用和对象上下文的租户的名称。

默认值： "admin"

tenant_ref

字符串

它是对类型为 tenant 的对象的引用。

tenant_uuid

字符串

用于所有 Avi API 调用和对象上下文的租户的 UUID。

默认值： ""

url

字符串

对象的 Avi 控制器 URL。

username

字符串

用于访问 Avi 控制器的用户名。默认值是环境变量 AVI_USERNAME。

uuid

字符串

对象的唯一标识符。

validate_only_leaf_crl

布尔值

启用后，avi 将仅使用 crl 验证叶子证书的吊销状态。

要启用整个链的验证，请禁用此选项并提供所有相关的 crl。

在 API 或模块中未指定时的默认值由 Avi 控制器解释为 True。

选项

  • false

  • true

备注

注意

示例

- 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) 对象

返回: 成功，已更改

状态

  • 此模块将在 6.0.0 版本中删除。[已弃用]

  • 有关更多信息，请参见 已弃用。

作者

  • Gaurav Rastogi (@grastogi23)