cisco.dnac.pnp_global_settings module – Resource module for Pnp Global Settings

Note

This module is part of the cisco.dnac collection (version 6.6.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. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 3.1.0

Synopsis

  • Manage operation update of the resource Pnp Global Settings.

  • Updates the user’s list of global PnP settings.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.5.5

  • python >= 3.5

Parameters

Parameter

Comments

_id

string

Pnp Global Settings’s _id.

aaaCredentials

dictionary

Pnp Global Settings’s aaaCredentials.

password

string

Pnp Global Settings’s password.

username

string

Pnp Global Settings’s username.

acceptEula

boolean

AcceptEula flag.

Choices:

  • false

  • true

defaultProfile

dictionary

Pnp Global Settings’s defaultProfile.

cert

string

Pnp Global Settings’s cert.

fqdnAddresses

list / elements=string

Pnp Global Settings’s fqdnAddresses.

ipAddresses

list / elements=string

Pnp Global Settings’s ipAddresses.

port

integer

Pnp Global Settings’s port.

proxy

boolean

Proxy flag.

Choices:

  • false

  • true

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

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:

  • false

  • true ← (default)

dnac_version

string

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

Default: "2.3.3.0"

savaMappingList

list / elements=dictionary

Pnp Global Settings’s savaMappingList.

autoSyncPeriod

integer

Pnp Global Settings’s autoSyncPeriod.

ccoUser

string

Pnp Global Settings’s ccoUser.

expiry

integer

Pnp Global Settings’s expiry.

lastSync

integer

Pnp Global Settings’s lastSync.

profile

dictionary

Pnp Global Settings’s profile.

addressFqdn

string

Pnp Global Settings’s addressFqdn.

addressIpV4

string

Pnp Global Settings’s addressIpV4.

cert

string

Pnp Global Settings’s cert.

makeDefault

boolean

MakeDefault flag.

Choices:

  • false

  • true

name

string

Pnp Global Settings’s name.

port

integer

Pnp Global Settings’s port.

profileId

string

Pnp Global Settings’s profileId.

proxy

boolean

Proxy flag.

Choices:

  • false

  • true

smartAccountId

string

Pnp Global Settings’s smartAccountId.

syncResult

dictionary

Pnp Global Settings’s syncResult.

syncList

list / elements=dictionary

Pnp Global Settings’s syncList.

deviceSnList

list / elements=string

Pnp Global Settings’s deviceSnList.

syncType

string

Pnp Global Settings’s syncType.

syncMsg

string

Pnp Global Settings’s syncMsg.

syncResultStr

string

Pnp Global Settings’s syncResultStr.

syncStartTime

integer

Pnp Global Settings’s syncStartTime.

syncStatus

string

Pnp Global Settings’s syncStatus.

tenantId

string

Pnp Global Settings’s tenantId.

token

string

Pnp Global Settings’s token.

virtualAccountId

string

Pnp Global Settings’s virtualAccountId.

taskTimeOuts

dictionary

Pnp Global Settings’s taskTimeOuts.

configTimeOut

integer

Pnp Global Settings’s configTimeOut.

generalTimeOut

integer

Pnp Global Settings’s generalTimeOut.

imageDownloadTimeOut

integer

Pnp Global Settings’s imageDownloadTimeOut.

tenantId

string

Pnp Global Settings’s tenantId.

validate_response_schema

boolean

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

Choices:

  • false

  • true ← (default)

version

integer

Pnp Global Settings’s version.

Notes

Note

  • SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.update_pnp_global_settings,

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

  • 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

See Also

See also

Cisco DNA Center documentation for Device Onboarding (PnP) UpdatePnPGlobalSettings

Complete reference of the UpdatePnPGlobalSettings API.

Examples

- name: Update all
  cisco.dnac.pnp_global_settings:
    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}}"
    state: present
    _id: string
    aaaCredentials:
      password: string
      username: string
    acceptEula: true
    defaultProfile:
      cert: string
      fqdnAddresses:
      - string
      ipAddresses:
      - string
      port: 0
      proxy: true
    savaMappingList:
    - 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
    taskTimeOuts:
      configTimeOut: 0
      generalTimeOut: 0
      imageDownloadTimeOut: 0
    tenantId: string
    version: 0

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: {"_id": "string", "aaaCredentials": {"password": "string", "username": "string"}, "acceptEula": true, "defaultProfile": {"cert": "string", "fqdnAddresses": ["string"], "ipAddresses": ["string"], "port": 0, "proxy": true}, "id": "string", "savaMappingList": [{"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"}], "taskTimeOuts": {"configTimeOut": 0, "generalTimeOut": 0, "imageDownloadTimeOut": 0}, "tenantId": "string", "version": 0}

Authors

  • Rafael Campos (@racampos)