Repository URL to install this package:
|
Version:
6.0.0 ▾
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: pnp_virtual_account_deregister
short_description: Resource module for Pnp Virtual Account Deregister
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.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module
author: Rafael Campos (@racampos)
options:
domain:
description: Domain query parameter. Smart Account Domain.
type: str
name:
description: Name query parameter. Virtual Account Name.
type: str
requirements:
- dnacentersdk >= 2.4.9
- python >= 3.5
notes:
- SDK Method used are
device_onboarding_pnp.DeviceOnboardingPnp.deregister_virtual_account,
- Paths used are
delete /dna/intent/api/v1/onboarding/pnp-settings/vacct,
"""
EXAMPLES = r"""
- 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
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
sample: >
{
"virtualAccountId": "string",
"autoSyncPeriod": 0,
"syncResultStr": "string",
"profile": {
"proxy": true,
"makeDefault": true,
"port": 0,
"profileId": "string",
"name": "string",
"addressIpV4": "string",
"cert": "string",
"addressFqdn": "string"
},
"ccoUser": "string",
"syncResult": {
"syncList": [
{
"syncType": "string",
"deviceSnList": [
"string"
]
}
],
"syncMsg": "string"
},
"token": "string",
"syncStartTime": 0,
"lastSync": 0,
"tenantId": "string",
"smartAccountId": "string",
"expiry": 0,
"syncStatus": "string"
}
"""