racampos.dnac.smart_virtual_account (0.0.1) — module

Manage SmartVirtualAccount objects of DeviceOnboardingPnp

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

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.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_smart_account_list
  cisco.dnac.smart_virtual_account:
    state: query  # required

  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_virtual_account_list
  cisco.dnac.smart_virtual_account:
    state: query  # required
    domain: SomeValue  # string, required
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- 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: SomeValue  # string, required, valid values: 'NOT_SYNCED', 'SYNCING', 'SUCCESS', 'FAILURE'.
    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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- 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: SomeValue  # string, required, valid values: 'NOT_SYNCED', 'SYNCING', 'SUCCESS', 'FAILURE'.
    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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: deregister_virtual_account
  cisco.dnac.smart_virtual_account:
    state: delete  # required
    domain: SomeValue  # string, required
    name: SomeValue  # string, required

Inputs

    
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

Outputs

add_virtual_account:
  autoSyncPeriod:
    description: SAVAMapping's autoSyncPeriod.
    returned: success
    sample: 0
    type: int
  ccoUser:
    description: SAVAMapping's Cco User.
    returned: success
    sample: <ccouser>
    type: str
  contains: null
  description: 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.
  expiry:
    description: SAVAMapping's expiry.
    returned: success
    sample: 0
    type: int
  lastSync:
    description: SAVAMapping's lastSync.
    returned: success
    sample: 0
    type: int
  profile:
    contains:
      addressFqdn:
        description: It is the smart virtual account's addressFqdn.
        returned: success
        sample: <addressfqdn>
        type: str
      addressIpV4:
        description: It is the smart virtual account's addressIpV4.
        returned: success
        sample: <addressipv4>
        type: str
      cert:
        description: It is the smart virtual account's cert.
        returned: success
        sample: <cert>
        type: str
      makeDefault:
        description: It is the smart virtual account's makeDefault.
        returned: success
        sample: false
        type: bool
      name:
        description: It is the smart virtual account's name.
        returned: success
        sample: <name>
        type: str
      port:
        description: It is the smart virtual account's port.
        returned: success
        sample: 0
        type: int
      profileId:
        description: It is the smart virtual account's profileId.
        returned: success
        sample: <profileid>
        type: str
      proxy:
        description: It is the smart virtual account's proxy.
        returned: success
        sample: false
        type: bool
    description: SAVAMapping's Profile.
    returned: success
    type: dict
  returned: success
  smartAccountId:
    description: SAVAMapping's Smart Account Id.
    returned: success
    sample: <smartaccountid>
    type: str
  syncResult:
    contains:
      syncList:
        contains:
          deviceSnList:
            description: It is the smart virtual account's deviceSnList.
            returned: success
            type: list
          syncType:
            description: It is the smart virtual account's syncType.
            returned: success
            sample: <synctype>
            type: str
        description: It is the smart virtual account's syncList.
        returned: success
        type: list
      syncMsg:
        description: It is the smart virtual account's syncMsg.
        returned: success
        sample: <syncmsg>
        type: str
    description: SAVAMapping's Sync Result.
    returned: success
    type: dict
  syncResultStr:
    description: SAVAMapping's Sync Result Str.
    returned: success
    sample: <syncresultstr>
    type: str
  syncStartTime:
    description: SAVAMapping's syncStartTime.
    returned: success
    sample: 0
    type: int
  syncStatus:
    description: SAVAMapping's Sync Status.
    returned: success
    sample: <syncstatus>
    type: str
  tenantId:
    description: SAVAMapping's Tenant Id.
    returned: success
    sample: <tenantid>
    type: str
  token:
    description: SAVAMapping's Token.
    returned: success
    sample: <token>
    type: str
  type: dict
  virtualAccountId:
    description: SAVAMapping's Virtual Account Id.
    returned: success
    sample: <virtualaccountid>
    type: str
deregister_virtual_account:
  autoSyncPeriod:
    description: AutoSyncPeriod, property of the response body.
    returned: success
    sample: 0
    type: int
  ccoUser:
    description: Cco User, property of the response body.
    returned: success
    sample: <ccouser>
    type: str
  contains: null
  description: 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.
  expiry:
    description: Expiry, property of the response body.
    returned: success
    sample: 0
    type: int
  lastSync:
    description: LastSync, property of the response body.
    returned: success
    sample: 0
    type: int
  profile:
    contains:
      addressFqdn:
        description: It is the smart virtual account's addressFqdn.
        returned: success
        sample: <addressfqdn>
        type: str
      addressIpV4:
        description: It is the smart virtual account's addressIpV4.
        returned: success
        sample: <addressipv4>
        type: str
      cert:
        description: It is the smart virtual account's cert.
        returned: success
        sample: <cert>
        type: str
      makeDefault:
        description: It is the smart virtual account's makeDefault.
        returned: success
        sample: false
        type: bool
      name:
        description: It is the smart virtual account's name.
        returned: success
        sample: <name>
        type: str
      port:
        description: It is the smart virtual account's port.
        returned: success
        sample: 0
        type: int
      profileId:
        description: It is the smart virtual account's profileId.
        returned: success
        sample: <profileid>
        type: str
      proxy:
        description: It is the smart virtual account's proxy.
        returned: success
        sample: false
        type: bool
    description: Profile, property of the response body.
    returned: success
    type: dict
  returned: success
  smartAccountId:
    description: Smart Account Id, property of the response body.
    returned: success
    sample: <smartaccountid>
    type: str
  syncResult:
    contains:
      syncList:
        contains:
          deviceSnList:
            description: It is the smart virtual account's deviceSnList.
            returned: success
            type: list
          syncType:
            description: It is the smart virtual account's syncType.
            returned: success
            sample: <synctype>
            type: str
        description: It is the smart virtual account's syncList.
        returned: success
        type: list
      syncMsg:
        description: It is the smart virtual account's syncMsg.
        returned: success
        sample: <syncmsg>
        type: str
    description: Sync Result, property of the response body.
    returned: success
    type: dict
  syncResultStr:
    description: Sync Result Str, property of the response body.
    returned: success
    sample: <syncresultstr>
    type: str
  syncStartTime:
    description: SyncStartTime, property of the response body.
    returned: success
    sample: 0
    type: int
  syncStatus:
    description: Sync Status, property of the response body.
    returned: success
    sample: <syncstatus>
    type: str
  tenantId:
    description: Tenant Id, property of the response body.
    returned: success
    sample: <tenantid>
    type: str
  token:
    description: Token, property of the response body.
    returned: success
    sample: <token>
    type: str
  type: dict
  virtualAccountId:
    description: Virtual Account Id, property of the response body.
    returned: success
    sample: <virtualaccountid>
    type: str
get_smart_account_list:
  contains: null
  description: Returns the list of Smart Account domains.
  payload:
    description: It is the smart virtual account's payload.
    returned: always
    type: list
  returned: always
  type: dict
get_virtual_account_list:
  contains: null
  description: Returns list of virtual accounts associated with the specified smart
    account.
  payload:
    description: It is the smart virtual account's payload.
    returned: always
    type: list
  returned: always
  type: dict
update_pnp_server_profile:
  autoSyncPeriod:
    description: SAVAMapping's autoSyncPeriod.
    returned: changed
    sample: 0
    type: int
  ccoUser:
    description: SAVAMapping's Cco User.
    returned: changed
    sample: <ccouser>
    type: str
  contains: null
  description: Updates the PnP Server profile in a registered Virtual Account in the
    PnP database. The response payload returns the updated smart & virtual account
    info.
  expiry:
    description: SAVAMapping's expiry.
    returned: changed
    sample: 0
    type: int
  lastSync:
    description: SAVAMapping's lastSync.
    returned: changed
    sample: 0
    type: int
  profile:
    contains:
      addressFqdn:
        description: It is the smart virtual account's addressFqdn.
        returned: changed
        sample: <addressfqdn>
        type: str
      addressIpV4:
        description: It is the smart virtual account's addressIpV4.
        returned: changed
        sample: <addressipv4>
        type: str
      cert:
        description: It is the smart virtual account's cert.
        returned: changed
        sample: <cert>
        type: str
      makeDefault:
        description: It is the smart virtual account's makeDefault.
        returned: changed
        sample: false
        type: bool
      name:
        description: It is the smart virtual account's name.
        returned: changed
        sample: <name>
        type: str
      port:
        description: It is the smart virtual account's port.
        returned: changed
        sample: 0
        type: int
      profileId:
        description: It is the smart virtual account's profileId.
        returned: changed
        sample: <profileid>
        type: str
      proxy:
        description: It is the smart virtual account's proxy.
        returned: changed
        sample: false
        type: bool
    description: SAVAMapping's Profile.
    returned: changed
    type: dict
  returned: changed
  smartAccountId:
    description: SAVAMapping's Smart Account Id.
    returned: changed
    sample: <smartaccountid>
    type: str
  syncResult:
    contains:
      syncList:
        contains:
          deviceSnList:
            description: It is the smart virtual account's deviceSnList.
            returned: changed
            type: list
          syncType:
            description: It is the smart virtual account's syncType.
            returned: changed
            sample: <synctype>
            type: str
        description: It is the smart virtual account's syncList.
        returned: changed
        type: list
      syncMsg:
        description: It is the smart virtual account's syncMsg.
        returned: changed
        sample: <syncmsg>
        type: str
    description: SAVAMapping's Sync Result.
    returned: changed
    type: dict
  syncResultStr:
    description: SAVAMapping's Sync Result Str.
    returned: changed
    sample: <syncresultstr>
    type: str
  syncStartTime:
    description: SAVAMapping's syncStartTime.
    returned: changed
    sample: 0
    type: int
  syncStatus:
    description: SAVAMapping's Sync Status.
    returned: changed
    sample: <syncstatus>
    type: str
  tenantId:
    description: SAVAMapping's Tenant Id.
    returned: changed
    sample: <tenantid>
    type: str
  token:
    description: SAVAMapping's Token.
    returned: changed
    sample: <token>
    type: str
  type: dict
  virtualAccountId:
    description: SAVAMapping's Virtual Account Id.
    returned: changed
    sample: <virtualaccountid>
    type: str

See also