cisco.dnac.sda_extranet_policies_v1 模块 – Sda 外联网策略 V1 资源模块

注意

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

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

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

要在剧本中使用它，请指定：cisco.dnac.sda_extranet_policies_v1。

cisco.dnac 6.14.0 中的新增功能

概要 

管理 Sda 外联网策略 V1 资源的创建、更新和删除操作。
根据用户输入添加外联网策略。
根据 ID 删除外联网策略。
根据用户输入删除外联网策略。
根据用户输入更新外联网策略。

注意

此模块具有相应的 action 插件。

要求 

在执行此模块的主机上需要以下要求。

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"`
extranetPolicyName 字符串	extranetPolicyName 查询参数。外联网策略的名称。
id 字符串	Id 路径参数。外联网策略的 ID。
payload 列表 / 元素=字典	Sda 外联网策略的有效负载。
extranetPolicyName 字符串	现有外联网策略的名称（不允许更新此字段）。
fabricIds 列表 / 元素=字符串	与该外联网策略关联的结构化站点 ID。
id 字符串	现有外联网策略的 ID（不允许更新此字段）。
providerVirtualNetworkName 字符串	现有提供商虚拟网络的名称（不允许更新此字段）。
subscriberVirtualNetworkNames 列表 / 元素=字符串	订户虚拟网络的名称。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。选项 `false` `true` ← (默认)

备注 

注意

使用的 SDK 方法为 sda.Sda.add_extranet_policy_v1、sda.Sda.delete_extranet_policy_by_id_v1、sda.Sda.update_extranet_policy_v1，
使用的路径为 post /dna/intent/api/v1/sda/extranetPolicies、delete /dna/intent/api/v1/sda/extranetPolicies、delete /dna/intent/api/v1/sda/extranetPolicies/{id}、put /dna/intent/api/v1/sda/extranetPolicies，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center SDA AddExtranetPolicyV1 文档: AddExtranetPolicyV1 API 的完整参考。
Cisco DNA Center SDA DeleteExtranetPoliciesV1 文档: DeleteExtranetPoliciesV1 API 的完整参考。
Cisco DNA Center SDA DeleteExtranetPolicyByIdV1 文档: DeleteExtranetPolicyByIdV1 API 的完整参考。
Cisco DNA Center SDA UpdateExtranetPolicyV1 文档: UpdateExtranetPolicyV1 API 的完整参考。

示例 

- name: Delete all
  cisco.dnac.sda_extranet_policies_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
    extranetPolicyName: string

- name: Update all
  cisco.dnac.sda_extranet_policies_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
    payload:
    - extranetPolicyName: string
      fabricIds:
      - string
      id: string
      providerVirtualNetworkName: string
      subscriberVirtualNetworkNames:
      - string

- name: Create
  cisco.dnac.sda_extranet_policies_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
    payload:
    - extranetPolicyName: string
      fabricIds:
      - string
      providerVirtualNetworkName: string
      subscriberVirtualNetworkNames:
      - string

- name: Delete by id
  cisco.dnac.sda_extranet_policies_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

返回值 

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表返回值：始终示例： `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)