cisco.dnac.auth_token_create_v1 模块 – 用于创建 Auth Token V1 的资源模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:cisco.dnac.auth_token_create_v1

cisco.dnac 6.14.0 中的新功能

概要

  • 管理资源 Auth Token Create V1 的创建操作。

  • 用于获取访问令牌的 API,该令牌有效期为 1 小时。所有 Cisco DNA Center API 调用都需要将使用此 API 获取的令牌设置为 X-Auth-Token HTTP 标头的值。

注意

此模块具有相应的 操作插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

dnac_debug

布尔值

用于 Cisco DNA Center SDK 启用调试的标志。

选项

  • false ← (默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认值: 443

dnac_username

别名:user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认值: "admin"

dnac_verify

布尔值

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

选项

  • false

  • true ← (默认)

dnac_version

字符串

通知 SDK 要使用的 Cisco DNA Center 版本。

默认值: "2.3.7.6"

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 启用针对 JSON 模式验证请求正文的标志。

选项

  • false

  • true ← (默认)

注意

注意

  • 使用的 SDK 方法是 authentication.Authentication.authentication_api_v1,

  • 使用的路径是 post /dna/system/api/v1/auth/token,

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,关于身份验证 AuthenticationAPIV1

AuthenticationAPIV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.auth_token_create_v1:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"

返回值

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

描述

dnac_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表

返回: 始终

示例: {"Token": "string"}

作者

  • Rafael Campos (@racampos)