cisco.ise.csr_generate 模块 – 用于 CSR 生成的资源模块

注意

此模块是 cisco.ise 集合(版本 2.9.6)的一部分。

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

要安装它,请使用:ansible-galaxy collection install cisco.ise。您需要进一步的要求才能使用此模块,请参阅 要求 以获取详细信息。

要在 playbook 中使用它,请指定:cisco.ise.csr_generate

cisco.ise 1.0.0 中的新功能

概要

  • 管理资源 CSR 生成的创建操作。

  • 为多用途、管理员、EAP 生成证书签名请求。

注意

此模块有一个相应的 操作插件

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

allowWildCardCert

boolean

AllowWildCardCert 标志。

选择

  • false

  • true

certificatePolicies

string

CSR 生成的 certificatePolicies。

digestType

string

CSR 生成的 digestType。

hostnames

list / elements=string

CSR 生成的 hostnames。

ise_debug

boolean

用于启用调试的 Identity Services Engine SDK 标志。

选择

  • false ← (默认)

  • true

ise_hostname

string / 必填

Identity Services Engine 主机名。

ise_password

string / 必填

用于身份验证的 Identity Services Engine 密码。

ise_single_request_timeout

integer

在 cisco.ise 3.0.0 中添加

RESTful HTTP 请求的超时时间(以秒为单位)。

默认值: 60

ise_username

string / 必填

用于身份验证的 Identity Services Engine 用户名。

ise_uses_api_gateway

boolean

在 cisco.ise 1.1.0 中添加

通知 SDK 是否使用 Identity Services Engine 的 API 网关发送请求的标志。

如果为 true,则使用 ISE 的 API 网关并将请求发送到 https://{{ise_hostname}}。

如果为 false,则将请求发送到 https://{{ise_hostname}}:{{port}},其中端口值取决于使用的服务(ERS、Mnt、UI、PxGrid)。

选择

  • false

  • true ← (默认)

ise_uses_csrf_token

boolean

在 cisco.ise 3.0.0 中添加

通知 SDK 是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。

如果为 True,则 SDK 假定您的 ISE CSRF 检查已启用。

如果为 True,则假定您需要 SDK 为您自动管理 CSRF 令牌。

选择

  • false ← (默认)

  • true

ise_verify

boolean

启用或禁用 SSL 证书验证的标志。

选择

  • false

  • true ← (默认)

ise_version

string

通知 SDK 要使用的 Identity Services Engine 版本。

默认值: "3.1_Patch_1"

ise_wait_on_rate_limit

boolean

用于启用自动速率限制处理的 Identity Services Engine SDK 标志。

选择

  • false

  • true ← (默认)

keyLength

string

CSR 生成的 keyLength。

keyType

string

CSR 生成的 keyType。

portalGroupTag

string

CSR 生成的 portalGroupTag。

sanDir

list / elements=string

CSR 生成的 sanDir。

sanDNS

list / elements=string

CSR 生成的 sanDNS。

sanIP

list / elements=string

CSR 生成的 sanIP。

sanURI

list / elements=string

CSR 生成的 sanURI。

subjectCity

string

CSR 生成的 subjectCity。

subjectCommonName

string

CSR 生成的 subjectCommonName。

subjectCountry

string

CSR 生成的 subjectCountry。

subjectOrg

string

CSR 生成的 subjectOrg。

subjectOrgUnit

string

CSR 生成的 subjectOrgUnit。

subjectState

string

CSR 生成的 subjectState。

usedFor

string

CSR 生成的 usedFor。

注释

注意

  • 使用的 SDK 方法是 certificates.Certificates.generate_csr,

  • 使用的路径是 post /api/v1/certs/certificate-signing-request,

  • 不支持 check_mode

  • 该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco ISE SDK 中的嵌入式连接管理器

  • 以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

另请参阅

另请参阅

Cisco ISE 证书文档

证书 API 的完整参考。

示例

- name: Create
  cisco.ise.csr_generate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    allowWildCardCert: true
    certificatePolicies: string
    digestType: string
    hostnames:
    - string
    keyLength: string
    keyType: string
    portalGroupTag: string
    sanDNS:
    - string
    sanDir:
    - string
    sanIP:
    - string
    sanURI:
    - string
    subjectCity: string
    subjectCommonName: string
    subjectCountry: string
    subjectOrg: string
    subjectOrgUnit: string
    subjectState: string
    usedFor: string

返回值

通用返回值记录在此处,以下是此模块独有的字段

描述

ise_response

dictionary

由 Cisco ISE Python SDK 返回的响应的字典或列表

返回: 始终

示例: {"response": [{"id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "message": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)