.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-entry .. role:: ansible-option-default .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.pnp_server_profile_update_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.pnp_server_profile_update module -- Resource module for Pnp Server Profile Update ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.2.0). 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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.pnp_server_profile_update`. .. version_added .. versionadded:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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 :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk >= 2.4.8 - python >= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-autoSyncPeriod: .. rst-class:: ansible-option-title **autoSyncPeriod** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's autoSyncPeriod. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-ccoUser: .. rst-class:: ansible-option-title **ccoUser** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's ccoUser. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-expiry: .. rst-class:: ansible-option-title **expiry** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's expiry. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-lastSync: .. rst-class:: ansible-option-title **lastSync** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's lastSync. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-profile: .. rst-class:: ansible-option-title **profile** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's profile. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-profile/addressFqdn: .. rst-class:: ansible-option-title **addressFqdn** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's addressFqdn. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-profile/addressIpV4: .. rst-class:: ansible-option-title **addressIpV4** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's addressIpV4. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-profile/cert: .. rst-class:: ansible-option-title **cert** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's cert. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-profile/makeDefault: .. rst-class:: ansible-option-title **makeDefault** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
MakeDefault flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-profile/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-profile/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-profile/profileId: .. rst-class:: ansible-option-title **profileId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's profileId. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-profile/proxy: .. rst-class:: ansible-option-title **proxy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Proxy flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-smartAccountId: .. rst-class:: ansible-option-title **smartAccountId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's smartAccountId. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-syncResult: .. rst-class:: ansible-option-title **syncResult** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's syncResult. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-syncResult/syncList: .. rst-class:: ansible-option-title **syncList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's syncList. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-syncResult/syncList/deviceSnList: .. rst-class:: ansible-option-title **deviceSnList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's deviceSnList. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-syncResult/syncList/syncType: .. rst-class:: ansible-option-title **syncType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's syncType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-syncResult/syncMsg: .. rst-class:: ansible-option-title **syncMsg** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's syncMsg. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-syncResultStr: .. rst-class:: ansible-option-title **syncResultStr** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's syncResultStr. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-syncStartTime: .. rst-class:: ansible-option-title **syncStartTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's syncStartTime. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-syncStatus: .. rst-class:: ansible-option-title **syncStatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's syncStatus. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-tenantId: .. rst-class:: ansible-option-title **tenantId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's tenantId. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-token: .. rst-class:: ansible-option-title **token** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's token. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__parameter-virtualAccountId: .. rst-class:: ansible-option-title **virtualAccountId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pnp Server Profile Update's virtualAccountId. .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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 .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_server_profile_update_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`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" .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors