cisco.dnac.reserve_ip_subpool_update 模块 – 用于保留 IP 子池更新的资源模块

注意

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

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

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

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

cisco.dnac 4.0.0 中的新增功能

概要

  • 此模块表示模块 reserve_ip_subpool_update_v1 的别名

注意

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

要求

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

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

id

字符串

Id 查询参数。子池组的 ID。

ipv4DhcpServers

列表 / 元素=字符串

dhcp 服务器 IP 的 IPv4 输入,例如“1.1.1.1”。

ipv4DnsServers

列表 / 元素=字符串

dns 服务器 IP 的 IPv4 输入,例如“4.4.4.4”。

ipv4GateWay

字符串

网关 IP 地址详细信息,例如 175.175.0.1。

ipv6AddressSpace

布尔值

如果值为 false,则只需要 IPv4 输入。注意:如果值为 false,则将删除组中任何现有的 IPv6 子池。

选项

  • false

  • true

ipv6DhcpServers

列表 / 元素=字符串

IPv6 格式的 DHCP 服务器作为输入,例如“2001 db8 1234”。

ipv6DnsServers

列表 / 元素=字符串

IPv6 格式的 DNS 服务器输入,例如“2001 db8 1234”。

ipv6GateWay

字符串

网关 IP 地址详细信息,例如 2001 db8 85a3 0 100 1。

ipv6GlobalPool

字符串

带 CIDR 的 IPv6 全局池地址,当 Ipv6AddressSpace 的值为 true 时,此地址为必需,例如 2001 db8 85a3 /64。

ipv6Prefix

布尔值

Ipv6 前缀的值为 true,则启用 IP6 前缀长度输入字段,如果为 false,则启用 IPv6 总主机输入。

选项

  • false

  • true

ipv6PrefixLength

整数

当 ipv6prefix 的值为 true 时,IPv6 前缀长度是必需的。

ipv6Subnet

字符串

IPv6 子网地址,例如 2001 db8 85a3 0 100。

ipv6TotalHost

整数

池的大小(以 IP 数量表示)。当 ipv6prefix 的值为 false 时,IPv6 总主机是必需的。

name

字符串

保留 IP 子池的名称。

siteId

字符串

SiteId 路径参数。要更新子池的站点的站点 ID。

slaacSupport

布尔值

Slaac 支持。

选项

  • false

  • true

validate_response_schema

布尔值

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

选项

  • false

  • true ←(默认)

备注

注意

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

  • 使用的路径是 put /dna/intent/api/v1/reserve-ip-subpool/{siteId},

  • 应该注意的是,此模块是 reserve_ip_subpool_update_v1 的别名

  • 在 v4.3.0 中删除了“type”、“ipv4GlobalPool”、“ipv4Prefix”、“ipv4PrefixLength”、“ipv4Subnet”和“ipv4TotalHost”选项。

  • 不支持 check_mode

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

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

另请参阅

另请参阅

有关网络设置 UpdateReserveIPSubpoolV1 的 Cisco DNA Center 文档

UpdateReserveIPSubpoolV1 API 的完整参考。

示例

- name: Update by id
  cisco.dnac.reserve_ip_subpool_update:
    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}}"
    id: string
    ipv4DhcpServers:
    - string
    ipv4DnsServers:
    - string
    ipv4GateWay: string
    ipv6AddressSpace: true
    ipv6DhcpServers:
    - string
    ipv6DnsServers:
    - string
    ipv6GateWay: string
    ipv6GlobalPool: string
    ipv6Prefix: true
    ipv6PrefixLength: 0
    ipv6Subnet: string
    ipv6TotalHost: 0
    name: string
    siteId: string
    slaacSupport: true

返回值

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

描述

dnac_response

字典

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

返回:始终

示例: {"executionId": "字符串", "executionStatusUrl": "字符串", "message": "字符串"}

作者

  • Rafael Campos (@racampos)