1. Packages
  2. Packages
  3. Checkpoint Provider
  4. API Docs
  5. getGaiaShowConfigurationBgpExternalPeers
Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw
Viewing docs for checkpoint 3.2.0
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 dictionary
    data "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
    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.
    RemoteAs 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
    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.
    RemoteAs 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
    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.
    remoteAs 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
    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.
    remoteAs 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
    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.
    remoteAs 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:

    From float64
    Id string
    Objects []GetGaiaShowConfigurationBgpExternalPeersObject
    To float64
    Total float64
    Debug bool
    Filter string
    Limit float64
    MemberId string
    Offset float64
    Order string
    RemoteAs 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
    remote_as string
    from Double
    id String
    objects List<GetGaiaShowConfigurationBgpExternalPeersObject>
    to Double
    total Double
    debug Boolean
    filter String
    limit Double
    memberId String
    offset Double
    order String
    remoteAs String
    from number
    id string
    objects GetGaiaShowConfigurationBgpExternalPeersObject[]
    to number
    total number
    debug boolean
    filter string
    limit number
    memberId string
    offset number
    order string
    remoteAs string
    from Number
    id String
    objects List<Property Map>
    to Number
    total Number
    debug Boolean
    filter String
    limit Number
    memberId String
    offset Number
    order String
    remoteAs String

    Supporting Types

    GetGaiaShowConfigurationBgpExternalPeersObject

    AcceptRoutes string
    AllowasInCount string
    AspathPrependCount string
    Authtypes List<GetGaiaShowConfigurationBgpExternalPeersObjectAuthtype>
    Capability string
    Comment string
    EnableAcceptMed bool
    EnableAsOverride bool
    EnableGracefulRestart bool
    EnableIgnoreFirstAshop bool
    EnableLogStateTransitions bool
    EnableLogWarnings bool
    EnableMultihop bool
    EnableNoAggregatorId bool
    EnablePassiveTcp bool
    EnablePing bool
    EnableRemovePrivateAs bool
    EnableRouteRefresh bool
    EnableSendKeepalives bool
    EnableSuppressDefaultOriginate bool
    ExportRoutemapLists List<GetGaiaShowConfigurationBgpExternalPeersObjectExportRoutemapList>
    GracefulRestartStalepathTime string
    Holdtime string
    ImportRoutemapLists List<GetGaiaShowConfigurationBgpExternalPeersObjectImportRoutemapList>
    InjectRoutemapLists List<GetGaiaShowConfigurationBgpExternalPeersObjectInjectRoutemapList>
    IpReachabilities List<GetGaiaShowConfigurationBgpExternalPeersObjectIpReachability>
    Keepalive string
    LocalAddress string
    MedOut string
    OutgoingInterface string
    Peer string
    PeerLocalAs List<GetGaiaShowConfigurationBgpExternalPeersObjectPeerLocalA>
    PeerType string
    RemoteAs 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
    SendRouteRefreshes List<GetGaiaShowConfigurationBgpExternalPeersObjectSendRouteRefresh>
    ThrottleCount string
    Traces List<string>
    Ttl string
    AcceptRoutes string
    AllowasInCount string
    AspathPrependCount string
    Authtypes []GetGaiaShowConfigurationBgpExternalPeersObjectAuthtype
    Capability string
    Comment string
    EnableAcceptMed bool
    EnableAsOverride bool
    EnableGracefulRestart bool
    EnableIgnoreFirstAshop bool
    EnableLogStateTransitions bool
    EnableLogWarnings bool
    EnableMultihop bool
    EnableNoAggregatorId bool
    EnablePassiveTcp bool
    EnablePing bool
    EnableRemovePrivateAs bool
    EnableRouteRefresh bool
    EnableSendKeepalives bool
    EnableSuppressDefaultOriginate bool
    ExportRoutemapLists []GetGaiaShowConfigurationBgpExternalPeersObjectExportRoutemapList
    GracefulRestartStalepathTime string
    Holdtime string
    ImportRoutemapLists []GetGaiaShowConfigurationBgpExternalPeersObjectImportRoutemapList
    InjectRoutemapLists []GetGaiaShowConfigurationBgpExternalPeersObjectInjectRoutemapList
    IpReachabilities []GetGaiaShowConfigurationBgpExternalPeersObjectIpReachability
    Keepalive string
    LocalAddress string
    MedOut string
    OutgoingInterface string
    Peer string
    PeerLocalAs []GetGaiaShowConfigurationBgpExternalPeersObjectPeerLocalA
    PeerType string
    RemoteAs 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
    SendRouteRefreshes []GetGaiaShowConfigurationBgpExternalPeersObjectSendRouteRefresh
    ThrottleCount string
    Traces []string
    Ttl string
    accept_routes string
    allowas_in_count string
    aspath_prepend_count string
    authtypes list(object)
    capability string
    comment string
    enable_accept_med bool
    enable_as_override bool
    enable_graceful_restart bool
    enable_ignore_first_ashop bool
    enable_log_state_transitions bool
    enable_log_warnings bool
    enable_multihop bool
    enable_no_aggregator_id bool
    enable_passive_tcp bool
    enable_ping bool
    enable_remove_private_as bool
    enable_route_refresh bool
    enable_send_keepalives bool
    enable_suppress_default_originate bool
    export_routemap_lists list(object)
    graceful_restart_stalepath_time string
    holdtime string
    import_routemap_lists list(object)
    inject_routemap_lists list(object)
    ip_reachabilities list(object)
    keepalive string
    local_address string
    med_out string
    outgoing_interface string
    peer string
    peer_local_as list(object)
    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_refreshes list(object)
    throttle_count string
    traces list(string)
    ttl string
    acceptRoutes String
    allowasInCount String
    aspathPrependCount String
    authtypes List<GetGaiaShowConfigurationBgpExternalPeersObjectAuthtype>
    capability String
    comment String
    enableAcceptMed Boolean
    enableAsOverride Boolean
    enableGracefulRestart Boolean
    enableIgnoreFirstAshop Boolean
    enableLogStateTransitions Boolean
    enableLogWarnings Boolean
    enableMultihop Boolean
    enableNoAggregatorId Boolean
    enablePassiveTcp Boolean
    enablePing Boolean
    enableRemovePrivateAs Boolean
    enableRouteRefresh Boolean
    enableSendKeepalives Boolean
    enableSuppressDefaultOriginate Boolean
    exportRoutemapLists List<GetGaiaShowConfigurationBgpExternalPeersObjectExportRoutemapList>
    gracefulRestartStalepathTime String
    holdtime String
    importRoutemapLists List<GetGaiaShowConfigurationBgpExternalPeersObjectImportRoutemapList>
    injectRoutemapLists List<GetGaiaShowConfigurationBgpExternalPeersObjectInjectRoutemapList>
    ipReachabilities List<GetGaiaShowConfigurationBgpExternalPeersObjectIpReachability>
    keepalive String
    localAddress String
    medOut String
    outgoingInterface String
    peer String
    peerLocalAs List<GetGaiaShowConfigurationBgpExternalPeersObjectPeerLocalA>
    peerType String
    remoteAs 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
    sendRouteRefreshes List<GetGaiaShowConfigurationBgpExternalPeersObjectSendRouteRefresh>
    throttleCount String
    traces List<String>
    ttl String
    acceptRoutes string
    allowasInCount string
    aspathPrependCount string
    authtypes GetGaiaShowConfigurationBgpExternalPeersObjectAuthtype[]
    capability string
    comment string
    enableAcceptMed boolean
    enableAsOverride boolean
    enableGracefulRestart boolean
    enableIgnoreFirstAshop boolean
    enableLogStateTransitions boolean
    enableLogWarnings boolean
    enableMultihop boolean
    enableNoAggregatorId boolean
    enablePassiveTcp boolean
    enablePing boolean
    enableRemovePrivateAs boolean
    enableRouteRefresh boolean
    enableSendKeepalives boolean
    enableSuppressDefaultOriginate boolean
    exportRoutemapLists GetGaiaShowConfigurationBgpExternalPeersObjectExportRoutemapList[]
    gracefulRestartStalepathTime string
    holdtime string
    importRoutemapLists GetGaiaShowConfigurationBgpExternalPeersObjectImportRoutemapList[]
    injectRoutemapLists GetGaiaShowConfigurationBgpExternalPeersObjectInjectRoutemapList[]
    ipReachabilities GetGaiaShowConfigurationBgpExternalPeersObjectIpReachability[]
    keepalive string
    localAddress string
    medOut string
    outgoingInterface string
    peer string
    peerLocalAs GetGaiaShowConfigurationBgpExternalPeersObjectPeerLocalA[]
    peerType string
    remoteAs 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
    sendRouteRefreshes GetGaiaShowConfigurationBgpExternalPeersObjectSendRouteRefresh[]
    throttleCount string
    traces string[]
    ttl string
    accept_routes str
    allowas_in_count str
    aspath_prepend_count str
    authtypes Sequence[GetGaiaShowConfigurationBgpExternalPeersObjectAuthtype]
    capability str
    comment str
    enable_accept_med bool
    enable_as_override bool
    enable_graceful_restart bool
    enable_ignore_first_ashop bool
    enable_log_state_transitions bool
    enable_log_warnings bool
    enable_multihop bool
    enable_no_aggregator_id bool
    enable_passive_tcp bool
    enable_ping bool
    enable_remove_private_as bool
    enable_route_refresh bool
    enable_send_keepalives bool
    enable_suppress_default_originate bool
    export_routemap_lists Sequence[GetGaiaShowConfigurationBgpExternalPeersObjectExportRoutemapList]
    graceful_restart_stalepath_time str
    holdtime str
    import_routemap_lists Sequence[GetGaiaShowConfigurationBgpExternalPeersObjectImportRoutemapList]
    inject_routemap_lists Sequence[GetGaiaShowConfigurationBgpExternalPeersObjectInjectRoutemapList]
    ip_reachabilities Sequence[GetGaiaShowConfigurationBgpExternalPeersObjectIpReachability]
    keepalive str
    local_address str
    med_out str
    outgoing_interface str
    peer str
    peer_local_as Sequence[GetGaiaShowConfigurationBgpExternalPeersObjectPeerLocalA]
    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_refreshes Sequence[GetGaiaShowConfigurationBgpExternalPeersObjectSendRouteRefresh]
    throttle_count str
    traces Sequence[str]
    ttl str
    acceptRoutes String
    allowasInCount String
    aspathPrependCount String
    authtypes List<Property Map>
    capability String
    comment String
    enableAcceptMed Boolean
    enableAsOverride Boolean
    enableGracefulRestart Boolean
    enableIgnoreFirstAshop Boolean
    enableLogStateTransitions Boolean
    enableLogWarnings Boolean
    enableMultihop Boolean
    enableNoAggregatorId Boolean
    enablePassiveTcp Boolean
    enablePing Boolean
    enableRemovePrivateAs Boolean
    enableRouteRefresh Boolean
    enableSendKeepalives Boolean
    enableSuppressDefaultOriginate Boolean
    exportRoutemapLists List<Property Map>
    gracefulRestartStalepathTime String
    holdtime String
    importRoutemapLists List<Property Map>
    injectRoutemapLists List<Property Map>
    ipReachabilities List<Property Map>
    keepalive String
    localAddress String
    medOut String
    outgoingInterface String
    peer String
    peerLocalAs List<Property Map>
    peerType String
    remoteAs 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
    sendRouteRefreshes List<Property Map>
    throttleCount String
    traces List<String>
    ttl String

    GetGaiaShowConfigurationBgpExternalPeersObjectAuthtype

    Secret string
    Type string
    Secret string
    Type string
    secret string
    type string
    secret String
    type String
    secret string
    type string
    secret str
    type str
    secret String
    type String

    GetGaiaShowConfigurationBgpExternalPeersObjectExportRoutemapList

    GetGaiaShowConfigurationBgpExternalPeersObjectExportRoutemapListConditionalRoutemap

    Condition string
    Name string
    Condition string
    Name string
    condition string
    name string
    condition String
    name String
    condition string
    name string
    condition String
    name String

    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

    AnyPassRoutemap string
    Family string
    Name string
    Preference double
    AnyPassRoutemap string
    Family string
    Name string
    Preference float64
    any_pass_routemap string
    family string
    name string
    preference number
    anyPassRoutemap String
    family String
    name String
    preference Double
    anyPassRoutemap string
    family string
    name string
    preference number
    anyPassRoutemap String
    family String
    name String
    preference Number

    GetGaiaShowConfigurationBgpExternalPeersObjectIpReachability

    GetGaiaShowConfigurationBgpExternalPeersObjectPeerLocalA

    GetGaiaShowConfigurationBgpExternalPeersObjectSendRouteRefresh

    Family string
    Type string
    Family string
    Type string
    family string
    type string
    family String
    type String
    family string
    type string
    family str
    type str
    family String
    type String

    Package Details

    Repository
    checkpoint checkpointsw/terraform-provider-checkpoint
    License
    Notes
    This Pulumi package is based on the checkpoint Terraform Provider.
    Viewing docs for checkpoint 3.2.0
    published on Monday, Jun 15, 2026 by checkpointsw

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial