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

Note

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

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_global_settings.

New in version 3.1.0: of cisco.dnac

Synopsis

  • Manage operation update of the resource Pnp Global Settings.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.3.3

  • python >= 3.5

Parameters

Parameter Choices/Defaults 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
    Choices:
  • no
  • yes
AcceptEula flag.
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
    Choices:
  • no
  • yes
Proxy flag.
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.2.3"
Informs the SDK which version of Cisco DNA Center to use.
savaMappingList
list / elements=string
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
    Choices:
  • no
  • yes
MakeDefault flag.
name
string
Pnp Global Settings's name.
port
integer
Pnp Global Settings's port.
profileId
string
Pnp Global Settings's profileId.
proxy
boolean
    Choices:
  • no
  • yes
Proxy flag.
smartAccountId
string
Pnp Global Settings's smartAccountId.
syncResult
dictionary
Pnp Global Settings's syncResult.
syncList
list / elements=string
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
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
version
integer
Pnp Global Settings's version.

Notes

Note

  • 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

Pnp Global Settings reference

Complete reference of the Pnp Global Settings object model.

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 Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "savaMappingList": [ { "syncStatus": "string", "syncStartTime": 0, "syncResult": { "syncList": [ { "syncType": "string", "deviceSnList": [ "string" ] } ], "syncMsg": "string" }, "lastSync": 0, "tenantId": "string", "profile": { "port": 0, "addressIpV4": "string", "addressFqdn": "string", "profileId": "string", "proxy": true, "makeDefault": true, "cert": "string", "name": "string" }, "token": "string", "expiry": 0, "ccoUser": "string", "smartAccountId": "string", "virtualAccountId": "string", "autoSyncPeriod": 0, "syncResultStr": "string" } ], "taskTimeOuts": { "imageDownloadTimeOut": 0, "configTimeOut": 0, "generalTimeOut": 0 }, "tenantId": "string", "aaaCredentials": { "password": "string", "username": "string" }, "defaultProfile": { "fqdnAddresses": [ "string" ], "proxy": true, "cert": "string", "ipAddresses": [ "string" ], "port": 0 }, "acceptEula": true, "id": "string", "_id": "string", "version": 0 }


Authors

  • Rafael Campos (@racampos)