cisco.dnac.network_device – Resource module for Network Device
Note
This plugin is part of the cisco.dnac collection (version 3.2.2).
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.
To use it in a playbook, specify: cisco.dnac.network_device.
New in version 3.1.0: of cisco.dnac
Synopsis
Manage operations create, update and delete of the resource Network Device.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.3.1
python >= 3.5
Parameters
Notes
Note
Does not support
check_modeThe 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
- Network Device reference
Complete reference of the Network Device object model.
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
updateMgmtIPaddressList:
- existMgmtIpAddress: string
newMgmtIpAddress: 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
id: string
isForceDelete: true
Return Values
Common return values are documented here, the following are the fields unique to this module: