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

ibm.getSatelliteLink

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 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",
});
Copy
import pulumi
import pulumi_ibm as ibm

satellite_link = ibm.get_satellite_link(location="location_id")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

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

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>
Copy
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]
Copy
func LookupSatelliteLink(ctx *Context, args *LookupSatelliteLinkArgs, opts ...InvokeOption) (*LookupSatelliteLinkResult, error)
func LookupSatelliteLinkOutput(ctx *Context, args *LookupSatelliteLinkOutputArgs, opts ...InvokeOption) LookupSatelliteLinkResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetSatelliteLinkResult> getSatelliteLink(GetSatelliteLinkArgs args, InvokeOptions options)
public static Output<GetSatelliteLinkResult> getSatelliteLink(GetSatelliteLinkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getSatelliteLink:getSatelliteLink
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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

GetSatelliteLinkPerformanceConnector

Connector This property is required. string
The name of the connector reported the performance data.
Latency This property is required. double
Latency between Connector and the Tunnel Server it connected.
RxBw This property is required. double
Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
TxBw This property is required. double
Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
Connector This property is required. string
The name of the connector reported the performance data.
Latency This property is required. float64
Latency between Connector and the Tunnel Server it connected.
RxBw This property is required. float64
Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
TxBw This property is required. float64
Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
connector This property is required. String
The name of the connector reported the performance data.
latency This property is required. Double
Latency between Connector and the Tunnel Server it connected.
rxBw This property is required. Double
Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
txBw This property is required. Double
Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
connector This property is required. string
The name of the connector reported the performance data.
latency This property is required. number
Latency between Connector and the Tunnel Server it connected.
rxBw This property is required. number
Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
txBw This property is required. number
Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
connector This property is required. str
The name of the connector reported the performance data.
latency This property is required. float
Latency between Connector and the Tunnel Server it connected.
rx_bw This property is required. float
Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
tx_bw This property is required. float
Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
connector This property is required. String
The name of the connector reported the performance data.
latency This property is required. Number
Latency between Connector and the Tunnel Server it connected.
rxBw This property is required. Number
Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.
txBw This property is required. 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 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm