/ home / cisco / cisco.dnac / 6.13.3 / module / network_device_by_ip_info

cisco.dnac.network_device_by_ip_info (6.13.3) — module

Information module for Network Device By Ip

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

Get Network Device By Ip by id.

Returns the network device by specified IP address.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get Network Device By Ip by id
  cisco.dnac.network_device_by_ip_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    ipAddress: string
  register: result

Inputs

    
headers:
    description: Additional headers.
    type: dict

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:
    - IpAddress path parameter. Device IP address.
    type: str

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

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

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

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

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    \"apManagerInterfaceIp\": \"string\",\n    \"\
    associatedWlcIp\": \"string\",\n    \"bootDateTime\": \"string\",\n    \"collectionInterval\"\
    : \"string\",\n    \"collectionStatus\": \"string\",\n    \"errorCode\": \"string\"\
    ,\n    \"errorDescription\": \"string\",\n    \"family\": \"string\",\n    \"\
    hostname\": \"string\",\n    \"id\": \"string\",\n    \"instanceTenantId\": \"\
    string\",\n    \"instanceUuid\": \"string\",\n    \"interfaceCount\": \"string\"\
    ,\n    \"inventoryStatusDetail\": \"string\",\n    \"lastUpdateTime\": 0,\n  \
    \  \"lastUpdated\": \"string\",\n    \"lineCardCount\": \"string\",\n    \"lineCardId\"\
    : \"string\",\n    \"location\": \"string\",\n    \"locationName\": \"string\"\
    ,\n    \"macAddress\": \"string\",\n    \"managementIpAddress\": \"string\",\n\
    \    \"memorySize\": \"string\",\n    \"platformId\": \"string\",\n    \"reachabilityFailureReason\"\
    : \"string\",\n    \"reachabilityStatus\": \"string\",\n    \"role\": \"string\"\
    ,\n    \"roleSource\": \"string\",\n    \"serialNumber\": \"string\",\n    \"\
    series\": \"string\",\n    \"snmpContact\": \"string\",\n    \"snmpLocation\"\
    : \"string\",\n    \"softwareType\": \"string\",\n    \"softwareVersion\": \"\
    string\",\n    \"tagCount\": \"string\",\n    \"tunnelUdpPort\": \"string\",\n\
    \    \"type\": \"string\",\n    \"upTime\": \"string\",\n    \"waasDeviceMode\"\
    : \"string\"\n  },\n  \"version\": \"string\"\n}\n"
  type: dict