cisco.catalystcenter.pnp_global_settings module -- Resource module for Pnp Global Settings

Note

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

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

New in cisco.catalystcenter 3.1.0

Synopsis

  • This module represents an alias of the module pnp_global_settings_v1

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

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

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

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

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

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

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

acceptEula

string

Accept Eula.

defaultProfile

dictionary

Pnp Global Settings's defaultProfile.

cert

string

Cert.

fqdnAddresses

list / elements=string

Fqdn Addresses.

ipAddresses

list / elements=string

Ip Addresses.

port

string

Port.

proxy

string

Proxy.

id

string

Id.

savaMappingList

list / elements=dictionary

Pnp Global Settings's savaMappingList.

ccoUser

string

Cco User.

expiry

string

Expiry.

profile

dictionary

Pnp Global Settings's profile.

addressFqdn

string

Address Fqdn.

addressIpV4

string

Address Ip V4.

cert

string

Cert.

makeDefault

string

Make Default.

name

string

Name.

port

string

Port.

profileId

string

Profile Id.

proxy

string

Proxy.

smartAccountId

string

Smart Account Id.

virtualAccountId

string

Virtual Account Id.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.update_pnp_global_settings_v1,

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

  • It should be noted that this module is an alias of pnp_global_settings_v1

  • 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 CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Device Onboarding (PnP) UpdatePnPGlobalSettingsV1

Complete reference of the UpdatePnPGlobalSettingsV1 API.

Examples

- name: Update all
  cisco.catalystcenter.pnp_global_settings:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    acceptEula: string
    defaultProfile:
      cert: string
      fqdnAddresses:
        - string
      ipAddresses:
        - string
      port: string
      proxy: string
    id: string
    savaMappingList:
      - ccoUser: string
        expiry: string
        profile:
          addressFqdn: string
          addressIpV4: string
          cert: string
          makeDefault: string
          name: string
          port: string
          profileId: string
          proxy: string
        smartAccountId: string
        virtualAccountId: string

Return Values

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

Key

Description

catalystcenter_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"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)