cisco.dnac.sites_time_zone_settings_v1_info 模块 – 站点时区设置 V1 信息模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.dnac.sites_time_zone_settings_v1_info

cisco.dnac 6.15.0 中的新增功能

概要

  • 获取所有站点时区设置 V1。

  • 检索站点的时区设置;`null` 值表示该设置将从父站点继承;空对象 `{}` 表示该设置在站点中未设置。

注意

此模块具有相应的 action 插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

_inherited

布尔型

_inherited 查询参数。包括为此站点明确设置的设置和从站点层次结构中更高层站点继承的设置;当为 `false` 时,`null` 值表示站点从父站点或站点层次结构中更高层站点继承该设置。

选项

  • false

  • true

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

字典

附加标头。

id

字符串

Id 路径参数。站点 ID。

validate_response_schema

布尔型

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

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 network_settings.NetworkSettings.retrieve_time_zone_settings_for_a_site_v1,

  • 使用的路径是 get /dna/intent/api/v1/sites/{id}/timeZoneSettings,

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 关于网络设置 RetrieveTimeZoneSettingsForASiteV1 的文档

RetrieveTimeZoneSettingsForASiteV1 API 的完整参考。

示例

- name: Get all Sites Time Zone Settings V1
  cisco.dnac.sites_time_zone_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}}"
    _inherited: True
    id: string
  register: result

返回值

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

描述

dnac_response

字典

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

返回:始终

示例: {"response": {"timeZone": {"identifier": "string", "inheritedSiteId": "string", "inheritedSiteName": "string"}}, "version": "string"}

作者

  • Rafael Campos (@racampos)