catalystwan 0.41.2.dev9__py3-none-any.whl → 0.41.3__py3-none-any.whl

catalystwan/models/configuration/feature_profile/sdwan/service/appqoe.py

@@ -1,11 +1,10 @@
 # Copyright 2024 Cisco Systems, Inc. and its affiliates
 
-from ipaddress import IPv4Address
 from typing import List, Literal, Optional, Union
 
-from pydantic import AliasPath, BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field
 
-from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase, as_global
+from catalystwan.api.configuration_groups.parcel import Default, Global, Variable
 
 VirtualApplicationType = Literal["dreopt"]
 
@@ -27,40 +26,6 @@ AppqoeDeviceRole = Literal[
 
 AppnavControllerGroupName = Literal["ACG-APPQOE"]
 ServiceNodeGroupName = Literal["SNG-APPQOE"]
-ServiceNodeGroupsNames = Literal[
-    "SNG-APPQOE",
-    "SNG-APPQOE1",
-    "SNG-APPQOE2",
-    "SNG-APPQOE3",
-    "SNG-APPQOE4",
-    "SNG-APPQOE5",
-    "SNG-APPQOE6",
-    "SNG-APPQOE7",
-    "SNG-APPQOE8",
-    "SNG-APPQOE9",
-    "SNG-APPQOE10",
-    "SNG-APPQOE11",
-    "SNG-APPQOE12",
-    "SNG-APPQOE13",
-    "SNG-APPQOE14",
-    "SNG-APPQOE15",
-    "SNG-APPQOE16",
-    "SNG-APPQOE17",
-    "SNG-APPQOE18",
-    "SNG-APPQOE19",
-    "SNG-APPQOE20",
-    "SNG-APPQOE21",
-    "SNG-APPQOE22",
-    "SNG-APPQOE23",
-    "SNG-APPQOE24",
-    "SNG-APPQOE25",
-    "SNG-APPQOE26",
-    "SNG-APPQOE27",
-    "SNG-APPQOE28",
-    "SNG-APPQOE29",
-    "SNG-APPQOE30",
-    "SNG-APPQOE31",
-]
 ForwarderAndServiceNodeAddress = Literal["192.168.2.2"]  # TODO: 1.Is it really constant? 2.Use ipaddress.IPv4Address?
 ForwarderAndServiceNodeControllerAddress = Literal[
     "192.168.2.1"
@@ -70,7 +35,7 @@ ServiceNodeExternalVpgIp = Literal["192.168.2.1/24"]  # TODO: 1.Is it really con
 
 
 class VirtualApplication(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     instance_id: Global[int] = Field(
         default=Global(value=1), serialization_alias="instanceId", validation_alias="instanceId"
@@ -80,15 +45,15 @@ class VirtualApplication(BaseModel):
         serialization_alias="applicationType",
         validation_alias="applicationType",
     )
-    resource_profile: Union[Global[ResourceProfile], Default[ResourceProfile]] = Field(
-        default=Default[ResourceProfile](value="default"),
+    resource_profile: Union[Global[ResourceProfile], Default[str]] = Field(
+        default=Global[ResourceProfile](value="default"),
         serialization_alias="resourceProfile",
         validation_alias="resourceProfile",
     )
 
 
 class Appqoe(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     name: Default[str] = Default(value="/1")
     appnav_controller_group: Global[AppnavControllerGroupName] = Field(
@@ -101,8 +66,8 @@ class Appqoe(BaseModel):
         serialization_alias="serviceNodeGroup",
         validation_alias="serviceNodeGroup",
     )
-    service_node_groups: List[Global[ServiceNodeGroupsNames]] = Field(
-        default=[Global[ServiceNodeGroupsNames](value="SNG-APPQOE")],
+    service_node_groups: List[Global[ServiceNodeGroupName]] = Field(
+        default=[Global[ServiceNodeGroupName](value="SNG-APPQOE")],
         serialization_alias="serviceNodeGroups",
         validation_alias="serviceNodeGroups",
     )
@@ -112,27 +77,25 @@ class Appqoe(BaseModel):
 
 class ServiceContext(BaseModel):
     model_config = ConfigDict(arbitrary_types_allowed=True)
-    appqoe: List[Appqoe] = Field(default_factory=lambda: [Appqoe()])
+    appqoe: List[Appqoe]
 
 
 # Frowarder
 
 
 class ServiceNodeInformation(BaseModel):
-    address: Global[IPv4Address]
+    address: Global[str]
 
 
 class ForwarderController(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
-    address: Union[Global[str], Global[IPv4Address], Variable]
-    vpn: Global[int] = Field(
-        default=Global[int](value=1), description="This is field is a depended on the Service VPN value."
-    )
+    address: Union[Global[str], Variable]
+    vpn: Global[int] = Global[int](value=1)
 
 
 class ForwarderAppnavControllerGroup(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     group_name: Default[AppnavControllerGroupName] = Field(
         default=Default(value="ACG-APPQOE"), serialization_alias="groupName", validation_alias="groupName"
@@ -143,17 +106,17 @@ class ForwarderAppnavControllerGroup(BaseModel):
 
 
 class ForwarderNodeGroup(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
-    name: Union[Global[str], Default[ServiceNodeGroupName]] = Default[ServiceNodeGroupName](value="SNG-APPQOE")
-    internal: Union[Default[bool], Global[bool]] = Default[bool](value=False)
+    name: Union[Global[str], Default[ServiceNodeGroupName]]
+    internal: Default[bool] = Default[bool](value=False)
     service_node: List[ServiceNodeInformation] = Field(
         serialization_alias="serviceNode", validation_alias="serviceNode"
     )
 
 
 class ForwarderRole(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     appnav_controller_group: List[ForwarderAppnavControllerGroup] = Field(
         serialization_alias="appnavControllerGroup", validation_alias="appnavControllerGroup"
@@ -161,9 +124,7 @@ class ForwarderRole(BaseModel):
     service_node_group: List[ForwarderNodeGroup] = Field(
         serialization_alias="serviceNodeGroup", validation_alias="serviceNodeGroup"
     )
-    service_context: ServiceContext = Field(
-        default_factory=ServiceContext, serialization_alias="serviceContext", validation_alias="serviceContext"
-    )
+    service_context: ServiceContext = Field(serialization_alias="serviceContext", validation_alias="serviceContext")
 
 
 # Forwarder and Service
@@ -180,7 +141,7 @@ class ForwarderAndServiceNodeController(BaseModel):
 
 
 class ForwarderAndServiceNodeAppnavControllerGroup(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     group_name: Default[AppnavControllerGroupName] = Field(
         default=Default[AppnavControllerGroupName](value="ACG-APPQOE"),
@@ -193,7 +154,7 @@ class ForwarderAndServiceNodeAppnavControllerGroup(BaseModel):
 
 
 class ForwarderAndServiceNodeGroup(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     name: Default[ServiceNodeGroupName] = Default[ServiceNodeGroupName](value="SNG-APPQOE")
     internal: Default[bool] = Default[bool](value=True)
@@ -203,7 +164,7 @@ class ForwarderAndServiceNodeGroup(BaseModel):
 
 
 class ForwarderAndServiceNodeRole(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     appnav_controller_group: List[ForwarderAndServiceNodeAppnavControllerGroup] = Field(
         serialization_alias="appnavControllerGroup", validation_alias="appnavControllerGroup"
@@ -219,18 +180,18 @@ class ForwarderAndServiceNodeRole(BaseModel):
 
 
 class ServiceNodeInformationExternal(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     address: Default[ServiceNodeExternalAddress] = Default[ServiceNodeExternalAddress](value="192.168.2.2")
     vpg_ip: Default[ServiceNodeExternalVpgIp] = Field(
-        default=Default[ServiceNodeExternalVpgIp](value="192.168.2.1/24"),
+        default=Default[ServiceNodeExternalVpgIp](value="192.168.2.1"),
         serialization_alias="vpgIp",
         validation_alias="vpgIp",
     )
 
 
 class ServiceNodeGroup(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     name: Default[ServiceNodeGroupName] = Default[ServiceNodeGroupName](value="SNG-APPQOE")
     external_node: Default[bool] = Field(
@@ -242,29 +203,33 @@ class ServiceNodeGroup(BaseModel):
 
 
 class ServiceNodeRole(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     service_node_group: List[ServiceNodeGroup] = Field(
         default=[ServiceNodeGroup()], serialization_alias="serviceNodeGroup", validation_alias="serviceNodeGroup"
     )
 
 
-class AppqoeParcel(_ParcelBase):
-    type_: Literal["appqoe"] = Field(default="appqoe", exclude=True)
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+class AppqoeData(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
-    dreopt: Optional[Union[Global[bool], Default[bool]]] = Field(
-        default=None, validation_alias=AliasPath("data", "dreopt")
-    )
+    dreopt: Optional[Union[Global[bool], Default[bool]]] = Default[bool](value=False)
     virtual_application: Optional[List[VirtualApplication]] = Field(
-        default=None, validation_alias=AliasPath("data", "virtualApplication")
+        serialization_alias="virtualApplication", validation_alias="virtualApplication"
     )
-    appqoe_device_role: Global[AppqoeDeviceRole] = Field(
-        default=as_global("forwarder"), validation_alias=AliasPath("data", "appqoeDeviceRole")
+    appqoe_device_role: Global[str] = Field(
+        default=Global(value="forwarder"), serialization_alias="appqoeDeviceRole", validation_alias="appqoeDeviceRole"
     )
 
-    forwarder: Optional[ForwarderRole] = Field(default=None, validation_alias=AliasPath("data", "forwarder"))
+    forwarder: Optional[ForwarderRole]
     forwarder_and_service_node: Optional[ForwarderAndServiceNodeRole] = Field(
-        default=None, validation_alias=AliasPath("data", "forwarderAndServiceNode")
+        serialization_alias="forwarderAndServiceNode", validation_alias="forwarderAndServiceNode"
     )
-    service_node: Optional[ServiceNodeRole] = Field(default=None, validation_alias=AliasPath("data", "serviceNode"))
+    service_node: Optional[ServiceNodeRole] = Field(serialization_alias="serviceNode", validation_alias="serviceNode")
+
+
+class AppqoeCreationPayload(BaseModel):
+    name: str
+    description: Optional[str] = None
+    data: AppqoeData
+    metadata: Optional[dict] = None

catalystwan/models/configuration/feature_profile/sdwan/service/bgp.py

@@ -0,0 +1,288 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal, Optional, Union
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.api.configuration_groups.parcel import Default, Global, Variable
+from catalystwan.models.configuration.feature_profile.common import Prefix
+
+
+class AggregatePrefix(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    prefix: Prefix
+    as_set: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="asSet", validation_alias="asSet", default=Default[bool](value=False)
+    )
+    summary_only: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="summaryOnly", validation_alias="summaryOnly", default=Default[bool](value=False)
+    )
+
+
+class AggregatePrefixIPv6(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    prefix: Union[Global[str], Variable]
+    as_set: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="asSet", validation_alias="asSet", default=Default[bool](value=False)
+    )
+    summary_only: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="summaryOnly", validation_alias="summaryOnly", default=Default[bool](value=False)
+    )
+
+
+class NetworkPrefix(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    prefix: Prefix
+
+
+class NetworkPrefixIPv6(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    prefix: Union[Global[str], Variable]
+
+
+RedistributeProtocol = Literal[
+    "static",
+    "connected",
+    "omp",
+    "nat",
+    "ospf",
+    "ospfv3",
+    "eigrp",
+]
+
+
+RedistributeProtocolIPv6 = Literal[
+    "static",
+    "connected",
+    "omp",
+    "ospf",
+]
+
+
+class RedistributedRoute(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    protocol: Union[Global[RedistributeProtocol], Variable]
+    route_policy: Optional[Union[Default[None], Global[UUID]]] = Field(
+        serialization_alias="routePolicy", validation_alias="routePolicy"
+    )
+
+
+class RedistributedRouteIPv6(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    protocol: Union[Global[RedistributeProtocolIPv6], Variable]
+    route_policy: Optional[Union[Default[None], Global[UUID]]] = Field(
+        serialization_alias="routePolicy", validation_alias="routePolicy"
+    )
+
+
+class AddressFamilyIPv4(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    aggregate_address: Optional[List[AggregatePrefix]] = Field(
+        serialization_alias="aggregateAddress", validation_alias="aggregateAddress"
+    )
+    network: Optional[List[NetworkPrefix]] = None
+    paths: Optional[Union[Global[int], Variable, Default[None]]] = None
+    originate: Optional[Union[Global[bool], Variable, Default[bool]]] = Default[bool](value=False)
+    name: Optional[Union[Default[None], Global[UUID]]] = None
+    filter: Optional[Union[Global[bool], Variable, Default[bool]]] = Default[bool](value=False)
+    redistribute: Optional[List[RedistributedRoute]] = None
+
+
+class PolicyType(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    policy_type: Global[str] = Field(serialization_alias="policyType", validation_alias="policyType")
+
+
+class PolicyTypeWithThreshold(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    policy_type: Global[str] = Field(serialization_alias="policyType", validation_alias="policyType")
+    prefix_number: Union[Global[int], Variable] = Field(serialization_alias="prefixNum", validation_alias="prefixNum")
+    threshold: Union[Global[int], Variable, Default[int]] = Default[int](value=75)
+
+
+class PolicyTypeWithRestart(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    policy_type: Global[str] = Field(serialization_alias="policyType", validation_alias="policyType")
+    prefix_number: Union[Global[int], Variable] = Field(serialization_alias="prefixNum", validation_alias="prefixNum")
+    threshold: Union[Global[int], Variable, Default[int]] = Default[int](value=75)
+    restart_interval: Union[Global[int], Variable]
+
+
+class AddressFamilyIPv6(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    aggregate_address: Optional[List[AggregatePrefixIPv6]] = Field(
+        serialization_alias="ipv6AggregateAddress", validation_alias="ipv6AggregateAddress"
+    )
+    network: Optional[List[NetworkPrefixIPv6]] = Field(
+        serialization_alias="ipv6Network", validation_alias="ipv6Network"
+    )
+    paths: Optional[Union[Global[int], Variable, Default[None]]] = None
+    originate: Optional[Union[Global[bool], Variable, Default[bool]]] = Default[bool](value=False)
+    name: Optional[Union[Default[None], Global[UUID]]] = None
+    filter: Optional[Union[Global[bool], Variable, Default[bool]]] = Default[bool](value=False)
+    redistribute: Optional[List[RedistributedRouteIPv6]] = None
+
+
+class BgpAddressFamily(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    family_type: Global[str] = Field(serialization_alias="familyType", validation_alias="familyType")
+    max_prefix_config: Optional[Union[PolicyType, PolicyTypeWithRestart, PolicyTypeWithThreshold]] = Field(
+        serialization_alias="maxPrefixConfig", validation_alias="maxPrefixConfig"
+    )
+    in_route_policy: Optional[Union[Default[None], Global[UUID]]] = Field(
+        serialization_alias="inRoutePolicy", validation_alias="inRoutePolicy"
+    )
+    out_route_policy: Optional[Union[Default[None], Global[UUID]]] = Field(
+        serialization_alias="outRoutePolicy", validation_alias="outRoutePolicy"
+    )
+
+
+class BgpIPv4Neighbor(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    address: Union[Global[str], Variable]
+    description: Optional[Union[Global[str], Variable, Default[None]]] = None
+    shutdown: Optional[Union[Global[bool], Variable, Default[bool]]] = Default[bool](value=False)
+    remote_as: Union[Global[int], Variable] = Field(serialization_alias="remoteAs", validation_alias="remoteAs")
+    local_as: Optional[Union[Global[int], Variable]] = Field(
+        serialization_alias="localAs", validation_alias="localAs", default=None
+    )
+    keepalive: Optional[Union[Global[int], Variable, Default[int]]] = Default[int](value=60)
+    holdtime: Optional[Union[Global[int], Variable, Default[int]]] = Default[int](value=180)
+    interface_name: Optional[Union[Global[str], Variable, Default[None]]] = Field(
+        serialization_alias="ifName", validation_alias="ifName", default=None
+    )
+    next_hop_self: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="nextHopSelf", validation_alias="nextHopSelf", default=Default[bool](value=False)
+    )
+    send_community: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="sendCommunity", validation_alias="sendCommunity", default=Default[bool](value=True)
+    )
+    send_ext_community: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="sendExtCommunity", validation_alias="sendExtCommunity", default=Default[bool](value=True)
+    )
+    ebgp_multihop: Optional[Union[Global[int], Variable, Default[int]]] = Field(
+        serialization_alias="ebgpMultihop", validation_alias="ebgpMultihop", default=Default[int](value=1)
+    )
+    password: Optional[Union[Global[str], Variable, Default[None]]] = None
+    send_label: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="sendLabel", validation_alias="sendLabel", default=Default[bool](value=False)
+    )
+    as_override: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="asOverride", validation_alias="asOverride", default=Default[bool](value=False)
+    )
+    as_number: Optional[Union[Global[int], Variable, Default[None]]] = Field(
+        serialization_alias="asNumber", validation_alias="asNumber", default=None
+    )
+    address_family: Optional[BgpAddressFamily] = Field(
+        serialization_alias="addressFamily", validation_alias="addressFamily"
+    )
+
+
+class BgpIPv6Neighbor(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    address: Union[Global[str], Variable]
+    description: Optional[Union[Global[str], Variable, Default[None]]] = None
+    shutdown: Optional[Union[Global[bool], Variable, Default[bool]]] = Default[bool](value=False)
+    remote_as: Union[Global[int], Variable] = Field(serialization_alias="remoteAs", validation_alias="remoteAs")
+    local_as: Optional[Union[Global[int], Variable]] = Field(
+        serialization_alias="localAs", validation_alias="localAs", default=None
+    )
+    keepalive: Optional[Union[Global[int], Variable, Default[int]]] = Default[int](value=60)
+    holdtime: Optional[Union[Global[int], Variable, Default[int]]] = Default[int](value=180)
+    interface_name: Optional[Union[Global[str], Variable, Default[None]]] = Field(
+        serialization_alias="ifName", validation_alias="ifName", default=None
+    )
+    next_hop_self: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="nextHopSelf", validation_alias="nextHopSelf", default=Default[bool](value=False)
+    )
+    send_community: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="sendCommunity", validation_alias="sendCommunity", default=Default[bool](value=True)
+    )
+    send_ext_community: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="sendExtCommunity", validation_alias="sendExtCommunity", default=Default[bool](value=True)
+    )
+    ebgp_multihop: Optional[Union[Global[int], Variable, Default[int]]] = Field(
+        serialization_alias="ebgpMultihop", validation_alias="ebgpMultihop", default=Default[int](value=1)
+    )
+    password: Optional[Union[Global[str], Variable, Default[None]]] = None
+    send_label: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="sendLabel", validation_alias="sendLabel", default=Default[bool](value=False)
+    )
+    as_override: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="asOverride", validation_alias="asOverride", default=Default[bool](value=False)
+    )
+    as_number: Optional[Union[Global[int], Variable, Default[None]]] = Field(
+        serialization_alias="asNumber", validation_alias="asNumber", default=None
+    )
+    address_family: Optional[BgpAddressFamily] = Field(
+        serialization_alias="addressFamily", validation_alias="addressFamily"
+    )
+
+
+class BgpData(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    as_num: Union[Global[int], Variable] = Field(serialization_alias="asNum", validation_alias="asNum")
+    router_id: Optional[Union[Global[str], Variable, Default[None]]] = Field(
+        serialization_alias="routerId", validation_alias="routerId", default=None
+    )
+    propagate_aspath: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="propagateAspath", validation_alias="propagateAspath", default=Default[bool](value=False)
+    )
+    propagate_community: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="propagateCommunity",
+        validation_alias="propagateCommunity",
+        default=Default[bool](value=False),
+    )
+    external: Optional[Union[Global[int], Variable, Default[int]]] = Default[int](value=20)
+    internal: Optional[Union[Global[int], Variable, Default[int]]] = Default[int](value=200)
+    local: Optional[Union[Global[int], Variable, Default[int]]] = Default[int](value=20)
+    keepalive: Optional[Union[Global[int], Variable, Default[int]]] = Default[int](value=60)
+    holdtime: Optional[Union[Global[int], Variable, Default[int]]] = Default[int](value=180)
+    always_compare: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="alwaysCompare", validation_alias="alwaysCompare", default=Default[bool](value=False)
+    )
+    deterministic: Optional[Union[Global[bool], Variable, Default[bool]]] = Default[bool](value=False)
+    missing_as_worst: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="missingAsWorst", validation_alias="missingAsWorst", default=Default[bool](value=False)
+    )
+    compare_router_id: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="compareRouterId", validation_alias="compareRouterId", default=Default[bool](value=False)
+    )
+    multipath_relax: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        serialization_alias="multipathRelax", validation_alias="multipathRelax", default=Default[bool](value=False)
+    )
+    neighbor: Optional[List[BgpIPv4Neighbor]] = None
+    ipv6_neighbor: Optional[List[BgpIPv6Neighbor]] = Field(
+        serialization_alias="ipv6Neighbor", validation_alias="ipv6Neighbor", default=None
+    )
+    address_family: Optional[AddressFamilyIPv4] = Field(
+        serialization_alias="addressFamily", validation_alias="addressFamily", default=None
+    )
+    ipv6_address_family: Optional[AddressFamilyIPv6] = Field(
+        serialization_alias="ipv6AddressFamily", validation_alias="ipv6AddressFamily", default=None
+    )
+
+
+class BgpCreationPayload(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    name: str
+    description: Optional[str] = None
+    data: BgpData
+    metadata: Optional[dict] = None