cisco.dnac.inventory_intent module – Resource module for Network Device

Note

This module is part of the cisco.dnac collection (version 6.10.3).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.inventory_intent.

New in cisco.dnac 6.8.0

Synopsis

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

Requirements

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

• dnacentersdk >= 2.5.5

• python >= 3.5

Parameters

Parameter	Comments
config list / elements=dictionary / required	List of devices with credentails to perform Add/Update/Delete/Resync operation
admin_status string	Status of Interface of a device, it can be (UP/DOWN).
clean_config boolean	Required if need to delete the Provisioned device by clearing current configuration. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
cli_transport string	Device’s cli transport protocol. Required for Adding Network Devices.
compute_device boolean	Compute Device flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
credential_update boolean	Make this as true needed for the updation of device credentials and other device details. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
deployment_mode string	Preview/Deploy [Preview means the configuration is not pushed to the device. Deploy makes the configuration pushed to the device] Default: :ansible-option-default:`"Deploy"`
description string	Info about the global user defined field. Also used while updating interface details.
device_added boolean	Make this as true needed for the addition of device in inventory. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
device_resync boolean	Make this as true needed for the resyncing of device. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
device_updated boolean	Make this as true needed for the updation of device role, interface details, device credentails or details. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dynamic_interfaces list / elements=dictionary	Interface details of the wireless device
interface_gateway string	Ip Address allocated to the interface
interface_ip_address string	Ip Address allocated to the interface
interface_name string	Ip Address allocated to the interface
interface_netmask_in_cidr integer	Ip Address allocated to the interface
lag_or_port_number integer	Ip Address allocated to the interface
vlan_id integer	Ip Address allocated to the interface
enable_password string	Device’s enable password.
extended_discovery_info string	Device’s extended discovery info.
force_sync boolean	If forcesync is true then device sync would run in high priority thread if available, else the sync will fail. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
http_password string	Device’s http password. Required for Adding Compute, Meraki, Firepower Management Devices.
http_port string	Device’s http port number. Required for Adding Compute, Firepower Management Devices.
http_secure boolean	HttpSecure flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
http_username string	Device’s http username. Required for Adding Compute,Firepower Management Devices.
ip_address list / elements=string	Device’s ipAddress. Required for Adding/Updating/Deleting/Resyncing Device except Meraki Devices.
managed_ap_locations list / elements=string	Location of the sites allocated for the APs
name string	Name of Global User Defined Field. Required for creating/deleting UDF and then assigning it to device.
netconf_port string	Device’s netconf port.
operation_enum string	enum(CREDENTIALDETAILS, DEVICEDETAILS) 0 to export Device Credential Details Or 1 to export Device Details.
parameters string	List of device parameters that needs to be exported to file.
password string	Device’s password. Required for Adding Network Device. Also needed for file encryption while exporting device in a csv file.
reboot_device boolean	Make this as true needed for the Rebooting of Access Points. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
role string	Role of device which can be ACCESS, CORE, DISTRIBUTION, BORDER ROUTER, UNKNOWN. Default: :ansible-option-default:`"ACCESS"`
role_source string	role source for the Device. Default: :ansible-option-default:`"AUTO"`
serial_number string	Device’s serial number.
site_name string	Required for Provisioning of Wired and Wireless Devices.
snmp_auth_passphrase string	Device’s snmp auth passphrase. Required for Adding Network, Compute, Third Party Devices.
snmp_auth_protocol string	Device’s snmp Auth Protocol. Default: :ansible-option-default:`"SHA"`
snmp_mode string	Device’s snmp Mode. Default: :ansible-option-default:`"AUTHPRIV"`
snmp_priv_passphrase string	Device’s snmp Private Passphrase. Required for Adding Network, Compute, Third Party Devices.
snmp_priv_protocol string	Device’s snmp Private Protocol. Required for Adding Network, Compute, Third Party Devices. Must be given in playbook if you are updating the device credentails. Default: :ansible-option-default:`"AES128"`
snmp_retry integer	Device’s snmp Retry. Default: :ansible-option-default:`3`
snmp_ro_community string	Device’s snmp ROCommunity. Required for Adding V2C Devices. Default: :ansible-option-default:`"public"`
snmp_rw_community string	Device’s snmp RWCommunity. Required for Adding V2C Devices. Default: :ansible-option-default:`"private"`
snmp_timeout integer	Device’s snmp Timeout. Default: :ansible-option-default:`5`
snmp_username string	Device’s snmp Username. Required for Adding Network, Compute, Third Party Devices.
snmp_version string	Device’s snmp Version. Default: :ansible-option-default:`"v3"`
type string	Select Device’s type from NETWORK_DEVICE, COMPUTE_DEVICE, MERAKI_DASHBOARD, THIRD_PARTY_DEVICE, FIREPOWER_MANAGEMENT_SYSTEM. Default: :ansible-option-default:`"NETWORK\_DEVICE"`
update_mgmt_ipaddresslist list / elements=dictionary	Network Device’s update Mgmt IPaddress List.
exist_mgmt_ipaddress string	Device’s existing Mgmt IpAddress.
new_mgmt_ipaddress string	Device’s new Mgmt IpAddress.
username string	Network Device’s username. Required for Adding Network Device.
value string	Value to assign to tag with or without the same user defined field name.
vlan_id integer	Unique Id number assigned to a VLAN within a network.
voice_vlan_id integer	Identifier used to distinguish a specific VLAN that is dedicated to voice traffic.
config_verify boolean	Set to True to verify the Cisco DNA Center config after applying the playbook config. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_host string / required	The Cisco DNA Center hostname.
dnac_log boolean	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 Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_log_level string	Specifies the log level for Cisco Catalyst Center logging, categorizing logs by severity. Options- [CRITICAL, ERROR, WARNING, INFO, DEBUG] Default: :ansible-option-default:`"INFO"`
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port string	The Cisco DNA Center port. Default: :ansible-option-default:`"443"`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.2.3.3"`
state string	The state of Cisco DNA Center after module completion. Choices: :ansible-option-choices-entry-default:`"merged"` ← (default) :ansible-option-choices-entry:`"deleted"`
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

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

See Also

See also

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

- name: Add 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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: merged
    config:
      - cli_transport: string
        compute_device: false
        enable_password: string
        extended_discovery_info: string
        http_password: string
        http_port: string
        http_secure: false
        http_username: string
        ip_address:
        - 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
        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_level: "{{dnac_log_level}}"
    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
        compute_device: true
        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_level: "{{dnac_log_level}}"
    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_level: "{{dnac_log_level}}"
    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_level: "{{dnac_log_level}}"
    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: Update device details or credentails 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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: merged
    config:
      - cli_transport: string
        compute_device: false
        password: string
        enable_password: string
        extended_discovery_info: string
        http_password: string
        http_port: string
        http_secure: false
        http_username: string
        ip_address:
        - string
        netconf_port: string
        serial_number: string
        snmp_auth_passphrase: string
        snmp_auth_protocol: string
        snmp_mode: string
        snmp_priv_passphrase: string
        snmp_priv_protocol: string
        snmp_username: string
        snmp_version: string
        type: string
        device_update: true
        credential_update: true
        update_mgmt_ipaddresslist:
        - exist_mgmt_ipaddress: string
          new_mgmt_ipaddress: string
        username: string

- 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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: merged
    config:
      - ip_address:
        - string
        provision_wired_device:
          site_name: string

- name: Associate Wireless 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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: merged
    config:
      - ip_address:
        - string
        provision_wireless_device:
        - site_name: string
        managed_ap_locations:
        - string
        dynamic_interfaces:
        - interface_ip_address: string
          interface_netmask_in_cidr: int
          interface_gateway: string
          lag_or_port_number: int
          vlan_id: int
          interface_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_level: "{{dnac_log_level}}"
    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_level: "{{dnac_log_level}}"
    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
          deployment_mode: str

- 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_level: "{{dnac_log_level}}"
    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_level: "{{dnac_log_level}}"
    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_level: "{{dnac_log_level}}"
    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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: merged
    config:
      - ip_address:
        - string
        reboot_device: true

- name: Delete Provision/Unprovision 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
    dnac_log_level: "{{dnac_log_level}}"
    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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: deleted
    config:
    - ip_address:
        - string
      add_user_defined_field:
        name: string

Return Values

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

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNA Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Abhishek Maheshwari (@abmahesh) Madhan Sankaranarayanan (@madhansansel)

Collection links

Issue Tracker Repository (Sources)