published on Monday, Jun 15, 2026 by checkpointsw
published on Monday, Jun 15, 2026 by checkpointsw
Create GaiaCommandSetBgp Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GaiaCommandSetBgp(name: string, args?: GaiaCommandSetBgpArgs, opts?: CustomResourceOptions);@overload
def GaiaCommandSetBgp(resource_name: str,
args: Optional[GaiaCommandSetBgpArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def GaiaCommandSetBgp(resource_name: str,
opts: Optional[ResourceOptions] = None,
as_: Optional[str] = None,
cluster_id: Optional[str] = None,
confederation: Optional[GaiaCommandSetBgpConfederationArgs] = None,
dampening: Optional[GaiaCommandSetBgpDampeningArgs] = None,
debug: Optional[bool] = None,
default_med: Optional[str] = None,
default_route_gateway: Optional[str] = None,
enable_communities: Optional[bool] = None,
enable_ecmp: Optional[bool] = None,
enable_synchronization: Optional[bool] = None,
gaia_command_set_bgp_id: Optional[str] = None,
graceful_restart: Optional[GaiaCommandSetBgpGracefulRestartArgs] = None,
ping: Optional[GaiaCommandSetBgpPingArgs] = None,
routing_domain: Optional[GaiaCommandSetBgpRoutingDomainArgs] = None)func NewGaiaCommandSetBgp(ctx *Context, name string, args *GaiaCommandSetBgpArgs, opts ...ResourceOption) (*GaiaCommandSetBgp, error)public GaiaCommandSetBgp(string name, GaiaCommandSetBgpArgs? args = null, CustomResourceOptions? opts = null)
public GaiaCommandSetBgp(String name, GaiaCommandSetBgpArgs args)
public GaiaCommandSetBgp(String name, GaiaCommandSetBgpArgs args, CustomResourceOptions options)
type: checkpoint:GaiaCommandSetBgp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "checkpoint_gaiacommandsetbgp" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GaiaCommandSetBgpArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GaiaCommandSetBgpArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GaiaCommandSetBgpArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GaiaCommandSetBgpArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GaiaCommandSetBgpArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var gaiaCommandSetBgpResource = new Checkpoint.GaiaCommandSetBgp("gaiaCommandSetBgpResource", new()
{
As = "string",
ClusterId = "string",
Confederation = new Checkpoint.Inputs.GaiaCommandSetBgpConfederationArgs
{
AspathLoopsPermitted = "string",
Identifier = "string",
},
Dampening = new Checkpoint.Inputs.GaiaCommandSetBgpDampeningArgs
{
Enabled = false,
KeepHistory = "string",
MaxFlap = "string",
ReachableDecay = "string",
ReuseBelow = "string",
SuppressAbove = "string",
UnreachableDecay = "string",
},
Debug = false,
DefaultMed = "string",
DefaultRouteGateway = "string",
EnableCommunities = false,
EnableEcmp = false,
EnableSynchronization = false,
GaiaCommandSetBgpId = "string",
GracefulRestart = new Checkpoint.Inputs.GaiaCommandSetBgpGracefulRestartArgs
{
RestartTime = "string",
SelectionDeferralTime = "string",
},
Ping = new Checkpoint.Inputs.GaiaCommandSetBgpPingArgs
{
Count = "string",
Interval = "string",
},
RoutingDomain = new Checkpoint.Inputs.GaiaCommandSetBgpRoutingDomainArgs
{
AspathLoopsPermitted = "string",
Identifier = "string",
},
});
example, err := checkpoint.NewGaiaCommandSetBgp(ctx, "gaiaCommandSetBgpResource", &checkpoint.GaiaCommandSetBgpArgs{
As: pulumi.String("string"),
ClusterId: pulumi.String("string"),
Confederation: &checkpoint.GaiaCommandSetBgpConfederationTypeArgs{
AspathLoopsPermitted: pulumi.String("string"),
Identifier: pulumi.String("string"),
},
Dampening: &checkpoint.GaiaCommandSetBgpDampeningArgs{
Enabled: pulumi.Bool(false),
KeepHistory: pulumi.String("string"),
MaxFlap: pulumi.String("string"),
ReachableDecay: pulumi.String("string"),
ReuseBelow: pulumi.String("string"),
SuppressAbove: pulumi.String("string"),
UnreachableDecay: pulumi.String("string"),
},
Debug: pulumi.Bool(false),
DefaultMed: pulumi.String("string"),
DefaultRouteGateway: pulumi.String("string"),
EnableCommunities: pulumi.Bool(false),
EnableEcmp: pulumi.Bool(false),
EnableSynchronization: pulumi.Bool(false),
GaiaCommandSetBgpId: pulumi.String("string"),
GracefulRestart: &checkpoint.GaiaCommandSetBgpGracefulRestartArgs{
RestartTime: pulumi.String("string"),
SelectionDeferralTime: pulumi.String("string"),
},
Ping: &checkpoint.GaiaCommandSetBgpPingArgs{
Count: pulumi.String("string"),
Interval: pulumi.String("string"),
},
RoutingDomain: &checkpoint.GaiaCommandSetBgpRoutingDomainArgs{
AspathLoopsPermitted: pulumi.String("string"),
Identifier: pulumi.String("string"),
},
})
resource "checkpoint_gaiacommandsetbgp" "gaiaCommandSetBgpResource" {
as = "string"
cluster_id = "string"
confederation = {
aspath_loops_permitted = "string"
identifier = "string"
}
dampening = {
enabled = false
keep_history = "string"
max_flap = "string"
reachable_decay = "string"
reuse_below = "string"
suppress_above = "string"
unreachable_decay = "string"
}
debug = false
default_med = "string"
default_route_gateway = "string"
enable_communities = false
enable_ecmp = false
enable_synchronization = false
gaia_command_set_bgp_id = "string"
graceful_restart = {
restart_time = "string"
selection_deferral_time = "string"
}
ping = {
count = "string"
interval = "string"
}
routing_domain = {
aspath_loops_permitted = "string"
identifier = "string"
}
}
var gaiaCommandSetBgpResource = new GaiaCommandSetBgp("gaiaCommandSetBgpResource", GaiaCommandSetBgpArgs.builder()
.as("string")
.clusterId("string")
.confederation(GaiaCommandSetBgpConfederationArgs.builder()
.aspathLoopsPermitted("string")
.identifier("string")
.build())
.dampening(GaiaCommandSetBgpDampeningArgs.builder()
.enabled(false)
.keepHistory("string")
.maxFlap("string")
.reachableDecay("string")
.reuseBelow("string")
.suppressAbove("string")
.unreachableDecay("string")
.build())
.debug(false)
.defaultMed("string")
.defaultRouteGateway("string")
.enableCommunities(false)
.enableEcmp(false)
.enableSynchronization(false)
.gaiaCommandSetBgpId("string")
.gracefulRestart(GaiaCommandSetBgpGracefulRestartArgs.builder()
.restartTime("string")
.selectionDeferralTime("string")
.build())
.ping(GaiaCommandSetBgpPingArgs.builder()
.count("string")
.interval("string")
.build())
.routingDomain(GaiaCommandSetBgpRoutingDomainArgs.builder()
.aspathLoopsPermitted("string")
.identifier("string")
.build())
.build());
gaia_command_set_bgp_resource = checkpoint.GaiaCommandSetBgp("gaiaCommandSetBgpResource",
as_="string",
cluster_id="string",
confederation={
"aspath_loops_permitted": "string",
"identifier": "string",
},
dampening={
"enabled": False,
"keep_history": "string",
"max_flap": "string",
"reachable_decay": "string",
"reuse_below": "string",
"suppress_above": "string",
"unreachable_decay": "string",
},
debug=False,
default_med="string",
default_route_gateway="string",
enable_communities=False,
enable_ecmp=False,
enable_synchronization=False,
gaia_command_set_bgp_id="string",
graceful_restart={
"restart_time": "string",
"selection_deferral_time": "string",
},
ping={
"count": "string",
"interval": "string",
},
routing_domain={
"aspath_loops_permitted": "string",
"identifier": "string",
})
const gaiaCommandSetBgpResource = new checkpoint.GaiaCommandSetBgp("gaiaCommandSetBgpResource", {
as: "string",
clusterId: "string",
confederation: {
aspathLoopsPermitted: "string",
identifier: "string",
},
dampening: {
enabled: false,
keepHistory: "string",
maxFlap: "string",
reachableDecay: "string",
reuseBelow: "string",
suppressAbove: "string",
unreachableDecay: "string",
},
debug: false,
defaultMed: "string",
defaultRouteGateway: "string",
enableCommunities: false,
enableEcmp: false,
enableSynchronization: false,
gaiaCommandSetBgpId: "string",
gracefulRestart: {
restartTime: "string",
selectionDeferralTime: "string",
},
ping: {
count: "string",
interval: "string",
},
routingDomain: {
aspathLoopsPermitted: "string",
identifier: "string",
},
});
type: checkpoint:GaiaCommandSetBgp
properties:
as: string
clusterId: string
confederation:
aspathLoopsPermitted: string
identifier: string
dampening:
enabled: false
keepHistory: string
maxFlap: string
reachableDecay: string
reuseBelow: string
suppressAbove: string
unreachableDecay: string
debug: false
defaultMed: string
defaultRouteGateway: string
enableCommunities: false
enableEcmp: false
enableSynchronization: false
gaiaCommandSetBgpId: string
gracefulRestart:
restartTime: string
selectionDeferralTime: string
ping:
count: string
interval: string
routingDomain:
aspathLoopsPermitted: string
identifier: string
GaiaCommandSetBgp Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GaiaCommandSetBgp resource accepts the following input properties:
- As string
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- Cluster
Id string - Specifies the cluster-id used for route reflection.
- Confederation
Gaia
Command Set Bgp Confederation - Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- Dampening
Gaia
Command Set Bgp Dampening - Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- Debug bool
- Enable debugging for this resource only.
- Default
Med string - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- Default
Route stringGateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- Enable
Communities bool - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- Enable
Ecmp bool - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- Enable
Synchronization bool - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- Gaia
Command stringSet Bgp Id - Graceful
Restart GaiaCommand Set Bgp Graceful Restart - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- Ping
Gaia
Command Set Bgp Ping - Configures global settings for BGP ping. ping blocks are documented below.
- Routing
Domain GaiaCommand Set Bgp Routing Domain - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
- As string
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- Cluster
Id string - Specifies the cluster-id used for route reflection.
- Confederation
Gaia
Command Set Bgp Confederation Type Args - Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- Dampening
Gaia
Command Set Bgp Dampening Args - Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- Debug bool
- Enable debugging for this resource only.
- Default
Med string - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- Default
Route stringGateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- Enable
Communities bool - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- Enable
Ecmp bool - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- Enable
Synchronization bool - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- Gaia
Command stringSet Bgp Id - Graceful
Restart GaiaCommand Set Bgp Graceful Restart Args - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- Ping
Gaia
Command Set Bgp Ping Args - Configures global settings for BGP ping. ping blocks are documented below.
- Routing
Domain GaiaCommand Set Bgp Routing Domain Args - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
- as string
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- cluster_
id string - Specifies the cluster-id used for route reflection.
- confederation object
- Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- dampening object
- Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- debug bool
- Enable debugging for this resource only.
- default_
med string - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- default_
route_ stringgateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- enable_
communities bool - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- enable_
ecmp bool - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- enable_
synchronization bool - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- gaia_
command_ stringset_ bgp_ id - graceful_
restart object - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- ping object
- Configures global settings for BGP ping. ping blocks are documented below.
- routing_
domain object - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
- as String
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- cluster
Id String - Specifies the cluster-id used for route reflection.
- confederation
Gaia
Command Set Bgp Confederation - Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- dampening
Gaia
Command Set Bgp Dampening - Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- debug Boolean
- Enable debugging for this resource only.
- default
Med String - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- default
Route StringGateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- enable
Communities Boolean - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- enable
Ecmp Boolean - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- enable
Synchronization Boolean - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- gaia
Command StringSet Bgp Id - graceful
Restart GaiaCommand Set Bgp Graceful Restart - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- ping
Gaia
Command Set Bgp Ping - Configures global settings for BGP ping. ping blocks are documented below.
- routing
Domain GaiaCommand Set Bgp Routing Domain - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
- as string
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- cluster
Id string - Specifies the cluster-id used for route reflection.
- confederation
Gaia
Command Set Bgp Confederation - Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- dampening
Gaia
Command Set Bgp Dampening - Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- debug boolean
- Enable debugging for this resource only.
- default
Med string - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- default
Route stringGateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- enable
Communities boolean - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- enable
Ecmp boolean - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- enable
Synchronization boolean - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- gaia
Command stringSet Bgp Id - graceful
Restart GaiaCommand Set Bgp Graceful Restart - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- ping
Gaia
Command Set Bgp Ping - Configures global settings for BGP ping. ping blocks are documented below.
- routing
Domain GaiaCommand Set Bgp Routing Domain - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
- as_ str
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- cluster_
id str - Specifies the cluster-id used for route reflection.
- confederation
Gaia
Command Set Bgp Confederation Args - Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- dampening
Gaia
Command Set Bgp Dampening Args - Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- debug bool
- Enable debugging for this resource only.
- default_
med str - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- default_
route_ strgateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- enable_
communities bool - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- enable_
ecmp bool - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- enable_
synchronization bool - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- gaia_
command_ strset_ bgp_ id - graceful_
restart GaiaCommand Set Bgp Graceful Restart Args - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- ping
Gaia
Command Set Bgp Ping Args - Configures global settings for BGP ping. ping blocks are documented below.
- routing_
domain GaiaCommand Set Bgp Routing Domain Args - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
- as String
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- cluster
Id String - Specifies the cluster-id used for route reflection.
- confederation Property Map
- Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- dampening Property Map
- Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- debug Boolean
- Enable debugging for this resource only.
- default
Med String - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- default
Route StringGateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- enable
Communities Boolean - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- enable
Ecmp Boolean - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- enable
Synchronization Boolean - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- gaia
Command StringSet Bgp Id - graceful
Restart Property Map - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- ping Property Map
- Configures global settings for BGP ping. ping blocks are documented below.
- routing
Domain Property Map - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the GaiaCommandSetBgp resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing GaiaCommandSetBgp Resource
Get an existing GaiaCommandSetBgp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GaiaCommandSetBgpState, opts?: CustomResourceOptions): GaiaCommandSetBgp@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
as_: Optional[str] = None,
cluster_id: Optional[str] = None,
confederation: Optional[GaiaCommandSetBgpConfederationArgs] = None,
dampening: Optional[GaiaCommandSetBgpDampeningArgs] = None,
debug: Optional[bool] = None,
default_med: Optional[str] = None,
default_route_gateway: Optional[str] = None,
enable_communities: Optional[bool] = None,
enable_ecmp: Optional[bool] = None,
enable_synchronization: Optional[bool] = None,
gaia_command_set_bgp_id: Optional[str] = None,
graceful_restart: Optional[GaiaCommandSetBgpGracefulRestartArgs] = None,
ping: Optional[GaiaCommandSetBgpPingArgs] = None,
routing_domain: Optional[GaiaCommandSetBgpRoutingDomainArgs] = None) -> GaiaCommandSetBgpfunc GetGaiaCommandSetBgp(ctx *Context, name string, id IDInput, state *GaiaCommandSetBgpState, opts ...ResourceOption) (*GaiaCommandSetBgp, error)public static GaiaCommandSetBgp Get(string name, Input<string> id, GaiaCommandSetBgpState? state, CustomResourceOptions? opts = null)public static GaiaCommandSetBgp get(String name, Output<String> id, GaiaCommandSetBgpState state, CustomResourceOptions options)resources: _: type: checkpoint:GaiaCommandSetBgp get: id: ${id}import {
to = checkpoint_gaiacommandsetbgp.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- As string
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- Cluster
Id string - Specifies the cluster-id used for route reflection.
- Confederation
Gaia
Command Set Bgp Confederation - Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- Dampening
Gaia
Command Set Bgp Dampening - Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- Debug bool
- Enable debugging for this resource only.
- Default
Med string - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- Default
Route stringGateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- Enable
Communities bool - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- Enable
Ecmp bool - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- Enable
Synchronization bool - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- Gaia
Command stringSet Bgp Id - Graceful
Restart GaiaCommand Set Bgp Graceful Restart - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- Ping
Gaia
Command Set Bgp Ping - Configures global settings for BGP ping. ping blocks are documented below.
- Routing
Domain GaiaCommand Set Bgp Routing Domain - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
- As string
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- Cluster
Id string - Specifies the cluster-id used for route reflection.
- Confederation
Gaia
Command Set Bgp Confederation Type Args - Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- Dampening
Gaia
Command Set Bgp Dampening Args - Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- Debug bool
- Enable debugging for this resource only.
- Default
Med string - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- Default
Route stringGateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- Enable
Communities bool - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- Enable
Ecmp bool - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- Enable
Synchronization bool - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- Gaia
Command stringSet Bgp Id - Graceful
Restart GaiaCommand Set Bgp Graceful Restart Args - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- Ping
Gaia
Command Set Bgp Ping Args - Configures global settings for BGP ping. ping blocks are documented below.
- Routing
Domain GaiaCommand Set Bgp Routing Domain Args - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
- as string
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- cluster_
id string - Specifies the cluster-id used for route reflection.
- confederation object
- Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- dampening object
- Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- debug bool
- Enable debugging for this resource only.
- default_
med string - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- default_
route_ stringgateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- enable_
communities bool - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- enable_
ecmp bool - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- enable_
synchronization bool - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- gaia_
command_ stringset_ bgp_ id - graceful_
restart object - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- ping object
- Configures global settings for BGP ping. ping blocks are documented below.
- routing_
domain object - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
- as String
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- cluster
Id String - Specifies the cluster-id used for route reflection.
- confederation
Gaia
Command Set Bgp Confederation - Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- dampening
Gaia
Command Set Bgp Dampening - Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- debug Boolean
- Enable debugging for this resource only.
- default
Med String - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- default
Route StringGateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- enable
Communities Boolean - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- enable
Ecmp Boolean - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- enable
Synchronization Boolean - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- gaia
Command StringSet Bgp Id - graceful
Restart GaiaCommand Set Bgp Graceful Restart - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- ping
Gaia
Command Set Bgp Ping - Configures global settings for BGP ping. ping blocks are documented below.
- routing
Domain GaiaCommand Set Bgp Routing Domain - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
- as string
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- cluster
Id string - Specifies the cluster-id used for route reflection.
- confederation
Gaia
Command Set Bgp Confederation - Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- dampening
Gaia
Command Set Bgp Dampening - Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- debug boolean
- Enable debugging for this resource only.
- default
Med string - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- default
Route stringGateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- enable
Communities boolean - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- enable
Ecmp boolean - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- enable
Synchronization boolean - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- gaia
Command stringSet Bgp Id - graceful
Restart GaiaCommand Set Bgp Graceful Restart - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- ping
Gaia
Command Set Bgp Ping - Configures global settings for BGP ping. ping blocks are documented below.
- routing
Domain GaiaCommand Set Bgp Routing Domain - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
- as_ str
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- cluster_
id str - Specifies the cluster-id used for route reflection.
- confederation
Gaia
Command Set Bgp Confederation Args - Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- dampening
Gaia
Command Set Bgp Dampening Args - Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- debug bool
- Enable debugging for this resource only.
- default_
med str - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- default_
route_ strgateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- enable_
communities bool - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- enable_
ecmp bool - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- enable_
synchronization bool - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- gaia_
command_ strset_ bgp_ id - graceful_
restart GaiaCommand Set Bgp Graceful Restart Args - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- ping
Gaia
Command Set Bgp Ping Args - Configures global settings for BGP ping. ping blocks are documented below.
- routing_
domain GaiaCommand Set Bgp Routing Domain Args - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
- as String
- Autonomous System Number The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535 WARNING: Removing the AS number will result in all BGP configurations and any associated route-redistribution or inbound-route-filter configurations being removed.
- cluster
Id String - Specifies the cluster-id used for route reflection.
- confederation Property Map
- Configure BGP Confederation parameters. A BGP Confederation is a single large AS that is divided into sub-AS's called Routing Domains. The Routing Domains are only visible within the Confederation; to the outside world, the entire Confederation appears as one AS. Confederations improve BGP performance for large AS's by reducing IBGP mesh size. IBGP is used within each Routing Domain, but between them, a modified form of eBGP is used which preserves route metrics and other BGP attributes. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. confederation blocks are documented below.
- dampening Property Map
- Weighted-route dampening minimizes the propagation of flapping routes across an internetwork. dampening blocks are documented below.
- debug Boolean
- Enable debugging for this resource only.
- default
Med String - Defines the Multi-Exit Discriminator metric (MED) used when advertising routes through BGP. If no value is specified, no metric is propagated. Any metrics configured in peer, Route Map, or route redistribution configurations will override the value configured here.
- default
Route StringGateway - A default route is generated if any BGP peer is up. This route has a higher rank than the default configured through static route configuration. If a specific BGP peer should not be considered for generating the default route, it should be explicitly suppressed via the peer-specific 'suppress-default-originate' configuration.
- enable
Communities Boolean - This option controls whether or not community information is included in BGP advertisements. This option must be enabled in order to configure the routing policy to filter incoming or outgoing advertisements based on community information.
- enable
Ecmp Boolean - Enables or disables ECMP (Equal-Cost Multi-Path) routing for IPv4 BGP routes.
- enable
Synchronization Boolean - Enabling this option directs Internal BGP (IBGP) peers to check for a matching route from IGP protocols before installing a route.
- gaia
Command StringSet Bgp Id - graceful
Restart Property Map - Configures global settings for BGP Graceful Restart. graceful_restart blocks are documented below.
- ping Property Map
- Configures global settings for BGP ping. ping blocks are documented below.
- routing
Domain Property Map - Configure Routing Domain parameters. In Confederation mode, the Routing Domain is the Confederation sub-AS. It acts as an independent AS within the Confederation, but is not visible outside the Confederation. The Routing Domain identifier (RDI) is the equivalent of its AS number. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. routing_domain blocks are documented below.
Supporting Types
GaiaCommandSetBgpConfederation, GaiaCommandSetBgpConfederationArgs
- Aspath
Loops stringPermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- Identifier string
- Specifies the identifier for the entire Confederation. The Confederation identifier is used as the AS number in external BGP sessions, so it must be a globally unique, normally assigned AS number. Both the Confederation identifer and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
- Aspath
Loops stringPermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- Identifier string
- Specifies the identifier for the entire Confederation. The Confederation identifier is used as the AS number in external BGP sessions, so it must be a globally unique, normally assigned AS number. Both the Confederation identifer and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
- aspath_
loops_ stringpermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- identifier string
- Specifies the identifier for the entire Confederation. The Confederation identifier is used as the AS number in external BGP sessions, so it must be a globally unique, normally assigned AS number. Both the Confederation identifer and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
- aspath
Loops StringPermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- identifier String
- Specifies the identifier for the entire Confederation. The Confederation identifier is used as the AS number in external BGP sessions, so it must be a globally unique, normally assigned AS number. Both the Confederation identifer and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
- aspath
Loops stringPermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- identifier string
- Specifies the identifier for the entire Confederation. The Confederation identifier is used as the AS number in external BGP sessions, so it must be a globally unique, normally assigned AS number. Both the Confederation identifer and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
- aspath_
loops_ strpermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- identifier str
- Specifies the identifier for the entire Confederation. The Confederation identifier is used as the AS number in external BGP sessions, so it must be a globally unique, normally assigned AS number. Both the Confederation identifer and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
- aspath
Loops StringPermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- identifier String
- Specifies the identifier for the entire Confederation. The Confederation identifier is used as the AS number in external BGP sessions, so it must be a globally unique, normally assigned AS number. Both the Confederation identifer and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
GaiaCommandSetBgpDampening, GaiaCommandSetBgpDampeningArgs
- Enabled bool
- Enable/disable weighted-route dampening.
- Keep
History string - Specifies the period over which route flapping history for a given route is maintained. The default value is 1800.
- Max
Flap string - Specifies the upper limit of the instability accepted. The value must be higher than one plus the suppress-above value. The default value is 16.
- Reachable
Decay string - Specifies the length of time (seconds) it takes for the instability metric to reach one half of its current value when the route is reachable. The default value is 300.
- Reuse
Below string - Specifies the value of the instability metric at which a suppressed but reachable route becomes unsuppressed. The value must be less than the suppress-above value. The default value is 2.
- Suppress
Above string - Specifies the value of the instability metric at which a route is suppressed. While suppressed, the route is neither installed, nor advertised as reachable. The default value is 3.
- Unreachable
Decay string - Specifies the rate at which the instability metric is decayed when a route is unreachable. This value must be equal to or greater than the reachable decay. The default value is 900.
- Enabled bool
- Enable/disable weighted-route dampening.
- Keep
History string - Specifies the period over which route flapping history for a given route is maintained. The default value is 1800.
- Max
Flap string - Specifies the upper limit of the instability accepted. The value must be higher than one plus the suppress-above value. The default value is 16.
- Reachable
Decay string - Specifies the length of time (seconds) it takes for the instability metric to reach one half of its current value when the route is reachable. The default value is 300.
- Reuse
Below string - Specifies the value of the instability metric at which a suppressed but reachable route becomes unsuppressed. The value must be less than the suppress-above value. The default value is 2.
- Suppress
Above string - Specifies the value of the instability metric at which a route is suppressed. While suppressed, the route is neither installed, nor advertised as reachable. The default value is 3.
- Unreachable
Decay string - Specifies the rate at which the instability metric is decayed when a route is unreachable. This value must be equal to or greater than the reachable decay. The default value is 900.
- enabled bool
- Enable/disable weighted-route dampening.
- keep_
history string - Specifies the period over which route flapping history for a given route is maintained. The default value is 1800.
- max_
flap string - Specifies the upper limit of the instability accepted. The value must be higher than one plus the suppress-above value. The default value is 16.
- reachable_
decay string - Specifies the length of time (seconds) it takes for the instability metric to reach one half of its current value when the route is reachable. The default value is 300.
- reuse_
below string - Specifies the value of the instability metric at which a suppressed but reachable route becomes unsuppressed. The value must be less than the suppress-above value. The default value is 2.
- suppress_
above string - Specifies the value of the instability metric at which a route is suppressed. While suppressed, the route is neither installed, nor advertised as reachable. The default value is 3.
- unreachable_
decay string - Specifies the rate at which the instability metric is decayed when a route is unreachable. This value must be equal to or greater than the reachable decay. The default value is 900.
- enabled Boolean
- Enable/disable weighted-route dampening.
- keep
History String - Specifies the period over which route flapping history for a given route is maintained. The default value is 1800.
- max
Flap String - Specifies the upper limit of the instability accepted. The value must be higher than one plus the suppress-above value. The default value is 16.
- reachable
Decay String - Specifies the length of time (seconds) it takes for the instability metric to reach one half of its current value when the route is reachable. The default value is 300.
- reuse
Below String - Specifies the value of the instability metric at which a suppressed but reachable route becomes unsuppressed. The value must be less than the suppress-above value. The default value is 2.
- suppress
Above String - Specifies the value of the instability metric at which a route is suppressed. While suppressed, the route is neither installed, nor advertised as reachable. The default value is 3.
- unreachable
Decay String - Specifies the rate at which the instability metric is decayed when a route is unreachable. This value must be equal to or greater than the reachable decay. The default value is 900.
- enabled boolean
- Enable/disable weighted-route dampening.
- keep
History string - Specifies the period over which route flapping history for a given route is maintained. The default value is 1800.
- max
Flap string - Specifies the upper limit of the instability accepted. The value must be higher than one plus the suppress-above value. The default value is 16.
- reachable
Decay string - Specifies the length of time (seconds) it takes for the instability metric to reach one half of its current value when the route is reachable. The default value is 300.
- reuse
Below string - Specifies the value of the instability metric at which a suppressed but reachable route becomes unsuppressed. The value must be less than the suppress-above value. The default value is 2.
- suppress
Above string - Specifies the value of the instability metric at which a route is suppressed. While suppressed, the route is neither installed, nor advertised as reachable. The default value is 3.
- unreachable
Decay string - Specifies the rate at which the instability metric is decayed when a route is unreachable. This value must be equal to or greater than the reachable decay. The default value is 900.
- enabled bool
- Enable/disable weighted-route dampening.
- keep_
history str - Specifies the period over which route flapping history for a given route is maintained. The default value is 1800.
- max_
flap str - Specifies the upper limit of the instability accepted. The value must be higher than one plus the suppress-above value. The default value is 16.
- reachable_
decay str - Specifies the length of time (seconds) it takes for the instability metric to reach one half of its current value when the route is reachable. The default value is 300.
- reuse_
below str - Specifies the value of the instability metric at which a suppressed but reachable route becomes unsuppressed. The value must be less than the suppress-above value. The default value is 2.
- suppress_
above str - Specifies the value of the instability metric at which a route is suppressed. While suppressed, the route is neither installed, nor advertised as reachable. The default value is 3.
- unreachable_
decay str - Specifies the rate at which the instability metric is decayed when a route is unreachable. This value must be equal to or greater than the reachable decay. The default value is 900.
- enabled Boolean
- Enable/disable weighted-route dampening.
- keep
History String - Specifies the period over which route flapping history for a given route is maintained. The default value is 1800.
- max
Flap String - Specifies the upper limit of the instability accepted. The value must be higher than one plus the suppress-above value. The default value is 16.
- reachable
Decay String - Specifies the length of time (seconds) it takes for the instability metric to reach one half of its current value when the route is reachable. The default value is 300.
- reuse
Below String - Specifies the value of the instability metric at which a suppressed but reachable route becomes unsuppressed. The value must be less than the suppress-above value. The default value is 2.
- suppress
Above String - Specifies the value of the instability metric at which a route is suppressed. While suppressed, the route is neither installed, nor advertised as reachable. The default value is 3.
- unreachable
Decay String - Specifies the rate at which the instability metric is decayed when a route is unreachable. This value must be equal to or greater than the reachable decay. The default value is 900.
GaiaCommandSetBgpGracefulRestart, GaiaCommandSetBgpGracefulRestartArgs
- Restart
Time string - Specifies the time (seconds) that BGP peers of this router should keep the routes advertised to them while this router restarts. The default value is 360.
- Selection
Deferral stringTime - Specifies the time (seconds) that this router will wait for the End-of-RIB notification from each of its BGP peers after a restart. The default value is 360.
- Restart
Time string - Specifies the time (seconds) that BGP peers of this router should keep the routes advertised to them while this router restarts. The default value is 360.
- Selection
Deferral stringTime - Specifies the time (seconds) that this router will wait for the End-of-RIB notification from each of its BGP peers after a restart. The default value is 360.
- restart_
time string - Specifies the time (seconds) that BGP peers of this router should keep the routes advertised to them while this router restarts. The default value is 360.
- selection_
deferral_ stringtime - Specifies the time (seconds) that this router will wait for the End-of-RIB notification from each of its BGP peers after a restart. The default value is 360.
- restart
Time String - Specifies the time (seconds) that BGP peers of this router should keep the routes advertised to them while this router restarts. The default value is 360.
- selection
Deferral StringTime - Specifies the time (seconds) that this router will wait for the End-of-RIB notification from each of its BGP peers after a restart. The default value is 360.
- restart
Time string - Specifies the time (seconds) that BGP peers of this router should keep the routes advertised to them while this router restarts. The default value is 360.
- selection
Deferral stringTime - Specifies the time (seconds) that this router will wait for the End-of-RIB notification from each of its BGP peers after a restart. The default value is 360.
- restart_
time str - Specifies the time (seconds) that BGP peers of this router should keep the routes advertised to them while this router restarts. The default value is 360.
- selection_
deferral_ strtime - Specifies the time (seconds) that this router will wait for the End-of-RIB notification from each of its BGP peers after a restart. The default value is 360.
- restart
Time String - Specifies the time (seconds) that BGP peers of this router should keep the routes advertised to them while this router restarts. The default value is 360.
- selection
Deferral StringTime - Specifies the time (seconds) that this router will wait for the End-of-RIB notification from each of its BGP peers after a restart. The default value is 360.
GaiaCommandSetBgpPing, GaiaCommandSetBgpPingArgs
GaiaCommandSetBgpRoutingDomain, GaiaCommandSetBgpRoutingDomainArgs
- Aspath
Loops stringPermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- Identifier string
- In Confederation mode, the Routing Domain identifier (RDI) identifies the Routing Domain, or Confederation sub-AS, to which this router belongs. The RDI is used as the AS number for peers within the Confederation, while the Confederation identifier is used outside the Confederation. The RDI does not have to be globally unique, since it is never used outside the Confederation. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
- Aspath
Loops stringPermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- Identifier string
- In Confederation mode, the Routing Domain identifier (RDI) identifies the Routing Domain, or Confederation sub-AS, to which this router belongs. The RDI is used as the AS number for peers within the Confederation, while the Confederation identifier is used outside the Confederation. The RDI does not have to be globally unique, since it is never used outside the Confederation. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
- aspath_
loops_ stringpermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- identifier string
- In Confederation mode, the Routing Domain identifier (RDI) identifies the Routing Domain, or Confederation sub-AS, to which this router belongs. The RDI is used as the AS number for peers within the Confederation, while the Confederation identifier is used outside the Confederation. The RDI does not have to be globally unique, since it is never used outside the Confederation. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
- aspath
Loops StringPermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- identifier String
- In Confederation mode, the Routing Domain identifier (RDI) identifies the Routing Domain, or Confederation sub-AS, to which this router belongs. The RDI is used as the AS number for peers within the Confederation, while the Confederation identifier is used outside the Confederation. The RDI does not have to be globally unique, since it is never used outside the Confederation. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
- aspath
Loops stringPermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- identifier string
- In Confederation mode, the Routing Domain identifier (RDI) identifies the Routing Domain, or Confederation sub-AS, to which this router belongs. The RDI is used as the AS number for peers within the Confederation, while the Confederation identifier is used outside the Confederation. The RDI does not have to be globally unique, since it is never used outside the Confederation. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
- aspath_
loops_ strpermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- identifier str
- In Confederation mode, the Routing Domain identifier (RDI) identifies the Routing Domain, or Confederation sub-AS, to which this router belongs. The RDI is used as the AS number for peers within the Confederation, while the Confederation identifier is used outside the Confederation. The RDI does not have to be globally unique, since it is never used outside the Confederation. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
- aspath
Loops StringPermitted - Specifies the number of times the Local AS can appear in an AS path for routes learned via BGP. Routes with numbers higher than the configured value are rejected. The default value is 1.
- identifier String
- In Confederation mode, the Routing Domain identifier (RDI) identifies the Routing Domain, or Confederation sub-AS, to which this router belongs. The RDI is used as the AS number for peers within the Confederation, while the Confederation identifier is used outside the Confederation. The RDI does not have to be globally unique, since it is never used outside the Confederation. Both the Confederation identifier and Routing Domain identifier must be configured before BGP can be configured on this router when Confederations are in use. An AS cannot be configured at the same time as the Confederation equivalents. The value can be one of the following: 'off' An integer from 1-4294967295 A float from 0.1-65535.65535
Package Details
- Repository
- checkpoint checkpointsw/terraform-provider-checkpoint
- License
- Notes
- This Pulumi package is based on the
checkpointTerraform Provider.
published on Monday, Jun 15, 2026 by checkpointsw