.. Document meta
:orphan:
.. 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 -- Resource module for Pnp Server Profile Update
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This plugin is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 3.1.2).
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:: 1.0.0 of cisco.dnac
.. contents::
:local:
:depth: 1
.. Deprecated
Synopsis
--------
.. Description
- Manage operation update of the resource Pnp Server Profile Update.
.. note::
This module has a corresponding :ref:`action plugin <action_plugins>`.
.. Aliases
.. Requirements
Requirements
------------
The below requirements are needed on the host that executes this module.
- dnacentersdk
.. Options
Parameters
----------
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="3">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-autoSyncPeriod"></div>
<b>autoSyncPeriod</b>
<a class="ansibleOptionLink" href="#parameter-autoSyncPeriod" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's autoSyncPeriod.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-ccoUser"></div>
<b>ccoUser</b>
<a class="ansibleOptionLink" href="#parameter-ccoUser" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's ccoUser.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-expiry"></div>
<b>expiry</b>
<a class="ansibleOptionLink" href="#parameter-expiry" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's expiry.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-lastSync"></div>
<b>lastSync</b>
<a class="ansibleOptionLink" href="#parameter-lastSync" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's lastSync.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-profile"></div>
<b>profile</b>
<a class="ansibleOptionLink" href="#parameter-profile" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's profile.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-profile/addressFqdn"></div>
<b>addressFqdn</b>
<a class="ansibleOptionLink" href="#parameter-profile/addressFqdn" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's addressFqdn.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-profile/addressIpV4"></div>
<b>addressIpV4</b>
<a class="ansibleOptionLink" href="#parameter-profile/addressIpV4" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's addressIpV4.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-profile/cert"></div>
<b>cert</b>
<a class="ansibleOptionLink" href="#parameter-profile/cert" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's cert.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-profile/makeDefault"></div>
<b>makeDefault</b>
<a class="ansibleOptionLink" href="#parameter-profile/makeDefault" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>MakeDefault flag.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-profile/name"></div>
<b>name</b>
<a class="ansibleOptionLink" href="#parameter-profile/name" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's name.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-profile/port"></div>
<b>port</b>
<a class="ansibleOptionLink" href="#parameter-profile/port" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's port.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-profile/profileId"></div>
<b>profileId</b>
<a class="ansibleOptionLink" href="#parameter-profile/profileId" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's profileId.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-profile/proxy"></div>
<b>proxy</b>
<a class="ansibleOptionLink" href="#parameter-profile/proxy" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Proxy flag.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-smartAccountId"></div>
<b>smartAccountId</b>
<a class="ansibleOptionLink" href="#parameter-smartAccountId" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's smartAccountId.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-syncResult"></div>
<b>syncResult</b>
<a class="ansibleOptionLink" href="#parameter-syncResult" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's syncResult.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-syncResult/syncList"></div>
<b>syncList</b>
<a class="ansibleOptionLink" href="#parameter-syncResult/syncList" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's syncList.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-syncResult/syncList/deviceSnList"></div>
<b>deviceSnList</b>
<a class="ansibleOptionLink" href="#parameter-syncResult/syncList/deviceSnList" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's deviceSnList.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-syncResult/syncList/syncType"></div>
<b>syncType</b>
<a class="ansibleOptionLink" href="#parameter-syncResult/syncList/syncType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's syncType.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-syncResult/syncMsg"></div>
<b>syncMsg</b>
<a class="ansibleOptionLink" href="#parameter-syncResult/syncMsg" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's syncMsg.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-syncResultStr"></div>
<b>syncResultStr</b>
<a class="ansibleOptionLink" href="#parameter-syncResultStr" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's syncResultStr.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-syncStartTime"></div>
<b>syncStartTime</b>
<a class="ansibleOptionLink" href="#parameter-syncStartTime" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's syncStartTime.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-syncStatus"></div>
<b>syncStatus</b>
<a class="ansibleOptionLink" href="#parameter-syncStatus" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's syncStatus.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-tenantId"></div>
<b>tenantId</b>
<a class="ansibleOptionLink" href="#parameter-tenantId" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's tenantId.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-token"></div>
<b>token</b>
<a class="ansibleOptionLink" href="#parameter-token" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's token.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-virtualAccountId"></div>
<b>virtualAccountId</b>
<a class="ansibleOptionLink" href="#parameter-virtualAccountId" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pnp Server Profile Update's virtualAccountId.</div>
</td>
</tr>
</table>
<br/>
.. Notes
.. Seealso
See Also
--------
.. seealso::
`Pnp Server Profile Update reference <https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary>`_
Complete reference of the Pnp Server Profile Update object model.
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- name: Create
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
- 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 <common_return_values>`, the following are the fields unique to this module:
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Key</th>
<th>Returned</th>
<th width="100%">Description</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-dnac_response"></div>
<b>dnac_response</b>
<a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>always</td>
<td>
<div>A dictionary or list with the response returned by the Cisco DNAC Python SDK</div>
<br/>
<div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{
"virtualAccountId": "string",
"autoSyncPeriod": 0,
"syncResultStr": "string",
"profile": {
"proxy": true,
"makeDefault": true,
"port": 0,
"profileId": "string",
"name": "string",
"addressIpV4": "string",
"cert": "string",
"addressFqdn": "string"
},
"ccoUser": "string",
"syncResult": {
"syncList": [
{
"syncType": "string",
"deviceSnList": [
"string"
]
}
],
"syncMsg": "string"
},
"token": "string",
"syncStartTime": 0,
"lastSync": 0,
"tenantId": "string",
"smartAccountId": "string",
"expiry": 0,
"syncStatus": "string"
}</div>
</td>
</tr>
</table>
<br/><br/>
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Rafael Campos (@racampos)
.. Parsing errors