catalystwan 0.40.2.dev1__py3-none-any.whl → 2.0.0a1__py3-none-any.whl

catalystwan/api/templates/models/cisco_secure_internet_gateway.py

@@ -1,385 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-import ipaddress
-from pathlib import Path
-from typing import ClassVar, List, Literal, Optional
-
-from pydantic import BeforeValidator, ConfigDict, Field
-from typing_extensions import Annotated
-
-from catalystwan.api.templates.feature_template import FeatureTemplate, FeatureTemplateValidator
-
-DEFAULT_TRACKER_THRESHOLD = 300
-DEFAULT_TRACKER_INTERVAL = 60
-DEFAULT_TRACKER_MULTIPLIER = 3
-DEFAULT_INTERFACE_MTU = 1400
-DEFAULT_INTERFACE_DPD_INTERVAL = 10
-DEFAULT_INTERFACE_DPD_RETRIES = 3
-DEFAULT_INTERFACE_IKE_VERSION = 2
-DEFAULT_INTERFACE_IKE_REKEY_INTERVAL = 14400
-DEFAULT_INTERFACE_IPSEC_REKEY_INTERVAL = 3600
-DEFAULT_INTERFACE_IPSEC_REPLAY_WINDOW = 512
-DEFAULT_INTERFACE_PAIR_ACTIVE_INTERFACE_WEIGHT = 1
-DEFAULT_INTERFACE_PAIR_BACKUP_INTERFACE_WEIGHT = 1
-DEFAULT_SIG_VPN_ID = 0
-DEFAULT_SERVICE_IDLE_TIME = 0
-DEFAULT_SERVICE_REFRESH_TIME = 0
-
-
-Application = Literal["sig"]
-TunnelSet = Literal["secure-internet-gateway-umbrella", "secure-internet-gateway-zscaler"]
-TunnelDcPreference = Literal["primary-dc", "secondary-dc"]
-IkeCiphersuite = Literal["aes256-cbc-sha1", "aes256-cbc-sha2", "aes128-cbc-sha1", "aes128-cbc-sha2"]
-IkeGroup = Literal["2", "14", "15", "16"]
-IpsecCiphersuite = Literal[
-    "aes256-cbc-sha1",
-    "aes256-cbc-sha384",
-    "aes256-cbc-sha256",
-    "aes256-cbc-sha512",
-    "aes256-gcm",
-    "null-sha1",
-    "null-sha384",
-    "null-sha256",
-    "null-sha512",
-]
-PerfectForwardSecrecy = Literal["group-2", "group-14", "group-15", "group-16", "none"]
-DisplayTimeUnit = Literal["MINUTE", "HOUR", "DAY"]
-RefreshTimeUnit = Literal["MINUTE", "HOUR", "DAY"]
-TrackerType = Literal["SIG"]
-SvcType = Literal["sig"]
-
-
-def is_private_ipv4_address(value: ipaddress.IPv4Interface) -> ipaddress.IPv4Interface:
-    # https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
-    assert value.is_private, "IPv4 address is not private"
-    return value
-
-
-PrivateIPv4Address = Annotated[
-    ipaddress.IPv4Interface,
-    BeforeValidator(is_private_ipv4_address),
-]
-
-
-class Interface(FeatureTemplateValidator):
-    if_name: str = Field(
-        ...,  # Ellipsis indicates a required field
-        pattern="ipsec(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[1-9])",
-        json_schema_extra={"vmanage_key": "if-name"},
-        description="Name of the interface. Ipsec1..255 allowed.",
-    )
-    auto: bool = Field(..., description="Flag to indicate if the interface should be automatically configured.")
-    shutdown: bool = Field(..., description="Flag to indicate if the interface is administratively down (shutdown).")
-    description: Optional[str] = Field(default=None, description="Description for the interface.")
-    unnumbered: bool = Field(default=True, description="Flag to indicate if the interface should be unnumbered.")
-    address: Optional[ipaddress.IPv4Interface] = Field(
-        default=None, description="IPv4 address and subnet mask for the interface."
-    )
-    tunnel_source: Optional[ipaddress.IPv4Address] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "tunnel-source"},
-        description="IPv4 address used as the source of the tunnel.",
-    )
-    tunnel_source_interface: Optional[str] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "tunnel-source-interface"},
-        description="Interface name used as the source of the tunnel.",
-    )
-    tunnel_route_via: Optional[str] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "tunnel-route-via"},
-        description="The route via which tunnel traffic should be sent.",
-    )
-    tunnel_destination: str = Field(
-        ...,
-        json_schema_extra={"vmanage_key": "tunnel-destination"},
-        description="The destination address for the tunnel.",
-    )
-    application: Application = Field(default="sig", description="Application type for the Secure Internet Gateway.")
-    tunnel_set: TunnelSet = Field(
-        default="secure-internet-gateway-umbrella",
-        json_schema_extra={"vmanage_key": "tunnel-set"},
-        description="Tunnel set used for the Secure Internet Gateway.",
-    )
-    tunnel_dc_preference: TunnelDcPreference = Field(
-        default="primary-dc",
-        json_schema_extra={"vmanage_key": "tunnel-dc-preference"},
-        description="Data center preference for the tunnel.",
-    )
-    tcp_mss_adjust: Optional[int] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "tcp-mss-adjust"},
-        description="TCP Maximum Segment Size (MSS) adjust value.",
-    )
-    mtu: int = Field(
-        default=DEFAULT_INTERFACE_MTU, description="MTU (Maximum Transmission Unit) size for the interface."
-    )
-    dpd_interval: Optional[int] = Field(
-        default=DEFAULT_INTERFACE_DPD_INTERVAL,
-        json_schema_extra={"vmanage_key": "dpd-interval"},
-        description="Dead Peer Detection (DPD) interval in seconds.",
-    )
-    dpd_retries: Optional[int] = Field(
-        default=DEFAULT_INTERFACE_DPD_RETRIES,
-        json_schema_extra={"vmanage_key": "dpd-retries"},
-        description="Number of retries for Dead Peer Detection (DPD).",
-    )
-    ike_version: int = Field(
-        default=DEFAULT_INTERFACE_IKE_VERSION,
-        json_schema_extra={"vmanage_key": "ike-version"},
-        description="Internet Key Exchange (IKE) protocol version.",
-    )
-    pre_shared_secret: Optional[str] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "pre-shared-secret"},
-        description="Pre-shared secret key for IKE authentication.",
-    )
-    ike_rekey_interval: Optional[int] = Field(
-        default=DEFAULT_INTERFACE_IKE_REKEY_INTERVAL,
-        json_schema_extra={"vmanage_key": "ike-rekey-interval"},
-        description="Interval for rekeying the IKE security association.",
-    )
-    ike_ciphersuite: Optional[IkeCiphersuite] = Field(
-        default="aes256-cbc-sha1",
-        json_schema_extra={"vmanage_key": "ike-ciphersuite"},
-        description="Ciphersuite for IKE security association establishment.",
-    )
-    ike_group: IkeGroup = Field(
-        default="14",
-        json_schema_extra={"vmanage_key": "ike-group"},
-        description="Diffie-Hellman group used for IKE key exchange.",
-    )
-    pre_shared_key_dynamic: bool = Field(
-        default=True,
-        json_schema_extra={"vmanage_key": "pre-shared-key-dynamic"},
-        description="Flag indicating if the pre-shared key is dynamic.",
-    )
-    ike_local_id: Optional[str] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "ike-local-id"},
-        description="Local identifier for IKE authentication.",
-    )
-    ike_remote_id: Optional[str] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "ike-remote-id"},
-        description="Remote identifier for IKE authentication.",
-    )
-    ipsec_rekey_interval: Optional[int] = Field(
-        default=DEFAULT_INTERFACE_IPSEC_REKEY_INTERVAL,
-        json_schema_extra={"vmanage_key": "ipsec-rekey-interval"},
-        description="Interval for rekeying the IPsec security association.",
-    )
-    ipsec_replay_window: Optional[int] = Field(
-        default=DEFAULT_INTERFACE_IPSEC_REPLAY_WINDOW,
-        json_schema_extra={"vmanage_key": "ipsec-replay-window"},
-        description="Replay window size for IPsec security association.",
-    )
-    ipsec_ciphersuite: IpsecCiphersuite = Field(
-        default="aes256-gcm",
-        json_schema_extra={"vmanage_key": "ipsec-ciphersuite"},
-        description="Ciphersuite for IPsec security association establishment.",
-    )
-    perfect_forward_secrecy: PerfectForwardSecrecy = Field(
-        default="none",
-        json_schema_extra={"vmanage_key": "perfect-forward-secrecy"},
-        description="Perfect Forward Secrecy (PFS) setting for IPsec key exchange.",
-    )
-    tracker: Optional[bool] = Field(default=None, description="Flag indicating if interface tracking is enabled.")
-    track_enable: Optional[bool] = Field(
-        default=True,
-        json_schema_extra={"vmanage_key": "track-enable"},
-        description="Flag indicating if tracking is enabled for the interface.",
-    )
-    tunnel_public_ip: Optional[ipaddress.IPv4Address] = Field(
-        default=None,
-        description="Public IP required to setup GRE tunnel to Zscaler",
-        json_schema_extra={"vmanage_key": "tunnel-public-ip"},
-    )
-    model_config: ClassVar[ConfigDict] = ConfigDict(populate_by_name=True)
-
-
-class InterfacePair(FeatureTemplateValidator):
-    active_interface: str = Field(
-        ..., json_schema_extra={"vmanage_key": "active-interface"}, description="Name of the active interface."
-    )
-    active_interface_weight: int = Field(
-        default=DEFAULT_INTERFACE_PAIR_ACTIVE_INTERFACE_WEIGHT,
-        json_schema_extra={"vmanage_key": "active-interface-weight"},
-        description="Weighting factor for the active interface, used in failover decisions.",
-    )
-    backup_interface: Optional[str] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "backup-interface"},
-        description="Name of the backup interface. Can be 'None' if no backup interface is defined.",
-    )
-    backup_interface_weight: int = Field(
-        default=DEFAULT_INTERFACE_PAIR_BACKUP_INTERFACE_WEIGHT,
-        json_schema_extra={"vmanage_key": "backup-interface-weight"},
-        description="Weighting factor for the backup interface, used in failover decisions.",
-    )
-    model_config: ClassVar[ConfigDict] = ConfigDict(populate_by_name=True)
-
-
-class Service(FeatureTemplateValidator):
-    svc_type: SvcType = Field(
-        default="sig", json_schema_extra={"vmanage_key": "svc-type"}, description="Type of service configured."
-    )
-    interface_pair: List[InterfacePair] = Field(
-        ...,
-        json_schema_extra={"data_path": ["ha-pairs"], "vmanage_key": "interface-pair"},
-        description="List of high-availability interface pairs.",
-    )
-    auth_required: Optional[bool] = Field(
-        default=False,
-        json_schema_extra={"vmanage_key": "auth-required"},
-        description="Flag indicating if authentication is required for the service.",
-    )
-    xff_forward_enabled: Optional[bool] = Field(
-        default=False,
-        json_schema_extra={"vmanage_key": "xff-forward-enabled"},
-        description="Flag indicating if X-Forwarded-For HTTP header is enabled.",
-    )
-    ofw_enabled: Optional[bool] = Field(
-        default=False,
-        json_schema_extra={"vmanage_key": "ofw-enabled"},
-        description="Flag indicating if on-premise firewall is enabled.",
-    )
-    ips_control: Optional[bool] = Field(
-        default=False,
-        json_schema_extra={"vmanage_key": "ips-control"},
-        description="Flag indicating if Intrusion Prevention System (IPS) control is enabled.",
-    )
-    caution_enabled: Optional[bool] = Field(
-        default=False,
-        json_schema_extra={"vmanage_key": "caution-enabled"},
-        description="Flag indicating if caution warnings are enabled.",
-    )
-    primary_data_center: Optional[str] = Field(
-        default="Auto",
-        json_schema_extra={"vmanage_key": "primary-data-center"},
-        description="Primary data center for the service. 'Auto' for automatic selection.",
-    )
-    secondary_data_center: Optional[str] = Field(
-        default="Auto",
-        json_schema_extra={"vmanage_key": "secondary-data-center"},
-        description="Secondary data center for the service. 'Auto' for automatic selection.",
-    )
-    ip: Optional[bool] = Field(
-        default=None, description="Flag indicating if IP filtering or processing is enabled for the service."
-    )
-    idle_time: Optional[int] = Field(
-        default=DEFAULT_SERVICE_IDLE_TIME,
-        json_schema_extra={"vmanage_key": "idle-time"},
-        description="Idle time before a session is considered inactive.",
-    )
-
-    display_time_unit: Optional[DisplayTimeUnit] = Field(
-        default="MINUTE",
-        json_schema_extra={"vmanage_key": "display-time-unit"},
-        description="Unit of time used for displaying time-related settings.",
-    )
-    ip_enforced_for_known_browsers: Optional[bool] = Field(
-        default=False,
-        json_schema_extra={"vmanage_key": "ip-enforced-for-known-browsers"},
-        description="Flag indicating if IP is enforced for known browsers.",
-    )
-    refresh_time: Optional[int] = Field(
-        default=DEFAULT_SERVICE_REFRESH_TIME,
-        json_schema_extra={"vmanage_key": "refresh-time"},
-        description="Time after which the service information is refreshed.",
-    )
-    refresh_time_unit: Optional[RefreshTimeUnit] = Field(
-        default="MINUTE",
-        json_schema_extra={"vmanage_key": "refresh-time-unit"},
-        description="Unit of time used for the refresh time setting.",
-    )
-    enabled: Optional[bool] = Field(default=None, description="Flag indicating if the service is enabled.")
-    block_internet_until_accepted: Optional[bool] = Field(
-        default=False,
-        json_schema_extra={"vmanage_key": "block-internet-until-accepted"},
-        description="Flag indicating if Internet access is blocked until the service is accepted.",
-    )
-    force_ssl_inspection: Optional[bool] = Field(
-        default=False,
-        json_schema_extra={"vmanage_key": "force-ssl-inspection"},
-        description="Flag indicating if SSL inspection is forced.",
-    )
-    timeout: Optional[int] = Field(
-        default=None, description="Timeout value for the service, after which the session is considered inactive."
-    )
-    location_name: Optional[str] = Field(
-        default="Auto",
-        json_schema_extra={"vmanage_key": "location-name"},
-        description="Secondary data center for the service. 'Auto' for automatic selection.",
-    )
-    data_center_primary: Optional[str] = Field(
-        default="Auto",
-        json_schema_extra={"vmanage_key": "data-center-primary"},
-        description="Zscaler location name (optional)",
-    )
-    data_center_secondary: Optional[str] = Field(
-        default="Auto",
-        json_schema_extra={"vmanage_key": "data-center-secondary"},
-        description=(
-            "Secondary data center for the service. 'Auto' for automatic selection "
-            "or a specific identifier for a manual selection."
-        ),
-    )
-
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class Tracker(FeatureTemplateValidator):
-    name: str = Field(..., description="Name of the tracker.")
-    endpoint_api_url: str = Field(
-        ...,
-        pattern=r"^http:\/\/[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*(\.[a-zA-Z]{2,})(\/\S*)?$",
-        json_schema_extra={"vmanage_key": "endpoint-api-url"},
-        description="URL of the endpoint API used by the tracker for health checks.",
-    )
-    threshold: Optional[int] = Field(
-        ge=100,
-        default=DEFAULT_TRACKER_THRESHOLD,
-        description="Threshold value for the tracker to trigger an alert or action.",
-    )
-    interval: Optional[int] = Field(
-        default=DEFAULT_TRACKER_INTERVAL, description="Interval at which the tracker performs health checks."
-    )
-    multiplier: Optional[int] = Field(
-        default=DEFAULT_TRACKER_MULTIPLIER,
-        description="Multiplier value used by the tracker to escalate repeated failures.",
-    )
-    tracker_type: TrackerType = Field(
-        ..., json_schema_extra={"vmanage_key": "tracker-type"}, description="Type of tracker used for monitoring."
-    )
-    model_config: ClassVar[ConfigDict] = ConfigDict(populate_by_name=True)
-
-
-class CiscoSecureInternetGatewayModel(FeatureTemplate):
-    model_config: ClassVar[ConfigDict] = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
-    _docs_description: str = "Cisco Secure Internet Gateway feature template configuration"
-
-    vpn_id: int = Field(
-        default=DEFAULT_SIG_VPN_ID,
-        json_schema_extra={"vmanage_key": "vpn-id"},
-        description="VPN ID associated with the Cisco Secure Internet Gateway service.",
-    )
-    child_org_id: str = Field(
-        default="",
-        json_schema_extra={"vmanage_key": "childOrgId"},
-        description="Child Organization Id",
-    )
-    interface: List[Interface] = Field(description="List of interface configurations associated with the service.")
-    service: List[Service] = Field(description="List of service configurations for the Cisco Secure Internet Gateway.")
-    tracker_src_ip: Optional[PrivateIPv4Address] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "tracker-src-ip"},
-        description="Source IP address used by the tracker for sending health check packets.",
-    )
-    tracker: Optional[List[Tracker]] = Field(
-        default=None,
-        description="List of trackers for monitoring the health of the Cisco Secure Internet Gateway service.",
-    )
-
-    payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
-    type: ClassVar[str] = "cisco_secure_internet_gateway"

catalystwan/api/templates/models/cisco_snmp_model.py

@@ -1,102 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-from pathlib import Path
-from typing import ClassVar, List, Literal, Optional
-
-from pydantic import ConfigDict, Field
-
-from catalystwan.api.templates.bool_str import BoolStr
-from catalystwan.api.templates.feature_template import FeatureTemplate, FeatureTemplateValidator
-
-Authorization = Literal["read-only"]
-SecurityLevel = Literal["no-auth-no-priv", "auth-no-priv", "auth-priv"]
-Auth = Literal["md5", "sha"]
-Priv = Literal["aes-cfb-128", "aes-256-cfb-128"]
-
-
-class Oid(FeatureTemplateValidator):
-    id: str = Field(description="The OID (Object Identifier) to include or exclude in the view")
-    exclude: Optional[BoolStr] = Field(
-        default=None, description="Indicates whether the OID should be excluded from the view"
-    )
-
-
-class View(FeatureTemplateValidator):
-    name: str = Field(description="The name of the SNMP view")
-    oid: Optional[List[Oid]] = Field(default=None, description="List of OIDs to include or exclude in the view")
-
-
-class Community(FeatureTemplateValidator):
-    name: str = Field(description="The name of the SNMP community")
-    view: str = Field(description="The SNMP view associated with the community")
-    authorization: Authorization = Field(description="The authorization level of the community")
-
-
-class Group(FeatureTemplateValidator):
-    name: str = Field(description="The name of the SNMP group")
-    security_level: SecurityLevel = Field(
-        description="The security level associated with the group", json_schema_extra={"vmanage_key": "security-level"}
-    )
-    view: str = Field(description="The SNMP view associated with the group")
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class User(FeatureTemplateValidator):
-    name: str = Field(description="The name of the SNMP user")
-    auth: Optional[Auth] = Field(default=None, description="The authentication protocol used")
-    auth_password: Optional[str] = Field(
-        default=None, description="The password for authentication", json_schema_extra={"vmanage_key": "auth-password"}
-    )
-    priv: Optional[Priv] = Field(default=None, description="The privacy (encryption) protocol used")
-    priv_password: Optional[str] = Field(
-        default=None, description="The password for privacy", json_schema_extra={"vmanage_key": "priv-password"}
-    )
-    group: str = Field(description="The group to which the user belongs")
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class Target(FeatureTemplateValidator):
-    vpn_id: int = Field(
-        description="The VPN ID where the SNMP target resides", json_schema_extra={"vmanage_key": "vpn-id"}
-    )
-    ip: str = Field(description="The IP address of the SNMP target")
-    port: int = Field(description="The port number for the SNMP target")
-    community_name: Optional[str] = Field(
-        default=None,
-        description="The community name for the SNMP target",
-        json_schema_extra={"vmanage_key": "community-name"},
-    )
-    user: Optional[str] = Field(default=None, description="The user name for the SNMP target")
-    source_interface: Optional[str] = Field(
-        default=None,
-        description="The source interface for sending SNMP traps",
-        json_schema_extra={"vmanage_key": "source-interface"},
-    )
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class CiscoSNMPModel(FeatureTemplate):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
-    _docs_description: str = "Cisco SNMP Feature Template configuration"
-
-    shutdown: Optional[BoolStr] = Field(
-        default=True, description="Indicates whether SNMP is administratively shut down"
-    )
-    contact: Optional[str] = Field(default=None, description="The contact information for the SNMP administrator")
-    location: Optional[str] = Field(default=None, description="The physical location information for the SNMP agent")
-    view: Optional[List[View]] = Field(default=None, description="List of SNMP views for controlling access to OIDs")
-    community: Optional[List[Community]] = Field(
-        default=None, description="List of SNMP communities for different access rights"
-    )
-    group: Optional[List[Group]] = Field(
-        default=None, description="List of SNMP groups defining security models and access rights"
-    )
-    user: Optional[List[User]] = Field(
-        default=None, description="List of SNMP users with authentication and privacy configurations"
-    )
-    target: Optional[List[Target]] = Field(
-        default=None, json_schema_extra={"data_path": ["trap"]}, description="List of SNMP targets for sending traps"
-    )
-
-    payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
-    type: ClassVar[str] = "cisco_snmp"