/ home / cisco / cisco.dnac / 6.13.3 / module / pnp_virtual_account_deregister

cisco.dnac.pnp_virtual_account_deregister (6.13.3) — module

Resource module for Pnp Virtual Account Deregister

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Manage operation delete of the resource Pnp Virtual Account Deregister.

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Delete all
  cisco.dnac.pnp_virtual_account_deregister:
    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}}"
    domain: string
    name: string

Inputs

    
name:
    description: Name query parameter. Virtual Account Name.
    type: str

domain:
    description: Domain query parameter. Smart Account Domain.
    type: str

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"virtualAccountId\": \"string\",\n  \"autoSyncPeriod\": 0,\n  \"\
    syncResultStr\": \"string\",\n  \"profile\": {\n    \"proxy\": true,\n    \"makeDefault\"\
    : true,\n    \"port\": 0,\n    \"profileId\": \"string\",\n    \"name\": \"string\"\
    ,\n    \"addressIpV4\": \"string\",\n    \"cert\": \"string\",\n    \"addressFqdn\"\
    : \"string\"\n  },\n  \"ccoUser\": \"string\",\n  \"syncResult\": {\n    \"syncList\"\
    : [\n      {\n        \"syncType\": \"string\",\n        \"deviceSnList\": [\n\
    \          \"string\"\n        ]\n      }\n    ],\n    \"syncMsg\": \"string\"\
    \n  },\n  \"token\": \"string\",\n  \"syncStartTime\": 0,\n  \"lastSync\": 0,\n\
    \  \"tenantId\": \"string\",\n  \"smartAccountId\": \"string\",\n  \"expiry\"\
    : 0,\n  \"syncStatus\": \"string\"\n}\n"
  type: dict