Try SpotterManage Topology objects of Topology
| "added in version" 1.0 of racampos.dnac"
Authors: first last (@GitHubID)
preview | supported by community
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install racampos.dnac:==0.0.1
collections:
- name: racampos.dnac
version: 0.0.1Returns 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.
- name: get_topology_details
cisco.dnac.topology:
state: query # required
vlan_id: SomeValue # string, required
layer2: True # boolean, required
register: query_result
- name: get_l3_topology_details
cisco.dnac.topology:
state: query # required
topology_type: SomeValue # string, required
layer3: True # boolean, required
register: query_result
- name: get_physical_topology
cisco.dnac.topology:
state: query # required
physical: True # boolean, required
node_type: SomeValue # string
register: query_result
- name: get_site_topology
cisco.dnac.topology:
state: query # required
site: True # boolean, required
register: query_result
- name: get_vlan_details
cisco.dnac.topology:
state: query # required
vlan: True # boolean, required
register: query_result
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
get_l3_topology_details:
contains: null
description: Returns the Layer 3 network Topology by routing protocol.
response:
contains:
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
links:
contains:
additionalInfo:
description: It is the Topology's additionalInfo.
returned: always
type: dict
endPortID:
description: It is the Topology's endPortID.
returned: always
sample: <endportid>
type: str
endPortIpv4Address:
description: It is the Topology's endPortIpv4Address.
returned: always
sample: <endportipv4address>
type: str
endPortIpv4Mask:
description: It is the Topology's endPortIpv4Mask.
returned: always
sample: <endportipv4mask>
type: str
endPortName:
description: It is the Topology's endPortName.
returned: always
sample: <endportname>
type: str
endPortSpeed:
description: It is the Topology's endPortSpeed.
returned: always
sample: <endportspeed>
type: str
greyOut:
description: It is the Topology's greyOut.
returned: always
sample: false
type: bool
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
linkStatus:
description: It is the Topology's linkStatus.
returned: always
sample: <linkstatus>
type: str
source:
description: It is the Topology's source.
returned: always
sample: <source>
type: str
startPortID:
description: It is the Topology's startPortID.
returned: always
sample: <startportid>
type: str
startPortIpv4Address:
description: It is the Topology's startPortIpv4Address.
returned: always
sample: <startportipv4address>
type: str
startPortIpv4Mask:
description: It is the Topology's startPortIpv4Mask.
returned: always
sample: <startportipv4mask>
type: str
startPortName:
description: It is the Topology's startPortName.
returned: always
sample: <startportname>
type: str
startPortSpeed:
description: It is the Topology's startPortSpeed.
returned: always
sample: <startportspeed>
type: str
tag:
description: It is the Topology's tag.
returned: always
sample: <tag>
type: str
target:
description: It is the Topology's target.
returned: always
sample: <target>
type: str
description: It is the Topology's links.
returned: always
type: list
nodes:
contains:
aclApplied:
description: It is the Topology's aclApplied.
returned: always
sample: false
type: bool
additionalInfo:
description: It is the Topology's additionalInfo.
returned: always
type: dict
customParam:
contains:
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
label:
description: It is the Topology's label.
returned: always
sample: <label>
type: str
parentNodeId:
description: It is the Topology's parentNodeId.
returned: always
sample: <parentnodeid>
type: str
x:
description: It is the Topology's x.
returned: always
sample: 0
type: int
y:
description: It is the Topology's y.
returned: always
sample: 0
type: int
description: It is the Topology's customParam.
returned: always
type: dict
dataPathId:
description: It is the Topology's dataPathId.
returned: always
sample: <datapathid>
type: str
deviceType:
description: It is the Topology's deviceType.
returned: always
sample: <devicetype>
type: str
family:
description: It is the Topology's family.
returned: always
sample: <family>
type: str
fixed:
description: It is the Topology's fixed.
returned: always
sample: false
type: bool
greyOut:
description: It is the Topology's greyOut.
returned: always
sample: false
type: bool
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
ip:
description: It is the Topology's ip.
returned: always
sample: 1.1.1.17
type: str
label:
description: It is the Topology's label.
returned: always
sample: <label>
type: str
networkType:
description: It is the Topology's networkType.
returned: always
sample: <networktype>
type: str
nodeType:
description: It is the Topology's nodeType.
returned: always
sample: <nodetype>
type: str
order:
description: It is the Topology's order.
returned: always
sample: 0
type: int
osType:
description: It is the Topology's osType.
returned: always
sample: <ostype>
type: str
platformId:
description: It is the Topology's platformId.
returned: always
sample: <platformid>
type: str
role:
description: It is the Topology's role.
returned: always
sample: <role>
type: str
roleSource:
description: It is the Topology's roleSource.
returned: always
sample: <rolesource>
type: str
softwareVersion:
description: It is the Topology's softwareVersion.
returned: always
sample: <softwareversion>
type: str
tags:
description: It is the Topology's tags.
returned: always
type: list
upperNode:
description: It is the Topology's upperNode.
returned: always
sample: <uppernode>
type: str
userId:
description: It is the Topology's userId.
returned: always
sample: <userid>
type: str
vlanId:
description: It is the Topology's vlanId.
returned: always
sample: <vlanid>
type: str
x:
description: It is the Topology's x.
returned: always
sample: 0
type: int
y:
description: It is the Topology's y.
returned: always
sample: 0
type: int
description: It is the Topology's nodes.
returned: always
type: list
description: Response, property of the response body.
returned: always
type: dict
returned: always
type: dict
version:
description: Version, property of the response body.
returned: always
sample: '1.0'
type: str
get_physical_topology:
contains: null
description: Returns the raw physical Topology by specified criteria of nodeType.
response:
contains:
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
links:
contains:
additionalInfo:
description: It is the Topology's additionalInfo.
returned: always
type: dict
endPortID:
description: It is the Topology's endPortID.
returned: always
sample: <endportid>
type: str
endPortIpv4Address:
description: It is the Topology's endPortIpv4Address.
returned: always
sample: <endportipv4address>
type: str
endPortIpv4Mask:
description: It is the Topology's endPortIpv4Mask.
returned: always
sample: <endportipv4mask>
type: str
endPortName:
description: It is the Topology's endPortName.
returned: always
sample: <endportname>
type: str
endPortSpeed:
description: It is the Topology's endPortSpeed.
returned: always
sample: <endportspeed>
type: str
greyOut:
description: It is the Topology's greyOut.
returned: always
sample: false
type: bool
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
linkStatus:
description: It is the Topology's linkStatus.
returned: always
sample: <linkstatus>
type: str
source:
description: It is the Topology's source.
returned: always
sample: <source>
type: str
startPortID:
description: It is the Topology's startPortID.
returned: always
sample: <startportid>
type: str
startPortIpv4Address:
description: It is the Topology's startPortIpv4Address.
returned: always
sample: <startportipv4address>
type: str
startPortIpv4Mask:
description: It is the Topology's startPortIpv4Mask.
returned: always
sample: <startportipv4mask>
type: str
startPortName:
description: It is the Topology's startPortName.
returned: always
sample: <startportname>
type: str
startPortSpeed:
description: It is the Topology's startPortSpeed.
returned: always
sample: <startportspeed>
type: str
tag:
description: It is the Topology's tag.
returned: always
sample: <tag>
type: str
target:
description: It is the Topology's target.
returned: always
sample: <target>
type: str
description: It is the Topology's links.
returned: always
type: list
nodes:
contains:
aclApplied:
description: It is the Topology's aclApplied.
returned: always
sample: false
type: bool
additionalInfo:
description: It is the Topology's additionalInfo.
returned: always
type: dict
customParam:
contains:
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
label:
description: It is the Topology's label.
returned: always
sample: <label>
type: str
parentNodeId:
description: It is the Topology's parentNodeId.
returned: always
sample: <parentnodeid>
type: str
x:
description: It is the Topology's x.
returned: always
sample: 0
type: int
y:
description: It is the Topology's y.
returned: always
sample: 0
type: int
description: It is the Topology's customParam.
returned: always
type: dict
dataPathId:
description: It is the Topology's dataPathId.
returned: always
sample: <datapathid>
type: str
deviceType:
description: It is the Topology's deviceType.
returned: always
sample: <devicetype>
type: str
family:
description: It is the Topology's family.
returned: always
sample: <family>
type: str
fixed:
description: It is the Topology's fixed.
returned: always
sample: false
type: bool
greyOut:
description: It is the Topology's greyOut.
returned: always
sample: false
type: bool
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
ip:
description: It is the Topology's ip.
returned: always
sample: 1.1.1.17
type: str
label:
description: It is the Topology's label.
returned: always
sample: <label>
type: str
networkType:
description: It is the Topology's networkType.
returned: always
sample: <networktype>
type: str
nodeType:
description: It is the Topology's nodeType.
returned: always
sample: <nodetype>
type: str
order:
description: It is the Topology's order.
returned: always
sample: 0
type: int
osType:
description: It is the Topology's osType.
returned: always
sample: <ostype>
type: str
platformId:
description: It is the Topology's platformId.
returned: always
sample: <platformid>
type: str
role:
description: It is the Topology's role.
returned: always
sample: <role>
type: str
roleSource:
description: It is the Topology's roleSource.
returned: always
sample: <rolesource>
type: str
softwareVersion:
description: It is the Topology's softwareVersion.
returned: always
sample: <softwareversion>
type: str
tags:
description: It is the Topology's tags.
returned: always
type: list
upperNode:
description: It is the Topology's upperNode.
returned: always
sample: <uppernode>
type: str
userId:
description: It is the Topology's userId.
returned: always
sample: <userid>
type: str
vlanId:
description: It is the Topology's vlanId.
returned: always
sample: <vlanid>
type: str
x:
description: It is the Topology's x.
returned: always
sample: 0
type: int
y:
description: It is the Topology's y.
returned: always
sample: 0
type: int
description: It is the Topology's nodes.
returned: always
type: list
description: Response, property of the response body.
returned: always
type: dict
returned: always
type: dict
version:
description: Version, property of the response body.
returned: always
sample: '1.0'
type: str
get_site_topology:
contains: null
description: Returns site Topology.
response:
contains:
sites:
contains:
displayName:
description: It is the Topology's displayName.
returned: always
sample: <displayname>
type: str
groupNameHierarchy:
description: It is the Topology's groupNameHierarchy.
returned: always
sample: <groupnamehierarchy>
type: str
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
latitude:
description: It is the Topology's latitude.
returned: always
sample: <latitude>
type: str
locationAddress:
description: It is the Topology's locationAddress.
returned: always
sample: <locationaddress>
type: str
locationCountry:
description: It is the Topology's locationCountry.
returned: always
sample: <locationcountry>
type: str
locationType:
description: It is the Topology's locationType.
returned: always
sample: <locationtype>
type: str
longitude:
description: It is the Topology's longitude.
returned: always
sample: <longitude>
type: str
name:
description: It is the Topology's name.
returned: always
sample: <name>
type: str
parentId:
description: It is the Topology's parentId.
returned: always
sample: <parentid>
type: str
description: It is the Topology's sites.
returned: always
type: list
description: Response, property of the response body.
returned: always
type: dict
returned: always
type: dict
version:
description: Version, property of the response body.
returned: always
sample: '1.0'
type: str
get_topology_details:
contains: null
description: Returns Layer 2 network Topology by specified VLAN ID.
response:
contains:
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
links:
contains:
additionalInfo:
description: It is the Topology's additionalInfo.
returned: always
type: dict
endPortID:
description: It is the Topology's endPortID.
returned: always
sample: <endportid>
type: str
endPortIpv4Address:
description: It is the Topology's endPortIpv4Address.
returned: always
sample: <endportipv4address>
type: str
endPortIpv4Mask:
description: It is the Topology's endPortIpv4Mask.
returned: always
sample: <endportipv4mask>
type: str
endPortName:
description: It is the Topology's endPortName.
returned: always
sample: <endportname>
type: str
endPortSpeed:
description: It is the Topology's endPortSpeed.
returned: always
sample: <endportspeed>
type: str
greyOut:
description: It is the Topology's greyOut.
returned: always
sample: false
type: bool
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
linkStatus:
description: It is the Topology's linkStatus.
returned: always
sample: <linkstatus>
type: str
source:
description: It is the Topology's source.
returned: always
sample: <source>
type: str
startPortID:
description: It is the Topology's startPortID.
returned: always
sample: <startportid>
type: str
startPortIpv4Address:
description: It is the Topology's startPortIpv4Address.
returned: always
sample: <startportipv4address>
type: str
startPortIpv4Mask:
description: It is the Topology's startPortIpv4Mask.
returned: always
sample: <startportipv4mask>
type: str
startPortName:
description: It is the Topology's startPortName.
returned: always
sample: <startportname>
type: str
startPortSpeed:
description: It is the Topology's startPortSpeed.
returned: always
sample: <startportspeed>
type: str
tag:
description: It is the Topology's tag.
returned: always
sample: <tag>
type: str
target:
description: It is the Topology's target.
returned: always
sample: <target>
type: str
description: It is the Topology's links.
returned: always
type: list
nodes:
contains:
aclApplied:
description: It is the Topology's aclApplied.
returned: always
sample: false
type: bool
additionalInfo:
description: It is the Topology's additionalInfo.
returned: always
type: dict
customParam:
contains:
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
label:
description: It is the Topology's label.
returned: always
sample: <label>
type: str
parentNodeId:
description: It is the Topology's parentNodeId.
returned: always
sample: <parentnodeid>
type: str
x:
description: It is the Topology's x.
returned: always
sample: 0
type: int
y:
description: It is the Topology's y.
returned: always
sample: 0
type: int
description: It is the Topology's customParam.
returned: always
type: dict
dataPathId:
description: It is the Topology's dataPathId.
returned: always
sample: <datapathid>
type: str
deviceType:
description: It is the Topology's deviceType.
returned: always
sample: <devicetype>
type: str
family:
description: It is the Topology's family.
returned: always
sample: <family>
type: str
fixed:
description: It is the Topology's fixed.
returned: always
sample: false
type: bool
greyOut:
description: It is the Topology's greyOut.
returned: always
sample: false
type: bool
id:
description: It is the Topology's id.
returned: always
sample: '478012'
type: str
ip:
description: It is the Topology's ip.
returned: always
sample: 1.1.1.17
type: str
label:
description: It is the Topology's label.
returned: always
sample: <label>
type: str
networkType:
description: It is the Topology's networkType.
returned: always
sample: <networktype>
type: str
nodeType:
description: It is the Topology's nodeType.
returned: always
sample: <nodetype>
type: str
order:
description: It is the Topology's order.
returned: always
sample: 0
type: int
osType:
description: It is the Topology's osType.
returned: always
sample: <ostype>
type: str
platformId:
description: It is the Topology's platformId.
returned: always
sample: <platformid>
type: str
role:
description: It is the Topology's role.
returned: always
sample: <role>
type: str
roleSource:
description: It is the Topology's roleSource.
returned: always
sample: <rolesource>
type: str
softwareVersion:
description: It is the Topology's softwareVersion.
returned: always
sample: <softwareversion>
type: str
tags:
description: It is the Topology's tags.
returned: always
type: list
upperNode:
description: It is the Topology's upperNode.
returned: always
sample: <uppernode>
type: str
userId:
description: It is the Topology's userId.
returned: always
sample: <userid>
type: str
vlanId:
description: It is the Topology's vlanId.
returned: always
sample: <vlanid>
type: str
x:
description: It is the Topology's x.
returned: always
sample: 0
type: int
y:
description: It is the Topology's y.
returned: always
sample: 0
type: int
description: It is the Topology's nodes.
returned: always
type: list
description: Response, property of the response body.
returned: always
type: dict
returned: always
type: dict
version:
description: Version, property of the response body.
returned: always
sample: '1.0'
type: str
get_vlan_details:
contains: null
description: Returns the list of VLAN names.
response:
description: Response, property of the response body (list of strings).
returned: always
type: list
returned: always
type: dict
version:
description: Version, property of the response body.
returned: always
sample: '1.0'
type: str