cisco.dnac.applications_v1 模块 – 应用 V1 资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 管理应用 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"

id

字符串

ID 查询参数。应用程序的 ID。

payload

列表 / 元素=字典

应用程序的有效负载。

applicationSet

字典

应用程序的 applicationSet。

idRef

字符串

ID 引用。

name

字符串

名称。

networkApplications

列表 / 元素=字典

应用程序的 networkApplications。

applicationSubType

字符串

应用程序子类型。

applicationType

字符串

应用程序类型。

appProtocol

字符串

应用协议。

categoryId

字符串

类别 ID。

displayName

字符串

显示名称。

dscp

字符串

DSCP。

engineId

字符串

引擎 ID。

helpString

字符串

帮助字符串。

ignoreConflict

字符串

忽略冲突。

longDescription

字符串

长描述。

name

字符串

名称。

popularity

字符串

流行度。

rank

字符串

排名。

serverName

字符串

服务器名称。

trafficClass

字符串

流量类。

url

字符串

URL。

networkIdentity

列表 / 元素=字典

应用程序的 networkIdentity。

displayName

字符串

显示名称。

lowerPort

字符串

下限端口。

ports

字符串

端口。

protocol

字符串

协议。

upperPort

字符串

上限端口。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 application_policy.ApplicationPolicy.create_application_v1、application_policy.ApplicationPolicy.delete_application_v1、application_policy.ApplicationPolicy.edit_application_v1,

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

  • 不支持 check_mode

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

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

另请参见

另请参见

Cisco DNA Center 应用策略 CreateApplicationV1 文档

CreateApplicationV1 API 的完整参考。

Cisco DNA Center 应用策略 DeleteApplicationV1 文档

DeleteApplicationV1 API 的完整参考。

Cisco DNA Center 应用策略 EditApplicationV1 文档

EditApplicationV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.applications_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:
    - applicationSet:
        idRef: string
      name: string
      networkApplications:
      - appProtocol: string
        applicationSubType: string
        applicationType: string
        categoryId: string
        displayName: string
        dscp: string
        engineId: string
        helpString: string
        ignoreConflict: string
        longDescription: string
        name: string
        popularity: string
        rank: string
        serverName: string
        trafficClass: string
        url: string
      networkIdentity:
      - displayName: string
        lowerPort: string
        ports: string
        protocol: string
        upperPort: string

- name: Update all
  cisco.dnac.applications_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:
    - applicationSet:
        idRef: string
      id: string
      name: string
      networkApplications:
      - appProtocol: string
        applicationSubType: string
        applicationType: string
        categoryId: string
        displayName: string
        dscp: string
        engineId: string
        helpString: string
        id: string
        ignoreConflict: string
        longDescription: string
        name: string
        popularity: string
        rank: string
        serverName: string
        trafficClass: string
        url: string
      networkIdentity:
      - displayName: string
        id: string
        lowerPort: string
        ports: string
        protocol: string
        upperPort: string

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