cisco.dnac.reserve_ip_subpool_v1 模块 – 用于预留 IP 子池 V1 的资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 管理资源 Reserve Ip Subpool V1 的创建、更新和删除操作。

  • 从全局池预留 IP 子池的 API。

  • 删除预留 IP 子池的 API。

  • 从全局池更新 IP 子池的 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"

id

字符串

Id 路径参数。要删除的预留 IP 子池的 ID。

ipv4DhcpServers

列表 / 元素=字符串

DHCP 服务器 IP 的 IPv4 输入，例如“1.1.1.1”。

ipv4DnsServers

列表 / 元素=字符串

DNS 服务器 IP 的 IPv4 输入，例如“4.4.4.4”。

ipv4GateWay

字符串

在 cisco.dnac 4.0.0 中添加

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

ipv4GlobalPool

字符串

具有 CIDR 的 IPv4 全局池地址，例如 175.175.0.0/16。

ipv4Prefix

布尔值

如果 IPv4 前缀值为 true，则启用 IP4 前缀长度输入字段，如果为 false，则启用 IPv4 总主机输入。

选项

  • false

  • true

ipv4PrefixLength

整数

当 IPv4 前缀值为 true 时，需要 IPv4 前缀长度。

ipv4Subnet

字符串

IPv4 子网地址，例如 175.175.0.0。如果创建 IPv4 子池，则需要传递 ipv4Subnet 或 ipv4TotalHost。

ipv4TotalHost

整数

当 IPv4 前缀值为 false 时，需要 IPv4 总主机。

ipv6AddressSpace

布尔值

如果省略或值为 false，则仅需要 IPv4 输入，否则需要 IPv6 和 IPv4。

选项

  • false

  • true

ipv6DhcpServers

列表 / 元素=字符串

以 IPv6 格式输入 DHCP 服务器，例如“2001 db8 1234”。

ipv6DnsServers

列表 / 元素=字符串

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

ipv6GateWay

字符串

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

ipv6GlobalPool

字符串

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

ipv6Prefix

布尔值

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

选项

  • false

  • true

ipv6PrefixLength

整数

当 IPv6 前缀值为 true 时，需要 IPv6 前缀长度。

ipv6Subnet

字符串

IPv6 子网地址，例如 2001 db8 85a3 0 100。如果创建 IPv6 子池，则需要传递 ipv6Subnet 或 ipv6TotalHost。

ipv6TotalHost

整数

当 IPv6 前缀值为 false 时，需要 IPv6 总主机。

name

字符串

预留 IP 子池的名称。

siteId

字符串

SiteId 路径参数。用于预留 IP 子池的站点 ID。

slaacSupport

布尔值

Slaac 支持。

选项

  • false

  • true

type

字符串

预留 IP 子池的类型。

validate_response_schema

布尔值

用于启用 Cisco DNA Center SDK 对照 JSON 模式验证请求体的标志。

选项

  • false

  • true ← (默认)

注意

注意

  • 使用的 SDK 方法为 network_settings.NetworkSettings.release_reserve_ip_subpool_v1、network_settings.NetworkSettings.reserve_ip_subpool_v1、network_settings.NetworkSettings.update_reserve_ip_subpool_v1。

  • 使用的路径为 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}。

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档，了解网络设置 ReserveIPSubpoolV1

ReserveIPSubpoolV1 API 的完整参考。

Cisco DNA Center 文档，了解网络设置 ReleaseReserveIPSubpoolV1

ReleaseReserveIPSubpoolV1 API 的完整参考。

Cisco DNA Center 文档，了解网络设置 UpdateReserveIPSubpoolV1

UpdateReserveIPSubpoolV1 API 的完整参考。

示例

- name: Delete by id
  cisco.dnac.reserve_ip_subpool_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}}"
    state: absent
    id: string

- name: Create
  cisco.dnac.reserve_ip_subpool_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}}"
    state: present
    ipv4DhcpServers:
    - string
    ipv4DnsServers:
    - string
    ipv4GateWay: string
    ipv4GlobalPool: string
    ipv4Prefix: true
    ipv4PrefixLength: 0
    ipv4Subnet: string
    ipv4TotalHost: 0
    ipv6AddressSpace: true
    ipv6DhcpServers:
    - string
    ipv6DnsServers:
    - string
    ipv6GateWay: string
    ipv6GlobalPool: string
    ipv6Prefix: true
    ipv6PrefixLength: 0
    ipv6Subnet: string
    ipv6TotalHost: 0
    name: string
    siteId: string
    slaacSupport: true
    type: string

- name: Update by id
  cisco.dnac.reserve_ip_subpool_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}}"
    state: present
    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": "string", "executionStatusUrl": "string", "message": "string"}

作者

  • Rafael Campos (@racampos)