cisco.dnac.pnp_settings – Manage PnpSettings objects of DeviceOnboardingPnp

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Returns global PnP settings of the user.

• 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

Parameters

Parameter				Choices/Defaults	Comments
_id string					Settings's _id.
aaaCredentials dictionary					Settings's aaaCredentials.
	password string				It is the pnp settings's password.
	username string				It is the pnp settings's username.
acceptEula boolean				Choices: no yes	Settings's acceptEula.
defaultProfile dictionary					Settings's defaultProfile.
	cert string				It is the pnp settings's cert.
	fqdnAddresses list / elements=string				It is the pnp settings's fqdnAddresses.
	ipAddresses list / elements=string				It is the pnp settings's ipAddresses.
	port integer				It is the pnp settings's port.
	proxy boolean			Choices: no yes	It is the pnp settings's proxy.
savaMappingList list / elements=dictionary					Settings's savaMappingList (list of objects).
	autoSyncPeriod integer				It is the pnp settings's autoSyncPeriod.
	ccoUser string				It is the pnp settings's ccoUser.
	expiry integer				It is the pnp settings's expiry.
	lastSync integer				It is the pnp settings's lastSync.
	profile dictionary / required				It is the pnp settings's profile.
		addressFqdn string			It is the pnp settings's addressFqdn.
		addressIpV4 string			It is the pnp settings's addressIpV4.
		cert string			It is the pnp settings's cert.
		makeDefault boolean		Choices: no yes	It is the pnp settings's makeDefault.
		name string			It is the pnp settings's name.
		port integer			It is the pnp settings's port.
		profileId string			It is the pnp settings's profileId.
		proxy boolean		Choices: no yes	It is the pnp settings's proxy.
	smartAccountId string / required				It is the pnp settings's smartAccountId.
	syncResult dictionary				It is the pnp settings's syncResult.
		syncList list / elements=dictionary			It is the pnp settings's syncList.
			deviceSnList list / elements=string		It is the pnp settings's deviceSnList.
			syncType string		It is the pnp settings's syncType.
		syncMsg string			It is the pnp settings's syncMsg.
	syncResultStr string				It is the pnp settings's syncResultStr.
	syncStartTime integer				It is the pnp settings's syncStartTime.
	syncStatus string / required				It is the pnp settings's syncStatus.
	tenantId string				It is the pnp settings's tenantId.
	token string				It is the pnp settings's token.
	virtualAccountId string / required				It is the pnp settings's virtualAccountId.
taskTimeOuts dictionary					Settings's taskTimeOuts.
	configTimeOut integer				It is the pnp settings's configTimeOut.
	generalTimeOut integer				It is the pnp settings's generalTimeOut.
	imageDownloadTimeOut integer				It is the pnp settings's imageDownloadTimeOut.
tenantId string					Settings's tenantId.
version integer					Settings's version.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.pnp_settings

The official documentation on the cisco.dnac.plugins.module_utils.definitions.pnp_settings module.

PnpSettings reference

Complete reference of the PnpSettings object model.

PnpSettings reference

SDK reference.

Examples

- name: get_pnp_global_settings
  cisco.dnac.pnp_settings:
    state: query  # required
  register: nm_get_pnp_global_settings

- name: update_pnp_global_settings
  cisco.dnac.pnp_settings:
    state: update  # required
    _id: SomeValue  # string
    aaaCredentials:
      password: SomeValue  # string
      username: SomeValue  # string
    acceptEula: True  # boolean
    defaultProfile:
      cert: SomeValue  # string
      fqdnAddresses:
      - SomeValue  # string
      ipAddresses:
      - SomeValue  # string
      port: 1  #  integer
      proxy: True  # boolean
    savaMappingList:
    - 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
      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
    taskTimeOuts:
      configTimeOut: 1  #  integer
      generalTimeOut: 1  #  integer
      imageDownloadTimeOut: 1  #  integer
    tenantId: SomeValue  # string
    version: 1  #  integer

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 with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: device_onboarding_pnp.get_pnp_global_settings

Authors

• Rafael Campos (@racampos)