published on Monday, Jun 15, 2026 by checkpointsw
published on Monday, Jun 15, 2026 by checkpointsw
This resource allows you to execute Check Point Bgp Confederation Peer.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as checkpoint from "@pulumi/checkpoint";
// Step 1: configure BGP confederation and routing-domain identifiers
const bgpSetup = new checkpoint.GaiaCommandSetBgp("bgp_setup", {
confederation: {
identifier: "65000",
},
routingDomain: {
identifier: "1234.4321",
},
});
// Step 2: enable the confederation peer group (enabled = true is required)
const confGroup = new checkpoint.GaiaCommandSetBgpConfederation("conf_group", {
memberAs: "1234.4321",
enabled: true,
}, {
dependsOn: [bgpSetup],
});
// Step 3: add the confederation peer
const example = new checkpoint.GaiaBgpConfederationPeer("example", {
peer: "10.0.0.1",
memberAs: "1234.4321",
}, {
dependsOn: [confGroup],
});
import pulumi
import pulumi_checkpoint as checkpoint
# Step 1: configure BGP confederation and routing-domain identifiers
bgp_setup = checkpoint.GaiaCommandSetBgp("bgp_setup",
confederation={
"identifier": "65000",
},
routing_domain={
"identifier": "1234.4321",
})
# Step 2: enable the confederation peer group (enabled = true is required)
conf_group = checkpoint.GaiaCommandSetBgpConfederation("conf_group",
member_as="1234.4321",
enabled=True,
opts = pulumi.ResourceOptions(depends_on=[bgp_setup]))
# Step 3: add the confederation peer
example = checkpoint.GaiaBgpConfederationPeer("example",
peer="10.0.0.1",
member_as="1234.4321",
opts = pulumi.ResourceOptions(depends_on=[conf_group]))
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/checkpoint/v3/checkpoint"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Step 1: configure BGP confederation and routing-domain identifiers
bgpSetup, err := checkpoint.NewGaiaCommandSetBgp(ctx, "bgp_setup", &checkpoint.GaiaCommandSetBgpArgs{
Confederation: &checkpoint.GaiaCommandSetBgpConfederationTypeArgs{
Identifier: pulumi.String("65000"),
},
RoutingDomain: &checkpoint.GaiaCommandSetBgpRoutingDomainArgs{
Identifier: pulumi.String("1234.4321"),
},
})
if err != nil {
return err
}
// Step 2: enable the confederation peer group (enabled = true is required)
confGroup, err := checkpoint.NewGaiaCommandSetBgpConfederation(ctx, "conf_group", &checkpoint.GaiaCommandSetBgpConfederationArgs{
MemberAs: pulumi.String("1234.4321"),
Enabled: pulumi.Bool(true),
}, pulumi.DependsOn([]pulumi.Resource{
bgpSetup,
}))
if err != nil {
return err
}
// Step 3: add the confederation peer
_, err = checkpoint.NewGaiaBgpConfederationPeer(ctx, "example", &checkpoint.GaiaBgpConfederationPeerArgs{
Peer: pulumi.String("10.0.0.1"),
MemberAs: pulumi.String("1234.4321"),
}, pulumi.DependsOn([]pulumi.Resource{
confGroup,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkpoint = Pulumi.Checkpoint;
return await Deployment.RunAsync(() =>
{
// Step 1: configure BGP confederation and routing-domain identifiers
var bgpSetup = new Checkpoint.GaiaCommandSetBgp("bgp_setup", new()
{
Confederation = new Checkpoint.Inputs.GaiaCommandSetBgpConfederationArgs
{
Identifier = "65000",
},
RoutingDomain = new Checkpoint.Inputs.GaiaCommandSetBgpRoutingDomainArgs
{
Identifier = "1234.4321",
},
});
// Step 2: enable the confederation peer group (enabled = true is required)
var confGroup = new Checkpoint.GaiaCommandSetBgpConfederation("conf_group", new()
{
MemberAs = "1234.4321",
Enabled = true,
}, new CustomResourceOptions
{
DependsOn =
{
bgpSetup,
},
});
// Step 3: add the confederation peer
var example = new Checkpoint.GaiaBgpConfederationPeer("example", new()
{
Peer = "10.0.0.1",
MemberAs = "1234.4321",
}, new CustomResourceOptions
{
DependsOn =
{
confGroup,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.GaiaCommandSetBgp;
import com.pulumi.checkpoint.GaiaCommandSetBgpArgs;
import com.pulumi.checkpoint.inputs.GaiaCommandSetBgpRoutingDomainArgs;
import com.pulumi.checkpoint.GaiaCommandSetBgpConfederation;
import com.pulumi.checkpoint.GaiaBgpConfederationPeer;
import com.pulumi.checkpoint.GaiaBgpConfederationPeerArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Step 1: configure BGP confederation and routing-domain identifiers
var bgpSetup = new GaiaCommandSetBgp("bgpSetup", GaiaCommandSetBgpArgs.builder()
.confederation(GaiaCommandSetBgpConfederationArgs.builder()
.identifier("65000")
.build())
.routingDomain(GaiaCommandSetBgpRoutingDomainArgs.builder()
.identifier("1234.4321")
.build())
.build());
// Step 2: enable the confederation peer group (enabled = true is required)
var confGroup = new GaiaCommandSetBgpConfederation("confGroup", GaiaCommandSetBgpConfederationArgs.builder()
.memberAs("1234.4321")
.enabled(true)
.build(), CustomResourceOptions.builder()
.dependsOn(bgpSetup)
.build());
// Step 3: add the confederation peer
var example = new GaiaBgpConfederationPeer("example", GaiaBgpConfederationPeerArgs.builder()
.peer("10.0.0.1")
.memberAs("1234.4321")
.build(), CustomResourceOptions.builder()
.dependsOn(confGroup)
.build());
}
}
resources:
# Step 1: configure BGP confederation and routing-domain identifiers
bgpSetup:
type: checkpoint:GaiaCommandSetBgp
name: bgp_setup
properties:
confederation:
identifier: '65000'
routingDomain:
identifier: '1234.4321'
# Step 2: enable the confederation peer group (enabled = true is required)
confGroup:
type: checkpoint:GaiaCommandSetBgpConfederation
name: conf_group
properties:
memberAs: '1234.4321'
enabled: true
options:
dependsOn:
- ${bgpSetup}
# Step 3: add the confederation peer
example:
type: checkpoint:GaiaBgpConfederationPeer
properties:
peer: 10.0.0.1
memberAs: '1234.4321'
options:
dependsOn:
- ${confGroup}
Example coming soon!
Create GaiaBgpConfederationPeer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GaiaBgpConfederationPeer(name: string, args: GaiaBgpConfederationPeerArgs, opts?: CustomResourceOptions);@overload
def GaiaBgpConfederationPeer(resource_name: str,
args: GaiaBgpConfederationPeerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GaiaBgpConfederationPeer(resource_name: str,
opts: Optional[ResourceOptions] = None,
member_as: Optional[str] = None,
peer: Optional[str] = None,
enable_route_refresh: Optional[bool] = None,
enable_log_warnings: Optional[bool] = None,
debug: Optional[bool] = None,
enable_graceful_restart: Optional[bool] = None,
enable_ignore_first_ashop: Optional[bool] = None,
enable_log_state_transitions: Optional[bool] = None,
enable_send_keepalives: Optional[bool] = None,
enable_no_aggregator_id: Optional[bool] = None,
enable_passive_tcp: Optional[bool] = None,
enable_ping: Optional[bool] = None,
comment: Optional[str] = None,
accept_routes: Optional[str] = None,
local_address: Optional[str] = None,
graceful_restart_stalepath_time: Optional[float] = None,
holdtime: Optional[float] = None,
keepalive: Optional[float] = None,
gaia_bgp_confederation_peer_id: Optional[str] = None,
capability: Optional[str] = None,
outgoing_interface: Optional[str] = None,
authtype: Optional[GaiaBgpConfederationPeerAuthtypeArgs] = None,
peer_type: Optional[str] = None,
throttle_count: Optional[float] = None,
traces: Optional[Sequence[str]] = None,
weight: Optional[float] = None)func NewGaiaBgpConfederationPeer(ctx *Context, name string, args GaiaBgpConfederationPeerArgs, opts ...ResourceOption) (*GaiaBgpConfederationPeer, error)public GaiaBgpConfederationPeer(string name, GaiaBgpConfederationPeerArgs args, CustomResourceOptions? opts = null)
public GaiaBgpConfederationPeer(String name, GaiaBgpConfederationPeerArgs args)
public GaiaBgpConfederationPeer(String name, GaiaBgpConfederationPeerArgs args, CustomResourceOptions options)
type: checkpoint:GaiaBgpConfederationPeer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "checkpoint_gaiabgpconfederationpeer" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GaiaBgpConfederationPeerArgs
- 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 GaiaBgpConfederationPeerArgs
- 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 GaiaBgpConfederationPeerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GaiaBgpConfederationPeerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GaiaBgpConfederationPeerArgs
- 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 gaiaBgpConfederationPeerResource = new Checkpoint.GaiaBgpConfederationPeer("gaiaBgpConfederationPeerResource", new()
{
MemberAs = "string",
Peer = "string",
EnableRouteRefresh = false,
EnableLogWarnings = false,
Debug = false,
EnableGracefulRestart = false,
EnableIgnoreFirstAshop = false,
EnableLogStateTransitions = false,
EnableSendKeepalives = false,
EnableNoAggregatorId = false,
EnablePassiveTcp = false,
EnablePing = false,
Comment = "string",
AcceptRoutes = "string",
LocalAddress = "string",
GracefulRestartStalepathTime = 0,
Holdtime = 0,
Keepalive = 0,
GaiaBgpConfederationPeerId = "string",
Capability = "string",
OutgoingInterface = "string",
Authtype = new Checkpoint.Inputs.GaiaBgpConfederationPeerAuthtypeArgs
{
Secret = "string",
Type = "string",
},
PeerType = "string",
ThrottleCount = 0,
Traces = new[]
{
"string",
},
Weight = 0,
});
example, err := checkpoint.NewGaiaBgpConfederationPeer(ctx, "gaiaBgpConfederationPeerResource", &checkpoint.GaiaBgpConfederationPeerArgs{
MemberAs: pulumi.String("string"),
Peer: pulumi.String("string"),
EnableRouteRefresh: pulumi.Bool(false),
EnableLogWarnings: pulumi.Bool(false),
Debug: pulumi.Bool(false),
EnableGracefulRestart: pulumi.Bool(false),
EnableIgnoreFirstAshop: pulumi.Bool(false),
EnableLogStateTransitions: pulumi.Bool(false),
EnableSendKeepalives: pulumi.Bool(false),
EnableNoAggregatorId: pulumi.Bool(false),
EnablePassiveTcp: pulumi.Bool(false),
EnablePing: pulumi.Bool(false),
Comment: pulumi.String("string"),
AcceptRoutes: pulumi.String("string"),
LocalAddress: pulumi.String("string"),
GracefulRestartStalepathTime: pulumi.Float64(0),
Holdtime: pulumi.Float64(0),
Keepalive: pulumi.Float64(0),
GaiaBgpConfederationPeerId: pulumi.String("string"),
Capability: pulumi.String("string"),
OutgoingInterface: pulumi.String("string"),
Authtype: &checkpoint.GaiaBgpConfederationPeerAuthtypeArgs{
Secret: pulumi.String("string"),
Type: pulumi.String("string"),
},
PeerType: pulumi.String("string"),
ThrottleCount: pulumi.Float64(0),
Traces: pulumi.StringArray{
pulumi.String("string"),
},
Weight: pulumi.Float64(0),
})
resource "checkpoint_gaiabgpconfederationpeer" "gaiaBgpConfederationPeerResource" {
member_as = "string"
peer = "string"
enable_route_refresh = false
enable_log_warnings = false
debug = false
enable_graceful_restart = false
enable_ignore_first_ashop = false
enable_log_state_transitions = false
enable_send_keepalives = false
enable_no_aggregator_id = false
enable_passive_tcp = false
enable_ping = false
comment = "string"
accept_routes = "string"
local_address = "string"
graceful_restart_stalepath_time = 0
holdtime = 0
keepalive = 0
gaia_bgp_confederation_peer_id = "string"
capability = "string"
outgoing_interface = "string"
authtype = {
secret = "string"
type = "string"
}
peer_type = "string"
throttle_count = 0
traces = ["string"]
weight = 0
}
var gaiaBgpConfederationPeerResource = new GaiaBgpConfederationPeer("gaiaBgpConfederationPeerResource", GaiaBgpConfederationPeerArgs.builder()
.memberAs("string")
.peer("string")
.enableRouteRefresh(false)
.enableLogWarnings(false)
.debug(false)
.enableGracefulRestart(false)
.enableIgnoreFirstAshop(false)
.enableLogStateTransitions(false)
.enableSendKeepalives(false)
.enableNoAggregatorId(false)
.enablePassiveTcp(false)
.enablePing(false)
.comment("string")
.acceptRoutes("string")
.localAddress("string")
.gracefulRestartStalepathTime(0.0)
.holdtime(0.0)
.keepalive(0.0)
.gaiaBgpConfederationPeerId("string")
.capability("string")
.outgoingInterface("string")
.authtype(GaiaBgpConfederationPeerAuthtypeArgs.builder()
.secret("string")
.type("string")
.build())
.peerType("string")
.throttleCount(0.0)
.traces("string")
.weight(0.0)
.build());
gaia_bgp_confederation_peer_resource = checkpoint.GaiaBgpConfederationPeer("gaiaBgpConfederationPeerResource",
member_as="string",
peer="string",
enable_route_refresh=False,
enable_log_warnings=False,
debug=False,
enable_graceful_restart=False,
enable_ignore_first_ashop=False,
enable_log_state_transitions=False,
enable_send_keepalives=False,
enable_no_aggregator_id=False,
enable_passive_tcp=False,
enable_ping=False,
comment="string",
accept_routes="string",
local_address="string",
graceful_restart_stalepath_time=float(0),
holdtime=float(0),
keepalive=float(0),
gaia_bgp_confederation_peer_id="string",
capability="string",
outgoing_interface="string",
authtype={
"secret": "string",
"type": "string",
},
peer_type="string",
throttle_count=float(0),
traces=["string"],
weight=float(0))
const gaiaBgpConfederationPeerResource = new checkpoint.GaiaBgpConfederationPeer("gaiaBgpConfederationPeerResource", {
memberAs: "string",
peer: "string",
enableRouteRefresh: false,
enableLogWarnings: false,
debug: false,
enableGracefulRestart: false,
enableIgnoreFirstAshop: false,
enableLogStateTransitions: false,
enableSendKeepalives: false,
enableNoAggregatorId: false,
enablePassiveTcp: false,
enablePing: false,
comment: "string",
acceptRoutes: "string",
localAddress: "string",
gracefulRestartStalepathTime: 0,
holdtime: 0,
keepalive: 0,
gaiaBgpConfederationPeerId: "string",
capability: "string",
outgoingInterface: "string",
authtype: {
secret: "string",
type: "string",
},
peerType: "string",
throttleCount: 0,
traces: ["string"],
weight: 0,
});
type: checkpoint:GaiaBgpConfederationPeer
properties:
acceptRoutes: string
authtype:
secret: string
type: string
capability: string
comment: string
debug: false
enableGracefulRestart: false
enableIgnoreFirstAshop: false
enableLogStateTransitions: false
enableLogWarnings: false
enableNoAggregatorId: false
enablePassiveTcp: false
enablePing: false
enableRouteRefresh: false
enableSendKeepalives: false
gaiaBgpConfederationPeerId: string
gracefulRestartStalepathTime: 0
holdtime: 0
keepalive: 0
localAddress: string
memberAs: string
outgoingInterface: string
peer: string
peerType: string
throttleCount: 0
traces:
- string
weight: 0
GaiaBgpConfederationPeer 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 GaiaBgpConfederationPeer resource accepts the following input properties:
- Member
As string - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- Peer string
- IP address of the peer.
- Accept
Routes string - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- Authtype
Gaia
Bgp Confederation Peer Authtype - Configure authentication policy for this peer. authtype blocks are documented below.
- Capability string
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- Comment string
- Set the comment for this peer.
- Debug bool
- Enable debug logging for this resource.
- Enable
Graceful boolRestart - Configures Graceful Restart capability for the given BGP peer.
- Enable
Ignore boolFirst Ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- Enable
Log boolState Transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- Enable
Log boolWarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- Enable
No boolAggregator Id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- Enable
Passive boolTcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- Enable
Ping bool - Enable or disable ping for this peer.
- Enable
Route boolRefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- Enable
Send boolKeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- Gaia
Bgp stringConfederation Peer Id - Graceful
Restart doubleStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- Holdtime double
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- Keepalive double
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- Local
Address string - Configures the address to be used on the local end of the TCP connection.
- Outgoing
Interface string - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- Peer
Type string - Specifies if this is a route reflector client.
- Throttle
Count double - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- Traces List<string>
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- Weight double
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- Member
As string - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- Peer string
- IP address of the peer.
- Accept
Routes string - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- Authtype
Gaia
Bgp Confederation Peer Authtype Args - Configure authentication policy for this peer. authtype blocks are documented below.
- Capability string
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- Comment string
- Set the comment for this peer.
- Debug bool
- Enable debug logging for this resource.
- Enable
Graceful boolRestart - Configures Graceful Restart capability for the given BGP peer.
- Enable
Ignore boolFirst Ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- Enable
Log boolState Transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- Enable
Log boolWarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- Enable
No boolAggregator Id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- Enable
Passive boolTcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- Enable
Ping bool - Enable or disable ping for this peer.
- Enable
Route boolRefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- Enable
Send boolKeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- Gaia
Bgp stringConfederation Peer Id - Graceful
Restart float64Stalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- Holdtime float64
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- Keepalive float64
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- Local
Address string - Configures the address to be used on the local end of the TCP connection.
- Outgoing
Interface string - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- Peer
Type string - Specifies if this is a route reflector client.
- Throttle
Count float64 - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- Traces []string
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- Weight float64
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- member_
as string - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- peer string
- IP address of the peer.
- accept_
routes string - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- authtype object
- Configure authentication policy for this peer. authtype blocks are documented below.
- capability string
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- comment string
- Set the comment for this peer.
- debug bool
- Enable debug logging for this resource.
- enable_
graceful_ boolrestart - Configures Graceful Restart capability for the given BGP peer.
- enable_
ignore_ boolfirst_ ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- enable_
log_ boolstate_ transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- enable_
log_ boolwarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- enable_
no_ boolaggregator_ id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- enable_
passive_ booltcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- enable_
ping bool - Enable or disable ping for this peer.
- enable_
route_ boolrefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- enable_
send_ boolkeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- gaia_
bgp_ stringconfederation_ peer_ id - graceful_
restart_ numberstalepath_ time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime number
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- keepalive number
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- local_
address string - Configures the address to be used on the local end of the TCP connection.
- outgoing_
interface string - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- peer_
type string - Specifies if this is a route reflector client.
- throttle_
count number - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces list(string)
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- weight number
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- member
As String - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- peer String
- IP address of the peer.
- accept
Routes String - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- authtype
Gaia
Bgp Confederation Peer Authtype - Configure authentication policy for this peer. authtype blocks are documented below.
- capability String
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- comment String
- Set the comment for this peer.
- debug Boolean
- Enable debug logging for this resource.
- enable
Graceful BooleanRestart - Configures Graceful Restart capability for the given BGP peer.
- enable
Ignore BooleanFirst Ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- enable
Log BooleanState Transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- enable
Log BooleanWarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- enable
No BooleanAggregator Id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- enable
Passive BooleanTcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- enable
Ping Boolean - Enable or disable ping for this peer.
- enable
Route BooleanRefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- enable
Send BooleanKeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- gaia
Bgp StringConfederation Peer Id - graceful
Restart DoubleStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime Double
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- keepalive Double
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- local
Address String - Configures the address to be used on the local end of the TCP connection.
- outgoing
Interface String - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- peer
Type String - Specifies if this is a route reflector client.
- throttle
Count Double - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces List<String>
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- weight Double
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- member
As string - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- peer string
- IP address of the peer.
- accept
Routes string - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- authtype
Gaia
Bgp Confederation Peer Authtype - Configure authentication policy for this peer. authtype blocks are documented below.
- capability string
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- comment string
- Set the comment for this peer.
- debug boolean
- Enable debug logging for this resource.
- enable
Graceful booleanRestart - Configures Graceful Restart capability for the given BGP peer.
- enable
Ignore booleanFirst Ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- enable
Log booleanState Transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- enable
Log booleanWarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- enable
No booleanAggregator Id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- enable
Passive booleanTcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- enable
Ping boolean - Enable or disable ping for this peer.
- enable
Route booleanRefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- enable
Send booleanKeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- gaia
Bgp stringConfederation Peer Id - graceful
Restart numberStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime number
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- keepalive number
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- local
Address string - Configures the address to be used on the local end of the TCP connection.
- outgoing
Interface string - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- peer
Type string - Specifies if this is a route reflector client.
- throttle
Count number - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces string[]
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- weight number
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- member_
as str - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- peer str
- IP address of the peer.
- accept_
routes str - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- authtype
Gaia
Bgp Confederation Peer Authtype Args - Configure authentication policy for this peer. authtype blocks are documented below.
- capability str
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- comment str
- Set the comment for this peer.
- debug bool
- Enable debug logging for this resource.
- enable_
graceful_ boolrestart - Configures Graceful Restart capability for the given BGP peer.
- enable_
ignore_ boolfirst_ ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- enable_
log_ boolstate_ transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- enable_
log_ boolwarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- enable_
no_ boolaggregator_ id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- enable_
passive_ booltcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- enable_
ping bool - Enable or disable ping for this peer.
- enable_
route_ boolrefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- enable_
send_ boolkeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- gaia_
bgp_ strconfederation_ peer_ id - graceful_
restart_ floatstalepath_ time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime float
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- keepalive float
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- local_
address str - Configures the address to be used on the local end of the TCP connection.
- outgoing_
interface str - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- peer_
type str - Specifies if this is a route reflector client.
- throttle_
count float - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces Sequence[str]
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- weight float
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- member
As String - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- peer String
- IP address of the peer.
- accept
Routes String - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- authtype Property Map
- Configure authentication policy for this peer. authtype blocks are documented below.
- capability String
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- comment String
- Set the comment for this peer.
- debug Boolean
- Enable debug logging for this resource.
- enable
Graceful BooleanRestart - Configures Graceful Restart capability for the given BGP peer.
- enable
Ignore BooleanFirst Ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- enable
Log BooleanState Transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- enable
Log BooleanWarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- enable
No BooleanAggregator Id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- enable
Passive BooleanTcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- enable
Ping Boolean - Enable or disable ping for this peer.
- enable
Route BooleanRefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- enable
Send BooleanKeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- gaia
Bgp StringConfederation Peer Id - graceful
Restart NumberStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime Number
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- keepalive Number
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- local
Address String - Configures the address to be used on the local end of the TCP connection.
- outgoing
Interface String - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- peer
Type String - Specifies if this is a route reflector client.
- throttle
Count Number - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces List<String>
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- weight Number
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
Outputs
All input properties are implicitly available as output properties. Additionally, the GaiaBgpConfederationPeer 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 GaiaBgpConfederationPeer Resource
Get an existing GaiaBgpConfederationPeer 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?: GaiaBgpConfederationPeerState, opts?: CustomResourceOptions): GaiaBgpConfederationPeer@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
accept_routes: Optional[str] = None,
authtype: Optional[GaiaBgpConfederationPeerAuthtypeArgs] = None,
capability: Optional[str] = None,
comment: Optional[str] = None,
debug: Optional[bool] = None,
enable_graceful_restart: Optional[bool] = None,
enable_ignore_first_ashop: Optional[bool] = None,
enable_log_state_transitions: Optional[bool] = None,
enable_log_warnings: Optional[bool] = None,
enable_no_aggregator_id: Optional[bool] = None,
enable_passive_tcp: Optional[bool] = None,
enable_ping: Optional[bool] = None,
enable_route_refresh: Optional[bool] = None,
enable_send_keepalives: Optional[bool] = None,
gaia_bgp_confederation_peer_id: Optional[str] = None,
graceful_restart_stalepath_time: Optional[float] = None,
holdtime: Optional[float] = None,
keepalive: Optional[float] = None,
local_address: Optional[str] = None,
member_as: Optional[str] = None,
outgoing_interface: Optional[str] = None,
peer: Optional[str] = None,
peer_type: Optional[str] = None,
throttle_count: Optional[float] = None,
traces: Optional[Sequence[str]] = None,
weight: Optional[float] = None) -> GaiaBgpConfederationPeerfunc GetGaiaBgpConfederationPeer(ctx *Context, name string, id IDInput, state *GaiaBgpConfederationPeerState, opts ...ResourceOption) (*GaiaBgpConfederationPeer, error)public static GaiaBgpConfederationPeer Get(string name, Input<string> id, GaiaBgpConfederationPeerState? state, CustomResourceOptions? opts = null)public static GaiaBgpConfederationPeer get(String name, Output<String> id, GaiaBgpConfederationPeerState state, CustomResourceOptions options)resources: _: type: checkpoint:GaiaBgpConfederationPeer get: id: ${id}import {
to = checkpoint_gaiabgpconfederationpeer.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.
- Accept
Routes string - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- Authtype
Gaia
Bgp Confederation Peer Authtype - Configure authentication policy for this peer. authtype blocks are documented below.
- Capability string
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- Comment string
- Set the comment for this peer.
- Debug bool
- Enable debug logging for this resource.
- Enable
Graceful boolRestart - Configures Graceful Restart capability for the given BGP peer.
- Enable
Ignore boolFirst Ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- Enable
Log boolState Transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- Enable
Log boolWarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- Enable
No boolAggregator Id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- Enable
Passive boolTcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- Enable
Ping bool - Enable or disable ping for this peer.
- Enable
Route boolRefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- Enable
Send boolKeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- Gaia
Bgp stringConfederation Peer Id - Graceful
Restart doubleStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- Holdtime double
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- Keepalive double
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- Local
Address string - Configures the address to be used on the local end of the TCP connection.
- Member
As string - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- Outgoing
Interface string - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- Peer string
- IP address of the peer.
- Peer
Type string - Specifies if this is a route reflector client.
- Throttle
Count double - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- Traces List<string>
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- Weight double
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- Accept
Routes string - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- Authtype
Gaia
Bgp Confederation Peer Authtype Args - Configure authentication policy for this peer. authtype blocks are documented below.
- Capability string
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- Comment string
- Set the comment for this peer.
- Debug bool
- Enable debug logging for this resource.
- Enable
Graceful boolRestart - Configures Graceful Restart capability for the given BGP peer.
- Enable
Ignore boolFirst Ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- Enable
Log boolState Transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- Enable
Log boolWarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- Enable
No boolAggregator Id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- Enable
Passive boolTcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- Enable
Ping bool - Enable or disable ping for this peer.
- Enable
Route boolRefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- Enable
Send boolKeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- Gaia
Bgp stringConfederation Peer Id - Graceful
Restart float64Stalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- Holdtime float64
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- Keepalive float64
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- Local
Address string - Configures the address to be used on the local end of the TCP connection.
- Member
As string - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- Outgoing
Interface string - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- Peer string
- IP address of the peer.
- Peer
Type string - Specifies if this is a route reflector client.
- Throttle
Count float64 - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- Traces []string
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- Weight float64
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- accept_
routes string - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- authtype object
- Configure authentication policy for this peer. authtype blocks are documented below.
- capability string
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- comment string
- Set the comment for this peer.
- debug bool
- Enable debug logging for this resource.
- enable_
graceful_ boolrestart - Configures Graceful Restart capability for the given BGP peer.
- enable_
ignore_ boolfirst_ ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- enable_
log_ boolstate_ transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- enable_
log_ boolwarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- enable_
no_ boolaggregator_ id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- enable_
passive_ booltcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- enable_
ping bool - Enable or disable ping for this peer.
- enable_
route_ boolrefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- enable_
send_ boolkeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- gaia_
bgp_ stringconfederation_ peer_ id - graceful_
restart_ numberstalepath_ time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime number
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- keepalive number
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- local_
address string - Configures the address to be used on the local end of the TCP connection.
- member_
as string - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- outgoing_
interface string - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- peer string
- IP address of the peer.
- peer_
type string - Specifies if this is a route reflector client.
- throttle_
count number - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces list(string)
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- weight number
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- accept
Routes String - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- authtype
Gaia
Bgp Confederation Peer Authtype - Configure authentication policy for this peer. authtype blocks are documented below.
- capability String
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- comment String
- Set the comment for this peer.
- debug Boolean
- Enable debug logging for this resource.
- enable
Graceful BooleanRestart - Configures Graceful Restart capability for the given BGP peer.
- enable
Ignore BooleanFirst Ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- enable
Log BooleanState Transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- enable
Log BooleanWarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- enable
No BooleanAggregator Id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- enable
Passive BooleanTcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- enable
Ping Boolean - Enable or disable ping for this peer.
- enable
Route BooleanRefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- enable
Send BooleanKeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- gaia
Bgp StringConfederation Peer Id - graceful
Restart DoubleStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime Double
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- keepalive Double
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- local
Address String - Configures the address to be used on the local end of the TCP connection.
- member
As String - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- outgoing
Interface String - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- peer String
- IP address of the peer.
- peer
Type String - Specifies if this is a route reflector client.
- throttle
Count Double - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces List<String>
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- weight Double
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- accept
Routes string - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- authtype
Gaia
Bgp Confederation Peer Authtype - Configure authentication policy for this peer. authtype blocks are documented below.
- capability string
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- comment string
- Set the comment for this peer.
- debug boolean
- Enable debug logging for this resource.
- enable
Graceful booleanRestart - Configures Graceful Restart capability for the given BGP peer.
- enable
Ignore booleanFirst Ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- enable
Log booleanState Transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- enable
Log booleanWarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- enable
No booleanAggregator Id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- enable
Passive booleanTcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- enable
Ping boolean - Enable or disable ping for this peer.
- enable
Route booleanRefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- enable
Send booleanKeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- gaia
Bgp stringConfederation Peer Id - graceful
Restart numberStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime number
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- keepalive number
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- local
Address string - Configures the address to be used on the local end of the TCP connection.
- member
As string - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- outgoing
Interface string - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- peer string
- IP address of the peer.
- peer
Type string - Specifies if this is a route reflector client.
- throttle
Count number - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces string[]
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- weight number
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- accept_
routes str - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- authtype
Gaia
Bgp Confederation Peer Authtype Args - Configure authentication policy for this peer. authtype blocks are documented below.
- capability str
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- comment str
- Set the comment for this peer.
- debug bool
- Enable debug logging for this resource.
- enable_
graceful_ boolrestart - Configures Graceful Restart capability for the given BGP peer.
- enable_
ignore_ boolfirst_ ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- enable_
log_ boolstate_ transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- enable_
log_ boolwarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- enable_
no_ boolaggregator_ id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- enable_
passive_ booltcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- enable_
ping bool - Enable or disable ping for this peer.
- enable_
route_ boolrefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- enable_
send_ boolkeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- gaia_
bgp_ strconfederation_ peer_ id - graceful_
restart_ floatstalepath_ time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime float
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- keepalive float
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- local_
address str - Configures the address to be used on the local end of the TCP connection.
- member_
as str - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- outgoing_
interface str - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- peer str
- IP address of the peer.
- peer_
type str - Specifies if this is a route reflector client.
- throttle_
count float - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces Sequence[str]
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- weight float
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- accept
Routes String - Whether or not to receive routes from the peer in the absence of an inbound route filter.
- authtype Property Map
- Configure authentication policy for this peer. authtype blocks are documented below.
- capability String
- Configure the IP capabilities supported for this session. By default, IPv4 unicast is enabled and IPv6 unicast is disabled
- comment String
- Set the comment for this peer.
- debug Boolean
- Enable debug logging for this resource.
- enable
Graceful BooleanRestart - Configures Graceful Restart capability for the given BGP peer.
- enable
Ignore BooleanFirst Ashop - Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.
- enable
Log BooleanState Transitions - Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.
- enable
Log BooleanWarnings - Directs the router to log a message whenever a warning is encountered in the code path.
- enable
No BooleanAggregator Id - Directs this router to specify the Router ID in the aggregator attribute as zero, rather than the actual Router ID. This prevents different routers in an AS from creating aggregate routes with different AS paths.
- enable
Passive BooleanTcp - Forces the router to wait for this peer to initiate the BGP session. By default, periodic messages are sent to all configured peers until a session is established. Modifying this option resets the peer connection.
- enable
Ping Boolean - Enable or disable ping for this peer.
- enable
Route BooleanRefresh - Enables or disables route refresh for this peer. Route Refresh is used to either re-learn routes from the peer, or to refresh the routing table of the peer without tearing down the BGP session. Both peers must support this capability.
- enable
Send BooleanKeepalives - Specifies that the router always send keepalives, even when an update would substitute.
- gaia
Bgp StringConfederation Peer Id - graceful
Restart NumberStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime Number
- Specifies the holdtime (seconds) to use when negotiating the connection with this peer. The default value is 180s. The holdtime must always be three times the keepalive time. Setting holdtime will automatically set keepalive time to appropriate value
- keepalive Number
- This is an alternative way to specify the holdtime (seconds) when negotiating a peering session. The keepalive interval is one-third the holdtime; both values can be configured, as long as the ratio is maintained. The keepalive must be either 0, i.e., no keepalives are sent, or at least 2. The default value is 60s.
- local
Address String - Configures the address to be used on the local end of the TCP connection.
- member
As String - Specify the Routing Domain identifier of the Confederation peer group to configure. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535
- outgoing
Interface String - Directs the router to use the interface specified to reach the group peer(s). This is required for IPv6 peers that are identified with a link-local address (an address belonging to the fe80::/64 subnet).
- peer String
- IP address of the peer.
- peer
Type String - Specifies if this is a route reflector client.
- throttle
Count Number - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces List<String>
- Configure tracing for BGP. Initially, the default values for global trace options are used. The valid values that can be used are: keepalive, open, packets, update, all, general, normal, policy, route, task, timer, and cluster. trace blocks are documented below.
- weight Number
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
Supporting Types
GaiaBgpConfederationPeerAuthtype, GaiaBgpConfederationPeerAuthtypeArgs
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