Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getSatelliteLink
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getSatelliteLink

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source for ibm_satellite_link. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const satelliteLink = ibm.getSatelliteLink({
    location: "location_id",
});

    import pulumi
import pulumi_ibm as ibm

satellite_link = ibm.get_satellite_link(location="location_id")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupSatelliteLink(ctx, &ibm.LookupSatelliteLinkArgs{
			Location: "location_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var satelliteLink = Ibm.GetSatelliteLink.Invoke(new()
    {
        Location = "location_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetSatelliteLinkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var satelliteLink = IbmFunctions.getSatelliteLink(GetSatelliteLinkArgs.builder()
            .location("location_id")
            .build());

    }
}

    variables:
  satelliteLink:
    fn::invoke:
      function: ibm:getSatelliteLink
      arguments:
        location: location_id

    Using getSatelliteLink

    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 getSatelliteLink(args: GetSatelliteLinkArgs, opts?: InvokeOptions): Promise<GetSatelliteLinkResult>
function getSatelliteLinkOutput(args: GetSatelliteLinkOutputArgs, opts?: InvokeOptions): Output<GetSatelliteLinkResult>
    def get_satellite_link(id: Optional[str] = None,
                       location: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetSatelliteLinkResult
def get_satellite_link_output(id: Optional[pulumi.Input[str]] = None,
                       location: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetSatelliteLinkResult]
    func LookupSatelliteLink(ctx *Context, args *LookupSatelliteLinkArgs, opts ...InvokeOption) (*LookupSatelliteLinkResult, error)
func LookupSatelliteLinkOutput(ctx *Context, args *LookupSatelliteLinkOutputArgs, opts ...InvokeOption) LookupSatelliteLinkResultOutput

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

    public static class GetSatelliteLink 
{
    public static Task<GetSatelliteLinkResult> InvokeAsync(GetSatelliteLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetSatelliteLinkResult> Invoke(GetSatelliteLinkInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSatelliteLinkResult> getSatelliteLink(GetSatelliteLinkArgs args, InvokeOptions options)
public static Output<GetSatelliteLinkResult> getSatelliteLink(GetSatelliteLinkArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getSatelliteLink:getSatelliteLink
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Location string
    The Location ID.
    Id string
    The unique identifier of the ibm_satellite_link.
    Location string
    The Location ID.
    Id string
    The unique identifier of the ibm_satellite_link.
    location String
    The Location ID.
    id String
    The unique identifier of the ibm_satellite_link.
    location string
    The Location ID.
    id string
    The unique identifier of the ibm_satellite_link.
    location str
    The Location ID.
    id str
    The unique identifier of the ibm_satellite_link.
    location String
    The Location ID.
    id String
    The unique identifier of the ibm_satellite_link.

    getSatelliteLink Result

    The following output properties are available:

    CreatedAt string
    Timestamp of creation of location.
    Crn string
    Service instance associated with this location.
    Description string
    Description of the location.
    Id string
    The unique identifier of the ibm_satellite_link.
    LastChange string
    Timestamp of latest modification of location.
    Location string
    Performances List<GetSatelliteLinkPerformance>
    The last performance data of the Location. Nested performance blocks have the following structure:
    SatelliteLinkHost string
    Satellite Link hostname of the location.
    Status string
    Enabled/Disabled.
    WsEndpoint string
    The ws endpoint of the location.
    CreatedAt string
    Timestamp of creation of location.
    Crn string
    Service instance associated with this location.
    Description string
    Description of the location.
    Id string
    The unique identifier of the ibm_satellite_link.
    LastChange string
    Timestamp of latest modification of location.
    Location string
    Performances []GetSatelliteLinkPerformance
    The last performance data of the Location. Nested performance blocks have the following structure:
    SatelliteLinkHost string
    Satellite Link hostname of the location.
    Status string
    Enabled/Disabled.
    WsEndpoint string
    The ws endpoint of the location.
    createdAt String
    Timestamp of creation of location.
    crn String
    Service instance associated with this location.
    description String
    Description of the location.
    id String
    The unique identifier of the ibm_satellite_link.
    lastChange String
    Timestamp of latest modification of location.
    location String
    performances List<GetSatelliteLinkPerformance>
    The last performance data of the Location. Nested performance blocks have the following structure:
    satelliteLinkHost String
    Satellite Link hostname of the location.
    status String
    Enabled/Disabled.
    wsEndpoint String
    The ws endpoint of the location.
    createdAt string
    Timestamp of creation of location.
    crn string
    Service instance associated with this location.
    description string
    Description of the location.
    id string
    The unique identifier of the ibm_satellite_link.
    lastChange string
    Timestamp of latest modification of location.
    location string
    performances GetSatelliteLinkPerformance[]
    The last performance data of the Location. Nested performance blocks have the following structure:
    satelliteLinkHost string
    Satellite Link hostname of the location.
    status string
    Enabled/Disabled.
    wsEndpoint string
    The ws endpoint of the location.
    created_at str
    Timestamp of creation of location.
    crn str
    Service instance associated with this location.
    description str
    Description of the location.
    id str
    The unique identifier of the ibm_satellite_link.
    last_change str
    Timestamp of latest modification of location.
    location str
    performances Sequence[GetSatelliteLinkPerformance]
    The last performance data of the Location. Nested performance blocks have the following structure:
    satellite_link_host str
    Satellite Link hostname of the location.
    status str
    Enabled/Disabled.
    ws_endpoint str
    The ws endpoint of the location.
    createdAt String
    Timestamp of creation of location.
    crn String
    Service instance associated with this location.
    description String
    Description of the location.
    id String
    The unique identifier of the ibm_satellite_link.
    lastChange String
    Timestamp of latest modification of location.
    location String
    performances List<Property Map>
    The last performance data of the Location. Nested performance blocks have the following structure:
    satelliteLinkHost String
    Satellite Link hostname of the location.
    status String
    Enabled/Disabled.
    wsEndpoint String
    The ws endpoint of the location.

    Supporting Types

    GetSatelliteLinkPerformance

    AvgLatency double
    Average latency calculated form latency of each Connector between Tunnel Server, unit is ms. -1 means no Connector established Tunnel.
    Bandwidth double
    Average Tatal Bandwidth of last two minutes, unit is Byte/s.
    Connectors List<GetSatelliteLinkPerformanceConnector>
    The last performance data of the Location read from each Connector. Nested connectors blocks have the following structure:
    HealthStatus string
    Tunnels health status based on the Tunnels number established. Down(0)/Critical(1)/Up(>=2).
    RxBandwidth double
    Average Receive (to Cloud) Bandwidth of last two minutes, unit is Byte/s.
    Tunnels double
    Tunnels number estbalished from the Location.
    TxBandwidth double
    Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.
    AvgLatency float64
    Average latency calculated form latency of each Connector between Tunnel Server, unit is ms. -1 means no Connector established Tunnel.
    Bandwidth float64
    Average Tatal Bandwidth of last two minutes, unit is Byte/s.
    Connectors []GetSatelliteLinkPerformanceConnector
    The last performance data of the Location read from each Connector. Nested connectors blocks have the following structure:
    HealthStatus string
    Tunnels health status based on the Tunnels number established. Down(0)/Critical(1)/Up(>=2).
    RxBandwidth float64
    Average Receive (to Cloud) Bandwidth of last two minutes, unit is Byte/s.
    Tunnels float64
    Tunnels number estbalished from the Location.
    TxBandwidth float64
    Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.
    avgLatency Double
    Average latency calculated form latency of each Connector between Tunnel Server, unit is ms. -1 means no Connector established Tunnel.
    bandwidth Double
    Average Tatal Bandwidth of last two minutes, unit is Byte/s.
    connectors List<GetSatelliteLinkPerformanceConnector>
    The last performance data of the Location read from each Connector. Nested connectors blocks have the following structure:
    healthStatus String
    Tunnels health status based on the Tunnels number established. Down(0)/Critical(1)/Up(>=2).
    rxBandwidth Double
    Average Receive (to Cloud) Bandwidth of last two minutes, unit is Byte/s.
    tunnels Double
    Tunnels number estbalished from the Location.
    txBandwidth Double
    Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.
    avgLatency number
    Average latency calculated form latency of each Connector between Tunnel Server, unit is ms. -1 means no Connector established Tunnel.
    bandwidth number
    Average Tatal Bandwidth of last two minutes, unit is Byte/s.
    connectors GetSatelliteLinkPerformanceConnector[]
    The last performance data of the Location read from each Connector. Nested connectors blocks have the following structure:
    healthStatus string
    Tunnels health status based on the Tunnels number established. Down(0)/Critical(1)/Up(>=2).
    rxBandwidth number
    Average Receive (to Cloud) Bandwidth of last two minutes, unit is Byte/s.
    tunnels number
    Tunnels number estbalished from the Location.
    txBandwidth number
    Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.
    avg_latency float
    Average latency calculated form latency of each Connector between Tunnel Server, unit is ms. -1 means no Connector established Tunnel.
    bandwidth float
    Average Tatal Bandwidth of last two minutes, unit is Byte/s.
    connectors Sequence[GetSatelliteLinkPerformanceConnector]
    The last performance data of the Location read from each Connector. Nested connectors blocks have the following structure:
    health_status str
    Tunnels health status based on the Tunnels number established. Down(0)/Critical(1)/Up(>=2).
    rx_bandwidth float
    Average Receive (to Cloud) Bandwidth of last two minutes, unit is Byte/s.
    tunnels float
    Tunnels number estbalished from the Location.
    tx_bandwidth float
    Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.
    avgLatency Number
    Average latency calculated form latency of each Connector between Tunnel Server, unit is ms. -1 means no Connector established Tunnel.
    bandwidth Number
    Average Tatal Bandwidth of last two minutes, unit is Byte/s.
    connectors List<Property Map>
    The last performance data of the Location read from each Connector. Nested connectors blocks have the following structure:
    healthStatus String
    Tunnels health status based on the Tunnels number established. Down(0)/Critical(1)/Up(>=2).
    rxBandwidth Number
    Average Receive (to Cloud) Bandwidth of last two minutes, unit is Byte/s.
    tunnels Number
    Tunnels number estbalished from the Location.
    txBandwidth Number
    Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.

    GetSatelliteLinkPerformanceConnector

    Connector string
    The name of the connector reported the performance data.
    Latency double
    Latency between Connector and the Tunnel Server it connected.
    RxBw double
    Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
    TxBw double
    Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
    Connector string
    The name of the connector reported the performance data.
    Latency float64
    Latency between Connector and the Tunnel Server it connected.
    RxBw float64
    Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
    TxBw float64
    Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
    connector String
    The name of the connector reported the performance data.
    latency Double
    Latency between Connector and the Tunnel Server it connected.
    rxBw Double
    Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
    txBw Double
    Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
    connector string
    The name of the connector reported the performance data.
    latency number
    Latency between Connector and the Tunnel Server it connected.
    rxBw number
    Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
    txBw number
    Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
    connector str
    The name of the connector reported the performance data.
    latency float
    Latency between Connector and the Tunnel Server it connected.
    rx_bw float
    Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
    tx_bw float
    Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
    connector String
    The name of the connector reported the performance data.
    latency Number
    Latency between Connector and the Tunnel Server it connected.
    rxBw Number
    Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
    txBw Number
    Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm