Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.unifi.diagnostics Namespace Reference

Functions

dict[str, Any] async_get_config_entry_diagnostics (HomeAssistant hass, UnifiConfigEntry config_entry)
 
dict[str, Any] async_replace_dict_data (Mapping data, dict[str, str] to_replace)
 
list[Any] async_replace_list_data (list|set|tuple data, dict[str, str] to_replace)
 

Variables

dictionary REDACT_CLIENTS = {"bssid", "essid"}
 
dictionary REDACT_CONFIG = {CONF_HOST, CONF_PASSWORD, CONF_USERNAME}
 
dictionary REDACT_DEVICES
 
dictionary REDACT_WLANS = {"bc_filter_list", "x_passphrase"}
 
dictionary TO_REDACT = {CONF_PASSWORD}
 

Detailed Description

Diagnostics support for UniFi Network.

Function Documentation

◆ async_get_config_entry_diagnostics()

dict[str, Any] homeassistant.components.unifi.diagnostics.async_get_config_entry_diagnostics ( HomeAssistant  hass,
UnifiConfigEntry   config_entry 
)
Return diagnostics for a config entry.

Definition at line 73 of file diagnostics.py.

◆ async_replace_dict_data()

dict[str, Any] homeassistant.components.unifi.diagnostics.async_replace_dict_data ( Mapping  data,
dict[str, str]   to_replace 
)
Redact sensitive data in a dict.

Definition at line 34 of file diagnostics.py.

◆ async_replace_list_data()

list[Any] homeassistant.components.unifi.diagnostics.async_replace_list_data ( list | set | tuple  data,
dict[str, str]   to_replace 
)
Redact sensitive data in a list.

Definition at line 53 of file diagnostics.py.

Variable Documentation

◆ REDACT_CLIENTS

dictionary homeassistant.components.unifi.diagnostics.REDACT_CLIENTS = {"bssid", "essid"}

Definition at line 18 of file diagnostics.py.

◆ REDACT_CONFIG

dictionary homeassistant.components.unifi.diagnostics.REDACT_CONFIG = {CONF_HOST, CONF_PASSWORD, CONF_USERNAME}

Definition at line 17 of file diagnostics.py.

◆ REDACT_DEVICES

dictionary homeassistant.components.unifi.diagnostics.REDACT_DEVICES
Initial value:
1 = {
2  "anon_id",
3  "gateway_mac",
4  "geo_info",
5  "serial",
6  "x_authkey",
7  "x_fingerprint",
8  "x_iapp_key",
9  "x_ssh_hostkey_fingerprint",
10  "x_vwirekey",
11 }

Definition at line 19 of file diagnostics.py.

◆ REDACT_WLANS

dictionary homeassistant.components.unifi.diagnostics.REDACT_WLANS = {"bc_filter_list", "x_passphrase"}

Definition at line 30 of file diagnostics.py.

◆ TO_REDACT

dictionary homeassistant.components.unifi.diagnostics.TO_REDACT = {CONF_PASSWORD}

Definition at line 16 of file diagnostics.py.