cisco.dnac.fabric_summary_info module -- Information module for Fabric Summary

Note

This module is part of the cisco.dnac collection (version 6.36.0).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.fabric_summary_info.

New in cisco.dnac 6.17.0

Synopsis

  • Get all Fabric Summary. - > Read Fabric summary for overall deployment. Get an aggregated summary of all fabric entities in a deployment including the entity health.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.10.1

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

endTime

float

EndTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.

headers

dictionary

Additional headers.

siteHierarchy

string

SiteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named "Global" (Ex. `Global/AreaName/BuildingName/FloorName`) This field supports wildcard asterisk (`*`) character search support. E.g. `*/San*, */San, /San*` Examples `?siteHierarchy=Global/AreaName/BuildingName/FloorName` (single siteHierarchy requested) `?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Gl obal/AreaName2/BuildingName2/FloorName2` (multiple siteHierarchies requested).

siteHierarchyId

string

SiteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`) This field supports wildcard asterisk (`*`) character search support. E.g. `*uuid*, *uuid, uuid*` Examples `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteH ierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2 /floorUuid2` (multiple siteHierarchyIds requested).

startTime

float

StartTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are sda.Sda.read_fabric_entity_summary,

  • Paths used are get /dna/data/api/v1/fabricSummary,

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for SDA ReadFabricEntitySummary

Complete reference of the ReadFabricEntitySummary API.

Examples

---
- name: Get all Fabric Summary
  cisco.dnac.fabric_summary_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}}"
    startTime: 0
    endTime: 0
    siteHierarchy: string
    siteHierarchyId: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"protocolSummaries": [{"fabricDeviceCount": 0, "fabricSiteCount": 0, "fabricSiteFairHealthCount": 0, "fabricSiteGoodHealthCount": 0, "fabricSiteGoodHealthPercentage": 0, "fabricSiteNoHealthCount": 0, "fabricSitePoorHealthCount": 0, "ipTransitNetworkCount": 0, "l2VnCount": 0, "l2VnFairHealthCount": 0, "l2VnGoodHealthCount": 0, "l2VnGoodHealthPercentage": 0, "l2VnNoHealthCount": 0, "l2VnPoorHealthCount": 0, "l3VnCount": 0, "l3VnFairHealthCount": 0, "l3VnGoodHealthCount": 0, "l3VnGoodHealthPercentage": 0, "l3VnNoHealthCount": 0, "l3VnPoorHealthCount": 0, "networkSegmentProtocol": "string", "p1IssueCount": 0, "p2IssueCount": 0, "p3IssueCount": 0, "transitNetworkCount": 0, "transitNetworkFairHealthCount": 0, "transitNetworkGoodHealthCount": 0, "transitNetworkGoodHealthPercentage": 0, "transitNetworkNoHealthCount": 0, "transitNetworkPoorHealthCount": 0}]}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)