cisco.dnac.network_device (6.13.3) — module

Resource module for Network Device

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3


Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
id:
    description: Id path parameter. Device ID.
    type: str

type:
    description: Network Device's type.
    type: str

httpPort:
    description: Network Device's httpPort.
    type: str

password:
    description: Network Device's password.
    type: str

snmpMode:
    description: Network Device's snmpMode.
    type: str

userName:
    description: Network Device's userName.
    type: str

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

ipAddress:
    description: Network Device's ipAddress.
    elements: str
    type: list

snmpRetry:
    description: Network Device's snmpRetry.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

httpSecure:
    description: HttpSecure flag.
    type: bool

cleanConfig:
    description: CleanConfig query parameter.
    type: bool
    version_added: 4.0.0
    version_added_collection: cisco.dnac

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

merakiOrgId:
    description: Network Device's merakiOrgId.
    elements: str
    type: list

netconfPort:
    description: Network Device's netconfPort.
    type: str

snmpTimeout:
    description: Network Device's snmpTimeout.
    type: int

snmpVersion:
    description: Network Device's snmpVersion.
    type: str

cliTransport:
    description: Network Device's cliTransport.
    type: str

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

httpPassword:
    description: Network Device's httpPassword.
    type: str

httpUserName:
    description: Network Device's httpUserName.
    type: str

serialNumber:
    description: Network Device's serialNumber.
    type: str

snmpUserName:
    description: Network Device's snmpUserName.
    type: str

computeDevice:
    description: ComputeDevice flag.
    type: bool

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

enablePassword:
    description: Network Device's enablePassword.
    type: str

snmpROCommunity:
    description: Network Device's snmpROCommunity.
    type: str

snmpRWCommunity:
    description: Network Device's snmpRWCommunity.
    type: str

snmpAuthProtocol:
    description: Network Device's snmpAuthProtocol.
    type: str

snmpPrivProtocol:
    description: Network Device's snmpPrivProtocol.
    type: str

snmpAuthPassphrase:
    description: Network Device's snmpAuthPassphrase.
    type: str

snmpPrivPassphrase:
    description: Network Device's snmpPrivPassphrase.
    type: str

extendedDiscoveryInfo:
    description: Network Device's extendedDiscoveryInfo.
    type: str

updateMgmtIPaddressList:
    description: Network Device's updateMgmtIPaddressList.
    elements: dict
    suboptions:
      existMgmtIpAddress:
        description: Network Device's existMgmtIpAddress.
        type: str
      newMgmtIpAddress:
        description: Network Device's newMgmtIpAddress.
        type: str
    type: list

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": {\n    \"taskId\": \"string\",\n    \"url\": \"string\"\
    \n  },\n  \"version\": \"string\"\n}\n"
  type: dict

See also