community.network.avi_sslkeyandcertificate 模块 – 用于设置 SSLKeyAndCertificate Avi RESTful 对象的模块

注意

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

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

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

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

注意

community.network 集合已被弃用，并将从 Ansible 12 中移除。请参阅 讨论主题 获取更多信息。

已弃用

在以下版本中移除：

6.0.0 版

原因：

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

替代方案：

未知。

概要

别名：network.avi.avi_sslkeyandcertificate

要求

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

  • avisdk

参数

参数

注释

api_context

字典

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

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

api_version

字符串

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

默认值： "16.4.4"

avi_api_patch_op

字符串

将 avi_api_update_method 设置为 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，用于与 session id 一起重用现有会话

默认值： ""

password

字符串

Avi 控制器密码

port

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API session id，用于与 csrftoken 一起重用现有会话

默认值： ""

tenant

字符串

Avi 控制器租户

默认值： "admin"

tenant_uuid

字符串

Avi 控制器租户 UUID

默认值： ""

timeout

字符串

Avi 控制器请求超时

默认值： 300

token

字符串

Avi 控制器 API 令牌

默认值： ""

username

字符串

Avi 控制器用户名

avi_disable_session_cache_as_fact

布尔值

它禁用将 avi 会话信息缓存在 fact 中。

选项

  • false ← (默认)

  • true

ca_certs

字符串

证书链中的 CA 证书。

certificate

字符串 / 必需

sslkeyandcertificate 的 sslcertificate 设置。

certificate_base64

布尔值

证书是否为 base64 编码。

在 18.1.2、18.2.1 中引入的字段。

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

选项

  • false

  • true

certificate_management_profile_ref

字符串

它是 certificatemanagementprofile 类型对象的引用。

controller

字符串

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

created_by

字符串

创建者姓名。

dynamic_params

字符串

证书管理配置文件所需的动态参数。

enckey_base64

字符串

与私钥对应的加密私钥（例如

由 HSM（如 Thales nShield）生成的那些）。

enckey_name

字符串

加密私钥的名称（例如

由 HSM（如 Thales nShield）生成的那些）。

format

字符串

密钥/证书文件的格式。

枚举选项 - SSL_PEM、SSL_PKCS12。

在 18.1.2、18.2.1 中引入的字段。

未在 API 或模块中指定时的默认值由 Avi Controller 解释为 SSL_PEM。

hardwaresecuritymodulegroup_ref

字符串

这是对硬件安全模块组类型对象的引用。

密钥

字符串

私钥。

key_base64

布尔值

指示私钥是否为base64编码。

在 18.1.2、18.2.1 中引入的字段。

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

选项

  • false

  • true

key_params

字符串

sslkeyandcertificate的Sslkeyparams设置。

key_passphrase

字符串

用于加密私钥的密码。

在 18.1.2、18.2.1 中引入的字段。

名称

字符串 / 必需

对象的名称。

password

字符串

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

状态

字符串

应应用于实体的状态。

选项

  • “不存在”

  • "存在" ← (默认)

状态

字符串

枚举选项 - ssl_certificate_finished, ssl_certificate_pending。

在API或模块中未指定时的默认值，Avi Controller将其解释为SSL_CERTIFICATE_FINISHED。

tenant

字符串

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

默认值： "admin"

tenant_ref

字符串

这是对租户类型对象的引用。

tenant_uuid

字符串

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

默认值： ""

类型

字符串

枚举选项 - ssl_certificate_type_virtualservice, ssl_certificate_type_system, ssl_certificate_type_ca。

URL

字符串

对象的Avi控制器URL。

username

字符串

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

UUID

字符串

对象的唯一对象标识符。

注释

注意

示例

- name: Create a SSL Key and Certificate
  community.network.avi_sslkeyandcertificate:
    controller: 10.10.27.90
    username: admin
    password: AviNetworks123!
    key: |
        -----BEGIN PRIVATE KEY-----
        ....
        -----END PRIVATE KEY-----
    certificate:
        self_signed: true
        certificate: |
          -----BEGIN CERTIFICATE-----
          ....
          -----END CERTIFICATE-----
    type: SSL_CERTIFICATE_TYPE_VIRTUALSERVICE
    name: MyTestCert

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键

描述

obj

字典

SSLKeyAndCertificate (api/sslkeyandcertificate) 对象

返回：成功，已更改

状态

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

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

作者

  • Gaurav Rastogi (@grastogi23)