cisco.catalystcenter.pnp_virtual_account_add module -- Resource module for Pnp Virtual Account Add

Note

This module is part of the cisco.catalystcenter collection (version 2.2.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.pnp_virtual_account_add.

New in cisco.catalystcenter 3.1.0

Synopsis

  • Manage operation create of the resource Pnp Virtual Account Add. - > 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.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

autoSyncPeriod

integer

Pnp Virtual Account Add's autoSyncPeriod.

catc_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catc_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

ccoUser

string

Pnp Virtual Account Add's ccoUser.

expiry

integer

Pnp Virtual Account Add's expiry.

lastSync

integer

Pnp Virtual Account Add's lastSync.

profile

dictionary

Pnp Virtual Account Add's profile.

addressFqdn

string

Required when cluster is configured with fully qualified domain name (FQDN).

addressIpV4

string

Required when cluster is configured with IPv4.

addressIpV6

string

Required when cluster is configured with IPv6.

cert

string

Pnp Virtual Account Add's cert.

makeDefault

boolean

MakeDefault flag.

Choices:

name

string

Pnp Virtual Account Add's name.

port

integer

Pnp Virtual Account Add's port.

profileId

string

Pnp Virtual Account Add's profileId.

proxy

boolean

Proxy flag.

Choices:

smartAccountId

string

Pnp Virtual Account Add's smartAccountId.

syncResult

dictionary

Pnp Virtual Account Add's syncResult.

syncList

list / elements=dictionary

Pnp Virtual Account Add's syncList.

deviceSnList

list / elements=string

Pnp Virtual Account Add's deviceSnList.

syncType

string

Pnp Virtual Account Add's syncType.

syncMsg

string

Pnp Virtual Account Add's syncMsg.

syncResultStr

string

Represent internal state and SHOULD not be used or relied upon. (Deprecated).

syncStartTime

integer

Pnp Virtual Account Add's syncStartTime.

syncStatus

string

Represent internal state and SHOULD not be used or relied upon. (Deprecated).

tenantId

string

Represent internal state and SHOULD not be used or relied upon. (Deprecated).

token

string

Represent internal state and SHOULD not be used or relied upon. (Deprecated).

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

virtualAccountId

string

Pnp Virtual Account Add's virtualAccountId.

Notes

Note

  • SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.add_virtual_account,

  • Paths used are post /dna/intent/api/v1/onboarding/pnp-settings/savacct,

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Device Onboarding (PnP) AddVirtualAccount

Complete reference of the AddVirtualAccount API.

Examples

---
- name: Create
  cisco.catalystcenter.pnp_virtual_account_add:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    autoSyncPeriod: 0
    ccoUser: string
    expiry: 0
    lastSync: 0
    profile:
      addressFqdn: string
      addressIpV4: string
      addressIpV6: string
      cert: string
      makeDefault: true
      name: string
      port: 0
      profileId: string
      proxy: true
    smartAccountId: string
    syncResult:
      syncList:
        - deviceSnList:
            - string
          syncType: string
      syncMsg: string
    syncResultStr: string
    syncStartTime: 0
    syncStatus: string
    tenantId: string
    token: string
    virtualAccountId: string

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"autoSyncPeriod": 0, "ccoUser": "string", "expiry": 0, "lastSync": 0, "profile": {"addressFqdn": "string", "addressIpV4": "string", "cert": "string", "makeDefault": true, "name": "string", "port": 0, "profileId": "string", "proxy": true}, "smartAccountId": "string", "syncStartTime": 0, "syncStatus": "string", "tenantId": "string", "virtualAccountId": "string"}`

Authors

  • Rafael Campos (@racampos)