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

mso.getSite

Explore with Pulumi AI

mso logo
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

    Data source for MSO Site.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as mso from "@pulumi/mso";
    
    const example = mso.getSite({
        name: "AWS-West",
    });
    
    import pulumi
    import pulumi_mso as mso
    
    example = mso.get_site(name="AWS-West")
    
    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.LookupSite(ctx, &mso.LookupSiteArgs{
    			Name: "AWS-West",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mso = Pulumi.Mso;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Mso.GetSite.Invoke(new()
        {
            Name = "AWS-West",
        });
    
    });
    
    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.GetSiteArgs;
    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.getSite(GetSiteArgs.builder()
                .name("AWS-West")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: mso:getSite
          arguments:
            name: AWS-West
    

    Argument Reference

    • name - (Required) The name of the Site.

    Attribute Reference

    • username - (Read-Only) The username of the Site.
    • password - (Read-Only) The password of the Site.
    • type - (Read-Only) The type of the Site.
    • group_id - (Read-Only) The group ID of the Site.
    • version - (Read-Only) The software version of the Site.
    • status - (Read-Only) The connectivity status of the Site.
    • reprovision - (Read-Only) Whether the Site needs a reprovision.
    • proxy - (Read-Only) Whether the Site uses a proxy.
    • sr_l3out - (Read-Only) Whether the Site has segment routing l3out enabled.
    • template_count - (Read-Only) The amount of templates attached to the Site.
    • apic_site_id - (Read-Only) The ID of the Site.
    • cloud_providers - (Read-Only) A list of cloud providers for the Site.
    • urls - (Read-Only) A list of URLs to reference the Site.
    • labels - (Read-Only) The labels of the Site.
    • location - (Read-Only) The location of the Site.
      • lat - (Read-Only) The latitude of the Site.
      • long - (Read-Only) The longitude of the Site.

    Using getSite

    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 getSite(args: GetSiteArgs, opts?: InvokeOptions): Promise<GetSiteResult>
    function getSiteOutput(args: GetSiteOutputArgs, opts?: InvokeOptions): Output<GetSiteResult>
    def get_site(id: Optional[str] = None,
                 name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSiteResult
    def get_site_output(id: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetSiteResult]
    func LookupSite(ctx *Context, args *LookupSiteArgs, opts ...InvokeOption) (*LookupSiteResult, error)
    func LookupSiteOutput(ctx *Context, args *LookupSiteOutputArgs, opts ...InvokeOption) LookupSiteResultOutput

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

    public static class GetSite 
    {
        public static Task<GetSiteResult> InvokeAsync(GetSiteArgs args, InvokeOptions? opts = null)
        public static Output<GetSiteResult> Invoke(GetSiteInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSiteResult> getSite(GetSiteArgs args, InvokeOptions options)
    public static Output<GetSiteResult> getSite(GetSiteArgs args, InvokeOptions options)
    
    fn::invoke:
      function: mso:index/getSite:getSite
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Id string
    Name string
    Id string
    name String
    id String
    name string
    id string
    name str
    id str
    name String
    id String

    getSite Result

    The following output properties are available:

    ApicSiteId string
    CloudProviders List<string>
    GroupId string
    Id string
    Labels List<string>
    Location Dictionary<string, string>
    Name string
    Password string
    Proxy bool
    Reprovision bool
    SrL3out bool
    Status string
    TemplateCount double
    Type string
    Urls List<string>
    Username string
    Version string
    ApicSiteId string
    CloudProviders []string
    GroupId string
    Id string
    Labels []string
    Location map[string]string
    Name string
    Password string
    Proxy bool
    Reprovision bool
    SrL3out bool
    Status string
    TemplateCount float64
    Type string
    Urls []string
    Username string
    Version string
    apicSiteId String
    cloudProviders List<String>
    groupId String
    id String
    labels List<String>
    location Map<String,String>
    name String
    password String
    proxy Boolean
    reprovision Boolean
    srL3out Boolean
    status String
    templateCount Double
    type String
    urls List<String>
    username String
    version String
    apicSiteId string
    cloudProviders string[]
    groupId string
    id string
    labels string[]
    location {[key: string]: string}
    name string
    password string
    proxy boolean
    reprovision boolean
    srL3out boolean
    status string
    templateCount number
    type string
    urls string[]
    username string
    version string
    apic_site_id str
    cloud_providers Sequence[str]
    group_id str
    id str
    labels Sequence[str]
    location Mapping[str, str]
    name str
    password str
    proxy bool
    reprovision bool
    sr_l3out bool
    status str
    template_count float
    type str
    urls Sequence[str]
    username str
    version str
    apicSiteId String
    cloudProviders List<String>
    groupId String
    id String
    labels List<String>
    location Map<String>
    name String
    password String
    proxy Boolean
    reprovision Boolean
    srL3out Boolean
    status String
    templateCount Number
    type String
    urls List<String>
    username String
    version String

    Package Details

    Repository
    mso ciscodevnet/terraform-provider-mso
    License
    Notes
    This Pulumi package is based on the mso Terraform Provider.
    mso logo
    mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet