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
Using getGaiaShowConfigurationBgpExternalPeers
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGaiaShowConfigurationBgpExternalPeers(args: GetGaiaShowConfigurationBgpExternalPeersArgs, opts?: InvokeOptions): Promise<GetGaiaShowConfigurationBgpExternalPeersResult>
function getGaiaShowConfigurationBgpExternalPeersOutput(args: GetGaiaShowConfigurationBgpExternalPeersOutputArgs, opts?: InvokeOptions): Output<GetGaiaShowConfigurationBgpExternalPeersResult>def get_gaia_show_configuration_bgp_external_peers(debug: Optional[bool] = None,
filter: Optional[str] = None,
id: Optional[str] = None,
limit: Optional[float] = None,
member_id: Optional[str] = None,
offset: Optional[float] = None,
order: Optional[str] = None,
remote_as: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGaiaShowConfigurationBgpExternalPeersResult
def get_gaia_show_configuration_bgp_external_peers_output(debug: pulumi.Input[Optional[bool]] = None,
filter: pulumi.Input[Optional[str]] = None,
id: pulumi.Input[Optional[str]] = None,
limit: pulumi.Input[Optional[float]] = None,
member_id: pulumi.Input[Optional[str]] = None,
offset: pulumi.Input[Optional[float]] = None,
order: pulumi.Input[Optional[str]] = None,
remote_as: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGaiaShowConfigurationBgpExternalPeersResult]func GetGaiaShowConfigurationBgpExternalPeers(ctx *Context, args *GetGaiaShowConfigurationBgpExternalPeersArgs, opts ...InvokeOption) (*GetGaiaShowConfigurationBgpExternalPeersResult, error)
func GetGaiaShowConfigurationBgpExternalPeersOutput(ctx *Context, args *GetGaiaShowConfigurationBgpExternalPeersOutputArgs, opts ...InvokeOption) GetGaiaShowConfigurationBgpExternalPeersResultOutput> Note: This function is named GetGaiaShowConfigurationBgpExternalPeers in the Go SDK.
public static class GetGaiaShowConfigurationBgpExternalPeers
{
public static Task<GetGaiaShowConfigurationBgpExternalPeersResult> InvokeAsync(GetGaiaShowConfigurationBgpExternalPeersArgs args, InvokeOptions? opts = null)
public static Output<GetGaiaShowConfigurationBgpExternalPeersResult> Invoke(GetGaiaShowConfigurationBgpExternalPeersInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetGaiaShowConfigurationBgpExternalPeersResult> getGaiaShowConfigurationBgpExternalPeers(GetGaiaShowConfigurationBgpExternalPeersArgs args, InvokeOptions options)
public static Output<GetGaiaShowConfigurationBgpExternalPeersResult> getGaiaShowConfigurationBgpExternalPeers(GetGaiaShowConfigurationBgpExternalPeersArgs args, InvokeOptions options)
fn::invoke:
function: checkpoint:index/getGaiaShowConfigurationBgpExternalPeers:getGaiaShowConfigurationBgpExternalPeers
arguments:
# arguments dictionarydata "checkpoint_getgaiashowconfigurationbgpexternalpeers" "name" {
# arguments
}The following arguments are supported:
- Debug bool
- Filter string
- Filter the results
- Id string
- Limit double
- The maximum number of returned results
- Member
Id string - Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
- Offset double
- The number of results to initially skip
- Order string
- Sorts the peers first by their AS, then by their IDs in either ascending or descending order.
- Remote
As string - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- Debug bool
- Filter string
- Filter the results
- Id string
- Limit float64
- The maximum number of returned results
- Member
Id string - Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
- Offset float64
- The number of results to initially skip
- Order string
- Sorts the peers first by their AS, then by their IDs in either ascending or descending order.
- Remote
As string - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- debug bool
- filter string
- Filter the results
- id string
- limit number
- The maximum number of returned results
- member_
id string - Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
- offset number
- The number of results to initially skip
- order string
- Sorts the peers first by their AS, then by their IDs in either ascending or descending order.
- remote_
as string - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- debug Boolean
- filter String
- Filter the results
- id String
- limit Double
- The maximum number of returned results
- member
Id String - Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
- offset Double
- The number of results to initially skip
- order String
- Sorts the peers first by their AS, then by their IDs in either ascending or descending order.
- remote
As String - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- debug boolean
- filter string
- Filter the results
- id string
- limit number
- The maximum number of returned results
- member
Id string - Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
- offset number
- The number of results to initially skip
- order string
- Sorts the peers first by their AS, then by their IDs in either ascending or descending order.
- remote
As string - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- debug bool
- filter str
- Filter the results
- id str
- limit float
- The maximum number of returned results
- member_
id str - Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
- offset float
- The number of results to initially skip
- order str
- Sorts the peers first by their AS, then by their IDs in either ascending or descending order.
- remote_
as str - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- debug Boolean
- filter String
- Filter the results
- id String
- limit Number
- The maximum number of returned results
- member
Id String - Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
- offset Number
- The number of results to initially skip
- order String
- Sorts the peers first by their AS, then by their IDs in either ascending or descending order.
- remote
As String - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
getGaiaShowConfigurationBgpExternalPeers Result
The following output properties are available:
Supporting Types
GetGaiaShowConfigurationBgpExternalPeersObject
- Accept
Routes string - Allowas
In stringCount - Aspath
Prepend stringCount - Authtypes
List<Get
Gaia Show Configuration Bgp External Peers Object Authtype> - Capability string
- Comment string
- Enable
Accept boolMed - Enable
As boolOverride - Enable
Graceful boolRestart - Enable
Ignore boolFirst Ashop - Enable
Log boolState Transitions - Enable
Log boolWarnings - Enable
Multihop bool - Enable
No boolAggregator Id - Enable
Passive boolTcp - Enable
Ping bool - Enable
Remove boolPrivate As - Enable
Route boolRefresh - Enable
Send boolKeepalives - Enable
Suppress boolDefault Originate - Export
Routemap List<GetLists Gaia Show Configuration Bgp External Peers Object Export Routemap List> - Graceful
Restart stringStalepath Time - Holdtime string
- Import
Routemap List<GetLists Gaia Show Configuration Bgp External Peers Object Import Routemap List> - Inject
Routemap List<GetLists Gaia Show Configuration Bgp External Peers Object Inject Routemap List> - Ip
Reachabilities List<GetGaia Show Configuration Bgp External Peers Object Ip Reachability> - Keepalive string
- Local
Address string - Med
Out string - Outgoing
Interface string - Peer string
- Peer
Local List<GetAs Gaia Show Configuration Bgp External Peers Object Peer Local A> - Peer
Type string - Remote
As string - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- Send
Route List<GetRefreshes Gaia Show Configuration Bgp External Peers Object Send Route Refresh> - Throttle
Count string - Traces List<string>
- Ttl string
- Accept
Routes string - Allowas
In stringCount - Aspath
Prepend stringCount - Authtypes
[]Get
Gaia Show Configuration Bgp External Peers Object Authtype - Capability string
- Comment string
- Enable
Accept boolMed - Enable
As boolOverride - Enable
Graceful boolRestart - Enable
Ignore boolFirst Ashop - Enable
Log boolState Transitions - Enable
Log boolWarnings - Enable
Multihop bool - Enable
No boolAggregator Id - Enable
Passive boolTcp - Enable
Ping bool - Enable
Remove boolPrivate As - Enable
Route boolRefresh - Enable
Send boolKeepalives - Enable
Suppress boolDefault Originate - Export
Routemap []GetLists Gaia Show Configuration Bgp External Peers Object Export Routemap List - Graceful
Restart stringStalepath Time - Holdtime string
- Import
Routemap []GetLists Gaia Show Configuration Bgp External Peers Object Import Routemap List - Inject
Routemap []GetLists Gaia Show Configuration Bgp External Peers Object Inject Routemap List - Ip
Reachabilities []GetGaia Show Configuration Bgp External Peers Object Ip Reachability - Keepalive string
- Local
Address string - Med
Out string - Outgoing
Interface string - Peer string
- Peer
Local []GetAs Gaia Show Configuration Bgp External Peers Object Peer Local A - Peer
Type string - Remote
As string - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- Send
Route []GetRefreshes Gaia Show Configuration Bgp External Peers Object Send Route Refresh - Throttle
Count string - Traces []string
- Ttl string
- accept_
routes string - allowas_
in_ stringcount - aspath_
prepend_ stringcount - authtypes list(object)
- capability string
- comment string
- enable_
accept_ boolmed - enable_
as_ booloverride - enable_
graceful_ boolrestart - enable_
ignore_ boolfirst_ ashop - enable_
log_ boolstate_ transitions - enable_
log_ boolwarnings - enable_
multihop bool - enable_
no_ boolaggregator_ id - enable_
passive_ booltcp - enable_
ping bool - enable_
remove_ boolprivate_ as - enable_
route_ boolrefresh - enable_
send_ boolkeepalives - enable_
suppress_ booldefault_ originate - export_
routemap_ list(object)lists - graceful_
restart_ stringstalepath_ time - holdtime string
- import_
routemap_ list(object)lists - inject_
routemap_ list(object)lists - ip_
reachabilities list(object) - keepalive string
- local_
address string - med_
out string - outgoing_
interface string - peer string
- peer_
local_ list(object)as - peer_
type string - remote_
as string - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- send_
route_ list(object)refreshes - throttle_
count string - traces list(string)
- ttl string
- accept
Routes String - allowas
In StringCount - aspath
Prepend StringCount - authtypes
List<Get
Gaia Show Configuration Bgp External Peers Object Authtype> - capability String
- comment String
- enable
Accept BooleanMed - enable
As BooleanOverride - enable
Graceful BooleanRestart - enable
Ignore BooleanFirst Ashop - enable
Log BooleanState Transitions - enable
Log BooleanWarnings - enable
Multihop Boolean - enable
No BooleanAggregator Id - enable
Passive BooleanTcp - enable
Ping Boolean - enable
Remove BooleanPrivate As - enable
Route BooleanRefresh - enable
Send BooleanKeepalives - enable
Suppress BooleanDefault Originate - export
Routemap List<GetLists Gaia Show Configuration Bgp External Peers Object Export Routemap List> - graceful
Restart StringStalepath Time - holdtime String
- import
Routemap List<GetLists Gaia Show Configuration Bgp External Peers Object Import Routemap List> - inject
Routemap List<GetLists Gaia Show Configuration Bgp External Peers Object Inject Routemap List> - ip
Reachabilities List<GetGaia Show Configuration Bgp External Peers Object Ip Reachability> - keepalive String
- local
Address String - med
Out String - outgoing
Interface String - peer String
- peer
Local List<GetAs Gaia Show Configuration Bgp External Peers Object Peer Local A> - peer
Type String - remote
As String - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- send
Route List<GetRefreshes Gaia Show Configuration Bgp External Peers Object Send Route Refresh> - throttle
Count String - traces List<String>
- ttl String
- accept
Routes string - allowas
In stringCount - aspath
Prepend stringCount - authtypes
Get
Gaia Show Configuration Bgp External Peers Object Authtype[] - capability string
- comment string
- enable
Accept booleanMed - enable
As booleanOverride - enable
Graceful booleanRestart - enable
Ignore booleanFirst Ashop - enable
Log booleanState Transitions - enable
Log booleanWarnings - enable
Multihop boolean - enable
No booleanAggregator Id - enable
Passive booleanTcp - enable
Ping boolean - enable
Remove booleanPrivate As - enable
Route booleanRefresh - enable
Send booleanKeepalives - enable
Suppress booleanDefault Originate - export
Routemap GetLists Gaia Show Configuration Bgp External Peers Object Export Routemap List[] - graceful
Restart stringStalepath Time - holdtime string
- import
Routemap GetLists Gaia Show Configuration Bgp External Peers Object Import Routemap List[] - inject
Routemap GetLists Gaia Show Configuration Bgp External Peers Object Inject Routemap List[] - ip
Reachabilities GetGaia Show Configuration Bgp External Peers Object Ip Reachability[] - keepalive string
- local
Address string - med
Out string - outgoing
Interface string - peer string
- peer
Local GetAs Gaia Show Configuration Bgp External Peers Object Peer Local A[] - peer
Type string - remote
As string - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- send
Route GetRefreshes Gaia Show Configuration Bgp External Peers Object Send Route Refresh[] - throttle
Count string - traces string[]
- ttl string
- accept_
routes str - allowas_
in_ strcount - aspath_
prepend_ strcount - authtypes
Sequence[Get
Gaia Show Configuration Bgp External Peers Object Authtype] - capability str
- comment str
- enable_
accept_ boolmed - enable_
as_ booloverride - enable_
graceful_ boolrestart - enable_
ignore_ boolfirst_ ashop - enable_
log_ boolstate_ transitions - enable_
log_ boolwarnings - enable_
multihop bool - enable_
no_ boolaggregator_ id - enable_
passive_ booltcp - enable_
ping bool - enable_
remove_ boolprivate_ as - enable_
route_ boolrefresh - enable_
send_ boolkeepalives - enable_
suppress_ booldefault_ originate - export_
routemap_ Sequence[Getlists Gaia Show Configuration Bgp External Peers Object Export Routemap List] - graceful_
restart_ strstalepath_ time - holdtime str
- import_
routemap_ Sequence[Getlists Gaia Show Configuration Bgp External Peers Object Import Routemap List] - inject_
routemap_ Sequence[Getlists Gaia Show Configuration Bgp External Peers Object Inject Routemap List] - ip_
reachabilities Sequence[GetGaia Show Configuration Bgp External Peers Object Ip Reachability] - keepalive str
- local_
address str - med_
out str - outgoing_
interface str - peer str
- peer_
local_ Sequence[Getas Gaia Show Configuration Bgp External Peers Object Peer Local A] - peer_
type str - remote_
as str - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- send_
route_ Sequence[Getrefreshes Gaia Show Configuration Bgp External Peers Object Send Route Refresh] - throttle_
count str - traces Sequence[str]
- ttl str
- accept
Routes String - allowas
In StringCount - aspath
Prepend StringCount - authtypes List<Property Map>
- capability String
- comment String
- enable
Accept BooleanMed - enable
As BooleanOverride - enable
Graceful BooleanRestart - enable
Ignore BooleanFirst Ashop - enable
Log BooleanState Transitions - enable
Log BooleanWarnings - enable
Multihop Boolean - enable
No BooleanAggregator Id - enable
Passive BooleanTcp - enable
Ping Boolean - enable
Remove BooleanPrivate As - enable
Route BooleanRefresh - enable
Send BooleanKeepalives - enable
Suppress BooleanDefault Originate - export
Routemap List<Property Map>Lists - graceful
Restart StringStalepath Time - holdtime String
- import
Routemap List<Property Map>Lists - inject
Routemap List<Property Map>Lists - ip
Reachabilities List<Property Map> - keepalive String
- local
Address String - med
Out String - outgoing
Interface String - peer String
- peer
Local List<Property Map>As - peer
Type String - remote
As String - The Autonomous System number of the peerThe value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
- send
Route List<Property Map>Refreshes - throttle
Count String - traces List<String>
- ttl String
GetGaiaShowConfigurationBgpExternalPeersObjectAuthtype
GetGaiaShowConfigurationBgpExternalPeersObjectExportRoutemapList
- conditional_
routemaps list(object) - family string
- name string
- preference number
- conditional
Routemaps List<Property Map> - family String
- name String
- preference Number
GetGaiaShowConfigurationBgpExternalPeersObjectExportRoutemapListConditionalRoutemap
GetGaiaShowConfigurationBgpExternalPeersObjectImportRoutemapList
- Family string
- Name string
- Preference double
- Family string
- Name string
- Preference float64
- family string
- name string
- preference number
- family String
- name String
- preference Double
- family string
- name string
- preference number
- family str
- name str
- preference float
- family String
- name String
- preference Number
GetGaiaShowConfigurationBgpExternalPeersObjectInjectRoutemapList
- Any
Pass stringRoutemap - Family string
- Name string
- Preference double
- Any
Pass stringRoutemap - Family string
- Name string
- Preference float64
- any_
pass_ stringroutemap - family string
- name string
- preference number
- any
Pass StringRoutemap - family String
- name String
- preference Double
- any
Pass stringRoutemap - family string
- name string
- preference number
- any_
pass_ strroutemap - family str
- name str
- preference float
- any
Pass StringRoutemap - family String
- name String
- preference Number
GetGaiaShowConfigurationBgpExternalPeersObjectIpReachability
- Check
Control boolPlane Failure - Local
Address string - Type string
- Check
Control boolPlane Failure - Local
Address string - Type string
- check_
control_ boolplane_ failure - local_
address string - type string
- check
Control BooleanPlane Failure - local
Address String - type String
- check
Control booleanPlane Failure - local
Address string - type string
- check_
control_ boolplane_ failure - local_
address str - type str
- check
Control BooleanPlane Failure - local
Address String - type String
GetGaiaShowConfigurationBgpExternalPeersObjectPeerLocalA
- As string
- Enable
Dual boolPeering - Enable
Inbound boolPeer Local - Enable
Outbound boolLocal
- As string
- Enable
Dual boolPeering - Enable
Inbound boolPeer Local - Enable
Outbound boolLocal
- as string
- enable_
dual_ boolpeering - enable_
inbound_ boolpeer_ local - enable_
outbound_ boollocal
- as String
- enable
Dual BooleanPeering - enable
Inbound BooleanPeer Local - enable
Outbound BooleanLocal
- as string
- enable
Dual booleanPeering - enable
Inbound booleanPeer Local - enable
Outbound booleanLocal
- as_ str
- enable_
dual_ boolpeering - enable_
inbound_ boolpeer_ local - enable_
outbound_ boollocal
- as String
- enable
Dual BooleanPeering - enable
Inbound BooleanPeer Local - enable
Outbound BooleanLocal
GetGaiaShowConfigurationBgpExternalPeersObjectSendRouteRefresh
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