Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw
published on Monday, Jun 15, 2026 by checkpointsw
Viewing docs for checkpoint 3.2.0
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 Internal Peer.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as checkpoint from "@pulumi/checkpoint";
// Step 1: configure a BGP AS number
const bgpSetup = new checkpoint.GaiaCommandSetBgp("bgp_setup", {as: "65001"});
// Step 2: enable the internal peer group
const intGroup = new checkpoint.GaiaCommandSetBgpInternal("int_group", {enabled: true}, {
dependsOn: [bgpSetup],
});
// Step 3: add the internal peer
const example = new checkpoint.GaiaBgpInternalPeer("example", {peer: "10.1.1.12"}, {
dependsOn: [intGroup],
});
import pulumi
import pulumi_checkpoint as checkpoint
# Step 1: configure a BGP AS number
bgp_setup = checkpoint.GaiaCommandSetBgp("bgp_setup", as_="65001")
# Step 2: enable the internal peer group
int_group = checkpoint.GaiaCommandSetBgpInternal("int_group", enabled=True,
opts = pulumi.ResourceOptions(depends_on=[bgp_setup]))
# Step 3: add the internal peer
example = checkpoint.GaiaBgpInternalPeer("example", peer="10.1.1.12",
opts = pulumi.ResourceOptions(depends_on=[int_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 a BGP AS number
bgpSetup, err := checkpoint.NewGaiaCommandSetBgp(ctx, "bgp_setup", &checkpoint.GaiaCommandSetBgpArgs{
As: pulumi.String("65001"),
})
if err != nil {
return err
}
// Step 2: enable the internal peer group
intGroup, err := checkpoint.NewGaiaCommandSetBgpInternal(ctx, "int_group", &checkpoint.GaiaCommandSetBgpInternalArgs{
Enabled: pulumi.Bool(true),
}, pulumi.DependsOn([]pulumi.Resource{
bgpSetup,
}))
if err != nil {
return err
}
// Step 3: add the internal peer
_, err = checkpoint.NewGaiaBgpInternalPeer(ctx, "example", &checkpoint.GaiaBgpInternalPeerArgs{
Peer: pulumi.String("10.1.1.12"),
}, pulumi.DependsOn([]pulumi.Resource{
intGroup,
}))
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 a BGP AS number
var bgpSetup = new Checkpoint.GaiaCommandSetBgp("bgp_setup", new()
{
As = "65001",
});
// Step 2: enable the internal peer group
var intGroup = new Checkpoint.GaiaCommandSetBgpInternal("int_group", new()
{
Enabled = true,
}, new CustomResourceOptions
{
DependsOn =
{
bgpSetup,
},
});
// Step 3: add the internal peer
var example = new Checkpoint.GaiaBgpInternalPeer("example", new()
{
Peer = "10.1.1.12",
}, new CustomResourceOptions
{
DependsOn =
{
intGroup,
},
});
});
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.GaiaCommandSetBgpInternal;
import com.pulumi.checkpoint.GaiaCommandSetBgpInternalArgs;
import com.pulumi.checkpoint.GaiaBgpInternalPeer;
import com.pulumi.checkpoint.GaiaBgpInternalPeerArgs;
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 a BGP AS number
var bgpSetup = new GaiaCommandSetBgp("bgpSetup", GaiaCommandSetBgpArgs.builder()
.as("65001")
.build());
// Step 2: enable the internal peer group
var intGroup = new GaiaCommandSetBgpInternal("intGroup", GaiaCommandSetBgpInternalArgs.builder()
.enabled(true)
.build(), CustomResourceOptions.builder()
.dependsOn(bgpSetup)
.build());
// Step 3: add the internal peer
var example = new GaiaBgpInternalPeer("example", GaiaBgpInternalPeerArgs.builder()
.peer("10.1.1.12")
.build(), CustomResourceOptions.builder()
.dependsOn(intGroup)
.build());
}
}
resources:
# Step 1: configure a BGP AS number
bgpSetup:
type: checkpoint:GaiaCommandSetBgp
name: bgp_setup
properties:
as: '65001'
# Step 2: enable the internal peer group
intGroup:
type: checkpoint:GaiaCommandSetBgpInternal
name: int_group
properties:
enabled: true
options:
dependsOn:
- ${bgpSetup}
# Step 3: add the internal peer
example:
type: checkpoint:GaiaBgpInternalPeer
properties:
peer: 10.1.1.12
options:
dependsOn:
- ${intGroup}
Example coming soon!
Create GaiaBgpInternalPeer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GaiaBgpInternalPeer(name: string, args: GaiaBgpInternalPeerArgs, opts?: CustomResourceOptions);@overload
def GaiaBgpInternalPeer(resource_name: str,
args: GaiaBgpInternalPeerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GaiaBgpInternalPeer(resource_name: str,
opts: Optional[ResourceOptions] = None,
peer: Optional[str] = None,
enable_suppress_default_originate: Optional[bool] = None,
peer_type: Optional[str] = None,
comment: Optional[str] = None,
debug: Optional[bool] = None,
gaia_bgp_internal_peer_id: Optional[str] = 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,
capability: Optional[str] = None,
enable_send_keepalives: Optional[bool] = None,
enable_graceful_restart: Optional[bool] = None,
graceful_restart_stalepath_time: Optional[str] = None,
holdtime: Optional[str] = None,
import_routemap_lists: Optional[Sequence[GaiaBgpInternalPeerImportRoutemapListArgs]] = None,
ip_reachability: Optional[GaiaBgpInternalPeerIpReachabilityArgs] = None,
keepalive: Optional[str] = None,
local_address: Optional[str] = None,
outgoing_interface: Optional[str] = None,
authtype: Optional[GaiaBgpInternalPeerAuthtypeArgs] = None,
accept_routes: Optional[str] = None,
send_route_refresh: Optional[GaiaBgpInternalPeerSendRouteRefreshArgs] = None,
throttle_count: Optional[str] = None,
traces: Optional[Sequence[GaiaBgpInternalPeerTraceArgs]] = None,
weight: Optional[str] = None)func NewGaiaBgpInternalPeer(ctx *Context, name string, args GaiaBgpInternalPeerArgs, opts ...ResourceOption) (*GaiaBgpInternalPeer, error)public GaiaBgpInternalPeer(string name, GaiaBgpInternalPeerArgs args, CustomResourceOptions? opts = null)
public GaiaBgpInternalPeer(String name, GaiaBgpInternalPeerArgs args)
public GaiaBgpInternalPeer(String name, GaiaBgpInternalPeerArgs args, CustomResourceOptions options)
type: checkpoint:GaiaBgpInternalPeer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "checkpoint_gaiabgpinternalpeer" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GaiaBgpInternalPeerArgs
- 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 GaiaBgpInternalPeerArgs
- 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 GaiaBgpInternalPeerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GaiaBgpInternalPeerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GaiaBgpInternalPeerArgs
- 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 gaiaBgpInternalPeerResource = new Checkpoint.GaiaBgpInternalPeer("gaiaBgpInternalPeerResource", new()
{
Peer = "string",
EnableSuppressDefaultOriginate = false,
PeerType = "string",
Comment = "string",
Debug = false,
GaiaBgpInternalPeerId = "string",
EnableIgnoreFirstAshop = false,
EnableLogStateTransitions = false,
EnableLogWarnings = false,
EnableNoAggregatorId = false,
EnablePassiveTcp = false,
EnablePing = false,
EnableRouteRefresh = false,
Capability = "string",
EnableSendKeepalives = false,
EnableGracefulRestart = false,
GracefulRestartStalepathTime = "string",
Holdtime = "string",
ImportRoutemapLists = new[]
{
new Checkpoint.Inputs.GaiaBgpInternalPeerImportRoutemapListArgs
{
Family = "string",
Name = "string",
Preference = 0,
},
},
IpReachability = new Checkpoint.Inputs.GaiaBgpInternalPeerIpReachabilityArgs
{
CheckControlPlaneFailure = false,
LocalAddress = "string",
Type = "string",
},
Keepalive = "string",
LocalAddress = "string",
OutgoingInterface = "string",
Authtype = new Checkpoint.Inputs.GaiaBgpInternalPeerAuthtypeArgs
{
Secret = "string",
Type = "string",
},
AcceptRoutes = "string",
SendRouteRefresh = new Checkpoint.Inputs.GaiaBgpInternalPeerSendRouteRefreshArgs
{
Family = "string",
Type = "string",
},
ThrottleCount = "string",
Traces = new[]
{
null,
},
Weight = "string",
});
example, err := checkpoint.NewGaiaBgpInternalPeer(ctx, "gaiaBgpInternalPeerResource", &checkpoint.GaiaBgpInternalPeerArgs{
Peer: pulumi.String("string"),
EnableSuppressDefaultOriginate: pulumi.Bool(false),
PeerType: pulumi.String("string"),
Comment: pulumi.String("string"),
Debug: pulumi.Bool(false),
GaiaBgpInternalPeerId: pulumi.String("string"),
EnableIgnoreFirstAshop: pulumi.Bool(false),
EnableLogStateTransitions: pulumi.Bool(false),
EnableLogWarnings: pulumi.Bool(false),
EnableNoAggregatorId: pulumi.Bool(false),
EnablePassiveTcp: pulumi.Bool(false),
EnablePing: pulumi.Bool(false),
EnableRouteRefresh: pulumi.Bool(false),
Capability: pulumi.String("string"),
EnableSendKeepalives: pulumi.Bool(false),
EnableGracefulRestart: pulumi.Bool(false),
GracefulRestartStalepathTime: pulumi.String("string"),
Holdtime: pulumi.String("string"),
ImportRoutemapLists: checkpoint.GaiaBgpInternalPeerImportRoutemapListArray{
&checkpoint.GaiaBgpInternalPeerImportRoutemapListArgs{
Family: pulumi.String("string"),
Name: pulumi.String("string"),
Preference: pulumi.Float64(0),
},
},
IpReachability: &checkpoint.GaiaBgpInternalPeerIpReachabilityArgs{
CheckControlPlaneFailure: pulumi.Bool(false),
LocalAddress: pulumi.String("string"),
Type: pulumi.String("string"),
},
Keepalive: pulumi.String("string"),
LocalAddress: pulumi.String("string"),
OutgoingInterface: pulumi.String("string"),
Authtype: &checkpoint.GaiaBgpInternalPeerAuthtypeArgs{
Secret: pulumi.String("string"),
Type: pulumi.String("string"),
},
AcceptRoutes: pulumi.String("string"),
SendRouteRefresh: &checkpoint.GaiaBgpInternalPeerSendRouteRefreshArgs{
Family: pulumi.String("string"),
Type: pulumi.String("string"),
},
ThrottleCount: pulumi.String("string"),
Traces: checkpoint.GaiaBgpInternalPeerTraceArray{
&checkpoint.GaiaBgpInternalPeerTraceArgs{},
},
Weight: pulumi.String("string"),
})
resource "checkpoint_gaiabgpinternalpeer" "gaiaBgpInternalPeerResource" {
peer = "string"
enable_suppress_default_originate = false
peer_type = "string"
comment = "string"
debug = false
gaia_bgp_internal_peer_id = "string"
enable_ignore_first_ashop = false
enable_log_state_transitions = false
enable_log_warnings = false
enable_no_aggregator_id = false
enable_passive_tcp = false
enable_ping = false
enable_route_refresh = false
capability = "string"
enable_send_keepalives = false
enable_graceful_restart = false
graceful_restart_stalepath_time = "string"
holdtime = "string"
import_routemap_lists {
family = "string"
name = "string"
preference = 0
}
ip_reachability = {
check_control_plane_failure = false
local_address = "string"
type = "string"
}
keepalive = "string"
local_address = "string"
outgoing_interface = "string"
authtype = {
secret = "string"
type = "string"
}
accept_routes = "string"
send_route_refresh = {
family = "string"
type = "string"
}
throttle_count = "string"
traces {
}
weight = "string"
}
var gaiaBgpInternalPeerResource = new GaiaBgpInternalPeer("gaiaBgpInternalPeerResource", GaiaBgpInternalPeerArgs.builder()
.peer("string")
.enableSuppressDefaultOriginate(false)
.peerType("string")
.comment("string")
.debug(false)
.gaiaBgpInternalPeerId("string")
.enableIgnoreFirstAshop(false)
.enableLogStateTransitions(false)
.enableLogWarnings(false)
.enableNoAggregatorId(false)
.enablePassiveTcp(false)
.enablePing(false)
.enableRouteRefresh(false)
.capability("string")
.enableSendKeepalives(false)
.enableGracefulRestart(false)
.gracefulRestartStalepathTime("string")
.holdtime("string")
.importRoutemapLists(GaiaBgpInternalPeerImportRoutemapListArgs.builder()
.family("string")
.name("string")
.preference(0.0)
.build())
.ipReachability(GaiaBgpInternalPeerIpReachabilityArgs.builder()
.checkControlPlaneFailure(false)
.localAddress("string")
.type("string")
.build())
.keepalive("string")
.localAddress("string")
.outgoingInterface("string")
.authtype(GaiaBgpInternalPeerAuthtypeArgs.builder()
.secret("string")
.type("string")
.build())
.acceptRoutes("string")
.sendRouteRefresh(GaiaBgpInternalPeerSendRouteRefreshArgs.builder()
.family("string")
.type("string")
.build())
.throttleCount("string")
.traces(GaiaBgpInternalPeerTraceArgs.builder()
.build())
.weight("string")
.build());
gaia_bgp_internal_peer_resource = checkpoint.GaiaBgpInternalPeer("gaiaBgpInternalPeerResource",
peer="string",
enable_suppress_default_originate=False,
peer_type="string",
comment="string",
debug=False,
gaia_bgp_internal_peer_id="string",
enable_ignore_first_ashop=False,
enable_log_state_transitions=False,
enable_log_warnings=False,
enable_no_aggregator_id=False,
enable_passive_tcp=False,
enable_ping=False,
enable_route_refresh=False,
capability="string",
enable_send_keepalives=False,
enable_graceful_restart=False,
graceful_restart_stalepath_time="string",
holdtime="string",
import_routemap_lists=[{
"family": "string",
"name": "string",
"preference": float(0),
}],
ip_reachability={
"check_control_plane_failure": False,
"local_address": "string",
"type": "string",
},
keepalive="string",
local_address="string",
outgoing_interface="string",
authtype={
"secret": "string",
"type": "string",
},
accept_routes="string",
send_route_refresh={
"family": "string",
"type": "string",
},
throttle_count="string",
traces=[{}],
weight="string")
const gaiaBgpInternalPeerResource = new checkpoint.GaiaBgpInternalPeer("gaiaBgpInternalPeerResource", {
peer: "string",
enableSuppressDefaultOriginate: false,
peerType: "string",
comment: "string",
debug: false,
gaiaBgpInternalPeerId: "string",
enableIgnoreFirstAshop: false,
enableLogStateTransitions: false,
enableLogWarnings: false,
enableNoAggregatorId: false,
enablePassiveTcp: false,
enablePing: false,
enableRouteRefresh: false,
capability: "string",
enableSendKeepalives: false,
enableGracefulRestart: false,
gracefulRestartStalepathTime: "string",
holdtime: "string",
importRoutemapLists: [{
family: "string",
name: "string",
preference: 0,
}],
ipReachability: {
checkControlPlaneFailure: false,
localAddress: "string",
type: "string",
},
keepalive: "string",
localAddress: "string",
outgoingInterface: "string",
authtype: {
secret: "string",
type: "string",
},
acceptRoutes: "string",
sendRouteRefresh: {
family: "string",
type: "string",
},
throttleCount: "string",
traces: [{}],
weight: "string",
});
type: checkpoint:GaiaBgpInternalPeer
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
enableSuppressDefaultOriginate: false
gaiaBgpInternalPeerId: string
gracefulRestartStalepathTime: string
holdtime: string
importRoutemapLists:
- family: string
name: string
preference: 0
ipReachability:
checkControlPlaneFailure: false
localAddress: string
type: string
keepalive: string
localAddress: string
outgoingInterface: string
peer: string
peerType: string
sendRouteRefresh:
family: string
type: string
throttleCount: string
traces:
- {}
weight: string
GaiaBgpInternalPeer 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 GaiaBgpInternalPeer resource accepts the following input properties:
- 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 Internal 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.
- Enable
Suppress boolDefault Originate - Eliminates this peer from consideration when generating the BGP default route.
- Gaia
Bgp stringInternal Peer Id - Graceful
Restart stringStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- Holdtime string
- 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
- Import
Routemap List<GaiaLists Bgp Internal Peer Import Routemap List> - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- Ip
Reachability GaiaBgp Internal Peer Ip Reachability - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- Keepalive string
- 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.
- Send
Route GaiaRefresh Bgp Internal Peer Send Route Refresh - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- Throttle
Count string - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- Traces
List<Gaia
Bgp Internal Peer Trace> - 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 string
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- 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 Internal 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.
- Enable
Suppress boolDefault Originate - Eliminates this peer from consideration when generating the BGP default route.
- Gaia
Bgp stringInternal Peer Id - Graceful
Restart stringStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- Holdtime string
- 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
- Import
Routemap []GaiaLists Bgp Internal Peer Import Routemap List Args - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- Ip
Reachability GaiaBgp Internal Peer Ip Reachability Args - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- Keepalive string
- 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.
- Send
Route GaiaRefresh Bgp Internal Peer Send Route Refresh Args - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- Throttle
Count string - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- Traces
[]Gaia
Bgp Internal Peer Trace Args - 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 string
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- 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.
- enable_
suppress_ booldefault_ originate - Eliminates this peer from consideration when generating the BGP default route.
- gaia_
bgp_ stringinternal_ peer_ id - graceful_
restart_ stringstalepath_ time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime string
- 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
- import_
routemap_ list(object)lists - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- ip_
reachability object - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- keepalive string
- 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.
- send_
route_ objectrefresh - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- throttle_
count string - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces list(object)
- 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 string
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- 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 Internal 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.
- enable
Suppress BooleanDefault Originate - Eliminates this peer from consideration when generating the BGP default route.
- gaia
Bgp StringInternal Peer Id - graceful
Restart StringStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime String
- 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
- import
Routemap List<GaiaLists Bgp Internal Peer Import Routemap List> - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- ip
Reachability GaiaBgp Internal Peer Ip Reachability - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- keepalive String
- 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.
- send
Route GaiaRefresh Bgp Internal Peer Send Route Refresh - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- throttle
Count String - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces
List<Gaia
Bgp Internal Peer Trace> - 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 String
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- 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 Internal 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.
- enable
Suppress booleanDefault Originate - Eliminates this peer from consideration when generating the BGP default route.
- gaia
Bgp stringInternal Peer Id - graceful
Restart stringStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime string
- 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
- import
Routemap GaiaLists Bgp Internal Peer Import Routemap List[] - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- ip
Reachability GaiaBgp Internal Peer Ip Reachability - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- keepalive string
- 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.
- send
Route GaiaRefresh Bgp Internal Peer Send Route Refresh - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- throttle
Count string - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces
Gaia
Bgp Internal Peer Trace[] - 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 string
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- 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 Internal 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.
- enable_
suppress_ booldefault_ originate - Eliminates this peer from consideration when generating the BGP default route.
- gaia_
bgp_ strinternal_ peer_ id - graceful_
restart_ strstalepath_ time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime str
- 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
- import_
routemap_ Sequence[Gaialists Bgp Internal Peer Import Routemap List Args] - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- ip_
reachability GaiaBgp Internal Peer Ip Reachability Args - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- keepalive str
- 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.
- send_
route_ Gaiarefresh Bgp Internal Peer Send Route Refresh Args - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- throttle_
count str - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces
Sequence[Gaia
Bgp Internal Peer Trace Args] - 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 str
- Specifies the default weight associated with each route accepted from this peer. This can be overriden by the weight specified in the import policy.
- 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.
- enable
Suppress BooleanDefault Originate - Eliminates this peer from consideration when generating the BGP default route.
- gaia
Bgp StringInternal Peer Id - graceful
Restart StringStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime String
- 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
- import
Routemap List<Property Map>Lists - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- ip
Reachability Property Map - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- keepalive String
- 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.
- send
Route Property MapRefresh - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- throttle
Count String - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces List<Property Map>
- 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 String
- 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 GaiaBgpInternalPeer resource produces the following output properties:
Look up Existing GaiaBgpInternalPeer Resource
Get an existing GaiaBgpInternalPeer 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?: GaiaBgpInternalPeerState, opts?: CustomResourceOptions): GaiaBgpInternalPeer@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
accept_routes: Optional[str] = None,
authtype: Optional[GaiaBgpInternalPeerAuthtypeArgs] = 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,
enable_suppress_default_originate: Optional[bool] = None,
gaia_bgp_internal_peer_id: Optional[str] = None,
graceful_restart_stalepath_time: Optional[str] = None,
holdtime: Optional[str] = None,
import_routemap_lists: Optional[Sequence[GaiaBgpInternalPeerImportRoutemapListArgs]] = None,
ip_reachability: Optional[GaiaBgpInternalPeerIpReachabilityArgs] = None,
keepalive: Optional[str] = None,
local_address: Optional[str] = None,
member_id: Optional[str] = None,
outgoing_interface: Optional[str] = None,
peer: Optional[str] = None,
peer_type: Optional[str] = None,
send_route_refresh: Optional[GaiaBgpInternalPeerSendRouteRefreshArgs] = None,
throttle_count: Optional[str] = None,
traces: Optional[Sequence[GaiaBgpInternalPeerTraceArgs]] = None,
weight: Optional[str] = None) -> GaiaBgpInternalPeerfunc GetGaiaBgpInternalPeer(ctx *Context, name string, id IDInput, state *GaiaBgpInternalPeerState, opts ...ResourceOption) (*GaiaBgpInternalPeer, error)public static GaiaBgpInternalPeer Get(string name, Input<string> id, GaiaBgpInternalPeerState? state, CustomResourceOptions? opts = null)public static GaiaBgpInternalPeer get(String name, Output<String> id, GaiaBgpInternalPeerState state, CustomResourceOptions options)resources: _: type: checkpoint:GaiaBgpInternalPeer get: id: ${id}import {
to = checkpoint_gaiabgpinternalpeer.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 Internal 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.
- Enable
Suppress boolDefault Originate - Eliminates this peer from consideration when generating the BGP default route.
- Gaia
Bgp stringInternal Peer Id - Graceful
Restart stringStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- Holdtime string
- 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
- Import
Routemap List<GaiaLists Bgp Internal Peer Import Routemap List> - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- Ip
Reachability GaiaBgp Internal Peer Ip Reachability - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- Keepalive string
- 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
Id string - No description available.
- 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.
- Send
Route GaiaRefresh Bgp Internal Peer Send Route Refresh - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- Throttle
Count string - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- Traces
List<Gaia
Bgp Internal Peer Trace> - 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 string
- 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 Internal 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.
- Enable
Suppress boolDefault Originate - Eliminates this peer from consideration when generating the BGP default route.
- Gaia
Bgp stringInternal Peer Id - Graceful
Restart stringStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- Holdtime string
- 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
- Import
Routemap []GaiaLists Bgp Internal Peer Import Routemap List Args - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- Ip
Reachability GaiaBgp Internal Peer Ip Reachability Args - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- Keepalive string
- 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
Id string - No description available.
- 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.
- Send
Route GaiaRefresh Bgp Internal Peer Send Route Refresh Args - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- Throttle
Count string - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- Traces
[]Gaia
Bgp Internal Peer Trace Args - 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 string
- 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.
- enable_
suppress_ booldefault_ originate - Eliminates this peer from consideration when generating the BGP default route.
- gaia_
bgp_ stringinternal_ peer_ id - graceful_
restart_ stringstalepath_ time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime string
- 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
- import_
routemap_ list(object)lists - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- ip_
reachability object - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- keepalive string
- 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_
id string - No description available.
- 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.
- send_
route_ objectrefresh - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- throttle_
count string - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces list(object)
- 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 string
- 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 Internal 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.
- enable
Suppress BooleanDefault Originate - Eliminates this peer from consideration when generating the BGP default route.
- gaia
Bgp StringInternal Peer Id - graceful
Restart StringStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime String
- 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
- import
Routemap List<GaiaLists Bgp Internal Peer Import Routemap List> - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- ip
Reachability GaiaBgp Internal Peer Ip Reachability - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- keepalive String
- 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
Id String - No description available.
- 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.
- send
Route GaiaRefresh Bgp Internal Peer Send Route Refresh - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- throttle
Count String - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces
List<Gaia
Bgp Internal Peer Trace> - 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 String
- 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 Internal 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.
- enable
Suppress booleanDefault Originate - Eliminates this peer from consideration when generating the BGP default route.
- gaia
Bgp stringInternal Peer Id - graceful
Restart stringStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime string
- 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
- import
Routemap GaiaLists Bgp Internal Peer Import Routemap List[] - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- ip
Reachability GaiaBgp Internal Peer Ip Reachability - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- keepalive string
- 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
Id string - No description available.
- 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.
- send
Route GaiaRefresh Bgp Internal Peer Send Route Refresh - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- throttle
Count string - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces
Gaia
Bgp Internal Peer Trace[] - 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 string
- 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 Internal 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.
- enable_
suppress_ booldefault_ originate - Eliminates this peer from consideration when generating the BGP default route.
- gaia_
bgp_ strinternal_ peer_ id - graceful_
restart_ strstalepath_ time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime str
- 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
- import_
routemap_ Sequence[Gaialists Bgp Internal Peer Import Routemap List Args] - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- ip_
reachability GaiaBgp Internal Peer Ip Reachability Args - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- keepalive str
- 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_
id str - No description available.
- 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.
- send_
route_ Gaiarefresh Bgp Internal Peer Send Route Refresh Args - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- throttle_
count str - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces
Sequence[Gaia
Bgp Internal Peer Trace Args] - 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 str
- 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.
- enable
Suppress BooleanDefault Originate - Eliminates this peer from consideration when generating the BGP default route.
- gaia
Bgp StringInternal Peer Id - graceful
Restart StringStalepath Time - Specifies the time (seconds) that this router will wait for a restarting BGP peer to send the End-of-RIB notification.
- holdtime String
- 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
- import
Routemap List<Property Map>Lists - Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.
- ip
Reachability Property Map - Directs BGP to start BFD (Bidirectional Forwarding Detection) for this peer. Either "single hop" or "multi hop" BFD can be configured. Either "single hop" or "multi hop" BFD must be configured in order to use the "check control plane" feature. ip_reachability blocks are documented below.
- keepalive String
- 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
Id String - No description available.
- 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.
- send
Route Property MapRefresh - 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. This field will not show up in the response if sent in the request. send_route_refresh blocks are documented below.
- throttle
Count String - This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.
- traces List<Property Map>
- 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 String
- 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
GaiaBgpInternalPeerAuthtype, GaiaBgpInternalPeerAuthtypeArgs
GaiaBgpInternalPeerImportRoutemapList, GaiaBgpInternalPeerImportRoutemapListArgs
- Family string
- Describes which family of routes this routemap will be applied to.
- Name string
- Name of the routemap
- Preference double
- Preference for the routemap. Routemaps are evaluated in order of increasing preference value.
- Family string
- Describes which family of routes this routemap will be applied to.
- Name string
- Name of the routemap
- Preference float64
- Preference for the routemap. Routemaps are evaluated in order of increasing preference value.
- family string
- Describes which family of routes this routemap will be applied to.
- name string
- Name of the routemap
- preference number
- Preference for the routemap. Routemaps are evaluated in order of increasing preference value.
- family String
- Describes which family of routes this routemap will be applied to.
- name String
- Name of the routemap
- preference Double
- Preference for the routemap. Routemaps are evaluated in order of increasing preference value.
- family string
- Describes which family of routes this routemap will be applied to.
- name string
- Name of the routemap
- preference number
- Preference for the routemap. Routemaps are evaluated in order of increasing preference value.
- family str
- Describes which family of routes this routemap will be applied to.
- name str
- Name of the routemap
- preference float
- Preference for the routemap. Routemaps are evaluated in order of increasing preference value.
- family String
- Describes which family of routes this routemap will be applied to.
- name String
- Name of the routemap
- preference Number
- Preference for the routemap. Routemaps are evaluated in order of increasing preference value.
GaiaBgpInternalPeerIpReachability, GaiaBgpInternalPeerIpReachabilityArgs
- Check
Control boolPlane Failure - This feature applies when the local node is helping the remote BGP peer undergo a graceful restart. Single hop or multi hop BFD must be enabled in order for this feature to be enabled.
- Local
Address string - Configure the multi-hop local address if multi-hop BFD is enabled. The local address must be a local address of this host or VIP in the case of a cluster.
- Type string
- Configure either "single hop" BFD, "multi hop" BFD, or none. The BFD protocol exists in "single hop" and "multi hop" variants (RFC 5881 and RFC 5883 respectively). For multi hop BFD to work, the peer must also have multihop enabled, with this machine's local address as the remote peer address and vice versa. Multihop BFD cannot be configured with IPv6 link-local peers.
- Check
Control boolPlane Failure - This feature applies when the local node is helping the remote BGP peer undergo a graceful restart. Single hop or multi hop BFD must be enabled in order for this feature to be enabled.
- Local
Address string - Configure the multi-hop local address if multi-hop BFD is enabled. The local address must be a local address of this host or VIP in the case of a cluster.
- Type string
- Configure either "single hop" BFD, "multi hop" BFD, or none. The BFD protocol exists in "single hop" and "multi hop" variants (RFC 5881 and RFC 5883 respectively). For multi hop BFD to work, the peer must also have multihop enabled, with this machine's local address as the remote peer address and vice versa. Multihop BFD cannot be configured with IPv6 link-local peers.
- check_
control_ boolplane_ failure - This feature applies when the local node is helping the remote BGP peer undergo a graceful restart. Single hop or multi hop BFD must be enabled in order for this feature to be enabled.
- local_
address string - Configure the multi-hop local address if multi-hop BFD is enabled. The local address must be a local address of this host or VIP in the case of a cluster.
- type string
- Configure either "single hop" BFD, "multi hop" BFD, or none. The BFD protocol exists in "single hop" and "multi hop" variants (RFC 5881 and RFC 5883 respectively). For multi hop BFD to work, the peer must also have multihop enabled, with this machine's local address as the remote peer address and vice versa. Multihop BFD cannot be configured with IPv6 link-local peers.
- check
Control BooleanPlane Failure - This feature applies when the local node is helping the remote BGP peer undergo a graceful restart. Single hop or multi hop BFD must be enabled in order for this feature to be enabled.
- local
Address String - Configure the multi-hop local address if multi-hop BFD is enabled. The local address must be a local address of this host or VIP in the case of a cluster.
- type String
- Configure either "single hop" BFD, "multi hop" BFD, or none. The BFD protocol exists in "single hop" and "multi hop" variants (RFC 5881 and RFC 5883 respectively). For multi hop BFD to work, the peer must also have multihop enabled, with this machine's local address as the remote peer address and vice versa. Multihop BFD cannot be configured with IPv6 link-local peers.
- check
Control booleanPlane Failure - This feature applies when the local node is helping the remote BGP peer undergo a graceful restart. Single hop or multi hop BFD must be enabled in order for this feature to be enabled.
- local
Address string - Configure the multi-hop local address if multi-hop BFD is enabled. The local address must be a local address of this host or VIP in the case of a cluster.
- type string
- Configure either "single hop" BFD, "multi hop" BFD, or none. The BFD protocol exists in "single hop" and "multi hop" variants (RFC 5881 and RFC 5883 respectively). For multi hop BFD to work, the peer must also have multihop enabled, with this machine's local address as the remote peer address and vice versa. Multihop BFD cannot be configured with IPv6 link-local peers.
- check_
control_ boolplane_ failure - This feature applies when the local node is helping the remote BGP peer undergo a graceful restart. Single hop or multi hop BFD must be enabled in order for this feature to be enabled.
- local_
address str - Configure the multi-hop local address if multi-hop BFD is enabled. The local address must be a local address of this host or VIP in the case of a cluster.
- type str
- Configure either "single hop" BFD, "multi hop" BFD, or none. The BFD protocol exists in "single hop" and "multi hop" variants (RFC 5881 and RFC 5883 respectively). For multi hop BFD to work, the peer must also have multihop enabled, with this machine's local address as the remote peer address and vice versa. Multihop BFD cannot be configured with IPv6 link-local peers.
- check
Control BooleanPlane Failure - This feature applies when the local node is helping the remote BGP peer undergo a graceful restart. Single hop or multi hop BFD must be enabled in order for this feature to be enabled.
- local
Address String - Configure the multi-hop local address if multi-hop BFD is enabled. The local address must be a local address of this host or VIP in the case of a cluster.
- type String
- Configure either "single hop" BFD, "multi hop" BFD, or none. The BFD protocol exists in "single hop" and "multi hop" variants (RFC 5881 and RFC 5883 respectively). For multi hop BFD to work, the peer must also have multihop enabled, with this machine's local address as the remote peer address and vice versa. Multihop BFD cannot be configured with IPv6 link-local peers.
GaiaBgpInternalPeerSendRouteRefresh, GaiaBgpInternalPeerSendRouteRefreshArgs
Package Details
- Repository
- checkpoint checkpointsw/terraform-provider-checkpoint
- License
- Notes
- This Pulumi package is based on the
checkpointTerraform Provider.
Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw
published on Monday, Jun 15, 2026 by checkpointsw