cisco.dnac.ipam_server_setting 模块 – IPAM 服务器设置资源模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.dnac.ipam_server_setting

cisco.dnac 6.15.0 中的新增功能

概要

  • 此模块表示模块 ipam_server_setting_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"

password

字符串

外部 IPAM 服务器登录用户名密码。

provider

字符串

外部 IPAM 的类型。可以是 INFOBLOX、BLUECAT 或 GENERIC。

serverName

字符串

此外部服务器的描述性名称,用于识别。

serverUrl

字符串

此外部服务器的 URL。

syncView

布尔值

将 IP 池从本地 IPAM 同步到此外部服务器。

选项

  • false

  • true

userName

字符串

外部 IPAM 服务器登录用户名。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

view

字符串

在外部 IPAM 服务器中创建池的视图。

备注

注意

  • 使用的 SDK 方法是 system_settings.SystemSettings.creates_configuration_details_of_the_external_ip_a_m_server_v1、system_settings.SystemSettings.deletes_configuration_details_of_the_external_ip_a_m_server_v1、system_settings.SystemSettings.updates_configuration_details_of_the_external_ip_a_m_server_v1,

  • 使用的路径是 post /dna/intent/api/v1/ipam/serverSetting、delete /dna/intent/api/v1/ipam/serverSetting、put /dna/intent/api/v1/ipam/serverSetting,

  • 需要注意的是,此模块是 ipam_server_setting_v1 的别名

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 系统设置 CreatesConfigurationDetailsOfTheExternalIPAMServerV1 文档

CreatesConfigurationDetailsOfTheExternalIPAMServerV1 API 的完整参考。

Cisco DNA Center 系统设置 DeletesConfigurationDetailsOfTheExternalIPAMServerV1 文档

DeletesConfigurationDetailsOfTheExternalIPAMServerV1 API 的完整参考。

Cisco DNA Center 系统设置 UpdatesConfigurationDetailsOfTheExternalIPAMServerV1 文档

UpdatesConfigurationDetailsOfTheExternalIPAMServerV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.ipam_server_setting:
    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
    password: string
    provider: string
    serverName: string
    serverUrl: string
    syncView: true
    userName: string
    view: string

- name: Delete all
  cisco.dnac.ipam_server_setting:
    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

- name: Update all
  cisco.dnac.ipam_server_setting:
    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
    password: string
    serverName: string
    serverUrl: string
    syncView: true
    userName: string
    view: string

返回值

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

描述

dnac_response

字典

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

返回值:始终返回

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

作者

  • Rafael Campos (@racampos)