/ home / cisco / cisco.dnac / 2.0.7 / module / topology

cisco.dnac.topology (2.0.7) — module

Manage Topology objects of Topology

| "added in version" 1.0.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:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Returns Layer 2 network Topology by specified VLAN ID.

Returns the Layer 3 network Topology by routing protocol.

Returns the raw physical Topology by specified criteria of nodeType.

Returns site Topology.

Returns the list of VLAN names.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: get_topology_details
  cisco.dnac.topology:
    state: query  # required
    vlan_id: SomeValue  # string, required
    layer2: True  # boolean, required
  register: nm_get_topology_details

Scanned by Steampunk Spotter

- name: get_l3_topology_details
  cisco.dnac.topology:
    state: query  # required
    topology_type: SomeValue  # string, required
    layer3: True  # boolean, required
  register: nm_get_l3_topology_details

Scanned by Steampunk Spotter

- name: get_physical_topology
  cisco.dnac.topology:
    state: query  # required
    physical: True  # boolean, required
    node_type: SomeValue  # string
  register: nm_get_physical_topology

Scanned by Steampunk Spotter

- name: get_site_topology
  cisco.dnac.topology:
    state: query  # required
    site: True  # boolean, required
  register: nm_get_site_topology

Scanned by Steampunk Spotter

- name: get_vlan_details
  cisco.dnac.topology:
    state: query  # required
    vlan: True  # boolean, required
  register: nm_get_vlan_details

Inputs

    
site:
    description:
    - If true retrieves the site Topology.
    required: true
    type: bool

vlan:
    description:
    - If true retrieves the vlan Topology.
    required: true
    type: bool

layer2:
    description:
    - If true retrieves the layer 2 Topology.
    required: true
    type: bool

layer3:
    description:
    - If true retrieves the layer 3 Topology.
    required: true
    type: bool

vlan_id:
    description:
    - Vlan Name for e.g Vlan1, Vlan23 etc.
    required: true
    type: str

physical:
    description:
    - If true retrieves the physical Topology.
    required: true
    type: bool

node_type:
    description:
    - NodeType query parameter.
    type: str

topology_type:
    description:
    - Type of Topology(OSPF,ISIS,etc).
    required: true
    type: str

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: topology.get_l3_topology_details
  type: str

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also