Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.http.ban.IpBanManager Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass)
 
None async_add_ban (self, IPv4Address|IPv6Address remote_addr)
 
None async_load (self)
 

Public Attributes

 hass
 
 ip_bans_lookup
 
 path
 

Private Member Functions

None _add_ban (self, IpBan ip_ban)
 

Detailed Description

Manage IP bans.

Definition at line 207 of file ban.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.http.ban.IpBanManager.__init__ (   self,
HomeAssistant  hass 
)
Init the ban manager.

Definition at line 210 of file ban.py.

Member Function Documentation

◆ _add_ban()

None homeassistant.components.http.ban.IpBanManager._add_ban (   self,
IpBan  ip_ban 
)
private
Update config file with new banned IP address.

Definition at line 240 of file ban.py.

◆ async_add_ban()

None homeassistant.components.http.ban.IpBanManager.async_add_ban (   self,
IPv4Address | IPv6Address  remote_addr 
)
Add a new IP address to the banned list.

Definition at line 249 of file ban.py.

◆ async_load()

None homeassistant.components.http.ban.IpBanManager.async_load (   self)
Load the existing IP bans.

Definition at line 216 of file ban.py.

Member Data Documentation

◆ hass

homeassistant.components.http.ban.IpBanManager.hass

Definition at line 212 of file ban.py.

◆ ip_bans_lookup

homeassistant.components.http.ban.IpBanManager.ip_bans_lookup

Definition at line 238 of file ban.py.

◆ path

homeassistant.components.http.ban.IpBanManager.path

Definition at line 213 of file ban.py.


The documentation for this class was generated from the following file: