1. Packages
  2. Packages
  3. Checkpoint Provider
  4. API Docs
  5. getGaiaShowConnections
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 getGaiaShowConnections

    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 getGaiaShowConnections(args: GetGaiaShowConnectionsArgs, opts?: InvokeOptions): Promise<GetGaiaShowConnectionsResult>
    function getGaiaShowConnectionsOutput(args: GetGaiaShowConnectionsOutputArgs, opts?: InvokeOptions): Output<GetGaiaShowConnectionsResult>
    def get_gaia_show_connections(debug: Optional[bool] = None,
                                  filter: Optional[GetGaiaShowConnectionsFilter] = None,
                                  id: Optional[str] = None,
                                  max_results: Optional[float] = None,
                                  member_id: Optional[str] = None,
                                  presets: Optional[Sequence[str]] = None,
                                  use_preset: Optional[bool] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetGaiaShowConnectionsResult
    def get_gaia_show_connections_output(debug: pulumi.Input[Optional[bool]] = None,
                                  filter: pulumi.Input[Optional[GetGaiaShowConnectionsFilterArgs]] = None,
                                  id: pulumi.Input[Optional[str]] = None,
                                  max_results: pulumi.Input[Optional[float]] = None,
                                  member_id: pulumi.Input[Optional[str]] = None,
                                  presets: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
                                  use_preset: pulumi.Input[Optional[bool]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetGaiaShowConnectionsResult]
    func GetGaiaShowConnections(ctx *Context, args *GetGaiaShowConnectionsArgs, opts ...InvokeOption) (*GetGaiaShowConnectionsResult, error)
    func GetGaiaShowConnectionsOutput(ctx *Context, args *GetGaiaShowConnectionsOutputArgs, opts ...InvokeOption) GetGaiaShowConnectionsResultOutput

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

    public static class GetGaiaShowConnections 
    {
        public static Task<GetGaiaShowConnectionsResult> InvokeAsync(GetGaiaShowConnectionsArgs args, InvokeOptions? opts = null)
        public static Output<GetGaiaShowConnectionsResult> Invoke(GetGaiaShowConnectionsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGaiaShowConnectionsResult> getGaiaShowConnections(GetGaiaShowConnectionsArgs args, InvokeOptions options)
    public static Output<GetGaiaShowConnectionsResult> getGaiaShowConnections(GetGaiaShowConnectionsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: checkpoint:index/getGaiaShowConnections:getGaiaShowConnections
      arguments:
        # arguments dictionary
    data "checkpoint_getgaiashowconnections" "name" {
        # arguments
    }

    The following arguments are supported:

    Debug bool
    Filter GetGaiaShowConnectionsFilter
    Connection filtering options filter blocks are documented below.
    Id string
    MaxResults double
    Max number of connection to display, or "all" (10 by default)
    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
    Presets List<string>
    The names of the presets to be used (API call "show-connections-presets" returns the list of available presets) preset blocks are documented below.
    UsePreset bool
    A preset represents a pre-configured request with default values. But any value can be overridden by being explicitly provided in the request.
    Debug bool
    Filter GetGaiaShowConnectionsFilter
    Connection filtering options filter blocks are documented below.
    Id string
    MaxResults float64
    Max number of connection to display, or "all" (10 by default)
    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
    Presets []string
    The names of the presets to be used (API call "show-connections-presets" returns the list of available presets) preset blocks are documented below.
    UsePreset bool
    A preset represents a pre-configured request with default values. But any value can be overridden by being explicitly provided in the request.
    debug bool
    filter object
    Connection filtering options filter blocks are documented below.
    id string
    max_results number
    Max number of connection to display, or "all" (10 by default)
    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
    presets list(string)
    The names of the presets to be used (API call "show-connections-presets" returns the list of available presets) preset blocks are documented below.
    use_preset bool
    A preset represents a pre-configured request with default values. But any value can be overridden by being explicitly provided in the request.
    debug Boolean
    filter GetGaiaShowConnectionsFilter
    Connection filtering options filter blocks are documented below.
    id String
    maxResults Double
    Max number of connection to display, or "all" (10 by default)
    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
    presets List<String>
    The names of the presets to be used (API call "show-connections-presets" returns the list of available presets) preset blocks are documented below.
    usePreset Boolean
    A preset represents a pre-configured request with default values. But any value can be overridden by being explicitly provided in the request.
    debug boolean
    filter GetGaiaShowConnectionsFilter
    Connection filtering options filter blocks are documented below.
    id string
    maxResults number
    Max number of connection to display, or "all" (10 by default)
    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
    presets string[]
    The names of the presets to be used (API call "show-connections-presets" returns the list of available presets) preset blocks are documented below.
    usePreset boolean
    A preset represents a pre-configured request with default values. But any value can be overridden by being explicitly provided in the request.
    debug bool
    filter GetGaiaShowConnectionsFilter
    Connection filtering options filter blocks are documented below.
    id str
    max_results float
    Max number of connection to display, or "all" (10 by default)
    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
    presets Sequence[str]
    The names of the presets to be used (API call "show-connections-presets" returns the list of available presets) preset blocks are documented below.
    use_preset bool
    A preset represents a pre-configured request with default values. But any value can be overridden by being explicitly provided in the request.
    debug Boolean
    filter Property Map
    Connection filtering options filter blocks are documented below.
    id String
    maxResults Number
    Max number of connection to display, or "all" (10 by default)
    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
    presets List<String>
    The names of the presets to be used (API call "show-connections-presets" returns the list of available presets) preset blocks are documented below.
    usePreset Boolean
    A preset represents a pre-configured request with default values. But any value can be overridden by being explicitly provided in the request.

    getGaiaShowConnections Result

    The following output properties are available:

    Data string
    Id string
    Results double
    Debug bool
    Filter GetGaiaShowConnectionsFilter
    MaxResults double
    MemberId string
    Presets List<string>
    UsePreset bool
    data string
    id string
    results number
    debug bool
    filter object
    max_results number
    member_id string
    presets list(string)
    use_preset bool
    data String
    id String
    results Double
    debug Boolean
    filter GetGaiaShowConnectionsFilter
    maxResults Double
    memberId String
    presets List<String>
    usePreset Boolean
    data string
    id string
    results number
    debug boolean
    filter GetGaiaShowConnectionsFilter
    maxResults number
    memberId string
    presets string[]
    usePreset boolean
    data String
    id String
    results Number
    debug Boolean
    filter Property Map
    maxResults Number
    memberId String
    presets List<String>
    usePreset Boolean

    Supporting Types

    GetGaiaShowConnectionsFilter

    Destination string
    Return connections with the given destination IP address
    DestinationPort double
    Return connections with the given destination port
    InstanceIds List<string>
    Query a specific instance / set of instances (all by default) instance_id blocks are documented below.
    IpProtocol double
    Return connections with the given IP protocol number
    IpVersion string
    Return connections of the given IP version (v4 / v6 / any (default))
    Source string
    Return connections with the given source IP address
    SourcePort double
    Return connections with the given source port
    Destination string
    Return connections with the given destination IP address
    DestinationPort float64
    Return connections with the given destination port
    InstanceIds []string
    Query a specific instance / set of instances (all by default) instance_id blocks are documented below.
    IpProtocol float64
    Return connections with the given IP protocol number
    IpVersion string
    Return connections of the given IP version (v4 / v6 / any (default))
    Source string
    Return connections with the given source IP address
    SourcePort float64
    Return connections with the given source port
    destination string
    Return connections with the given destination IP address
    destination_port number
    Return connections with the given destination port
    instance_ids list(string)
    Query a specific instance / set of instances (all by default) instance_id blocks are documented below.
    ip_protocol number
    Return connections with the given IP protocol number
    ip_version string
    Return connections of the given IP version (v4 / v6 / any (default))
    source string
    Return connections with the given source IP address
    source_port number
    Return connections with the given source port
    destination String
    Return connections with the given destination IP address
    destinationPort Double
    Return connections with the given destination port
    instanceIds List<String>
    Query a specific instance / set of instances (all by default) instance_id blocks are documented below.
    ipProtocol Double
    Return connections with the given IP protocol number
    ipVersion String
    Return connections of the given IP version (v4 / v6 / any (default))
    source String
    Return connections with the given source IP address
    sourcePort Double
    Return connections with the given source port
    destination string
    Return connections with the given destination IP address
    destinationPort number
    Return connections with the given destination port
    instanceIds string[]
    Query a specific instance / set of instances (all by default) instance_id blocks are documented below.
    ipProtocol number
    Return connections with the given IP protocol number
    ipVersion string
    Return connections of the given IP version (v4 / v6 / any (default))
    source string
    Return connections with the given source IP address
    sourcePort number
    Return connections with the given source port
    destination str
    Return connections with the given destination IP address
    destination_port float
    Return connections with the given destination port
    instance_ids Sequence[str]
    Query a specific instance / set of instances (all by default) instance_id blocks are documented below.
    ip_protocol float
    Return connections with the given IP protocol number
    ip_version str
    Return connections of the given IP version (v4 / v6 / any (default))
    source str
    Return connections with the given source IP address
    source_port float
    Return connections with the given source port
    destination String
    Return connections with the given destination IP address
    destinationPort Number
    Return connections with the given destination port
    instanceIds List<String>
    Query a specific instance / set of instances (all by default) instance_id blocks are documented below.
    ipProtocol Number
    Return connections with the given IP protocol number
    ipVersion String
    Return connections of the given IP version (v4 / v6 / any (default))
    source String
    Return connections with the given source IP address
    sourcePort Number
    Return connections with the given source port

    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