Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Checkpoint Provider
  4. API Docs
  5. getGaiaShowConfigurationBgpConfederationPeers
Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw
Schema (JSON)
checkpointsw/terraform-provider-checkpoint

checkpoint.getGaiaShowConfigurationBgpConfederationPeers

Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw
Schema (JSON)
checkpointsw/terraform-provider-checkpoint

    Using getGaiaShowConfigurationBgpConfederationPeers

    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 getGaiaShowConfigurationBgpConfederationPeers(args: GetGaiaShowConfigurationBgpConfederationPeersArgs, opts?: InvokeOptions): Promise<GetGaiaShowConfigurationBgpConfederationPeersResult>
function getGaiaShowConfigurationBgpConfederationPeersOutput(args: GetGaiaShowConfigurationBgpConfederationPeersOutputArgs, opts?: InvokeOptions): Output<GetGaiaShowConfigurationBgpConfederationPeersResult>
    def get_gaia_show_configuration_bgp_confederation_peers(debug: Optional[bool] = None,
                                                        filter: Optional[str] = None,
                                                        id: Optional[str] = None,
                                                        limit: Optional[float] = None,
                                                        member_as: Optional[str] = None,
                                                        member_id: Optional[str] = None,
                                                        offset: Optional[float] = None,
                                                        order: Optional[str] = None,
                                                        opts: Optional[InvokeOptions] = None) -> GetGaiaShowConfigurationBgpConfederationPeersResult
def get_gaia_show_configuration_bgp_confederation_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_as: pulumi.Input[Optional[str]] = 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[GetGaiaShowConfigurationBgpConfederationPeersResult]
    func GetGaiaShowConfigurationBgpConfederationPeers(ctx *Context, args *GetGaiaShowConfigurationBgpConfederationPeersArgs, opts ...InvokeOption) (*GetGaiaShowConfigurationBgpConfederationPeersResult, error)
func GetGaiaShowConfigurationBgpConfederationPeersOutput(ctx *Context, args *GetGaiaShowConfigurationBgpConfederationPeersOutputArgs, opts ...InvokeOption) GetGaiaShowConfigurationBgpConfederationPeersResultOutput

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

    public static class GetGaiaShowConfigurationBgpConfederationPeers 
{
    public static Task<GetGaiaShowConfigurationBgpConfederationPeersResult> InvokeAsync(GetGaiaShowConfigurationBgpConfederationPeersArgs args, InvokeOptions? opts = null)
    public static Output<GetGaiaShowConfigurationBgpConfederationPeersResult> Invoke(GetGaiaShowConfigurationBgpConfederationPeersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGaiaShowConfigurationBgpConfederationPeersResult> getGaiaShowConfigurationBgpConfederationPeers(GetGaiaShowConfigurationBgpConfederationPeersArgs args, InvokeOptions options)
public static Output<GetGaiaShowConfigurationBgpConfederationPeersResult> getGaiaShowConfigurationBgpConfederationPeers(GetGaiaShowConfigurationBgpConfederationPeersArgs args, InvokeOptions options)

    fn::invoke:
  function: checkpoint:index/getGaiaShowConfigurationBgpConfederationPeers:getGaiaShowConfigurationBgpConfederationPeers
  arguments:
    # arguments dictionary
    data "checkpoint_getgaiashowconfigurationbgpconfederationpeers" "name" {
    # arguments
}

    The following arguments are supported:

    Debug bool
    Filter string
    Filter the results
    Id string
    Limit double
    The maximum number of returned results
    MemberAs string
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    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
    MemberAs string
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    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_as string
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    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
    memberAs String
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    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
    memberAs string
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    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_as str
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    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
    memberAs String
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    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.

    getGaiaShowConfigurationBgpConfederationPeers Result

    The following output properties are available:

    From float64
    Id string
    Objects []GetGaiaShowConfigurationBgpConfederationPeersObject
    To float64
    Total float64
    Debug bool
    Filter string
    Limit float64
    MemberAs string
    MemberId string
    Offset float64
    Order string
    from number
    id string
    objects list(object)
    to number
    total number
    debug bool
    filter string
    limit number
    member_as string
    member_id string
    offset number
    order string
    from number
    id string
    objects GetGaiaShowConfigurationBgpConfederationPeersObject[]
    to number
    total number
    debug boolean
    filter string
    limit number
    memberAs string
    memberId string
    offset number
    order string
    from Number
    id String
    objects List<Property Map>
    to Number
    total Number
    debug Boolean
    filter String
    limit Number
    memberAs String
    memberId String
    offset Number
    order String

    Supporting Types

    GetGaiaShowConfigurationBgpConfederationPeersObject

    AcceptRoutes string
    Authtypes List<GetGaiaShowConfigurationBgpConfederationPeersObjectAuthtype>
    Capability string
    Comment string
    EnableGracefulRestart bool
    EnableIgnoreFirstAshop bool
    EnableLogStateTransitions bool
    EnableLogWarnings bool
    EnableNoAggregatorId bool
    EnablePassiveTcp bool
    EnablePing bool
    EnableRouteRefresh bool
    EnableSendKeepalives bool
    GracefulRestartStalepathTime string
    Holdtime string
    Keepalive string
    LocalAddress string
    MemberAs string
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    OutgoingInterface string
    Peer string
    PeerType string
    ThrottleCount string
    Traces List<string>
    Weight string
    AcceptRoutes string
    Authtypes []GetGaiaShowConfigurationBgpConfederationPeersObjectAuthtype
    Capability string
    Comment string
    EnableGracefulRestart bool
    EnableIgnoreFirstAshop bool
    EnableLogStateTransitions bool
    EnableLogWarnings bool
    EnableNoAggregatorId bool
    EnablePassiveTcp bool
    EnablePing bool
    EnableRouteRefresh bool
    EnableSendKeepalives bool
    GracefulRestartStalepathTime string
    Holdtime string
    Keepalive string
    LocalAddress string
    MemberAs string
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    OutgoingInterface string
    Peer string
    PeerType string
    ThrottleCount string
    Traces []string
    Weight string
    accept_routes string
    authtypes list(object)
    capability string
    comment string
    enable_graceful_restart bool
    enable_ignore_first_ashop bool
    enable_log_state_transitions bool
    enable_log_warnings bool
    enable_no_aggregator_id bool
    enable_passive_tcp bool
    enable_ping bool
    enable_route_refresh bool
    enable_send_keepalives bool
    graceful_restart_stalepath_time string
    holdtime string
    keepalive string
    local_address string
    member_as string
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    outgoing_interface string
    peer string
    peer_type string
    throttle_count string
    traces list(string)
    weight string
    acceptRoutes String
    authtypes List<GetGaiaShowConfigurationBgpConfederationPeersObjectAuthtype>
    capability String
    comment String
    enableGracefulRestart Boolean
    enableIgnoreFirstAshop Boolean
    enableLogStateTransitions Boolean
    enableLogWarnings Boolean
    enableNoAggregatorId Boolean
    enablePassiveTcp Boolean
    enablePing Boolean
    enableRouteRefresh Boolean
    enableSendKeepalives Boolean
    gracefulRestartStalepathTime String
    holdtime String
    keepalive String
    localAddress String
    memberAs String
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    outgoingInterface String
    peer String
    peerType String
    throttleCount String
    traces List<String>
    weight String
    acceptRoutes string
    authtypes GetGaiaShowConfigurationBgpConfederationPeersObjectAuthtype[]
    capability string
    comment string
    enableGracefulRestart boolean
    enableIgnoreFirstAshop boolean
    enableLogStateTransitions boolean
    enableLogWarnings boolean
    enableNoAggregatorId boolean
    enablePassiveTcp boolean
    enablePing boolean
    enableRouteRefresh boolean
    enableSendKeepalives boolean
    gracefulRestartStalepathTime string
    holdtime string
    keepalive string
    localAddress string
    memberAs string
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    outgoingInterface string
    peer string
    peerType string
    throttleCount string
    traces string[]
    weight string
    accept_routes str
    authtypes Sequence[GetGaiaShowConfigurationBgpConfederationPeersObjectAuthtype]
    capability str
    comment str
    enable_graceful_restart bool
    enable_ignore_first_ashop bool
    enable_log_state_transitions bool
    enable_log_warnings bool
    enable_no_aggregator_id bool
    enable_passive_tcp bool
    enable_ping bool
    enable_route_refresh bool
    enable_send_keepalives bool
    graceful_restart_stalepath_time str
    holdtime str
    keepalive str
    local_address str
    member_as str
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    outgoing_interface str
    peer str
    peer_type str
    throttle_count str
    traces Sequence[str]
    weight str
    acceptRoutes String
    authtypes List<Property Map>
    capability String
    comment String
    enableGracefulRestart Boolean
    enableIgnoreFirstAshop Boolean
    enableLogStateTransitions Boolean
    enableLogWarnings Boolean
    enableNoAggregatorId Boolean
    enablePassiveTcp Boolean
    enablePing Boolean
    enableRouteRefresh Boolean
    enableSendKeepalives Boolean
    gracefulRestartStalepathTime String
    holdtime String
    keepalive String
    localAddress String
    memberAs String
    Specify the Routing Domain identifier of the Confederation peer. If the peer group specified is the local Routing Domain, it will run IBGP in a full mesh (just as an internal peer group normally would in non-Confederation mode). Otherwise, if an external Routing Domain within the Confederation is specified, the peer group will run a modified version of eBGP, which preserves route metrics and other BGP attributes. The value can be one of the following: 'all' An integer from 1-4294967295 A float from 0.1-65535.65535
    outgoingInterface String
    peer String
    peerType String
    throttleCount String
    traces List<String>
    weight String

    GetGaiaShowConfigurationBgpConfederationPeersObjectAuthtype

    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

    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
    Schema (JSON)
    checkpointsw/terraform-provider-checkpoint

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial