.. 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.network_devices_validate_device_create_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.network_devices_validate_device_create module -- Resource module for Network Devices Validate Device Create ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.46.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.network_devices_validate_device_create`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.46.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Network Devices Validate Device Create. - \> Validates the credentials and connectivity of a network device. This endpoint checks if the provided details are correct and if the device can be reached. The task response contains status for HTTP, SNMP, CLI, NETCONF, Enable Password and CLI Priviledge 15. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.11.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-category: .. rst-class:: ansible-option-title **category** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Category of the device. Used to determine the type of the device being added. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials: .. rst-class:: ansible-option-title **credentials** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Devices Validate Device Create's credentials. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/cli: .. rst-class:: ansible-option-title **cli** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Devices Validate Device Create's cli. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/cli/enablepassword: .. rst-class:: ansible-option-title **enablePassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password that is used to move to a higher privilege level in the CLI. Configure this password only if your network devices require it. Passwords cannot contain spaces or angle brackets(\<\>). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/cli/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
CLI Password. Passwords cannot contain spaces or angle brackets(\<\>). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/cli/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Protocol used for CLI access. Default is SSH. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/cli/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
CLI username to login to the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/http: .. rst-class:: ansible-option-title **http** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Devices Validate Device Create's http. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/http/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HTTP password. The password cannot contain spaces or angle brackets (\< \>). Note that some Cisco IOS XE devices do not allow a question mark (?). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/http/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
HTTP port. The default port is 443 for protocol= HTTPS and 80 for protocol=HTTP. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/http/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HTTP protocol. Compute device require HTTPS. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/http/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HTTP username. Username cannot contain spaces or angle brackets (\< \>). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/meraki: .. rst-class:: ansible-option-title **meraki** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Devices Validate Device Create's meraki. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/meraki/apikey: .. rst-class:: ansible-option-title **apiKey** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Meraki API key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/meraki/orgids: .. rst-class:: ansible-option-title **orgIds** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Meraki organizations for which the devices needs to be imported. Imports devices from all organizations if not provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/netconf: .. rst-class:: ansible-option-title **netconf** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Devices Validate Device Create's netconf. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/netconf/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Netconf port of the device. Default port is 830. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/snmp: .. rst-class:: ansible-option-title **snmp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Devices Validate Device Create's snmp. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/snmp/authpassword: .. rst-class:: ansible-option-title **authPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMPv3 authentication password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/snmp/authtype: .. rst-class:: ansible-option-title **authType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMPv3 authentication type. Required for AUTHPRIV (Authentication and Privacy) and AUTHNOPRIV (Authentication) modes. SHA256 The device will be authenticated using SHA256. SHA The device will be authenticated using SHA. MD5 The device will be authenticated using MD5. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/snmp/mode: .. rst-class:: ansible-option-title **mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Security level that an SNMP message requires. AUTHPRIV provides both authentication and encryption. AUTHNOPRIV provides authentication, but does not provide encryption. NOAUTHNOPRIV does not provide authentication or encryption. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/snmp/privacypassword: .. rst-class:: ansible-option-title **privacyPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMPv3 privacy password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/snmp/privacytype: .. rst-class:: ansible-option-title **privacyType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP privacy type. Required if the SNMP mode is AUTHPRIV. AES128 algorithm used for encryption. AES192 algorithm used for encryption. AES256 algorithm used for encryption. CISCOAES192 algorithm used for encryption. CISCOAES256 algorithm used for encryption. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/snmp/readcommunity: .. rst-class:: ansible-option-title **readCommunity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Read-only community string password used only to view SNMP information on the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/snmp/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name associated with the SNMPv3 settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/snmp/version: .. rst-class:: ansible-option-title **version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP version to be used for the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-credentials/snmp/writecommunity: .. rst-class:: ansible-option-title **writeCommunity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Write community string used to make changes to the SNMP information on the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_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.network_devices_validate_device_create_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.network_devices_validate_device_create_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.network_devices_validate_device_create_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.network_devices_validate_device_create_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.network_devices_validate_device_create_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.network_devices_validate_device_create_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.network_devices_validate_device_create_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:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_module__parameter-managementaddress: .. rst-class:: ansible-option-title **managementAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Management address of the network device. For meraki dashboard, this is the dashboard URL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_validate_device_create_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.validates\_a\_network\_device, - Paths used are post /dna/intent/api/v1/networkDevices/validateDevice, - 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 ValidatesANetworkDevice `_ Complete reference of the ValidatesANetworkDevice API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.dnac.network_devices_validate_device_create: 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}}" category: string credentials: cli: enablePassword: string password: string protocol: string username: string http: password: string port: 0 protocol: string username: string meraki: apiKey: string orgIds: - string netconf: port: 0 snmp: authPassword: string authType: string mode: string privacyPassword: string privacyType: string readCommunity: string username: string version: string writeCommunity: string managementAddress: 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.network_devices_validate_device_create_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:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors