cisco.dnac.applications_v2 模块 – 应用 V2 资源模块

注意

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

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

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

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

cisco.dnac 6.14.0 中的新增功能

概要

  • 管理应用 V2 资源的创建、更新和删除操作。

  • 创建新的自定义应用程序。

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

id

字符串

ID 路径参数。要删除的自定义应用程序的 ID。

payload

列表 / 元素=字典

应用 V2 的有效负载。

displayName

字符串

显示名称。

id

字符串

应用程序 ID。

indicativeNetworkIdentity

列表 / 元素=字典

应用 V2 的 indicativeNetworkIdentity。

displayName

字符串

显示名称。

id

字符串

ID。

lowerPort

浮点数

下限端口。

ports

字符串

端口。

protocol

字符串

协议。

upperPort

浮点数

上限端口。

instanceId

整数

实例 ID。

instanceVersion

浮点数

实例版本。

name

字符串

应用程序名称。

namespace

字符串

命名空间。

networkApplications

列表 / 元素=字典

应用 V2 的 networkApplications。

applicationSubType

字符串

应用程序子类型,LEARNED 表示发现的应用程序,NONE 表示 nbar 和自定义应用程序。

applicationType

字符串

应用程序类型,DEFAULT 表示 nbar 应用程序,DEFAULT_MODIFIED 表示 nbar 修改后的应用程序,CUSTOM 表示自定义应用程序。

appProtocol

字符串

应用程序协议。

categoryId

字符串

类别 ID。

displayName

字符串

显示名称。

dscp

字符串

DSCP。

engineId

字符串

引擎 ID。

helpString

字符串

帮助字符串。

id

字符串

ID。

ignoreConflict

布尔值

忽略冲突,true 或 false。

选项

  • false

  • true

longDescription

字符串

长描述。

name

字符串

应用程序名称。

popularity

浮点数

流行度。

rank

整数

排名,1 到 65535 之间的任何值。

selectorId

字符串

选择器 ID。

serverName

字符串

服务器名称。

trafficClass

字符串

流量类别。

url

字符串

URL。

networkIdentity

列表 / 元素=字典

应用 V2 的 networkIdentity。

displayName

字符串

显示名称。

id

字符串

ID。

ipv4Subnet

列表 / 元素=字符串

IPv4 子网。

ipv6Subnet

列表 / 元素=字典

IPv6 子网。

lowerPort

浮点数

下限端口。

ports

字符串

端口。

protocol

字符串

协议。

upperPort

浮点数

上限端口。

parentScalableGroup

字典

应用 V2 的 parentScalableGroup。

idRef

字符串

父应用程序集的 ID 引用。

qualifier

字符串

限定符,有效值为 application。

scalableGroupExternalHandle

字符串

可扩展组外部句柄,应等于应用程序名称。

scalableGroupType

字符串

可扩展组类型,有效值为 APPLICATION。

type

字符串

类型,有效值为 scalablegroup。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志,用于启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法为 application_policy.ApplicationPolicy.create_applications_v2、application_policy.ApplicationPolicy.delete_application_v2、application_policy.ApplicationPolicy.edit_applications_v2。

  • 使用的路径为 post /dna/intent/api/v2/applications、delete /dna/intent/api/v2/applications/{id}、put /dna/intent/api/v2/applications。

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 应用策略 CreateApplicationsV2 文档

CreateApplicationsV2 API 的完整参考。

Cisco DNA Center 应用策略 DeleteApplicationV2 文档

DeleteApplicationV2 API 的完整参考。

Cisco DNA Center 应用策略 EditApplicationsV2 文档

EditApplicationsV2 API 的完整参考。

示例

- name: Update all
  cisco.dnac.applications_v2:
    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:
    - displayName: string
      id: string
      indicativeNetworkIdentity:
      - displayName: string
        id: string
        lowerPort: 0
        ports: string
        protocol: string
        upperPort: 0
      instanceId: 0
      instanceVersion: 0
      name: string
      namespace: string
      networkApplications:
      - appProtocol: string
        applicationSubType: string
        applicationType: string
        categoryId: string
        displayName: string
        dscp: string
        engineId: string
        helpString: string
        id: string
        ignoreConflict: true
        longDescription: string
        name: string
        popularity: 0
        rank: 0
        selectorId: string
        serverName: string
        trafficClass: string
        url: string
      networkIdentity:
      - displayName: string
        id: string
        ipv4Subnet:
        - string
        ipv6Subnet:
        - {}
        lowerPort: 0
        ports: string
        protocol: string
        upperPort: 0
      parentScalableGroup:
        idRef: string
      qualifier: string
      scalableGroupExternalHandle: string
      scalableGroupType: string
      type: string

- name: Create
  cisco.dnac.applications_v2:
    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:
    - indicativeNetworkIdentity:
      - ipv4Subnet:
        - string
        ipv6Subnet:
        - string
        lowerPort: 0
        ports: string
        protocol: string
        upperPort: 0
      name: string
      networkApplications:
      - appProtocol: string
        applicationType: string
        categoryId: string
        dscp: string
        engineId: 0
        helpString: string
        ignoreConflict: true
        rank: 0
        serverName: string
        trafficClass: string
        type: string
        url: string
      networkIdentity:
      - ipv4Subnet:
        - string
        lowerPort: 0
        ports: string
        protocol: string
        upperPort: 0
      parentScalableGroup:
        idRef: string
      scalableGroupType: string
      type: string

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