hfortix-fortios 0.5.0__py3-none-any.whl → 0.5.2__py3-none-any.whl

hfortix_fortios/api/v2/monitor/system/__init__.pyi

@@ -0,0 +1,177 @@
+"""Type stubs for SYSTEM category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .acme_certificate_status import AcmeCertificateStatus
+    from .acquired_dns import AcquiredDns
+    from .automation_action import AutomationAction
+    from .available_certificates import AvailableCertificates
+    from .available_interfaces import AvailableInterfaces
+    from .botnet import Botnet
+    from .botnet_domains import BotnetDomains
+    from .central_management import CentralManagement
+    from .check_port_availability import CheckPortAvailability
+    from .current_admins import CurrentAdmins
+    from .global_resources import GlobalResources
+    from .global_search import GlobalSearch
+    from .ha_backup_hb_used import HaBackupHbUsed
+    from .ha_checksums import HaChecksums
+    from .ha_history import HaHistory
+    from .ha_hw_interface import HaHwInterface
+    from .ha_nonsync_checksums import HaNonsyncChecksums
+    from .ha_statistics import HaStatistics
+    from .ha_table_checksums import HaTableChecksums
+    from .interface_connected_admins_info import InterfaceConnectedAdminsInfo
+    from .ipconf import Ipconf
+    from .link_monitor import LinkMonitor
+    from .monitor_sensor import MonitorSensor
+    from .ntp import Ntp
+    from .performance import Performance
+    from .resolve_fqdn import ResolveFqdn
+    from .resource import Resource
+    from .running_processes import RunningProcesses
+    from .sandbox import Sandbox
+    from .sensor_info import SensorInfo
+    from .status import Status
+    from .storage import Storage
+    from .timezone import Timezone
+    from .trusted_cert_authorities import TrustedCertAuthorities
+    from .vdom_link import VdomLink
+    from .vdom_resource import VdomResource
+    from .vm_information import VmInformation
+    from .x3g_modem import X3gModem
+    from .admin import Admin
+    from .api_user import ApiUser
+    from .automation_stitch import AutomationStitch
+    from .certificate import Certificate
+    from .change_password import ChangePassword
+    from .cluster import Cluster
+    from .com_log import ComLog
+    from .config import Config
+    from .config_error_log import ConfigErrorLog
+    from .config_revision import ConfigRevision
+    from .config_script import ConfigScript
+    from .config_sync import ConfigSync
+    from .crash_log import CrashLog
+    from .csf import Csf
+    from .debug import Debug
+    from .dhcp import Dhcp
+    from .dhcp6 import Dhcp6
+    from .disconnect_admins import DisconnectAdmins
+    from .external_resource import ExternalResource
+    from .firmware import Firmware
+    from .fortiguard import Fortiguard
+    from .fortimanager import Fortimanager
+    from .fsck import Fsck
+    from .ha_peer import HaPeer
+    from .hscalefw_license import HscalefwLicense
+    from .interface import Interface
+    from .ipam import Ipam
+    from .logdisk import Logdisk
+    from .lte_modem import LteModem
+    from .modem import Modem
+    from .object import Object
+    from .os import Os
+    from .password_policy_conform import PasswordPolicyConform
+    from .private_data_encryption import PrivateDataEncryption
+    from .process import Process
+    from .sdn_connector import SdnConnector
+    from .time import Time
+    from .traffic_history import TrafficHistory
+    from .upgrade_report import UpgradeReport
+    from .usb_device import UsbDevice
+    from .usb_log import UsbLog
+    from .vmlicense import Vmlicense
+    from .x5g_modem import X5gModem
+
+
+class System:
+    """Type stub for System."""
+
+    admin: Admin
+    api_user: ApiUser
+    automation_stitch: AutomationStitch
+    certificate: Certificate
+    change_password: ChangePassword
+    cluster: Cluster
+    com_log: ComLog
+    config: Config
+    config_error_log: ConfigErrorLog
+    config_revision: ConfigRevision
+    config_script: ConfigScript
+    config_sync: ConfigSync
+    crash_log: CrashLog
+    csf: Csf
+    debug: Debug
+    dhcp: Dhcp
+    dhcp6: Dhcp6
+    disconnect_admins: DisconnectAdmins
+    external_resource: ExternalResource
+    firmware: Firmware
+    fortiguard: Fortiguard
+    fortimanager: Fortimanager
+    fsck: Fsck
+    ha_peer: HaPeer
+    hscalefw_license: HscalefwLicense
+    interface: Interface
+    ipam: Ipam
+    logdisk: Logdisk
+    lte_modem: LteModem
+    modem: Modem
+    object: Object
+    os: Os
+    password_policy_conform: PasswordPolicyConform
+    private_data_encryption: PrivateDataEncryption
+    process: Process
+    sdn_connector: SdnConnector
+    time: Time
+    traffic_history: TrafficHistory
+    upgrade_report: UpgradeReport
+    usb_device: UsbDevice
+    usb_log: UsbLog
+    vmlicense: Vmlicense
+    x5g_modem: X5gModem
+    acme_certificate_status: AcmeCertificateStatus
+    acquired_dns: AcquiredDns
+    automation_action: AutomationAction
+    available_certificates: AvailableCertificates
+    available_interfaces: AvailableInterfaces
+    botnet: Botnet
+    botnet_domains: BotnetDomains
+    central_management: CentralManagement
+    check_port_availability: CheckPortAvailability
+    current_admins: CurrentAdmins
+    global_resources: GlobalResources
+    global_search: GlobalSearch
+    ha_backup_hb_used: HaBackupHbUsed
+    ha_checksums: HaChecksums
+    ha_history: HaHistory
+    ha_hw_interface: HaHwInterface
+    ha_nonsync_checksums: HaNonsyncChecksums
+    ha_statistics: HaStatistics
+    ha_table_checksums: HaTableChecksums
+    interface_connected_admins_info: InterfaceConnectedAdminsInfo
+    ipconf: Ipconf
+    link_monitor: LinkMonitor
+    monitor_sensor: MonitorSensor
+    ntp: Ntp
+    performance: Performance
+    resolve_fqdn: ResolveFqdn
+    resource: Resource
+    running_processes: RunningProcesses
+    sandbox: Sandbox
+    sensor_info: SensorInfo
+    status: Status
+    storage: Storage
+    timezone: Timezone
+    trusted_cert_authorities: TrustedCertAuthorities
+    vdom_link: VdomLink
+    vdom_resource: VdomResource
+    vm_information: VmInformation
+    x3g_modem: X3gModem
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/monitor/system/admin/__init__.pyi

@@ -0,0 +1,17 @@
+"""Type stubs for ADMIN category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .change_vdom_mode import ChangeVdomMode
+
+
+class Admin:
+    """Type stub for Admin."""
+
+    change_vdom_mode: ChangeVdomMode
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/monitor/system/api_user/__init__.pyi

@@ -0,0 +1,17 @@
+"""Type stubs for API_USER category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .generate_key import GenerateKey
+
+
+class ApiUser:
+    """Type stub for ApiUser."""
+
+    generate_key: GenerateKey
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/monitor/system/automation_stitch/__init__.pyi

@@ -0,0 +1,19 @@
+"""Type stubs for AUTOMATION_STITCH category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .test import Test
+    from .webhook import Webhook
+
+
+class AutomationStitch:
+    """Type stub for AutomationStitch."""
+
+    test: Test
+    webhook: Webhook
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/monitor/system/certificate/__init__.pyi

@@ -0,0 +1,19 @@
+"""Type stubs for CERTIFICATE category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .download import Download
+    from .read_info import ReadInfo
+
+
+class Certificate:
+    """Type stub for Certificate."""
+
+    download: Download
+    read_info: ReadInfo
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/monitor/system/change_password/__init__.pyi

@@ -0,0 +1,17 @@
+"""Type stubs for CHANGE_PASSWORD category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .select import Select
+
+
+class ChangePassword:
+    """Type stub for ChangePassword."""
+
+    select: Select
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/monitor/system/cluster/__init__.pyi

@@ -0,0 +1,17 @@
+"""Type stubs for CLUSTER category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .state import State
+
+
+class Cluster:
+    """Type stub for Cluster."""
+
+    state: State
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/monitor/system/com_log/__init__.pyi

@@ -0,0 +1,21 @@
+"""Type stubs for COM_LOG category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .download import Download
+    from .dump import Dump
+    from .update import Update
+
+
+class ComLog:
+    """Type stub for ComLog."""
+
+    download: Download
+    dump: Dump
+    update: Update
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/monitor/system/config/__init__.pyi

@@ -0,0 +1,21 @@
+"""Type stubs for CONFIG category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .backup import Backup
+    from .restore import Restore
+    from .restore_status import RestoreStatus
+
+
+class Config:
+    """Type stub for Config."""
+
+    backup: Backup
+    restore: Restore
+    restore_status: RestoreStatus
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/monitor/system/config.pyi

@@ -0,0 +1,87 @@
+from typing import TypedDict, Literal, NotRequired, Any, Coroutine, Union
+
+
+class Performance:
+    """
+    Configuration for system/performance/status
+    
+    Path: system/performance
+    Category: monitor
+    """
+    
+    def get(
+        self,
+        name: str | None = ...,
+        filter: str | None = ...,
+        range: list[int] | None = ...,
+        sort: str | None = ...,
+        format: str | None = ...,
+        action: str | None = ...,
+        vdom: str | bool | None = ...,
+        raw_json: bool = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    def post(
+        self,
+        payload_dict: dict[str, Any] | None = ...,
+        vdom: str | bool | None = ...,
+        raw_json: bool = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    def put(
+        self,
+        payload_dict: dict[str, Any] | None = ...,
+        vdom: str | bool | None = ...,
+        raw_json: bool = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    def delete(
+        self,
+        name: str | None = ...,
+        vdom: str | bool | None = ...,
+        raw_json: bool = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    def exists(
+        self,
+        name: str,
+        vdom: str | bool | None = ...,
+    ) -> Union[bool, Coroutine[Any, Any, bool]]: ...
+    
+    def set(
+        self,
+        payload_dict: dict[str, Any] | None = ...,
+        vdom: str | bool | None = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    # Helper methods
+    @staticmethod
+    def help(field_name: str | None = ...) -> str: ...
+    
+    @staticmethod
+    def fields(detailed: bool = ...) -> Union[list[str], list[dict[str, Any]]]: ...
+    
+    @staticmethod
+    def field_info(field_name: str) -> dict[str, Any]: ...
+    
+    @staticmethod
+    def validate_field(name: str, value: Any) -> bool: ...
+    
+    @staticmethod
+    def required_fields() -> list[str]: ...
+    
+    @staticmethod
+    def defaults() -> dict[str, Any]: ...
+    
+    @staticmethod
+    def schema() -> dict[str, Any]: ...
+
+
+__all__ = [
+    "Performance",
+]

hfortix_fortios/api/v2/monitor/system/config_error_log/__init__.pyi

@@ -0,0 +1,17 @@
+"""Type stubs for CONFIG_ERROR_LOG category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .download import Download
+
+
+class ConfigErrorLog:
+    """Type stub for ConfigErrorLog."""
+
+    download: Download
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/monitor/system/config_revision/__init__.pyi

@@ -0,0 +1,25 @@
+"""Type stubs for CONFIG_REVISION category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .delete import Delete
+    from .file import File
+    from .info import Info
+    from .save import Save
+    from .update_comments import UpdateComments
+
+
+class ConfigRevision:
+    """Type stub for ConfigRevision."""
+
+    delete: Delete
+    file: File
+    info: Info
+    save: Save
+    update_comments: UpdateComments
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/monitor/system/config_revision.pyi

@@ -0,0 +1,87 @@
+from typing import TypedDict, Literal, NotRequired, Any, Coroutine, Union
+
+
+class Performance:
+    """
+    Configuration for system/performance/status
+    
+    Path: system/performance
+    Category: monitor
+    """
+    
+    def get(
+        self,
+        name: str | None = ...,
+        filter: str | None = ...,
+        range: list[int] | None = ...,
+        sort: str | None = ...,
+        format: str | None = ...,
+        action: str | None = ...,
+        vdom: str | bool | None = ...,
+        raw_json: bool = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    def post(
+        self,
+        payload_dict: dict[str, Any] | None = ...,
+        vdom: str | bool | None = ...,
+        raw_json: bool = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    def put(
+        self,
+        payload_dict: dict[str, Any] | None = ...,
+        vdom: str | bool | None = ...,
+        raw_json: bool = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    def delete(
+        self,
+        name: str | None = ...,
+        vdom: str | bool | None = ...,
+        raw_json: bool = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    def exists(
+        self,
+        name: str,
+        vdom: str | bool | None = ...,
+    ) -> Union[bool, Coroutine[Any, Any, bool]]: ...
+    
+    def set(
+        self,
+        payload_dict: dict[str, Any] | None = ...,
+        vdom: str | bool | None = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    # Helper methods
+    @staticmethod
+    def help(field_name: str | None = ...) -> str: ...
+    
+    @staticmethod
+    def fields(detailed: bool = ...) -> Union[list[str], list[dict[str, Any]]]: ...
+    
+    @staticmethod
+    def field_info(field_name: str) -> dict[str, Any]: ...
+    
+    @staticmethod
+    def validate_field(name: str, value: Any) -> bool: ...
+    
+    @staticmethod
+    def required_fields() -> list[str]: ...
+    
+    @staticmethod
+    def defaults() -> dict[str, Any]: ...
+    
+    @staticmethod
+    def schema() -> dict[str, Any]: ...
+
+
+__all__ = [
+    "Performance",
+]

hfortix_fortios/api/v2/monitor/system/config_script/__init__.pyi

@@ -0,0 +1,21 @@
+"""Type stubs for CONFIG_SCRIPT category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .delete import Delete
+    from .run import Run
+    from .upload import Upload
+
+
+class ConfigScript:
+    """Type stub for ConfigScript."""
+
+    delete: Delete
+    run: Run
+    upload: Upload
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/monitor/system/config_script.pyi

@@ -0,0 +1,87 @@
+from typing import TypedDict, Literal, NotRequired, Any, Coroutine, Union
+
+
+class Performance:
+    """
+    Configuration for system/performance/status
+    
+    Path: system/performance
+    Category: monitor
+    """
+    
+    def get(
+        self,
+        name: str | None = ...,
+        filter: str | None = ...,
+        range: list[int] | None = ...,
+        sort: str | None = ...,
+        format: str | None = ...,
+        action: str | None = ...,
+        vdom: str | bool | None = ...,
+        raw_json: bool = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    def post(
+        self,
+        payload_dict: dict[str, Any] | None = ...,
+        vdom: str | bool | None = ...,
+        raw_json: bool = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    def put(
+        self,
+        payload_dict: dict[str, Any] | None = ...,
+        vdom: str | bool | None = ...,
+        raw_json: bool = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    def delete(
+        self,
+        name: str | None = ...,
+        vdom: str | bool | None = ...,
+        raw_json: bool = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    def exists(
+        self,
+        name: str,
+        vdom: str | bool | None = ...,
+    ) -> Union[bool, Coroutine[Any, Any, bool]]: ...
+    
+    def set(
+        self,
+        payload_dict: dict[str, Any] | None = ...,
+        vdom: str | bool | None = ...,
+        **kwargs: Any,
+    ) -> Union[dict[str, Any], Coroutine[Any, Any, dict[str, Any]]]: ...
+    
+    # Helper methods
+    @staticmethod
+    def help(field_name: str | None = ...) -> str: ...
+    
+    @staticmethod
+    def fields(detailed: bool = ...) -> Union[list[str], list[dict[str, Any]]]: ...
+    
+    @staticmethod
+    def field_info(field_name: str) -> dict[str, Any]: ...
+    
+    @staticmethod
+    def validate_field(name: str, value: Any) -> bool: ...
+    
+    @staticmethod
+    def required_fields() -> list[str]: ...
+    
+    @staticmethod
+    def defaults() -> dict[str, Any]: ...
+    
+    @staticmethod
+    def schema() -> dict[str, Any]: ...
+
+
+__all__ = [
+    "Performance",
+]

hfortix_fortios/api/v2/monitor/system/config_sync/__init__.pyi

@@ -0,0 +1,17 @@
+"""Type stubs for CONFIG_SYNC category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .status import Status
+
+
+class ConfigSync:
+    """Type stub for ConfigSync."""
+
+    status: Status
+
+    def __init__(self, client: IHTTPClient) -> None: ...