/ home / cisco / cisco.dnac / 6.13.3 / module / system_health_info

cisco.dnac.system_health_info (6.13.3) — module

Information module for System Health

| "added in version" 3.1.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:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all System Health.

This API retrieves the latest system events.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all System Health
  cisco.dnac.system_health_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}}"
    summary: True
    domain: string
    subdomain: string
    limit: 0
    offset: 0
  register: result

Inputs

limit:
description:
- Limit query parameter.
type: int

domain:
description:
- 'Domain query parameter. Fetch system events with this domain. Possible values of
domain are listed here /dna/platform/app/consumer-portal/developer-toolkit/events.

'
type: str

offset:
description:
- Offset query parameter.
type: int

headers:
description: Additional headers.
type: dict

summary:
description:
- Summary query parameter. Fetch the latest high severity event.
type: bool

dnac_host:
description:
- The Cisco DNA Center hostname.
required: true
type: str

dnac_port:
default: 443
description:
- The Cisco DNA Center port.
type: int

subdomain:
description:
- 'Subdomain query parameter. Fetch system events with this subdomain. Possible values
of subdomain are listed here /dna/platform/app/consumer-portal/developer-toolkit/events.

'
type: str

dnac_debug:
default: false
description:
- Flag for Cisco DNA Center SDK to enable debugging.
type: bool

dnac_verify:
default: true
description:
- Flag to enable or disable SSL certificate verification.
type: bool

dnac_version:
default: 2.3.5.3
description:
- Informs the SDK which version of Cisco DNA Center to use.
type: str

dnac_password:
description:
- The Cisco DNA Center password to authenticate.
type: str

dnac_username:
aliases:
- user
default: admin
description:
- The Cisco DNA Center username to authenticate.
type: str

validate_response_schema:
default: true
description:
- Flag for Cisco DNA Center SDK to enable the validation of request bodies against
a JSON schema.
type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"healthEvents\": [\n    {\n      \"severity\": \"string\",\n    \
    \  \"hostname\": \"string\",\n      \"instance\": \"string\",\n      \"subDomain\"\
    : \"string\",\n      \"domain\": \"string\",\n      \"description\": \"string\"\
    ,\n      \"state\": \"string\",\n      \"timestamp\": \"string\",\n      \"status\"\
    : \"string\"\n    }\n  ],\n  \"version\": \"string\",\n  \"hostName\": \"string\"\
    ,\n  \"cimcaddress\": [\n    \"string\"\n  ]\n}\n"
  type: dict