Health Policy

Location in GUI: Troubleshooting » Health » Policy

NOTE: Due to FMC bug, the Health Policy cannot be updated. If change to the policy is needed, please remove and recreate it.

Diagram

Classes

policies (fmc.domains)

Name	Type	Constraint	Mandatory	Default Value
health_policies	List	`[health_policies]`	No

health_policies (fmc.domains.policies)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.+ -]{1,64}$`	Yes
description	String	max: `255`	No
policy_type	Choice	`DevicePolicy`	Yes	`DevicePolicy`
is_default_policy	Boolean	`true`, `false`	No	`false`
health_module_run_time_interval	Integer	min: `5`, max: `60`	No	`5`
metric_collection_interval	Integer	min: `1`, max: `60`	No	`1`
health_modules	List	`[health_modules]`	No

health_modules (fmc.domains.policies.health_policies)

Name	Type	Constraint	Mandatory	Default Value
name	Choice	`hm_disk_status`, `hm_asp_drop`, `hm_tds`, `hm_db`, `hm_conn_status_sse`, `hm_is5800_powersupply`, `hm_card_reset`, `hm_ntp_server`, `hm_threat_grid_amp`, `hm_ftd_ha`, `hm_talosagent`, `hm_conn_status_amp`, `hm_snort_stats`, `hm_critical_process`, `hm_fsic`, `hm_ftd_csdac_identity_services`, `hm_deployed_configuration`, `hm_ftd_config_resource`, `hm_routing_stats`, `hm_vpn_stats`, `hm_snortstats`, `hm_is5800_alarm`, `hm_cluster`, `hm_bypass`, `hm_mu`, `hm_reconfig_detection`, `hm_xTLS`, `hm_pathmonitoring`, `hm_cpu`, `hm_process`, `hm_simu`, `hm_fmcaccess_config_change`, `hm_linkstate_propagation`, `hm_adv_snort_stats`, `hm_sdwan`, `hm_static_analysis`, `hm_chm`, `hm_platform_faults`, `hm_conn_stats`, `hm_fxos_health`, `hm_chassis_status_ftd`, `hm_du`, `hm_ifconfig`, `hm_flow_offload`, `hm_inlinelink_alarm`	Yes
enabled	Boolean	`true`, `false`	No	`true`
type	Choice	`FTD`, `FMC_FTD`, `SENSOR`, `FMC`	Yes
alert_severity	Choice	`Critical`, `Major`, `Warning`, `Minor`, `Info`	No
critical_threshold	Integer	min: `1`, max: `99`	No
warning_threshold	Integer	min: `1`, max: `99`	No
alert_configs	List	`[alert_configs]`	No
custom_thresholds	List	`[custom_thresholds]`	No

alert_configs (fmc.domains.policies.health_policies.health_modules)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
enabled	Boolean	`true`, `false`	No	`true`
thresholds	List	`[thresholds]`	No

custom_thresholds (fmc.domains.policies.health_policies.health_modules)

Name	Type	Constraint	Mandatory	Default Value
type	Choice	`Red-FC`, `Yellow-FC`	Yes
threshold	Integer	min: `1`, max: `99`	Yes

thresholds (fmc.domains.policies.health_policies.health_modules.alert_configs)

Name	Type	Constraint	Mandatory	Default Value
type	Choice	`red`, `yellow`	Yes
threshold	Integer	min: `1`, max: `99`	Yes

Examples

Health Policy

fmc:
  domains:
    - name: Global
      policies:
        health_policies:
          - name: MyHealthPolicyName1
            health_module_run_time_interval: 11
            metric_collection_interval: 15
            description: "Health policy 1"
            health_modules:
              - name: hm_asp_drop
                type: FTD
                alert_configs:
                  - name: nat-no-xlate-to-pat-pool
              - name: hm_chassis_status_ftd
                critical_threshold: 86
                warning_threshold: 76
                type: FTD
              - name: hm_mu
                type: FMC_FTD
                alert_configs:
                  - name: alert_mu
                    thresholds:
                      - type: red
                        threshold: 92
                      - type: yellow
                        threshold: 89
              - name: hm_du
                type: FMC_FTD
                warning_threshold: 84
                critical_threshold: 91
                custom_thresholds:
                  - type: Yellow-FC
                    threshold: 94
                  - type: Red-FC
                    threshold: 97