cisco.dnac.smart_virtual_account – Manage SmartVirtualAccount objects of DeviceOnboardingPnp

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.smart_virtual_account.

New in version 1.0.0: of cisco.dnac

Synopsis

• Returns 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.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk

Parameters

Parameter			Choices/Defaults	Comments
autoSyncPeriod integer				SAVAMapping's autoSyncPeriod.
ccoUser string				SAVAMapping's ccoUser.
domain string / required				Smart Account Domain.
expiry integer				SAVAMapping's expiry.
lastSync integer				SAVAMapping's lastSync.
name string				Virtual Account Name. Required for state delete.
profile dictionary / required				SAVAMapping's profile.
	addressFqdn string			It is the smart virtual account's addressFqdn.
	addressIpV4 string			It is the smart virtual account's addressIpV4.
	cert string			It is the smart virtual account's cert.
	makeDefault boolean		Choices: no yes	It is the smart virtual account's makeDefault.
	name string			It is the smart virtual account's name.
	port integer			It is the smart virtual account's port.
	profileId string			It is the smart virtual account's profileId.
	proxy boolean		Choices: no yes	It is the smart virtual account's proxy.
smartAccountId string / required				SAVAMapping's smartAccountId.
syncResult dictionary				SAVAMapping's syncResult.
	syncList list / elements=dictionary			It is the smart virtual account's syncList.
		deviceSnList list / elements=string		It is the smart virtual account's deviceSnList.
		syncType string		It is the smart virtual account's syncType.
	syncMsg string			It is the smart virtual account's syncMsg.
syncResultStr string				SAVAMapping's syncResultStr.
syncStartTime integer				SAVAMapping's syncStartTime.
syncStatus string / required				SAVAMapping's syncStatus.
tenantId string				SAVAMapping's tenantId.
token string				SAVAMapping's token.
virtualAccountId string / required				SAVAMapping's virtualAccountId.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.smart_virtual_account

The official documentation on the cisco.dnac.plugins.module_utils.definitions.smart_virtual_account module.

SmartVirtualAccount reference

Complete reference of the SmartVirtualAccount object model.

SmartVirtualAccount reference

SDK reference.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
dnac_response dictionary	always	A dictionary with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: device_onboarding_pnp.add_virtual_account

Authors

• Rafael Campos (@racampos)