cisco.dnac.network_settings_intent 模块 – IP 地址池和网络功能的资源模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 需求 获取详细信息。
要在 playbook 中使用它，请指定：cisco.dnac.network_settings_intent。
cisco.dnac 6.6.0 中的新增功能
概要
管理全局池、预留池和网络资源的操作。
用于创建/更新/删除全局池的 API。
用于从全局池中预留/更新/删除 IP 子池的 API。
用于更新 DHCP、Syslog、SNMP、NTP、网络 AAA、客户端和端点 AAA 以及/或 DNS 中心服务器设置的网络设置的 API。
需求
执行此模块的主机需要以下需求。
dnacentersdk == 2.4.5
python >= 3.9
参数
参数 |
注释 |
|---|---|
正在管理的全局池、预留池和网络的详细信息列表。 |
|
管理全局级别的 IPv4 和 IPv6 IP 池。 |
|
全局池的设置。 |
|
包含全局 IP 池配置列表。 |
|
定义 IP 池的无类别域间路由块，可在网络中系统地分配 IP 地址。 |
|
负责自动为本地网络上的设备分配 IP 地址和网络配置参数的 DHCP 服务器 IP。 |
|
负责将域名转换为相应的 IP 地址。 |
|
充当网络之间数据流量的入口或出口点。 |
|
IP 地址空间，IPv4 或 IPv6。 |
|
指定分配给全局 IP 池的名称。 |
|
包括通用 IP 池和隧道 IP 池。通用 - 用于网络中的通用目的，例如设备管理或网络设备之间的通信。隧道 - 指定用于隧道接口以封装网络协议内的分组。它用于 VPN 连接、GRE 隧道或其他类型的覆盖网络。 选项
|
|
全局池的前一个标识符。仅当您需要更新全局池的名称时才应使用它。 |
|
设置站点的默认网络设置 |
|
网络管理详细信息设置。 |
|
网络 V2 的 clientAndEndpoint_aaa。 |
|
ISE 服务器的 IP 地址（例如 1.1.1.4）。 |
|
AAA 或 ISE 服务器的 IP 地址（例如 2.2.2.1）。 |
|
AAA 或 ISE 服务器的协议（例如 RADIUS）。 |
|
服务器类型 AAA 或 ISE 服务器（例如 AAA）。 |
|
ISE 服务器的共享密钥。 |
|
DHCP 服务器 IP（例如 1.1.1.1）。 |
|
网络 V2 的 dnsServer。 |
|
DHCP 的域名（例如；cisco）。 |
|
DHCP 的主 IP 地址（例如 2.2.2.2）。 |
|
DHCP 的次要 IP 地址（例如 3.3.3.3）。 |
|
网络 V2 的 messageOfTheday。 |
|
横幅消息（例如；您好）。 |
|
保留现有的横幅消息（例如“true”或“false”）。 |
|
网络 V2 的 netflowcollector。 |
|
NetFlow 收集器的 IP 地址（例如 3.3.3.1）。 |
|
NetFlow 收集器的端口（例如；443）。 |
|
网络 V2 的 network_aaa。 |
|
AAA 和 ISE 服务器的 IP 地址（例如 1.1.1.1）。 |
|
AAA 或 ISE 服务器的 IP 地址（例如 2.2.2.2）。 |
|
AAA 或 ISE 服务器的协议（例如 RADIUS）。 |
|
AAA 网络的服务器类型（例如 AAA）。 |
|
ISE 服务器的共享密钥。 |
|
NTP 服务器的 IP 地址（例如 1.1.1.2）。 |
|
网络 V2 的 snmpServer。 |
|
为 SNMP 服务器配置 Cisco Catalyst Center IP（例如 true）。 选项
|
|
SNMP 服务器的 IP 地址（例如 4.4.4.1）。 |
|
网络 V2 的 syslogServer。 |
|
为 syslog 服务器配置 Cisco Catalyst Center IP（例如 true）。 选项
|
|
syslog 服务器的 IP 地址（例如 4.4.4.4）。 |
|
输入时区（例如 Africa/Abidjan）。 |
|
作为路径参数提供的站点名称，用于指定将在哪里预留 IP 子池。 |
|
来自全局池的预留 IP 子池详细信息。 |
|
指定 DHCP 服务器的 IPv4 地址，例如“1.1.1.1”。 |
|
指定 DNS 服务器的 IPv4 地址，例如“4.4.4.4”。 |
|
提供网关的 IPv4 地址，例如“175.175.0.1”。 |
|
带有 cidr 的 IP v4 全局池地址，例如 175.175.0.0/16。 |
|
启用 ip4 前缀长度或启用 ipv4 总主机输入 选项
|
|
当 ipv4_prefix 值为 true 时，需要 ipv4 前缀长度。 |
|
指示 IPv4 子网地址，例如“175.175.0.0”。 |
|
IPv4 的主机总数，当“ipv4_prefix”设置为 false 时需要。 |
|
确定是否需要 IPv6 和 IPv4 输入。如果设置为 false，则只需要 IPv4 输入。如果设置为 true，则需要 IPv6 和 IPv4 输入。 选项
|
|
以格式指定 DHCP 服务器的 IPv6 地址。例如，“2001:0db8:0123:4567:89ab:cdef:0001:0001”。 |
|
指定 DNS 服务器的 IPv6 地址。例如，“2001:0db8:0123:4567:89ab:cdef:0002:0002”。 |
|
提供网关的 IPv6 地址。例如，“2001:0db8:0123:4567:89ab:cdef:0003:0003”。 |
|
IPv6全局池地址，带CIDR，当ipv6_address_space值为true时，此项必填，例如2001:db8:85a3:/64。 |
|
如果ipv6_prefix值为true，则启用ip6前缀长度输入字段；如果为false，则启用IPv6主机总数输入。 选项
|
|
当ipv6_prefix值为true时，IPv6前缀长度必填。 |
|
IPv6子网地址，例如2001:db8:85a3:0:100。 |
|
如果'ipv6_prefix'设置为false，则需要IPv6主机总数。 |
|
保留IP子池的名称。 |
|
保留IP子池的类型。Generic - 用于网络中的通用目的，例如设备管理或网络设备之间的通信。LAN - 用于局域网内的设备和资源，例如设备连接、内部通信或服务。Management - 用于管理目的，例如设备管理接口、管理访问或其他管理功能。Service - 用于网络服务和应用程序，例如DNS（域名系统）、DHCP（动态主机配置协议）、NTP（网络时间协议）。WAN - 用于广域网的设备和资源，例如远程站点与其他网络的互连或在广域网中托管的服务。 选项
|
|
与保留IP子池关联的旧名称。 |
|
作为路径参数提供的站点名称，用于指定将在哪里预留 IP 子池。 |
|
允许IPv6网络上的设备自主配置其IP地址，无需手动设置。 选项
|
|
应用playbook配置后，设置为True以验证Cisco Catalyst Center。 选项
|
|
定义检索任务详细信息的API调用的超时时间（秒）。如果在此期间未收到任务详细信息，则进程将结束，并记录超时通知。 默认值： |
|
用于启用Cisco DNA Center SDK调试的标志。 选项
|
|
Cisco DNA Center主机名。 |
|
启用/禁用playbook执行日志记录的标志。 当为true且提供了dnac_log_file_path时，- 在执行位置创建指定名称的日志文件。 当为true且未提供dnac_log_file_path时，- 在执行位置创建名为“dnac.log”的日志文件。 当为false时，- 日志记录被禁用。 如果日志文件不存在，- 根据“dnac_log_append”标志以追加或写入模式创建它。 如果日志文件存在，- 根据“dnac_log_append”标志将其覆盖或追加。 选项
|
|
确定文件的模式。设置为True表示“追加”模式。设置为False表示“写入”模式。 选项
|
|
控制日志记录。如果dnac_log为True，则记录日志。 如果未指定路径，- 当“dnac_log_append”为True时，在当前Ansible目录中生成“dnac.log”；日志被追加。- 当“dnac_log_append”为False时，生成“dnac.log”；日志被覆盖。 如果指定了路径，- 当“dnac_log_append”为True时，文件以追加模式打开。- 当“dnac_log_append”为False时，文件以写入(w)模式打开。- 在共享文件场景中，如果没有追加模式，则每次模块执行后内容都会被覆盖。- 对于共享日志文件，将第一个模块的append设置为False（以覆盖）；对于后续模块，将append设置为True。 默认值： |
|
设置日志级别的阈值。级别等于或高于此级别的消息将被记录。级别按严重性顺序排列[CRITICAL、ERROR、WARNING、INFO、DEBUG]。 CRITICAL表示严重的错误导致程序停止。仅显示CRITICAL消息。 ERROR表示阻止功能出现的问题。显示ERROR和CRITICAL消息。 WARNING表示潜在的未来问题。显示WARNING、ERROR、CRITICAL消息。 INFO跟踪正常操作。显示INFO、WARNING、ERROR、CRITICAL消息。 DEBUG提供详细的诊断信息。显示所有日志消息。 默认值： |
|
用于身份验证的Cisco DNA Center密码。 |
|
Cisco DNA Center端口。 默认值： |
|
指定连续调用API以检索任务详细信息的时间间隔（秒）。 默认值： |
|
用于身份验证的Cisco DNA Center用户名。 默认值： |
|
启用或禁用SSL证书验证的标志。 选项
|
|
通知SDK使用哪个版本的Cisco DNA Center。 默认值： |
|
模块完成后的Cisco Catalyst Center状态。 选项
|
|
用于启用Cisco DNA Center SDK根据JSON模式验证请求主体的标志。 选项
|
注释
注意
使用的SDK方法是network_settings.NetworkSettings.create_global_pool、network_settings.NetworkSettings.delete_global_ip_pool、network_settings.NetworkSettings.update_global_pool、network_settings.NetworkSettings.release_reserve_ip_subpool、network_settings.NetworkSettings.reserve_ip_subpool、network_settings.NetworkSettings.update_reserve_ip_subpool、network_settings.NetworkSettings.update_network_v2，
使用的路径是post /dna/intent/api/v1/global-pool、delete /dna/intent/api/v1/global-pool/{id}、put /dna/intent/api/v1/global-pool、post /dna/intent/api/v1/reserve-ip-subpool/{siteId}、delete /dna/intent/api/v1/reserve-ip-subpool/{id}、put /dna/intent/api/v1/reserve-ip-subpool/{siteId}、put /dna/intent/api/v2/network/{siteId}，
不支持
check_mode插件在控制节点上运行，不使用任何ansible连接插件，而是使用Cisco DNAC SDK的嵌入式连接管理器。
以dnac_开头的参数由Cisco DNAC Python SDK用于建立连接。
示例
- name: Create global pool, reserve an ip pool and network
cisco.dnac.network_settings_intent:
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_log: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- global_pool_details:
settings:
ip_pool:
- name: string
gateway: string
ip_address_space: string
cidr: string
pool_type: Generic
dhcp_server_ips: list
dns_server_ips: list
reserve_pool_details:
ipv6_address_space: True
ipv4_global_pool: string
ipv4_prefix: True
ipv4_prefix_length: 9
ipv4_subnet: string
name: string
ipv6_prefix: True
ipv6_prefix_length: 64
ipv6_global_pool: string
ipv6_subnet: string
site_name: string
slaac_support: True
pool_type: LAN
network_management_details:
settings:
dhcp_server: list
dns_server:
domain_name: string
primary_ip_address: string
secondary_ip_address: string
client_and_endpoint_aaa:
network: string
protocol: string
servers: string
message_of_the_day:
banner_message: string
retain_existing_banner: string
netflow_collector:
ip_address: string
port: 443
network_aaa:
network: string
protocol: string
servers: string
ntp_server: list
snmp_server:
configure_dnac_ip: True
ip_addresses: list
syslog_server:
configure_dnac_ip: True
ip_addresses: list
site_name: string
返回值
常见的返回值已在此处记录，以下是此模块特有的字段。
键 |
描述 |
|---|---|
包含Cisco DNA Center Python SDK返回的响应的字典或列表。 返回：始终 示例： |
|
包含Cisco DNA Center Python SDK返回的响应的字典或列表。 返回：始终 示例： |
|
包含Cisco DNA Center Python SDK返回的响应的字典或列表。 返回：始终 示例： |