.. 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-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.inventory_intent_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.inventory_intent module -- Resource module for Network Device ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.10.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.inventory_intent`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.8.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Network Device. - Adds the device with given credential. - Deletes the network device for the given Id. - Sync the devices provided as input. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.inventory_intent_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.5.5 - 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.inventory_intent_module__parameter-config: .. rst-class:: ansible-option-title **config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
List of devices with credentails to perform Add/Update/Delete/Resync operation .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/admin_status: .. rst-class:: ansible-option-title **admin_status** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Status of Interface of a device, it can be (UP/DOWN). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/clean_config: .. rst-class:: ansible-option-title **clean_config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Required if need to delete the Provisioned device by clearing current configuration. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/cli_transport: .. rst-class:: ansible-option-title **cli_transport** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's cli transport protocol. Required for Adding Network Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/compute_device: .. rst-class:: ansible-option-title **compute_device** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Compute Device flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/deployment_mode: .. rst-class:: ansible-option-title **deployment_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Preview/Deploy [Preview means the configuration is not pushed to the device. Deploy makes the configuration pushed to the device] .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"Deploy"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Info about the global user defined field. Also used while updating interface details. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/enable_password: .. rst-class:: ansible-option-title **enable_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's enable password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/extended_discovery_info: .. rst-class:: ansible-option-title **extended_discovery_info** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's extended discovery info. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/force_sync: .. rst-class:: ansible-option-title **force_sync** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If forcesync is true then device sync would run in high priority thread if available, else the sync will fail. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/http_password: .. rst-class:: ansible-option-title **http_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's http password. Required for Adding Compute, Meraki, Firepower Management Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/http_port: .. rst-class:: ansible-option-title **http_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's http port number. Required for Adding Compute, Firepower Management Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/http_secure: .. rst-class:: ansible-option-title **http_secure** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
HttpSecure flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/http_username: .. rst-class:: ansible-option-title **http_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's http username. Required for Adding Compute,Firepower Management Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter that is Device ID. Required for Deleting/Updating Device Roles. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/ip_address: .. rst-class:: ansible-option-title **ip_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Device's ipAddress. Required for Adding/Updating/Deleting/Resyncing Device except Meraki Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/meraki_org_id: .. rst-class:: ansible-option-title **meraki_org_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Device's meraki org id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of Global User Defined Field. Required for creating/deleting UDF and then assigning it to device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/netconf_port: .. rst-class:: ansible-option-title **netconf_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's netconf port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/operation_enum: .. rst-class:: ansible-option-title **operation_enum** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
enum(CREDENTIALDETAILS, DEVICEDETAILS) 0 to export Device Credential Details Or 1 to export Device Details. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/parameters: .. rst-class:: ansible-option-title **parameters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
List of device parameters that needs to be exported to file. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's password. Required for Adding Network Device. Also needed for file encryption while exporting device in a csv file. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/role: .. rst-class:: ansible-option-title **role** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Role of device which can be ACCESS, CORE, DISTRIBUTION, BORDER ROUTER, UNKNOWN. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"ACCESS"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/role_source: .. rst-class:: ansible-option-title **role_source** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
role source for the Device. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"AUTO"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/serial_number: .. rst-class:: ansible-option-title **serial_number** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's serial number. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/site_name: .. rst-class:: ansible-option-title **site_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Required for Provisioning of Wired and Wireless Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/snmp_auth_passphrase: .. rst-class:: ansible-option-title **snmp_auth_passphrase** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's snmp auth passphrase. Required for Adding Network, Compute, Third Party Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/snmp_auth_protocol: .. rst-class:: ansible-option-title **snmp_auth_protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's snmp Auth Protocol. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"SHA"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/snmp_mode: .. rst-class:: ansible-option-title **snmp_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's snmp Mode. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"AUTHPRIV"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/snmp_priv_passphrase: .. rst-class:: ansible-option-title **snmp_priv_passphrase** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's snmp Private Passphrase. Required for Adding Network, Compute, Third Party Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/snmp_priv_protocol: .. rst-class:: ansible-option-title **snmp_priv_protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's snmp Private Protocol. Required for Adding Network, Compute, Third Party Devices. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"AES128"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/snmp_retry: .. rst-class:: ansible-option-title **snmp_retry** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Device's snmp Retry. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`3` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/snmp_ro_community: .. rst-class:: ansible-option-title **snmp_ro_community** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's snmp ROCommunity. Required for Adding V2C Devices. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"public"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/snmp_rw_community: .. rst-class:: ansible-option-title **snmp_rw_community** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's snmp RWCommunity. Required for Adding V2C Devices. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"private"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/snmp_timeout: .. rst-class:: ansible-option-title **snmp_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Device's snmp Timeout. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`5` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/snmp_username: .. rst-class:: ansible-option-title **snmp_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's snmp Username. Required for Adding Network, Compute, Third Party Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/snmp_version: .. rst-class:: ansible-option-title **snmp_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's snmp Version. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"v3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Select Device's type from NETWORK\_DEVICE, COMPUTE\_DEVICE, MERAKI\_DASHBOARD, THIRD\_PARTY\_DEVICE, FIREPOWER\_MANAGEMENT\_SYSTEM. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"NETWORK\_DEVICE"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/update_mgmt_ipaddresslist: .. rst-class:: ansible-option-title **update_mgmt_ipaddresslist** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Network Device's update Mgmt IPaddress List. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/update_mgmt_ipaddresslist/exist_mgmt_ipaddress: .. rst-class:: ansible-option-title **exist_mgmt_ipaddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's existing Mgmt IpAddress. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/update_mgmt_ipaddresslist/new_mgmt_ipaddress: .. rst-class:: ansible-option-title **new_mgmt_ipaddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's new Mgmt IpAddress. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's username. Required for Adding Network Device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Value to assign to tag with or without the same user defined field name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/vlan_id: .. rst-class:: ansible-option-title **vlan_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Unique Id number assigned to a VLAN within a network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_module__parameter-config/voice_vlan_id: .. rst-class:: ansible-option-title **voice_vlan_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Identifier used to distinguish a specific VLAN that is dedicated to voice traffic. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_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-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_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.inventory_intent_module__parameter-dnac_log: .. rst-class:: ansible-option-title **dnac_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for logging playbook execution details. If set to true the log file will be created at the location of the execution with the name dnac.log .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_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.inventory_intent_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. 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.inventory_intent_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.inventory_intent_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.inventory_intent_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:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_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.inventory_intent_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The state of Cisco DNA Center after module completion. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"merged"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"deleted"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_intent_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:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are devices.Devices.add\_device, devices.Devices.delete\_device\_by\_id, devices.Devices.sync\_devices, - Paths used are post /dna/intent/api/v1/network-device, delete /dna/intent/api/v1/network-device/{id}, put /dna/intent/api/v1/network-device, - Removed 'managementIpAddress' options in v4.3.0. - 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 See Also -------- .. seealso:: `Cisco DNA Center documentation for Devices AddDevice2 `_ Complete reference of the AddDevice2 API. `Cisco DNA Center documentation for Devices DeleteDeviceById `_ Complete reference of the DeleteDeviceById API. `Cisco DNA Center documentation for Devices SyncDevices2 `_ Complete reference of the SyncDevices2 API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Add/Update new device in Inventory with full credentials cisco.dnac.inventory_intent: 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}}" dnac_log: False state: merged config: - cli_transport: string compute_device: true enable_password: string extended_discovery_info: string http_password: string http_port: string http_secure: true http_username: string ip_address: - string meraki_org_id: - string netconf_port: string password: string serial_number: string snmp_auth_passphrase: string snmp_auth_protocol: string snmp_mode: string snmp_priv_passphrase: string snmp_priv_protocol: string snmp_ro_community: string snmp_rw_community: string snmp_retry: 3 snmp_timeout: 5 snmp_username: string snmp_version: string type: string device_added: true update_mgmt_ipaddresslist: - exist_mgmt_ipaddress: string new_mgmt_ipaddress: string username: string - name: Add new Compute device in Inventory with full credentials.Inputs needed for Compute Device cisco.dnac.inventory_intent: 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}}" dnac_log: False state: merged config: - ip_address: string http_username: string http_password: string http_port: string snmp_auth_passphrase: string snmp_auth_protocol: string snmp_mode: string snmp_priv_passphrase: string snmp_priv_protocol: string snmp_retry: 3 snmp_timeout: 5 snmp_username: string username: string device_added: true type: "COMPUTE_DEVICE" - name: Add new Meraki device in Inventory with full credentials.Inputs needed for Meraki Device. cisco.dnac.inventory_intent: 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}}" dnac_log: False state: merged config: - http_password: string device_added: true type: "MERAKI_DASHBOARD" - name: Add new Firepower Management device in Inventory with full credentials.Input needed to add Device. cisco.dnac.inventory_intent: 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}}" dnac_log: False state: merged config: - ip_address: string http_username: string http_password: string http_port: string device_added: true type: "FIREPOWER_MANAGEMENT_SYSTEM" - name: Add new Third Party device in Inventory with full credentials.Input needed to add Device. cisco.dnac.inventory_intent: 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}}" dnac_log: False state: merged config: - ip_address: string snmp_auth_passphrase: string snmp_auth_protocol: string snmp_mode: string snmp_priv_passphrase: string snmp_priv_protocol: string snmp_retry: 3 snmp_timeout: 5 snmp_username: string device_added: true type: "THIRD_PARTY_DEVICE" - name: Associate Wired Devices to site and Provisioned it in Inventory cisco.dnac.inventory_intent: 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}}" dnac_log: False state: merged config: - ip_address: string provision_wired_device: site_name: string - name: Update Device Role with IP Address cisco.dnac.inventory_intent: 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}}" dnac_log: False state: merged config: - ip_address: string device_updated: true update_device_role: role: string role_source: string - name: Update Interface details with IP Address cisco.dnac.inventory_intent: 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}}" dnac_log: False state: merged config: - ip_address: string device_updated: true update_interface_details: description: str admin_status: str vlan_id: int voice_vlan_id: int - name: Export Device Details in a CSV file Interface details with IP Address cisco.dnac.inventory_intent: 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}}" dnac_log: False state: merged config: - ip_address: string export_device_list: password: str operation_enum: str parameters: str - name: Create Global User Defined with IP Address cisco.dnac.inventory_intent: 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}}" dnac_log: False state: merged config: - ip_address: string add_user_defined_field: name: string description: string value: string - name: Resync Device with IP Addresses cisco.dnac.inventory_intent: 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}}" dnac_log: False state: merged config: - ip_address: string device_resync: true force_sync: false - name: Reboot AP Devices with IP Addresses cisco.dnac.inventory_intent: 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}}" dnac_log: False state: merged config: - ip_address: string reboot_device: true - name: Delete Provision/Unprovisioned Devices by IP Address cisco.dnac.inventory_intent: 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}}" dnac_log: False state: deleted config: - ip_address: string clean_config: false - name: Delete Global User Defined Field with name cisco.dnac.inventory_intent: 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}}" dnac_log: False state: deleted config: - ip_address: string add_user_defined_field: name: 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.inventory_intent_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 DNA Center 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:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Abhishek Maheshwari (@abmahesh) Madhan Sankaranarayanan (@madhansansel) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors