.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.fabric_site_health_summaries_info module -- Information module for Fabric Site Health Summaries Info +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.27.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.fabric_site_health_summaries_info`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.17.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - This module represents an alias of the module fabric\_site\_health\_summaries\_v1\_info .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.4.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-attribute: .. rst-class:: ansible-option-title **attribute** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Attribute query parameter. The list of FabricSite health attributes. Please refer to \`\`\`fabricSiteAttributes\`\`\` section in the Open API specification document mentioned in the description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-endtime: .. rst-class:: ansible-option-title **endTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-headers: .. rst-class:: ansible-option-title **headers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Additional headers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id query parameter. The list of entity Uuids. (Ex."6bef213c-19ca-4170-8375-b694e251101c") Examples id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested) id=6bef213c-19ca-4170-8375- b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple entity uuid with '&' separator). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-limit: .. rst-class:: ansible-option-title **limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Limit query parameter. Maximum number of records to return. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-offset: .. rst-class:: ansible-option-title **offset** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Offset query parameter. Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-order: .. rst-class:: ansible-option-title **order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Order query parameter. The sort order of the field ascending or descending. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-sortby: .. rst-class:: ansible-option-title **sortBy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SortBy query parameter. A field within the response to sort by. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-starttime: .. rst-class:: ansible-option-title **startTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__parameter-view: .. rst-class:: ansible-option-title **view** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are sda.Sda.read\_list\_of\_fabric\_sites\_with\_their\_health\_summary\_v1, - Paths used are get /dna/data/api/v1/fabricSiteHealthSummaries, - It should be noted that this module is an alias of fabric\_site\_health\_summaries\_v1\_info - Supports \ :literal:`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 .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for SDA ReadListOfFabricSitesWithTheirHealthSummaryV1 `_ Complete reference of the ReadListOfFabricSitesWithTheirHealthSummaryV1 API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Get all Fabric Site Health Summaries Info cisco.dnac.fabric_site_health_summaries_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 limit: 0 offset: 0 sortBy: string order: string id: string attribute: string view: string register: result .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.fabric_site_health_summaries_info_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"[\\n {\\n \\"id\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"goodHealthPercentage\\": 0,\\n \\"goodHealthDeviceCount\\": 0,\\n \\"totalDeviceCount\\": 0,\\n \\"poorHealthDeviceCount\\": 0,\\n \\"fairHealthDeviceCount\\": 0,\\n \\"associatedL2VnCount\\": 0,\\n \\"associatedL3VnCount\\": 0,\\n \\"networkProtocol\\": \\"string\\",\\n \\"connectivityGoodHealthPercentage\\": 0,\\n \\"connectivityTotalHealthDeviceCount\\": 0,\\n \\"connectivityGoodHealthDeviceCount\\": 0,\\n \\"connectivityPoorHealthDeviceCount\\": 0,\\n \\"connectivityFairHealthDeviceCount\\": 0,\\n \\"infraGoodHealthPercentage\\": 0,\\n \\"infraTotalHealthDeviceCount\\": 0,\\n \\"infraGoodHealthDeviceCount\\": 0,\\n \\"infraFairHealthDeviceCount\\": 0,\\n \\"infraPoorHealthDeviceCount\\": 0,\\n \\"controlPlaneGoodHealthPercentage\\": 0,\\n \\"controlPlaneTotalHealthDeviceCount\\": 0,\\n \\"controlPlaneGoodHealthDeviceCount\\": 0,\\n \\"controlPlanePoorHealthDeviceCount\\": 0,\\n \\"controlPlaneFairHealthDeviceCount\\": 0,\\n \\"pubsubInfraVnGoodHealthPercentage\\": 0,\\n \\"pubsubInfraVnTotalHealthDeviceCount\\": 0,\\n \\"pubsubInfraVnGoodHealthDeviceCount\\": 0,\\n \\"pubsubInfraVnPoorHealthDeviceCount\\": 0,\\n \\"pubsubInfraVnFairHealthDeviceCount\\": 0,\\n \\"bgpEvpnGoodHealthPercentage\\": {},\\n \\"bgpEvpnTotalHealthDeviceCount\\": 0,\\n \\"bgpEvpnGoodHealthDeviceCount\\": 0,\\n \\"bgpEvpnPoorHealthDeviceCount\\": 0,\\n \\"bgpEvpnFairHealthDeviceCount\\": 0,\\n \\"ctsEnvDataDownloadGoodHealthPercentage\\": 0,\\n \\"ctsEnvDataDownloadTotalHealthDeviceCount\\": 0,\\n \\"ctsEnvDataDownloadGoodHealthDeviceCount\\": 0,\\n \\"ctsEnvDataDownloadPoorHealthDeviceCount\\": 0,\\n \\"ctsEnvDataDownloadFairHealthDeviceCount\\": 0,\\n \\"aaaStatusGoodHealthPercentage\\": 0,\\n \\"aaaStatusTotalHealthDeviceCount\\": 0,\\n \\"aaaStatusGoodHealthDeviceCount\\": 0,\\n \\"aaaStatusPoorHealthDeviceCount\\": 0,\\n \\"aaaStatusFairHealthDeviceCount\\": 0,\\n \\"portChannelGoodHealthPercentage\\": 0,\\n \\"portChannelTotalHealthDeviceCount\\": 0,\\n \\"portChannelGoodHealthDeviceCount\\": 0,\\n \\"portChannelPoorHealthDeviceCount\\": 0,\\n \\"portChannelFairHealthDeviceCount\\": 0,\\n \\"peerScoreGoodHealthPercentage\\": {},\\n \\"peerScoreTotalHealthDeviceCount\\": 0,\\n \\"peerScoreGoodHealthDeviceCount\\": 0,\\n \\"peerScorePoorHealthDeviceCount\\": 0,\\n \\"peerScoreFairHealthDeviceCount\\": 0,\\n \\"lispSessionGoodHealthPercentage\\": 0,\\n \\"lispSessionTotalHealthDeviceCount\\": 0,\\n \\"lispSessionGoodHealthDeviceCount\\": 0,\\n \\"lispSessionPoorHealthDeviceCount\\": 0,\\n \\"lispSessionFairHealthDeviceCount\\": 0,\\n \\"borderToControlPlaneGoodHealthPercentage\\": 0,\\n \\"borderToControlPlaneTotalHealthDeviceCount\\": 0,\\n \\"borderToControlPlaneGoodHealthDeviceCount\\": 0,\\n \\"borderToControlPlanePoorHealthDeviceCount\\": 0,\\n \\"borderToControlPlaneFairHealthDeviceCount\\": 0,\\n \\"bgpBgpSiteGoodHealthPercentage\\": 0,\\n \\"bgpBgpSiteTotalHealthDeviceCount\\": 0,\\n \\"bgpBgpSiteGoodHealthDeviceCount\\": 0,\\n \\"bgpBgpSitePoorHealthDeviceCount\\": 0,\\n \\"bgpBgpSiteFairHealthDeviceCount\\": 0,\\n \\"bgpPubsubSiteGoodHealthPercentage\\": 0,\\n \\"bgpPubsubSiteTotalHealthDeviceCount\\": 0,\\n \\"bgpPubsubSiteGoodHealthDeviceCount\\": 0,\\n \\"bgpPubsubSitePoorHealthDeviceCount\\": 0,\\n \\"bgpPubsubSiteFairHealthDeviceCount\\": 0,\\n \\"bgpPeerInfraVnScoreGoodHealthPercentage\\": 0,\\n \\"bgpPeerInfraVnTotalHealthDeviceCount\\": 0,\\n \\"bgpPeerInfraVnGoodHealthDeviceCount\\": 0,\\n \\"bgpPeerInfraVnPoorHealthDeviceCount\\": 0,\\n \\"bgpPeerInfraVnFairHealthDeviceCount\\": 0\\n }\\n]\\n"` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors