cisco.dnac.network_v2 模块 – 网络 V2 的资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 管理资源网络 V2 的创建和更新操作。

  • 用于为 DHCP、Syslog、SNMP、NTP、网络 AAA、客户端和端点 AAA 和/或 DNS 中心服务器设置创建网络设置的 API。

  • 用于为 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"

settings

字典

网络 V2 的设置。

clientAndEndpoint_aaa

字典

网络 V2 的 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

字典

网络 V2 的 dnsServer。

domainName

字符串

DHCP 的域名(例如;cisco)。

primaryIpAddress

字符串

DHCP 的主 IP 地址(例如 2.2.2.2)。

secondaryIpAddress

字符串

DHCP 的辅助 IP 地址(例如 3.3.3.3)。

messageOfTheday

字典

网络 V2 的 messageOfTheday。

bannerMessage

字符串

横幅消息的文本(例如;您好)。

retainExistingBanner

字符串

保留现有横幅消息(例如“true”或“false”)。

netflowcollector

字典

网络 V2 的 netflowcollector。

ipAddress

字符串

NetFlow 收集器的 IP 地址(例如 3.3.3.1)。

port

浮点数

NetFlow 收集器的端口(例如;443)。

network_aaa

字典

网络 V2 的 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

字典

网络 V2 的 snmpServer。

configureDnacIP

布尔值

SNMP 服务器的配置 DNAC IP(例如 true)。

选项

  • false

  • true

ipAddresses

列表 / 元素=字符串

SNMP 服务器的 IP 地址(例如 4.4.4.1)。

syslogServer

字典

网络 V2 的 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.create_network_v2、network_settings.NetworkSettings.update_network_v2,

  • 使用的路径是 post /dna/intent/api/v2/network/{siteId},put /dna/intent/api/v2/network/{siteId},

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,关于网络设置 CreateNetworkV2

CreateNetworkV2 API 的完整参考。

Cisco DNA Center 文档,关于网络设置 UpdateNetworkV2

UpdateNetworkV2 API 的完整参考。

示例

- name: Create
  cisco.dnac.network_v2:
    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}}"
    state: present
    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

- name: Update by id
  cisco.dnac.network_v2:
    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}}"
    state: present
    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 返回的响应的字典或列表

返回: 总是

示例: {"taskId": "string", "url": "string"}

作者

  • Rafael Campos (@racampos)