1. Packages
  2. Mso Provider
  3. API Docs
  4. getRemoteLocation
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

mso.getRemoteLocation

Explore with Pulumi AI

Data source for MSO Remote Location.

Example Usage

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

const example = mso.getRemoteLocation({
    name: "remote_location_name",
});
Copy
import pulumi
import pulumi_mso as mso

example = mso.get_remote_location(name="remote_location_name")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mso.LookupRemoteLocation(ctx, &mso.LookupRemoteLocationArgs{
			Name: "remote_location_name",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mso = Pulumi.Mso;

return await Deployment.RunAsync(() => 
{
    var example = Mso.GetRemoteLocation.Invoke(new()
    {
        Name = "remote_location_name",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mso.MsoFunctions;
import com.pulumi.mso.inputs.GetRemoteLocationArgs;
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 example = MsoFunctions.getRemoteLocation(GetRemoteLocationArgs.builder()
            .name("remote_location_name")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: mso:getRemoteLocation
      arguments:
        name: remote_location_name
Copy

Argument Reference

  • name - (Required) The name of the Remote Location.

Attribute Reference

  • description - (Read-Only) The description of the Remote Location.
  • protocol - (Read-Only) The protocol used to export to the Remote Location.
  • hostname - (Read-Only) The hostname or ip address of the Remote Location.
  • path - (Read-Only) The full path to a directory on the Remote Location.
  • port - (Read-Only) The port used to connect to the Remote Location.
  • username - (Read-Only) The username used to log in to the Remote Location.

Using getRemoteLocation

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 getRemoteLocation(args: GetRemoteLocationArgs, opts?: InvokeOptions): Promise<GetRemoteLocationResult>
function getRemoteLocationOutput(args: GetRemoteLocationOutputArgs, opts?: InvokeOptions): Output<GetRemoteLocationResult>
Copy
def get_remote_location(id: Optional[str] = None,
                        name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetRemoteLocationResult
def get_remote_location_output(id: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetRemoteLocationResult]
Copy
func LookupRemoteLocation(ctx *Context, args *LookupRemoteLocationArgs, opts ...InvokeOption) (*LookupRemoteLocationResult, error)
func LookupRemoteLocationOutput(ctx *Context, args *LookupRemoteLocationOutputArgs, opts ...InvokeOption) LookupRemoteLocationResultOutput
Copy

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

public static class GetRemoteLocation 
{
    public static Task<GetRemoteLocationResult> InvokeAsync(GetRemoteLocationArgs args, InvokeOptions? opts = null)
    public static Output<GetRemoteLocationResult> Invoke(GetRemoteLocationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRemoteLocationResult> getRemoteLocation(GetRemoteLocationArgs args, InvokeOptions options)
public static Output<GetRemoteLocationResult> getRemoteLocation(GetRemoteLocationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mso:index/getRemoteLocation:getRemoteLocation
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Id string
Name This property is required. string
Id string
name This property is required. String
id String
name This property is required. string
id string
name This property is required. str
id str
name This property is required. String
id String

getRemoteLocation Result

The following output properties are available:

Description string
Hostname string
Id string
Name string
Path string
Port double
Protocol string
Username string
Description string
Hostname string
Id string
Name string
Path string
Port float64
Protocol string
Username string
description String
hostname String
id String
name String
path String
port Double
protocol String
username String
description string
hostname string
id string
name string
path string
port number
protocol string
username string
description str
hostname str
id str
name str
path str
port float
protocol str
username str
description String
hostname String
id String
name String
path String
port Number
protocol String
username String

Package Details

Repository
mso ciscodevnet/terraform-provider-mso
License
Notes
This Pulumi package is based on the mso Terraform Provider.