cisco.dnac.network_device – Resource module for Network Device

Note

This plugin is part of the cisco.dnac collection (version 3.1.6).

To install it use: ansible-galaxy collection install cisco.dnac.

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

New in version 1.0.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

Parameters

Parameter Choices/Defaults Comments
cliTransport
string
Network Device's cliTransport.
computeDevice
boolean
    Choices:
  • no
  • yes
ComputeDevice flag.
enablePassword
string
Network Device's enablePassword.
extendedDiscoveryInfo
string
Network Device's extendedDiscoveryInfo.
httpPassword
string
Network Device's httpPassword.
httpPort
string
Network Device's httpPort.
httpSecure
boolean
    Choices:
  • no
  • yes
HttpSecure flag.
httpUserName
string
Network Device's httpUserName.
id
string
Id path parameter. Device ID.
ipAddress
list / elements=string
Network Device's ipAddress.
isForceDelete
boolean
    Choices:
  • no
  • yes
IsForceDelete query parameter.
merakiOrgId
list / elements=string
Network Device's merakiOrgId.
netconfPort
string
Network Device's netconfPort.
password
string
Network Device's password.
serialNumber
string
Network Device's serialNumber.
snmpAuthPassphrase
string
Network Device's snmpAuthPassphrase.
snmpAuthProtocol
string
Network Device's snmpAuthProtocol.
snmpMode
string
Network Device's snmpMode.
snmpPrivPassphrase
string
Network Device's snmpPrivPassphrase.
snmpPrivProtocol
string
Network Device's snmpPrivProtocol.
snmpRetry
integer
Network Device's snmpRetry.
snmpROCommunity
string
Network Device's snmpROCommunity.
snmpRWCommunity
string
Network Device's snmpRWCommunity.
snmpTimeout
integer
Network Device's snmpTimeout.
snmpUserName
string
Network Device's snmpUserName.
snmpVersion
string
Network Device's snmpVersion.
type
string
Network Device's type.
updateMgmtIPaddressList
list / elements=string
Network Device's updateMgmtIPaddressList.
existMgmtIpAddress
string
Network Device's existMgmtIpAddress.
newMgmtIpAddress
string
Network Device's newMgmtIpAddress.
userName
string
Network Device's userName.

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:

Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "response": { "taskId": "string", "url": "string" }, "version": "string" }


Authors

  • Rafael Campos (@racampos)