cisco.dnac.network_device module – Resource module for Network Device
Note
This module is part of the cisco.dnac collection (version 6.22.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 ansible-galaxy collection list
.
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.network_device
.
New in cisco.dnac 3.1.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.
Update the credentials, management IP address of a given device or a set of devices in Catalyst Center and trigger an inventory sync.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
CleanConfig query parameter. Choices:
|
|
CLI transport. Supported values telnet, ssh2. |
|
Compute Device or not. Options are TRUE / FALSE. Choices:
|
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
CLI enable password of the device. |
|
This field holds that info as whether to add device with canned data or not. Supported values DISCOVER_WITH_CANNED_DATA. |
|
HTTP password of the device. |
|
HTTP port of the device. |
|
Flag to select HTTP / HTTPS protocol. Options are TRUE / FALSE. TRUE for HTTPS and FALSE for HTTP. Choices:
|
|
HTTP Username of the device. |
|
Id path parameter. Device ID. |
|
IP Address of the device. |
|
Selected meraki organization for which the devices needs to be imported. |
|
Netconf Port of the device. |
|
CLI Password of the device. |
|
Serial Number of the Device. |
|
SNMPV3 auth passphrase of the device. |
|
SNMPV3 auth protocol. Supported values sha, md5. |
|
SNMPV3 mode. Supported values noAuthnoPriv, authNoPriv, authPriv. |
|
SNMPV3 priv passphrase. |
|
SNMPV3 priv protocol. Supported values AES128. |
|
SNMP retry count. Max value supported is 3. Default is Global SNMP retry (if exists) or 3. |
|
SNMP Read Community of the device. |
|
SNMP Write Community of the device. |
|
SNMP timeout in seconds. Max value supported is 300. Default is Global SNMP timeout (if exists) or 5. |
|
SNMPV3 user name of the device. |
|
SNMP version. Values supported v2, v3. Default is v2. |
|
Type of device being added. |
|
Network Device’s updateMgmtIPaddressList. |
|
ExistMgmtIpAddress IP Address of the device. |
|
New IP Address to be Updated. |
|
CLI user name of the device. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
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 UpdateDeviceDetails
Complete reference of the UpdateDeviceDetails API.
Examples
- name: Create
cisco.dnac.network_device:
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}}"
state: present
cliTransport: string
computeDevice: true
enablePassword: string
extendedDiscoveryInfo: string
httpPassword: string
httpPort: string
httpSecure: true
httpUserName: string
ipAddress:
- string
merakiOrgId:
- string
netconfPort: string
password: string
serialNumber: string
snmpAuthPassphrase: string
snmpAuthProtocol: string
snmpMode: string
snmpPrivPassphrase: string
snmpPrivProtocol: string
snmpROCommunity: string
snmpRWCommunity: string
snmpRetry: 0
snmpTimeout: 0
snmpUserName: string
snmpVersion: string
type: string
userName: string
- name: Update all
cisco.dnac.network_device:
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}}"
state: present
cliTransport: string
computeDevice: true
enablePassword: string
extendedDiscoveryInfo: string
httpPassword: string
httpPort: string
httpSecure: true
httpUserName: string
ipAddress:
- string
merakiOrgId:
- string
netconfPort: string
password: string
serialNumber: string
snmpAuthPassphrase: string
snmpAuthProtocol: string
snmpMode: string
snmpPrivPassphrase: string
snmpPrivProtocol: string
snmpROCommunity: string
snmpRWCommunity: string
snmpRetry: 0
snmpTimeout: 0
snmpUserName: string
snmpVersion: string
type: string
updateMgmtIPaddressList:
- existMgmtIpAddress: string
newMgmtIpAddress: string
userName: string
- name: Delete by id
cisco.dnac.network_device:
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}}"
state: absent
cleanConfig: true
id: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |