checkpoint.GaiaBgpExternalPeer

Example coming soon!

name string

The unique name of the resource.

args GaiaBgpExternalPeerArgs

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 GaiaBgpExternalPeerArgs

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 GaiaBgpExternalPeerArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args GaiaBgpExternalPeerArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args GaiaBgpExternalPeerArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

Peer string

IP address of the peer.

RemoteAs string

The Autonomous System number of the peer group to configure.The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535

AcceptRoutes string

Whether or not to receive routes from the peer in the absence of an inbound route filter.

AllowasInCount string

Specifies the number of times the Local AS can occur in an AS path received from this peer. A value of 0 means that the Local AS cannot be in the received AS path. The default value is 0. If the Peer Local AS feature is enabled, then this value represents the total cumulative occurances of the Local AS and Peer Local AS that can occur in an AS path.

AspathPrependCount string

Specifies the number of times this router adds its AS to the route's AS path for eBGP (external) or CBGP (Confederation) sessions. The default value is 1. If the Peer Local AS feature is enabled, the configured Peer Local AS will be the AS number prepended.

Authtype GaiaBgpExternalPeerAuthtype

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.

EnableAcceptMed bool

Specifies whether to accept the MED attribute received from this external peer. MEDs are always accepted from internal and confederation peers. If this parameter is set to 'off', the MED is stripped before the update is added to the routing table. If this parameter is reconfigured, the affected peering sessions are automatically restarted.

EnableAsOverride bool

Directs the router to overwrite this peer's AS number with this router's AS in the AS path. If the Peer Local AS feature is enabled, this router will use the configured Peer Local AS to override the remote peer's AS number.

EnableGracefulRestart bool

Configures Graceful Restart capability for the given BGP peer.

EnableIgnoreFirstAshop bool

Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.

EnableLogStateTransitions bool

Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.

EnableLogWarnings bool

Directs the router to log a message whenever a warning is encountered in the code path.

EnableMultihop bool

Multihop is used to establish peering with External BGP (eBGP) peers that are not directly connected. The router then uses the IGP route table to reach the peer. The feature can be used to perform eBGP load balancing. Cannot be configured with IPv6 link-local peers.

EnableNoAggregatorId bool

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.

EnablePassiveTcp bool

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.

EnablePing bool

Enable or disable ping for this peer.

EnableRemovePrivateAs bool

Specifies that private AS number be removed from updates to this peer. The following conditions apply: If the AS path includes both public and private AS numbers, no private AS numbers are removed. If the AS path contains the AS number of the destination peer, no private AS numbers are removed. If the AS path contains only confederations and private AS numbers, private AS numbers are removed.

EnableRouteRefresh bool

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.

EnableSendKeepalives bool

Specifies that the router always send keepalives, even when an update would substitute.

EnableSuppressDefaultOriginate bool

Eliminates this peer from consideration when generating the BGP default route.

ExportRoutemapLists List<GaiaBgpExternalPeerExportRoutemapList>

Configure export policy for the given BGP peer group or peer. export_routemap_list blocks are documented below.

GaiaBgpExternalPeerId string

GracefulRestartStalepathTime string

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

ImportRoutemapLists List<GaiaBgpExternalPeerImportRoutemapList>

Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.

InjectRoutemapLists List<GaiaBgpExternalPeerInjectRoutemapList>

Configure conditional route injection for a routemap inject_routemap_list blocks are documented below.

IpReachability GaiaBgpExternalPeerIpReachability

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.

LocalAddress string

Configures the address to be used on the local end of the TCP connection.

MedOut string

Specifies the Multi-Exit Discriminator (MED) metric used on BGP routes sent to this peer. This BGP attribute is optional, and if none is specified, then no metric will be propagated to the peer. This metric is overridden by any metric specified in export policy.

OutgoingInterface 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).

PeerLocalAs GaiaBgpExternalPeerPeerLocalAs

Configures a peer-specific Local AS number different to the systemwide Local AS number. The Peer Local AS will replace the Local AS in the BGP session. peer_local_as blocks are documented below.

SendRouteRefresh GaiaBgpExternalPeerSendRouteRefresh

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.

ThrottleCount 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<GaiaBgpExternalPeerTrace>

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.

Ttl string

Limits the number of hops over which the eBGP multihop session is established. This feature is used only with multihop. The default value is 64.

Peer string

IP address of the peer.

RemoteAs string

The Autonomous System number of the peer group to configure.The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535

AcceptRoutes string

Whether or not to receive routes from the peer in the absence of an inbound route filter.

AllowasInCount string

Specifies the number of times the Local AS can occur in an AS path received from this peer. A value of 0 means that the Local AS cannot be in the received AS path. The default value is 0. If the Peer Local AS feature is enabled, then this value represents the total cumulative occurances of the Local AS and Peer Local AS that can occur in an AS path.

AspathPrependCount string

Specifies the number of times this router adds its AS to the route's AS path for eBGP (external) or CBGP (Confederation) sessions. The default value is 1. If the Peer Local AS feature is enabled, the configured Peer Local AS will be the AS number prepended.

Authtype GaiaBgpExternalPeerAuthtypeArgs

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.

EnableAcceptMed bool

Specifies whether to accept the MED attribute received from this external peer. MEDs are always accepted from internal and confederation peers. If this parameter is set to 'off', the MED is stripped before the update is added to the routing table. If this parameter is reconfigured, the affected peering sessions are automatically restarted.

EnableAsOverride bool

Directs the router to overwrite this peer's AS number with this router's AS in the AS path. If the Peer Local AS feature is enabled, this router will use the configured Peer Local AS to override the remote peer's AS number.

EnableGracefulRestart bool

Configures Graceful Restart capability for the given BGP peer.

EnableIgnoreFirstAshop bool

Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.

EnableLogStateTransitions bool

Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.

EnableLogWarnings bool

Directs the router to log a message whenever a warning is encountered in the code path.

EnableMultihop bool

Multihop is used to establish peering with External BGP (eBGP) peers that are not directly connected. The router then uses the IGP route table to reach the peer. The feature can be used to perform eBGP load balancing. Cannot be configured with IPv6 link-local peers.

EnableNoAggregatorId bool

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.

EnablePassiveTcp bool

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.

EnablePing bool

Enable or disable ping for this peer.

EnableRemovePrivateAs bool

Specifies that private AS number be removed from updates to this peer. The following conditions apply: If the AS path includes both public and private AS numbers, no private AS numbers are removed. If the AS path contains the AS number of the destination peer, no private AS numbers are removed. If the AS path contains only confederations and private AS numbers, private AS numbers are removed.

EnableRouteRefresh bool

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.

EnableSendKeepalives bool

Specifies that the router always send keepalives, even when an update would substitute.

EnableSuppressDefaultOriginate bool

Eliminates this peer from consideration when generating the BGP default route.

ExportRoutemapLists []GaiaBgpExternalPeerExportRoutemapListArgs

Configure export policy for the given BGP peer group or peer. export_routemap_list blocks are documented below.

GaiaBgpExternalPeerId string

GracefulRestartStalepathTime string

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

ImportRoutemapLists []GaiaBgpExternalPeerImportRoutemapListArgs

Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.

InjectRoutemapLists []GaiaBgpExternalPeerInjectRoutemapListArgs

Configure conditional route injection for a routemap inject_routemap_list blocks are documented below.

IpReachability GaiaBgpExternalPeerIpReachabilityArgs

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.

LocalAddress string

Configures the address to be used on the local end of the TCP connection.

MedOut string

Specifies the Multi-Exit Discriminator (MED) metric used on BGP routes sent to this peer. This BGP attribute is optional, and if none is specified, then no metric will be propagated to the peer. This metric is overridden by any metric specified in export policy.

OutgoingInterface 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).

PeerLocalAs GaiaBgpExternalPeerPeerLocalAsArgs

Configures a peer-specific Local AS number different to the systemwide Local AS number. The Peer Local AS will replace the Local AS in the BGP session. peer_local_as blocks are documented below.

SendRouteRefresh GaiaBgpExternalPeerSendRouteRefreshArgs

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.

ThrottleCount string

This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.

Traces []GaiaBgpExternalPeerTraceArgs

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.

Ttl string

Limits the number of hops over which the eBGP multihop session is established. This feature is used only with multihop. The default value is 64.

peer string

IP address of the peer.

remote_as string

The Autonomous System number of the peer group to configure.The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535

accept_routes string

Whether or not to receive routes from the peer in the absence of an inbound route filter.

allowas_in_count string

Specifies the number of times the Local AS can occur in an AS path received from this peer. A value of 0 means that the Local AS cannot be in the received AS path. The default value is 0. If the Peer Local AS feature is enabled, then this value represents the total cumulative occurances of the Local AS and Peer Local AS that can occur in an AS path.

aspath_prepend_count string

Specifies the number of times this router adds its AS to the route's AS path for eBGP (external) or CBGP (Confederation) sessions. The default value is 1. If the Peer Local AS feature is enabled, the configured Peer Local AS will be the AS number prepended.

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_accept_med bool

Specifies whether to accept the MED attribute received from this external peer. MEDs are always accepted from internal and confederation peers. If this parameter is set to 'off', the MED is stripped before the update is added to the routing table. If this parameter is reconfigured, the affected peering sessions are automatically restarted.

enable_as_override bool

Directs the router to overwrite this peer's AS number with this router's AS in the AS path. If the Peer Local AS feature is enabled, this router will use the configured Peer Local AS to override the remote peer's AS number.

enable_graceful_restart bool

Configures Graceful Restart capability for the given BGP peer.

enable_ignore_first_ashop bool

Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.

enable_log_state_transitions bool

Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.

enable_log_warnings bool

Directs the router to log a message whenever a warning is encountered in the code path.

enable_multihop bool

Multihop is used to establish peering with External BGP (eBGP) peers that are not directly connected. The router then uses the IGP route table to reach the peer. The feature can be used to perform eBGP load balancing. Cannot be configured with IPv6 link-local peers.

enable_no_aggregator_id bool

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_tcp bool

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_remove_private_as bool

Specifies that private AS number be removed from updates to this peer. The following conditions apply: If the AS path includes both public and private AS numbers, no private AS numbers are removed. If the AS path contains the AS number of the destination peer, no private AS numbers are removed. If the AS path contains only confederations and private AS numbers, private AS numbers are removed.

enable_route_refresh bool

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_keepalives bool

Specifies that the router always send keepalives, even when an update would substitute.

enable_suppress_default_originate bool

Eliminates this peer from consideration when generating the BGP default route.

export_routemap_lists list(object)

Configure export policy for the given BGP peer group or peer. export_routemap_list blocks are documented below.

gaia_bgp_external_peer_id string

graceful_restart_stalepath_time string

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_lists list(object)

Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.

inject_routemap_lists list(object)

Configure conditional route injection for a routemap inject_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.

med_out string

Specifies the Multi-Exit Discriminator (MED) metric used on BGP routes sent to this peer. This BGP attribute is optional, and if none is specified, then no metric will be propagated to the peer. This metric is overridden by any metric specified in export policy.

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_local_as object

Configures a peer-specific Local AS number different to the systemwide Local AS number. The Peer Local AS will replace the Local AS in the BGP session. peer_local_as blocks are documented below.

send_route_refresh object

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.

ttl string

Limits the number of hops over which the eBGP multihop session is established. This feature is used only with multihop. The default value is 64.

peer String

IP address of the peer.

remoteAs String

The Autonomous System number of the peer group to configure.The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535

acceptRoutes String

Whether or not to receive routes from the peer in the absence of an inbound route filter.

allowasInCount String

Specifies the number of times the Local AS can occur in an AS path received from this peer. A value of 0 means that the Local AS cannot be in the received AS path. The default value is 0. If the Peer Local AS feature is enabled, then this value represents the total cumulative occurances of the Local AS and Peer Local AS that can occur in an AS path.

aspathPrependCount String

Specifies the number of times this router adds its AS to the route's AS path for eBGP (external) or CBGP (Confederation) sessions. The default value is 1. If the Peer Local AS feature is enabled, the configured Peer Local AS will be the AS number prepended.

authtype GaiaBgpExternalPeerAuthtype

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.

enableAcceptMed Boolean

Specifies whether to accept the MED attribute received from this external peer. MEDs are always accepted from internal and confederation peers. If this parameter is set to 'off', the MED is stripped before the update is added to the routing table. If this parameter is reconfigured, the affected peering sessions are automatically restarted.

enableAsOverride Boolean

Directs the router to overwrite this peer's AS number with this router's AS in the AS path. If the Peer Local AS feature is enabled, this router will use the configured Peer Local AS to override the remote peer's AS number.

enableGracefulRestart Boolean

Configures Graceful Restart capability for the given BGP peer.

enableIgnoreFirstAshop Boolean

Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.

enableLogStateTransitions Boolean

Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.

enableLogWarnings Boolean

Directs the router to log a message whenever a warning is encountered in the code path.

enableMultihop Boolean

Multihop is used to establish peering with External BGP (eBGP) peers that are not directly connected. The router then uses the IGP route table to reach the peer. The feature can be used to perform eBGP load balancing. Cannot be configured with IPv6 link-local peers.

enableNoAggregatorId Boolean

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.

enablePassiveTcp Boolean

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.

enablePing Boolean

Enable or disable ping for this peer.

enableRemovePrivateAs Boolean

Specifies that private AS number be removed from updates to this peer. The following conditions apply: If the AS path includes both public and private AS numbers, no private AS numbers are removed. If the AS path contains the AS number of the destination peer, no private AS numbers are removed. If the AS path contains only confederations and private AS numbers, private AS numbers are removed.

enableRouteRefresh Boolean

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.

enableSendKeepalives Boolean

Specifies that the router always send keepalives, even when an update would substitute.

enableSuppressDefaultOriginate Boolean

Eliminates this peer from consideration when generating the BGP default route.

exportRoutemapLists List<GaiaBgpExternalPeerExportRoutemapList>

Configure export policy for the given BGP peer group or peer. export_routemap_list blocks are documented below.

gaiaBgpExternalPeerId String

gracefulRestartStalepathTime String

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

importRoutemapLists List<GaiaBgpExternalPeerImportRoutemapList>

Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.

injectRoutemapLists List<GaiaBgpExternalPeerInjectRoutemapList>

Configure conditional route injection for a routemap inject_routemap_list blocks are documented below.

ipReachability GaiaBgpExternalPeerIpReachability

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.

localAddress String

Configures the address to be used on the local end of the TCP connection.

medOut String

Specifies the Multi-Exit Discriminator (MED) metric used on BGP routes sent to this peer. This BGP attribute is optional, and if none is specified, then no metric will be propagated to the peer. This metric is overridden by any metric specified in export policy.

outgoingInterface 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).

peerLocalAs GaiaBgpExternalPeerPeerLocalAs

Configures a peer-specific Local AS number different to the systemwide Local AS number. The Peer Local AS will replace the Local AS in the BGP session. peer_local_as blocks are documented below.

sendRouteRefresh GaiaBgpExternalPeerSendRouteRefresh

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.

throttleCount 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<GaiaBgpExternalPeerTrace>

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.

ttl String

Limits the number of hops over which the eBGP multihop session is established. This feature is used only with multihop. The default value is 64.

peer string

IP address of the peer.

remoteAs string

The Autonomous System number of the peer group to configure.The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535

acceptRoutes string

Whether or not to receive routes from the peer in the absence of an inbound route filter.

allowasInCount string

Specifies the number of times the Local AS can occur in an AS path received from this peer. A value of 0 means that the Local AS cannot be in the received AS path. The default value is 0. If the Peer Local AS feature is enabled, then this value represents the total cumulative occurances of the Local AS and Peer Local AS that can occur in an AS path.

aspathPrependCount string

Specifies the number of times this router adds its AS to the route's AS path for eBGP (external) or CBGP (Confederation) sessions. The default value is 1. If the Peer Local AS feature is enabled, the configured Peer Local AS will be the AS number prepended.

authtype GaiaBgpExternalPeerAuthtype

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.

enableAcceptMed boolean

Specifies whether to accept the MED attribute received from this external peer. MEDs are always accepted from internal and confederation peers. If this parameter is set to 'off', the MED is stripped before the update is added to the routing table. If this parameter is reconfigured, the affected peering sessions are automatically restarted.

enableAsOverride boolean

Directs the router to overwrite this peer's AS number with this router's AS in the AS path. If the Peer Local AS feature is enabled, this router will use the configured Peer Local AS to override the remote peer's AS number.

enableGracefulRestart boolean

Configures Graceful Restart capability for the given BGP peer.

enableIgnoreFirstAshop boolean

Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.

enableLogStateTransitions boolean

Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.

enableLogWarnings boolean

Directs the router to log a message whenever a warning is encountered in the code path.

enableMultihop boolean

Multihop is used to establish peering with External BGP (eBGP) peers that are not directly connected. The router then uses the IGP route table to reach the peer. The feature can be used to perform eBGP load balancing. Cannot be configured with IPv6 link-local peers.

enableNoAggregatorId boolean

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.

enablePassiveTcp boolean

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.

enablePing boolean

Enable or disable ping for this peer.

enableRemovePrivateAs boolean

Specifies that private AS number be removed from updates to this peer. The following conditions apply: If the AS path includes both public and private AS numbers, no private AS numbers are removed. If the AS path contains the AS number of the destination peer, no private AS numbers are removed. If the AS path contains only confederations and private AS numbers, private AS numbers are removed.

enableRouteRefresh boolean

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.

enableSendKeepalives boolean

Specifies that the router always send keepalives, even when an update would substitute.

enableSuppressDefaultOriginate boolean

Eliminates this peer from consideration when generating the BGP default route.

exportRoutemapLists GaiaBgpExternalPeerExportRoutemapList[]

Configure export policy for the given BGP peer group or peer. export_routemap_list blocks are documented below.

gaiaBgpExternalPeerId string

gracefulRestartStalepathTime string

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

importRoutemapLists GaiaBgpExternalPeerImportRoutemapList[]

Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.

injectRoutemapLists GaiaBgpExternalPeerInjectRoutemapList[]

Configure conditional route injection for a routemap inject_routemap_list blocks are documented below.

ipReachability GaiaBgpExternalPeerIpReachability

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.

localAddress string

Configures the address to be used on the local end of the TCP connection.

medOut string

Specifies the Multi-Exit Discriminator (MED) metric used on BGP routes sent to this peer. This BGP attribute is optional, and if none is specified, then no metric will be propagated to the peer. This metric is overridden by any metric specified in export policy.

outgoingInterface 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).

peerLocalAs GaiaBgpExternalPeerPeerLocalAs

Configures a peer-specific Local AS number different to the systemwide Local AS number. The Peer Local AS will replace the Local AS in the BGP session. peer_local_as blocks are documented below.

sendRouteRefresh GaiaBgpExternalPeerSendRouteRefresh

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.

throttleCount string

This option throttles the network traffic when there are many BGP peers by changing the number of updates sent at a time.

traces GaiaBgpExternalPeerTrace[]

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.

ttl string

Limits the number of hops over which the eBGP multihop session is established. This feature is used only with multihop. The default value is 64.

peer str

IP address of the peer.

remote_as str

The Autonomous System number of the peer group to configure.The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535

accept_routes str

Whether or not to receive routes from the peer in the absence of an inbound route filter.

allowas_in_count str

Specifies the number of times the Local AS can occur in an AS path received from this peer. A value of 0 means that the Local AS cannot be in the received AS path. The default value is 0. If the Peer Local AS feature is enabled, then this value represents the total cumulative occurances of the Local AS and Peer Local AS that can occur in an AS path.

aspath_prepend_count str

Specifies the number of times this router adds its AS to the route's AS path for eBGP (external) or CBGP (Confederation) sessions. The default value is 1. If the Peer Local AS feature is enabled, the configured Peer Local AS will be the AS number prepended.

authtype GaiaBgpExternalPeerAuthtypeArgs

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_accept_med bool

Specifies whether to accept the MED attribute received from this external peer. MEDs are always accepted from internal and confederation peers. If this parameter is set to 'off', the MED is stripped before the update is added to the routing table. If this parameter is reconfigured, the affected peering sessions are automatically restarted.

enable_as_override bool

Directs the router to overwrite this peer's AS number with this router's AS in the AS path. If the Peer Local AS feature is enabled, this router will use the configured Peer Local AS to override the remote peer's AS number.

enable_graceful_restart bool

Configures Graceful Restart capability for the given BGP peer.

enable_ignore_first_ashop bool

Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.

enable_log_state_transitions bool

Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.

enable_log_warnings bool

Directs the router to log a message whenever a warning is encountered in the code path.

enable_multihop bool

Multihop is used to establish peering with External BGP (eBGP) peers that are not directly connected. The router then uses the IGP route table to reach the peer. The feature can be used to perform eBGP load balancing. Cannot be configured with IPv6 link-local peers.

enable_no_aggregator_id bool

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_tcp bool

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_remove_private_as bool

Specifies that private AS number be removed from updates to this peer. The following conditions apply: If the AS path includes both public and private AS numbers, no private AS numbers are removed. If the AS path contains the AS number of the destination peer, no private AS numbers are removed. If the AS path contains only confederations and private AS numbers, private AS numbers are removed.

enable_route_refresh bool

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_keepalives bool

Specifies that the router always send keepalives, even when an update would substitute.

enable_suppress_default_originate bool

Eliminates this peer from consideration when generating the BGP default route.

export_routemap_lists Sequence[GaiaBgpExternalPeerExportRoutemapListArgs]

Configure export policy for the given BGP peer group or peer. export_routemap_list blocks are documented below.

gaia_bgp_external_peer_id str

graceful_restart_stalepath_time str

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_lists Sequence[GaiaBgpExternalPeerImportRoutemapListArgs]

Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.

inject_routemap_lists Sequence[GaiaBgpExternalPeerInjectRoutemapListArgs]

Configure conditional route injection for a routemap inject_routemap_list blocks are documented below.

ip_reachability GaiaBgpExternalPeerIpReachabilityArgs

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.

med_out str

Specifies the Multi-Exit Discriminator (MED) metric used on BGP routes sent to this peer. This BGP attribute is optional, and if none is specified, then no metric will be propagated to the peer. This metric is overridden by any metric specified in export policy.

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_local_as GaiaBgpExternalPeerPeerLocalAsArgs

Configures a peer-specific Local AS number different to the systemwide Local AS number. The Peer Local AS will replace the Local AS in the BGP session. peer_local_as blocks are documented below.

send_route_refresh GaiaBgpExternalPeerSendRouteRefreshArgs

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[GaiaBgpExternalPeerTraceArgs]

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.

ttl str

Limits the number of hops over which the eBGP multihop session is established. This feature is used only with multihop. The default value is 64.

peer String

IP address of the peer.

remoteAs String

The Autonomous System number of the peer group to configure.The value can be one of the following: An integer from 1-4294967295 A float from 0.1-65535.65535

acceptRoutes String

Whether or not to receive routes from the peer in the absence of an inbound route filter.

allowasInCount String

Specifies the number of times the Local AS can occur in an AS path received from this peer. A value of 0 means that the Local AS cannot be in the received AS path. The default value is 0. If the Peer Local AS feature is enabled, then this value represents the total cumulative occurances of the Local AS and Peer Local AS that can occur in an AS path.

aspathPrependCount String

Specifies the number of times this router adds its AS to the route's AS path for eBGP (external) or CBGP (Confederation) sessions. The default value is 1. If the Peer Local AS feature is enabled, the configured Peer Local AS will be the AS number prepended.

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.

enableAcceptMed Boolean

Specifies whether to accept the MED attribute received from this external peer. MEDs are always accepted from internal and confederation peers. If this parameter is set to 'off', the MED is stripped before the update is added to the routing table. If this parameter is reconfigured, the affected peering sessions are automatically restarted.

enableAsOverride Boolean

Directs the router to overwrite this peer's AS number with this router's AS in the AS path. If the Peer Local AS feature is enabled, this router will use the configured Peer Local AS to override the remote peer's AS number.

enableGracefulRestart Boolean

Configures Graceful Restart capability for the given BGP peer.

enableIgnoreFirstAshop Boolean

Specifies that the router ignore the first AS number in the AS_PATH for routes learned from this peer.

enableLogStateTransitions Boolean

Directs the router to log a message whenever the peer enters or leaves ESTABLISHED state.

enableLogWarnings Boolean

Directs the router to log a message whenever a warning is encountered in the code path.

enableMultihop Boolean

Multihop is used to establish peering with External BGP (eBGP) peers that are not directly connected. The router then uses the IGP route table to reach the peer. The feature can be used to perform eBGP load balancing. Cannot be configured with IPv6 link-local peers.

enableNoAggregatorId Boolean

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.

enablePassiveTcp Boolean

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.

enablePing Boolean

Enable or disable ping for this peer.

enableRemovePrivateAs Boolean

Specifies that private AS number be removed from updates to this peer. The following conditions apply: If the AS path includes both public and private AS numbers, no private AS numbers are removed. If the AS path contains the AS number of the destination peer, no private AS numbers are removed. If the AS path contains only confederations and private AS numbers, private AS numbers are removed.

enableRouteRefresh Boolean

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.

enableSendKeepalives Boolean

Specifies that the router always send keepalives, even when an update would substitute.

enableSuppressDefaultOriginate Boolean

Eliminates this peer from consideration when generating the BGP default route.

exportRoutemapLists List<Property Map>

Configure export policy for the given BGP peer group or peer. export_routemap_list blocks are documented below.

gaiaBgpExternalPeerId String

gracefulRestartStalepathTime String

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

importRoutemapLists List<Property Map>

Configure import policy for the given BGP peer. import_routemap_list blocks are documented below.

injectRoutemapLists List<Property Map>

Configure conditional route injection for a routemap inject_routemap_list blocks are documented below.

ipReachability 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.

localAddress String

Configures the address to be used on the local end of the TCP connection.

medOut String

Specifies the Multi-Exit Discriminator (MED) metric used on BGP routes sent to this peer. This BGP attribute is optional, and if none is specified, then no metric will be propagated to the peer. This metric is overridden by any metric specified in export policy.

outgoingInterface 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).

peerLocalAs Property Map

Configures a peer-specific Local AS number different to the systemwide Local AS number. The Peer Local AS will replace the Local AS in the BGP session. peer_local_as blocks are documented below.

sendRouteRefresh Property Map

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.

throttleCount 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.

ttl String

Limits the number of hops over which the eBGP multihop session is established. This feature is used only with multihop. The default value is 64.

Id string

The provider-assigned unique ID for this managed resource.

PeerType string

Computed field, returned in the response.

Id string

The provider-assigned unique ID for this managed resource.

PeerType string

Computed field, returned in the response.

id string

The provider-assigned unique ID for this managed resource.

peer_type string

Computed field, returned in the response.

id String

The provider-assigned unique ID for this managed resource.

peerType String

Computed field, returned in the response.

id string

The provider-assigned unique ID for this managed resource.

peerType string

Computed field, returned in the response.

id str

The provider-assigned unique ID for this managed resource.

peer_type str

Computed field, returned in the response.

id String

The provider-assigned unique ID for this managed resource.

peerType String

Computed field, returned in the response.