Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.fail2ban.sensor Namespace Reference

Classes

class  BanLogParser
 
class  BanSensor
 

Functions

None async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_JAILS = "jails"
 
string DEFAULT_LOG = "/var/log/fail2ban.log"
 
string DEFAULT_NAME = "fail2ban"
 
 PLATFORM_SCHEMA
 
 SCAN_INTERVAL = timedelta(seconds=120)
 
string STATE_ALL_BANS = "total_bans"
 
string STATE_CURRENT_BANS = "current_bans"
 

Detailed Description

Support for displaying IPs banned by fail2ban.

Function Documentation

◆ async_setup_platform()

None homeassistant.components.fail2ban.sensor.async_setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  async_add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the fail2ban sensor.

Definition at line 42 of file sensor.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.fail2ban.sensor._LOGGER = logging.getLogger(__name__)
private

Definition at line 22 of file sensor.py.

◆ CONF_JAILS

string homeassistant.components.fail2ban.sensor.CONF_JAILS = "jails"

Definition at line 24 of file sensor.py.

◆ DEFAULT_LOG

string homeassistant.components.fail2ban.sensor.DEFAULT_LOG = "/var/log/fail2ban.log"

Definition at line 27 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.fail2ban.sensor.DEFAULT_NAME = "fail2ban"

Definition at line 26 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.fail2ban.sensor.PLATFORM_SCHEMA
Initial value:
1 = SENSOR_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_JAILS): vol.All(cv.ensure_list, vol.Length(min=1)),
4  vol.Optional(CONF_FILE_PATH): cv.isfile,
5  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
6  }
7 )

Definition at line 33 of file sensor.py.

◆ SCAN_INTERVAL

homeassistant.components.fail2ban.sensor.SCAN_INTERVAL = timedelta(seconds=120)

Definition at line 31 of file sensor.py.

◆ STATE_ALL_BANS

string homeassistant.components.fail2ban.sensor.STATE_ALL_BANS = "total_bans"

Definition at line 30 of file sensor.py.

◆ STATE_CURRENT_BANS

string homeassistant.components.fail2ban.sensor.STATE_CURRENT_BANS = "current_bans"

Definition at line 29 of file sensor.py.