Generate Sphinx docs in markdown
This commit is contained in:
parent
bc4e9caacb
commit
81ff7959f7
84 changed files with 2873 additions and 29 deletions
72
SRV/docs/_build/markdown/api/services/firewalld_service.md
vendored
Normal file
72
SRV/docs/_build/markdown/api/services/firewalld_service.md
vendored
Normal file
|
|
@ -0,0 +1,72 @@
|
|||
# Firewalld Service
|
||||
|
||||
Сервис для управления firewalld через D‑Bus.
|
||||
|
||||
Назначение:
|
||||
|
||||
- Обёртка над интерфейсами org.fedoraproject.FirewallD1 для выполнения типовых операций по зонам: просмотр/изменение дефолтной зоны, добавление и удаление сервисов, портов, источников, перезагрузка конфигурации.
|
||||
|
||||
Примечания:
|
||||
|
||||
- Используется pydbus.SystemBus для доступа к системной шине.
|
||||
- Методы генерируют дружелюбные исключения при ошибках, содержащие контекст операции.
|
||||
|
||||
### *class* services.firewalld_service.FirewalldService
|
||||
|
||||
Bases: `object`
|
||||
|
||||
#### add_port(zone: str, port: int, protocol: str, timeout: int | None = 0) → None
|
||||
|
||||
Add a port to a zone.
|
||||
|
||||
#### add_service(zone: str, service: str, timeout: int | None = 0) → None
|
||||
|
||||
Add a service to a zone.
|
||||
|
||||
#### add_source(zone: str, source: str) → None
|
||||
|
||||
Add a source to a zone.
|
||||
|
||||
#### get_default_zone() → str
|
||||
|
||||
Get the default zone.
|
||||
|
||||
#### get_ports(zone: str) → List[str]
|
||||
|
||||
Get list of ports in a zone.
|
||||
|
||||
#### get_services(zone: str) → List[str]
|
||||
|
||||
Get list of services in a zone.
|
||||
|
||||
#### get_sources(zone: str) → List[str]
|
||||
|
||||
Get list of sources in a zone.
|
||||
|
||||
#### get_zone_settings(zone: str) → Dict
|
||||
|
||||
Get all settings for a zone.
|
||||
|
||||
#### get_zones() → List[str]
|
||||
|
||||
Get list of all zones.
|
||||
|
||||
#### reload() → None
|
||||
|
||||
Reload firewall rules.
|
||||
|
||||
#### remove_port(zone: str, port: int, protocol: str) → None
|
||||
|
||||
Remove a port from a zone.
|
||||
|
||||
#### remove_service(zone: str, service: str) → None
|
||||
|
||||
Remove a service from a zone.
|
||||
|
||||
#### remove_source(zone: str, source: str) → None
|
||||
|
||||
Remove a source from a zone.
|
||||
|
||||
#### set_default_zone(zone: str) → None
|
||||
|
||||
Set the default zone.
|
||||
Loading…
Add table
Add a link
Reference in a new issue