/ home / cisco / cisco.dnac / 6.13.3 / module / topology_physical_info

cisco.dnac.topology_physical_info (6.13.3) — module

Information module for Topology Physical

| "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 all Topology Physical.

Returns the raw physical topology by specified criteria of nodeType.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Topology Physical
  cisco.dnac.topology_physical_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}}"
    nodeType: string
  register: result

Inputs

    
headers:
    description: Additional headers.
    type: dict

nodeType:
    description:
    - NodeType query parameter.
    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

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    \"id\": \"string\",\n    \"links\": [\n     \
    \ {\n        \"additionalInfo\": {},\n        \"endPortID\": \"string\",\n   \
    \     \"endPortIpv4Address\": \"string\",\n        \"endPortIpv4Mask\": \"string\"\
    ,\n        \"endPortName\": \"string\",\n        \"endPortSpeed\": \"string\"\
    ,\n        \"greyOut\": true,\n        \"id\": \"string\",\n        \"linkStatus\"\
    : \"string\",\n        \"source\": \"string\",\n        \"startPortID\": \"string\"\
    ,\n        \"startPortIpv4Address\": \"string\",\n        \"startPortIpv4Mask\"\
    : \"string\",\n        \"startPortName\": \"string\",\n        \"startPortSpeed\"\
    : \"string\",\n        \"tag\": \"string\",\n        \"target\": \"string\"\n\
    \      }\n    ],\n    \"nodes\": [\n      {\n        \"aclApplied\": true,\n \
    \       \"additionalInfo\": {},\n        \"customParam\": {\n          \"id\"\
    : \"string\",\n          \"label\": \"string\",\n          \"parentNodeId\": \"\
    string\",\n          \"x\": 0,\n          \"y\": 0\n        },\n        \"dataPathId\"\
    : \"string\",\n        \"deviceType\": \"string\",\n        \"family\": \"string\"\
    ,\n        \"fixed\": true,\n        \"greyOut\": true,\n        \"id\": \"string\"\
    ,\n        \"ip\": \"string\",\n        \"label\": \"string\",\n        \"networkType\"\
    : \"string\",\n        \"nodeType\": \"string\",\n        \"order\": 0,\n    \
    \    \"osType\": \"string\",\n        \"platformId\": \"string\",\n        \"\
    role\": \"string\",\n        \"roleSource\": \"string\",\n        \"softwareVersion\"\
    : \"string\",\n        \"tags\": [\n          \"string\"\n        ],\n       \
    \ \"upperNode\": \"string\",\n        \"userId\": \"string\",\n        \"vlanId\"\
    : \"string\",\n        \"x\": 0,\n        \"y\": 0\n      }\n    ]\n  },\n  \"\
    version\": \"string\"\n}\n"
  type: dict