getIkeGatewayList

Strata Cloud Manager v0.4.3 (0.x), Mar 9 26

Viewing docs for Strata Cloud Manager v0.4.3 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-scm

Viewing docs for Strata Cloud Manager v0.4.3 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-scm

Example Usage

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

// Data source to retrieve a list of IKE Gateways.
// You can filter the list by folder, snippet, or device.
// This example retrieves all gateways in the "Shared" folder.
const exampleListIkeGatewayDs = scm.getIkeGatewayList({
    folder: "Remote Networks",
});
export const ikeGatewayListTotal = exampleListIkeGatewayDs.then(exampleListIkeGatewayDs => exampleListIkeGatewayDs.total);
export const ikeGatewayListData = exampleListIkeGatewayDs.then(exampleListIkeGatewayDs => exampleListIkeGatewayDs.datas);

import pulumi
import pulumi_scm as scm

# Data source to retrieve a list of IKE Gateways.
# You can filter the list by folder, snippet, or device.
# This example retrieves all gateways in the "Shared" folder.
example_list_ike_gateway_ds = scm.get_ike_gateway_list(folder="Remote Networks")
pulumi.export("ikeGatewayListTotal", example_list_ike_gateway_ds.total)
pulumi.export("ikeGatewayListData", example_list_ike_gateway_ds.datas)

package main

import (
	"github.com/pulumi/pulumi-scm/sdk/go/scm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Data source to retrieve a list of IKE Gateways.
		// You can filter the list by folder, snippet, or device.
		// This example retrieves all gateways in the "Shared" folder.
		exampleListIkeGatewayDs, err := scm.GetIkeGatewayList(ctx, &scm.GetIkeGatewayListArgs{
			Folder: pulumi.StringRef("Remote Networks"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("ikeGatewayListTotal", exampleListIkeGatewayDs.Total)
		ctx.Export("ikeGatewayListData", exampleListIkeGatewayDs.Datas)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Data source to retrieve a list of IKE Gateways.
    // You can filter the list by folder, snippet, or device.
    // This example retrieves all gateways in the "Shared" folder.
    var exampleListIkeGatewayDs = Scm.GetIkeGatewayList.Invoke(new()
    {
        Folder = "Remote Networks",
    });

    return new Dictionary<string, object?>
    {
        ["ikeGatewayListTotal"] = exampleListIkeGatewayDs.Apply(getIkeGatewayListResult => getIkeGatewayListResult.Total),
        ["ikeGatewayListData"] = exampleListIkeGatewayDs.Apply(getIkeGatewayListResult => getIkeGatewayListResult.Datas),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.ScmFunctions;
import com.pulumi.scm.inputs.GetIkeGatewayListArgs;
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) {
        // Data source to retrieve a list of IKE Gateways.
        // You can filter the list by folder, snippet, or device.
        // This example retrieves all gateways in the "Shared" folder.
        final var exampleListIkeGatewayDs = ScmFunctions.getIkeGatewayList(GetIkeGatewayListArgs.builder()
            .folder("Remote Networks")
            .build());

        ctx.export("ikeGatewayListTotal", exampleListIkeGatewayDs.total());
        ctx.export("ikeGatewayListData", exampleListIkeGatewayDs.datas());
    }
}

variables:
  # /**
  #  * Data source to retrieve a list of IKE Gateways.
  #  * You can filter the list by folder, snippet, or device.
  #  * This example retrieves all gateways in the "Shared" folder.
  #  */
  exampleListIkeGatewayDs:
    fn::invoke:
      function: scm:getIkeGatewayList
      arguments:
        folder: Remote Networks
outputs:
  # /**
  #  * Output the total number of IKE Gateways found by the data source.
  #  */
  ikeGatewayListTotal: ${exampleListIkeGatewayDs.total}
  # /**
  #  * Output the list of data for all retrieved IKE Gateways.
  #  * This provides the configuration details for each gateway in the list.
  #  * $ terraform output -json ike_gateway_list_data can help you view the details.
  #  */
  ikeGatewayListData: ${exampleListIkeGatewayDs.datas}

Using getIkeGatewayList

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 getIkeGatewayList(args: GetIkeGatewayListArgs, opts?: InvokeOptions): Promise<GetIkeGatewayListResult>
function getIkeGatewayListOutput(args: GetIkeGatewayListOutputArgs, opts?: InvokeOptions): Output<GetIkeGatewayListResult>

def get_ike_gateway_list(device: Optional[str] = None,
                         folder: Optional[str] = None,
                         limit: Optional[int] = None,
                         name: Optional[str] = None,
                         offset: Optional[int] = None,
                         snippet: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetIkeGatewayListResult
def get_ike_gateway_list_output(device: Optional[pulumi.Input[str]] = None,
                         folder: Optional[pulumi.Input[str]] = None,
                         limit: Optional[pulumi.Input[int]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         offset: Optional[pulumi.Input[int]] = None,
                         snippet: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetIkeGatewayListResult]

func GetIkeGatewayList(ctx *Context, args *GetIkeGatewayListArgs, opts ...InvokeOption) (*GetIkeGatewayListResult, error)
func GetIkeGatewayListOutput(ctx *Context, args *GetIkeGatewayListOutputArgs, opts ...InvokeOption) GetIkeGatewayListResultOutput

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

public static class GetIkeGatewayList 
{
    public static Task<GetIkeGatewayListResult> InvokeAsync(GetIkeGatewayListArgs args, InvokeOptions? opts = null)
    public static Output<GetIkeGatewayListResult> Invoke(GetIkeGatewayListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIkeGatewayListResult> getIkeGatewayList(GetIkeGatewayListArgs args, InvokeOptions options)
public static Output<GetIkeGatewayListResult> getIkeGatewayList(GetIkeGatewayListArgs args, InvokeOptions options)

fn::invoke:
  function: scm:index/getIkeGatewayList:getIkeGatewayList
  arguments:
    # arguments dictionary

The following arguments are supported:

Device string: The device of the item.
Folder string: The folder of the item. Default: Shared.
Limit int: The max number of items to return. Default: 200.
Name string: The name of the item.
Offset int: The offset of the first item to return.
Snippet string: The snippet of the item.

Device string: The device of the item.
Folder string: The folder of the item. Default: Shared.
Limit int: The max number of items to return. Default: 200.
Name string: The name of the item.
Offset int: The offset of the first item to return.
Snippet string: The snippet of the item.

device String: The device of the item.
folder String: The folder of the item. Default: Shared.
limit Integer: The max number of items to return. Default: 200.
name String: The name of the item.
offset Integer: The offset of the first item to return.
snippet String: The snippet of the item.

device string: The device of the item.
folder string: The folder of the item. Default: Shared.
limit number: The max number of items to return. Default: 200.
name string: The name of the item.
offset number: The offset of the first item to return.
snippet string: The snippet of the item.

device str: The device of the item.
folder str: The folder of the item. Default: Shared.
limit int: The max number of items to return. Default: 200.
name str: The name of the item.
offset int: The offset of the first item to return.
snippet str: The snippet of the item.

device String: The device of the item.
folder String: The folder of the item. Default: Shared.
limit Number: The max number of items to return. Default: 200.
name String: The name of the item.
offset Number: The offset of the first item to return.
snippet String: The snippet of the item.