checkpoint.getGaiaShowBgpPeers

checkpoint 3.2.0, Jun 15 26

Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw

checkpointsw/terraform-provider-checkpoint

Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw

checkpointsw/terraform-provider-checkpoint

Using getGaiaShowBgpPeers

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 getGaiaShowBgpPeers(args: GetGaiaShowBgpPeersArgs, opts?: InvokeOptions): Promise<GetGaiaShowBgpPeersResult>
function getGaiaShowBgpPeersOutput(args: GetGaiaShowBgpPeersOutputArgs, opts?: InvokeOptions): Output<GetGaiaShowBgpPeersResult>

def get_gaia_show_bgp_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,
                            opts: Optional[InvokeOptions] = None) -> GetGaiaShowBgpPeersResult
def get_gaia_show_bgp_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,
                            opts: Optional[InvokeOptions] = None) -> Output[GetGaiaShowBgpPeersResult]

func GetGaiaShowBgpPeers(ctx *Context, args *GetGaiaShowBgpPeersArgs, opts ...InvokeOption) (*GetGaiaShowBgpPeersResult, error)
func GetGaiaShowBgpPeersOutput(ctx *Context, args *GetGaiaShowBgpPeersOutputArgs, opts ...InvokeOption) GetGaiaShowBgpPeersResultOutput

> Note: This function is named GetGaiaShowBgpPeers in the Go SDK.

public static class GetGaiaShowBgpPeers 
{
    public static Task<GetGaiaShowBgpPeersResult> InvokeAsync(GetGaiaShowBgpPeersArgs args, InvokeOptions? opts = null)
    public static Output<GetGaiaShowBgpPeersResult> Invoke(GetGaiaShowBgpPeersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGaiaShowBgpPeersResult> getGaiaShowBgpPeers(GetGaiaShowBgpPeersArgs args, InvokeOptions options)
public static Output<GetGaiaShowBgpPeersResult> getGaiaShowBgpPeers(GetGaiaShowBgpPeersArgs args, InvokeOptions options)

fn::invoke:
  function: checkpoint:index/getGaiaShowBgpPeers:getGaiaShowBgpPeers
  arguments:
    # arguments dictionary

data "checkpoint_getgaiashowbgppeers" "name" {
    # arguments
}

The following arguments are supported:

Debug bool
Filter string: Filter the results
Id string
Limit double: The maximum number of returned results
MemberId 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.

Debug bool
Filter string: Filter the results
Id string
Limit float64: The maximum number of returned results
MemberId 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.

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.

debug Boolean
filter String: Filter the results
id String
limit Double: The maximum number of returned results
memberId 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.

debug boolean
filter string: Filter the results
id string
limit number: The maximum number of returned results
memberId 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.

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.

debug Boolean
filter String: Filter the results
id String
limit Number: The maximum number of returned results
memberId 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.

getGaiaShowBgpPeers Result

The following output properties are available:

From double
Id string
Objects List<GetGaiaShowBgpPeersObject>
To double
Total double
Debug bool
Filter string
Limit double
MemberId string
Offset double
Order string

From float64
Id string
Objects []GetGaiaShowBgpPeersObject
To float64
Total float64
Debug bool
Filter string
Limit float64
MemberId string
Offset float64
Order string

from number
id string
objects list(object)
to number
total number
debug bool
filter string
limit number
member_id string
offset number
order string

from Double
id String
objects List<GetGaiaShowBgpPeersObject>
to Double
total Double
debug Boolean
filter String
limit Double
memberId String
offset Double
order String

from number
id string
objects GetGaiaShowBgpPeersObject[]
to number
total number
debug boolean
filter string
limit number
memberId string
offset number
order string

from_ float
id str
objects Sequence[GetGaiaShowBgpPeersObject]
to float
total float
debug bool
filter str
limit float
member_id str
offset float
order str

from Number
id String
objects List<Property Map>
to Number
total Number
debug Boolean
filter String
limit Number
memberId String
offset Number
order String

Supporting Types

GetGaiaShowBgpPeersObject

As string
AuthFailures double
Authtype string
EnableMultihop bool
GracefulRestarts List<GetGaiaShowBgpPeersObjectGracefulRestart>
Keepalives List<GetGaiaShowBgpPeersObjectKeepalife>
LocalAs string
MemberId 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
MultihopTtl double
OurCapabilitiesLists List<string>
Peer string
PeerCapabilitiesLists List<string>
ReachabilityDetections List<GetGaiaShowBgpPeersObjectReachabilityDetection>
Receiveds List<GetGaiaShowBgpPeersObjectReceived>
RemoteAs string
Sents List<GetGaiaShowBgpPeersObjectSent>
State string
Type string
Uptime double

As string
AuthFailures float64
Authtype string
EnableMultihop bool
GracefulRestarts []GetGaiaShowBgpPeersObjectGracefulRestart
Keepalives []GetGaiaShowBgpPeersObjectKeepalife
LocalAs string
MemberId 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
MultihopTtl float64
OurCapabilitiesLists []string
Peer string
PeerCapabilitiesLists []string
ReachabilityDetections []GetGaiaShowBgpPeersObjectReachabilityDetection
Receiveds []GetGaiaShowBgpPeersObjectReceived
RemoteAs string
Sents []GetGaiaShowBgpPeersObjectSent
State string
Type string
Uptime float64

as string
auth_failures number
authtype string
enable_multihop bool
graceful_restarts list(object)
keepalives list(object)
local_as string
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
multihop_ttl number
our_capabilities_lists list(string)
peer string
peer_capabilities_lists list(string)
reachability_detections list(object)
receiveds list(object)
remote_as string
sents list(object)
state string
type string
uptime number

as String
authFailures Double
authtype String
enableMultihop Boolean
gracefulRestarts List<GetGaiaShowBgpPeersObjectGracefulRestart>
keepalives List<GetGaiaShowBgpPeersObjectKeepalife>
localAs String
memberId 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
multihopTtl Double
ourCapabilitiesLists List<String>
peer String
peerCapabilitiesLists List<String>
reachabilityDetections List<GetGaiaShowBgpPeersObjectReachabilityDetection>
receiveds List<GetGaiaShowBgpPeersObjectReceived>
remoteAs String
sents List<GetGaiaShowBgpPeersObjectSent>
state String
type String
uptime Double

as string
authFailures number
authtype string
enableMultihop boolean
gracefulRestarts GetGaiaShowBgpPeersObjectGracefulRestart[]
keepalives GetGaiaShowBgpPeersObjectKeepalife[]
localAs string
memberId 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
multihopTtl number
ourCapabilitiesLists string[]
peer string
peerCapabilitiesLists string[]
reachabilityDetections GetGaiaShowBgpPeersObjectReachabilityDetection[]
receiveds GetGaiaShowBgpPeersObjectReceived[]
remoteAs string
sents GetGaiaShowBgpPeersObjectSent[]
state string
type string
uptime number

as_ str
auth_failures float
authtype str
enable_multihop bool
graceful_restarts Sequence[GetGaiaShowBgpPeersObjectGracefulRestart]
keepalives Sequence[GetGaiaShowBgpPeersObjectKeepalife]
local_as str
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
multihop_ttl float
our_capabilities_lists Sequence[str]
peer str
peer_capabilities_lists Sequence[str]
reachability_detections Sequence[GetGaiaShowBgpPeersObjectReachabilityDetection]
receiveds Sequence[GetGaiaShowBgpPeersObjectReceived]
remote_as str
sents Sequence[GetGaiaShowBgpPeersObjectSent]
state str
type str
uptime float

as String
authFailures Number
authtype String
enableMultihop Boolean
gracefulRestarts List<Property Map>
keepalives List<Property Map>
localAs String
memberId 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
multihopTtl Number
ourCapabilitiesLists List<String>
peer String
peerCapabilitiesLists List<String>
reachabilityDetections List<Property Map>
receiveds List<Property Map>
remoteAs String
sents List<Property Map>
state String
type String
uptime Number