cisco.catalystcenter.fabric_site_health_summaries_id_info module -- Information module for Fabric Site Health Summaries Id
Note
This module is part of the cisco.catalystcenter collection (version 2.2.1).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.fabric_site_health_summaries_id_info.
New in cisco.catalystcenter 6.17.0
Synopsis
Get Fabric Site Health Summaries Id by id.
Get Fabric site health summary for a specific fabric site by providing the unique fabric site id in the url path.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.1.3.0.0
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Attribute query parameter. The list of FabricSite health attributes. Please refer to ```fabricSiteAttributes``` section in the Open API specification document mentioned in the description. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
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. |
|
Additional headers. |
|
Id path parameter. Unique fabric site id. |
|
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. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
|
View query parameter. The specific summary view being requested. A maximum of 3 views can be queried at a time per request. Please refer to ```fabricSiteViews``` section in the Open API specification document mentioned in the description. |
Notes
Note
SDK Method used are sda.Sda.read_fabric_sites_with_health_summary_from_id,
Paths used are get /dna/data/api/v1/fabricSiteHealthSummaries/{id},
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins,
but instead uses the embedded connection manager from Cisco CATALYST SDK
See Also
See also
- Cisco DNA Center documentation for SDA ReadFabricSitesWithHealthSummaryFromId
Complete reference of the ReadFabricSitesWithHealthSummaryFromId API.
Examples
---
- name: Get Fabric Site Health Summaries Id by id
cisco.catalystcenter.fabric_site_health_summaries_id_info:
catc_host: "{{catc_host}}"
catc_username: "{{catc_username}}"
catc_password: "{{catc_password}}"
catc_verify: "{{catc_verify}}"
catc_api_port: "{{catc_api_port}}"
catc_version: "{{catc_version}}"
catc_debug: "{{catc_debug}}"
headers: "{{my_headers | from_json}}"
startTime: 0
endTime: 0
attribute: string
view: string
id: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|