Try SpotterManage SmartVirtualAccount objects of DeviceOnboardingPnp
| "added in version" 1.0.0 of cisco.dnac"
Authors: Rafael Campos (@racampos)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.dnac:==2.0.7
collections:
- name: cisco.dnac
version: 2.0.7Returns the list of Smart Account domains.
Returns list of virtual accounts associated with the specified smart account.
Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile.
Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info.
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.
- name: get_smart_account_list
cisco.dnac.smart_virtual_account:
state: query # required
register: nm_get_smart_account_list
- name: get_virtual_account_list
cisco.dnac.smart_virtual_account:
state: query # required
domain: SomeValue # string, required
register: nm_get_virtual_account_list
- name: add_virtual_account
cisco.dnac.smart_virtual_account:
state: create # required
profile: # required
addressFqdn: SomeValue # string
addressIpV4: SomeValue # string
cert: SomeValue # string
makeDefault: True # boolean
name: SomeValue # string
port: 1 # integer
profileId: SomeValue # string
proxy: True # boolean
smartAccountId: SomeValue # string, required
syncStatus: # valid values are 'NOT_SYNCED',
# 'SYNCING',
# 'SUCCESS',
# 'FAILURE'.
SomeValue # string, required
virtualAccountId: SomeValue # string, required
autoSyncPeriod: 1 # integer
ccoUser: SomeValue # string
expiry: 1 # integer
lastSync: 1 # integer
syncResult:
syncList:
- deviceSnList:
- SomeValue # string
syncType: SomeValue # string
syncMsg: SomeValue # string
syncResultStr: SomeValue # string
syncStartTime: 1 # integer
tenantId: SomeValue # string
token: SomeValue # string
- name: update_pnp_server_profile
cisco.dnac.smart_virtual_account:
state: update # required
profile: # required
addressFqdn: SomeValue # string
addressIpV4: SomeValue # string
cert: SomeValue # string
makeDefault: True # boolean
name: SomeValue # string
port: 1 # integer
profileId: SomeValue # string
proxy: True # boolean
smartAccountId: SomeValue # string, required
syncStatus: # valid values are 'NOT_SYNCED',
# 'SYNCING',
# 'SUCCESS',
# 'FAILURE'.
SomeValue # string, required
virtualAccountId: SomeValue # string, required
autoSyncPeriod: 1 # integer
ccoUser: SomeValue # string
expiry: 1 # integer
lastSync: 1 # integer
syncResult:
syncList:
- deviceSnList:
- SomeValue # string
syncType: SomeValue # string
syncMsg: SomeValue # string
syncResultStr: SomeValue # string
syncStartTime: 1 # integer
tenantId: SomeValue # string
token: SomeValue # string
- name: deregister_virtual_account
cisco.dnac.smart_virtual_account:
state: delete # required
domain: SomeValue # string, required
name: SomeValue # string, required
name:
description:
- Virtual Account Name.
- Required for state delete.
type: str
token:
description:
- SAVAMapping's token.
type: str
domain:
description:
- Smart Account Domain.
required: true
type: str
expiry:
description:
- SAVAMapping's expiry.
type: int
ccoUser:
description:
- SAVAMapping's ccoUser.
type: str
profile:
description:
- SAVAMapping's profile.
required: true
suboptions:
addressFqdn:
description:
- It is the smart virtual account's addressFqdn.
type: str
addressIpV4:
description:
- It is the smart virtual account's addressIpV4.
type: str
cert:
description:
- It is the smart virtual account's cert.
type: str
makeDefault:
description:
- It is the smart virtual account's makeDefault.
type: bool
name:
description:
- It is the smart virtual account's name.
type: str
port:
description:
- It is the smart virtual account's port.
type: int
profileId:
description:
- It is the smart virtual account's profileId.
type: str
proxy:
description:
- It is the smart virtual account's proxy.
type: bool
type: dict
lastSync:
description:
- SAVAMapping's lastSync.
type: int
tenantId:
description:
- SAVAMapping's tenantId.
type: str
syncResult:
description:
- SAVAMapping's syncResult.
suboptions:
syncList:
description:
- It is the smart virtual account's syncList.
elements: dict
suboptions:
deviceSnList:
description:
- It is the smart virtual account's deviceSnList.
type: list
syncType:
description:
- It is the smart virtual account's syncType.
type: str
type: list
syncMsg:
description:
- It is the smart virtual account's syncMsg.
type: str
type: dict
syncStatus:
description:
- SAVAMapping's syncStatus.
required: true
type: str
syncResultStr:
description:
- SAVAMapping's syncResultStr.
type: str
syncStartTime:
description:
- SAVAMapping's syncStartTime.
type: int
autoSyncPeriod:
description:
- SAVAMapping's autoSyncPeriod.
type: int
smartAccountId:
description:
- SAVAMapping's smartAccountId.
required: true
type: str
virtualAccountId:
description:
- SAVAMapping's virtualAccountId.
required: true
type: str
dnac_response:
description: A dictionary with the response returned by the DNA Center Python SDK
returned: always
sample:
response: 29
version: '1.0'
type: dict
missing_params:
description: Provided arguments do not comply with the schema of the DNA Center
Python SDK function
returned: when the function request schema is not satisfied
sample: null
type: list
sdk_function:
description: The DNA Center SDK function used to execute the task
returned: always
sample: device_onboarding_pnp.add_virtual_account
type: str