cisco.dnac.pnp_global_settings_v1_info 模块 – PnP 全局设置 V1 的信息模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有 PnP 全局设置 V1。

  • 返回用户的全局 PnP 设置。

注意

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

要求

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

  • 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"

headers

字典

其他标头。

validate_response_schema

布尔值

Cisco DNA Center SDK 的标志,用于启用根据 JSON 模式验证请求主体。

选项

  • false

  • true ←(默认)

说明

注意

  • 使用的 SDK 方法是 device_onboarding_pnp.DeviceOnboardingPnp.get_pnp_global_settings_v1,

  • 使用的路径是 get /dna/intent/api/v1/onboarding/pnp-settings,

  • 支持 check_mode

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

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

另请参阅

另请参阅

有关设备加入 (PnP) GetPnPGlobalSettingsV1 的 Cisco DNA Center 文档

GetPnPGlobalSettingsV1 API 的完整参考。

示例

- name: Get all Pnp Global Settings V1
  cisco.dnac.pnp_global_settings_v1_info:
    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}}"
    headers: "{{my_headers | from_json}}"
  register: result

返回值

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

描述

dnac_response

字典

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

返回:始终

示例: {"aaaCredentials": {"password": "string", "username": "string"}, "acceptEula": true, "defaultProfile": {"cert": "string", "fqdnAddresses": ["string"], "ipAddresses": ["string"], "port": 0, "proxy": true}, "id": "string", "savaMappingList": [{"autoSyncPeriod": 0, "ccoUser": "string", "expiry": 0, "lastSync": 0, "profile": {"addressFqdn": "string", "addressIpV4": "string", "cert": "string", "makeDefault": true, "name": "string", "port": 0, "profileId": "string", "proxy": true}, "smartAccountId": "string", "syncResult": {"syncList": [{"deviceSnList": ["string"], "syncType": "string"}], "syncMsg": "string"}, "syncResultStr": "string", "syncStartTime": 0, "syncStatus": "string", "tenantId": "string", "token": "string", "virtualAccountId": "string"}], "taskTimeOuts": {"configTimeOut": 0, "generalTimeOut": 0, "imageDownloadTimeOut": 0}, "tenantId": "string", "version": 0}

作者

  • Rafael Campos (@racampos)