cisco.dnac.network_update_v1 模块 – 用于网络更新 V1 的资源模块

注意

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

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

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

要在 Playbook 中使用它，请指定：cisco.dnac.network_update_v1。

cisco.dnac 3.1.0 中的新增功能

概要 

管理资源网络更新 V1 的操作更新。
用于更新 DHCP、Syslog、SNMP、NTP、网络 AAA、客户端和端点 AAA 和/或 DNS 服务器设置的网络设置的 API。

注意

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

要求 

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

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"`
设置字典	网络更新的设置。
clientAndEndpoint_aaa 字典	网络更新的 clientAndEndpoint_aaa。
ipAddress 字符串	ISE 服务器的 IP 地址（例如 1.1.1.4）。
network 字符串	AAA 或 ISE 服务器的 IP 地址（例如 2.2.2.1）。
protocol 字符串	AAA 或 ISE 服务器的协议（例如 RADIUS）。
servers 字符串	服务器类型 AAA 或 ISE 服务器（例如 AAA）。
sharedSecret 字符串	ISE 服务器的共享密钥。
dhcpServer 列表 / 元素=字符串	DHCP 服务器 IP（例如 1.1.1.1）。
dnsServer 字典	网络更新的 dnsServer。
domainName 字符串	DHCP 的域名（例如；cisco）。
primaryIpAddress 字符串	DHCP 的主 IP 地址（例如 2.2.2.2）。
secondaryIpAddress 字符串	DHCP 的辅助 IP 地址（例如 3.3.3.3）。
messageOfTheday 字典	网络更新的 messageOfTheday。
bannerMessage 字符串	横幅消息的消息（例如；早上好）。
retainExistingBanner 字符串	保留现有的横幅消息（例如“true”或“false”）。
netflowcollector 字典	网络更新的 netflowcollector。
ipAddress 字符串	NetFlow 收集器的 IP 地址（例如 3.3.3.1）。
port 浮点数	NetFlow 收集器的端口（例如；443）。
network_aaa 字典	网络更新的 network_aaa。
ipAddress 字符串	AAA 和 ISE 服务器的 IP 地址（例如 1.1.1.1）。
network 字符串	AAA 或 ISE 服务器的 IP 地址（例如 2.2.2.2）。
protocol 字符串	AAA 或 ISE 服务器的协议（例如 RADIUS）。
servers 字符串	AAA 网络的服务器类型（例如 AAA）。
sharedSecret 字符串	ISE 服务器的共享密钥。
ntpServer 列表 / 元素=字符串	NTP 服务器的 IP 地址（例如 1.1.1.2）。
snmpServer 字典	网络更新的 snmpServer。
configureDnacIP 布尔值	SNMP 服务器的配置 DNAC IP（例如 true）。选择 `false` `true`
ipAddresses 列表 / 元素=字符串	SNMP 服务器的 IP 地址（例如 4.4.4.1）。
syslogServer 字典	网络更新的 syslogServer。
configureDnacIP 布尔值	syslog 服务器的配置 DNAC IP（例如 true）。选择 `false` `true`
ipAddresses 列表 / 元素=字符串	syslog 服务器的 IP 地址（例如 4.4.4.4）。
timezone 字符串	时区的输入（例如 Africa/Abidjan）。
siteId 字符串	SiteId 路径参数。站点 ID，用于更新与该站点关联的网络设置。
validate_response_schema 布尔值	Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式验证请求正文。选择 `false` `true` ←（默认）

注释 

注意

使用的 SDK 方法是 network_settings.NetworkSettings.update_network_v1，
使用的路径是 put /dna/intent/api/v1/network/{siteId}，
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

有关网络设置 UpdateNetworkV1 的 Cisco DNA Center 文档: UpdateNetworkV1 API 的完整参考。

示例 

- name: Update by id
  cisco.dnac.network_update_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}}"
    settings:
      clientAndEndpoint_aaa:
        ipAddress: string
        network: string
        protocol: string
        servers: string
        sharedSecret: string
      dhcpServer:
      - string
      dnsServer:
        domainName: string
        primaryIpAddress: string
        secondaryIpAddress: string
      messageOfTheday:
        bannerMessage: string
        retainExistingBanner: string
      netflowcollector:
        ipAddress: string
        port: 0
      network_aaa:
        ipAddress: string
        network: string
        protocol: string
        servers: string
        sharedSecret: string
      ntpServer:
      - string
      snmpServer:
        configureDnacIP: true
        ipAddresses:
        - string
      syslogServer:
        configureDnacIP: true
        ipAddresses:
        - string
      timezone: string
    siteId: string

返回值 

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

键	描述
dnac_response 字典	由 Cisco DNAC Python SDK 返回的字典或列表返回: 总是示例: `{"executionId": "string", "executionStatusUrl": "string", "message": "string"}`

作者

Rafael Campos (@racampos)