cisco.dnac.pnp_server_profile_update module – Resource module for Pnp Server Profile Update

Note

This module is part of the cisco.dnac collection (version 6.2.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operation update of the resource Pnp Server Profile Update.

• Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.8

• python >= 3.5

Parameters

Parameter	Comments
autoSyncPeriod integer	Pnp Server Profile Update’s autoSyncPeriod.
ccoUser string	Pnp Server Profile Update’s ccoUser.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: no ← (default) yes
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: “admin”
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: “2.2.3.3”
expiry integer	Pnp Server Profile Update’s expiry.
lastSync integer	Pnp Server Profile Update’s lastSync.
profile dictionary	Pnp Server Profile Update’s profile.
addressFqdn string	Pnp Server Profile Update’s addressFqdn.
addressIpV4 string	Pnp Server Profile Update’s addressIpV4.
cert string	Pnp Server Profile Update’s cert.
makeDefault boolean	MakeDefault flag. Choices: no yes
name string	Pnp Server Profile Update’s name.
port integer	Pnp Server Profile Update’s port.
profileId string	Pnp Server Profile Update’s profileId.
proxy boolean	Proxy flag. Choices: no yes
smartAccountId string	Pnp Server Profile Update’s smartAccountId.
syncResult dictionary	Pnp Server Profile Update’s syncResult.
syncList list / elements=dictionary	Pnp Server Profile Update’s syncList.
deviceSnList list / elements=string	Pnp Server Profile Update’s deviceSnList.
syncType string	Pnp Server Profile Update’s syncType.
syncMsg string	Pnp Server Profile Update’s syncMsg.
syncResultStr string	Pnp Server Profile Update’s syncResultStr.
syncStartTime integer	Pnp Server Profile Update’s syncStartTime.
syncStatus string	Pnp Server Profile Update’s syncStatus.
tenantId string	Pnp Server Profile Update’s tenantId.
token string	Pnp Server Profile Update’s token.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: no yes ← (default)
virtualAccountId string	Pnp Server Profile Update’s virtualAccountId.

Notes

Note

• SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.update_pnp_server_profile,

• Paths used are put /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 the embedded connection manager from Cisco DNAC SDK

• The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

Examples

- name: Update all
  cisco.dnac.pnp_server_profile_update:
    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}}"
    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
    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 DNAC Python SDK Returned: always Sample: “{\n \”virtualAccountId\”: \”string\”,\n \”autoSyncPeriod\”: 0,\n \”syncResultStr\”: \”string\”,\n \”profile\”: {\n \”proxy\”: true,\n \”makeDefault\”: true,\n \”port\”: 0,\n \”profileId\”: \”string\”,\n \”name\”: \”string\”,\n \”addressIpV4\”: \”string\”,\n \”cert\”: \”string\”,\n \”addressFqdn\”: \”string\”\n },\n \”ccoUser\”: \”string\”,\n \”syncResult\”: {\n \”syncList\”: [\n {\n \”syncType\”: \”string\”,\n \”deviceSnList\”: [\n \”string\”\n ]\n }\n ],\n \”syncMsg\”: \”string\”\n },\n \”token\”: \”string\”,\n \”syncStartTime\”: 0,\n \”lastSync\”: 0,\n \”tenantId\”: \”string\”,\n \”smartAccountId\”: \”string\”,\n \”expiry\”: 0,\n \”syncStatus\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)