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

checkpoint.getGaiaShowRoutesAggregate

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

    Using getGaiaShowRoutesAggregate

    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 getGaiaShowRoutesAggregate(args: GetGaiaShowRoutesAggregateArgs, opts?: InvokeOptions): Promise<GetGaiaShowRoutesAggregateResult>
function getGaiaShowRoutesAggregateOutput(args: GetGaiaShowRoutesAggregateOutputArgs, opts?: InvokeOptions): Output<GetGaiaShowRoutesAggregateResult>
    def get_gaia_show_routes_aggregate(address_family: Optional[str] = None,
                                   debug: Optional[bool] = 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) -> GetGaiaShowRoutesAggregateResult
def get_gaia_show_routes_aggregate_output(address_family: pulumi.Input[Optional[str]] = None,
                                   debug: pulumi.Input[Optional[bool]] = 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[GetGaiaShowRoutesAggregateResult]
    func GetGaiaShowRoutesAggregate(ctx *Context, args *GetGaiaShowRoutesAggregateArgs, opts ...InvokeOption) (*GetGaiaShowRoutesAggregateResult, error)
func GetGaiaShowRoutesAggregateOutput(ctx *Context, args *GetGaiaShowRoutesAggregateOutputArgs, opts ...InvokeOption) GetGaiaShowRoutesAggregateResultOutput

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

    public static class GetGaiaShowRoutesAggregate 
{
    public static Task<GetGaiaShowRoutesAggregateResult> InvokeAsync(GetGaiaShowRoutesAggregateArgs args, InvokeOptions? opts = null)
    public static Output<GetGaiaShowRoutesAggregateResult> Invoke(GetGaiaShowRoutesAggregateInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGaiaShowRoutesAggregateResult> getGaiaShowRoutesAggregate(GetGaiaShowRoutesAggregateArgs args, InvokeOptions options)
public static Output<GetGaiaShowRoutesAggregateResult> getGaiaShowRoutesAggregate(GetGaiaShowRoutesAggregateArgs args, InvokeOptions options)

    fn::invoke:
  function: checkpoint:index/getGaiaShowRoutesAggregate:getGaiaShowRoutesAggregate
  arguments:
    # arguments dictionary
    data "checkpoint_getgaiashowroutesaggregate" "name" {
    # arguments
}

    The following arguments are supported:

    AddressFamily string
    Address family of routes returned. IPv6 route monitoring, or specifying "inet6" for this field, is only supported on GAIA versions R81.10 and up.
    Debug bool
    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 routes in either ascending or descending order.
    AddressFamily string
    Address family of routes returned. IPv6 route monitoring, or specifying "inet6" for this field, is only supported on GAIA versions R81.10 and up.
    Debug bool
    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 routes in either ascending or descending order.
    address_family string
    Address family of routes returned. IPv6 route monitoring, or specifying "inet6" for this field, is only supported on GAIA versions R81.10 and up.
    debug bool
    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 routes in either ascending or descending order.
    addressFamily String
    Address family of routes returned. IPv6 route monitoring, or specifying "inet6" for this field, is only supported on GAIA versions R81.10 and up.
    debug Boolean
    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 routes in either ascending or descending order.
    addressFamily string
    Address family of routes returned. IPv6 route monitoring, or specifying "inet6" for this field, is only supported on GAIA versions R81.10 and up.
    debug boolean
    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 routes in either ascending or descending order.
    address_family str
    Address family of routes returned. IPv6 route monitoring, or specifying "inet6" for this field, is only supported on GAIA versions R81.10 and up.
    debug bool
    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 routes in either ascending or descending order.
    addressFamily String
    Address family of routes returned. IPv6 route monitoring, or specifying "inet6" for this field, is only supported on GAIA versions R81.10 and up.
    debug Boolean
    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 routes in either ascending or descending order.

    getGaiaShowRoutesAggregate Result

    The following output properties are available:

    From double
    Id string
    Objects List<GetGaiaShowRoutesAggregateObject>
    To double
    Total double
    AddressFamily string
    Debug bool
    Limit double
    MemberId string
    Offset double
    Order string
    From float64
    Id string
    Objects []GetGaiaShowRoutesAggregateObject
    To float64
    Total float64
    AddressFamily string
    Debug bool
    Limit float64
    MemberId string
    Offset float64
    Order string
    from number
    id string
    objects list(object)
    to number
    total number
    address_family string
    debug bool
    limit number
    member_id string
    offset number
    order string
    from Double
    id String
    objects List<GetGaiaShowRoutesAggregateObject>
    to Double
    total Double
    addressFamily String
    debug Boolean
    limit Double
    memberId String
    offset Double
    order String
    from number
    id string
    objects GetGaiaShowRoutesAggregateObject[]
    to number
    total number
    addressFamily string
    debug boolean
    limit number
    memberId string
    offset number
    order string
    from Number
    id String
    objects List<Property Map>
    to Number
    total Number
    addressFamily String
    debug Boolean
    limit Number
    memberId String
    offset Number
    order String

    Supporting Types

    GetGaiaShowRoutesAggregateObject

    active_age number
    address string
    age number
    cost string
    mask_length number
    next_hops list(object)
    protocol string

    GetGaiaShowRoutesAggregateObjectNextHop

    GetGaiaShowRoutesAggregateObjectNextHopGateway

    Address string
    Interface string
    Address string
    Interface string
    address string
    interface string
    address String
    interface_ String
    address string
    interface string
    address String
    interface 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