1. Packages
  2. Netbox Provider
  3. API Docs
  4. getSite
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

netbox.getSite

Explore with Pulumi AI

netbox logo
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const getByName = netbox.getSite({
        name: "Example Site 1",
    });
    const getBySlug = netbox.getSite({
        slug: "example-site-1",
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    get_by_name = netbox.get_site(name="Example Site 1")
    get_by_slug = netbox.get_site(slug="example-site-1")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v3/netbox"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := netbox.LookupSite(ctx, &netbox.LookupSiteArgs{
    			Name: pulumi.StringRef("Example Site 1"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = netbox.LookupSite(ctx, &netbox.LookupSiteArgs{
    			Slug: pulumi.StringRef("example-site-1"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Netbox = Pulumi.Netbox;
    
    return await Deployment.RunAsync(() => 
    {
        var getByName = Netbox.GetSite.Invoke(new()
        {
            Name = "Example Site 1",
        });
    
        var getBySlug = Netbox.GetSite.Invoke(new()
        {
            Slug = "example-site-1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.netbox.NetboxFunctions;
    import com.pulumi.netbox.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 getByName = NetboxFunctions.getSite(GetSiteArgs.builder()
                .name("Example Site 1")
                .build());
    
            final var getBySlug = NetboxFunctions.getSite(GetSiteArgs.builder()
                .slug("example-site-1")
                .build());
    
        }
    }
    
    variables:
      getByName:
        fn::invoke:
          function: netbox:getSite
          arguments:
            name: Example Site 1
      getBySlug:
        fn::invoke:
          function: netbox:getSite
          arguments:
            slug: example-site-1
    

    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(facility: Optional[str] = None,
                 id: Optional[str] = None,
                 name: Optional[str] = None,
                 slug: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSiteResult
    def get_site_output(facility: Optional[pulumi.Input[str]] = None,
                 id: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 slug: 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: netbox:index/getSite:getSite
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Facility string
    Id string
    The ID of this resource.
    Name string
    Slug string
    Facility string
    Id string
    The ID of this resource.
    Name string
    Slug string
    facility String
    id String
    The ID of this resource.
    name String
    slug String
    facility string
    id string
    The ID of this resource.
    name string
    slug string
    facility str
    id str
    The ID of this resource.
    name str
    slug str
    facility String
    id String
    The ID of this resource.
    name String
    slug String

    getSite Result

    The following output properties are available:

    AsnIds List<double>
    Comments string
    Description string
    Facility string
    GroupId double
    Id string
    The ID of this resource.
    Name string
    RegionId double
    SiteId double
    Slug string
    Status string
    TenantId double
    TimeZone string
    AsnIds []float64
    Comments string
    Description string
    Facility string
    GroupId float64
    Id string
    The ID of this resource.
    Name string
    RegionId float64
    SiteId float64
    Slug string
    Status string
    TenantId float64
    TimeZone string
    asnIds List<Double>
    comments String
    description String
    facility String
    groupId Double
    id String
    The ID of this resource.
    name String
    regionId Double
    siteId Double
    slug String
    status String
    tenantId Double
    timeZone String
    asnIds number[]
    comments string
    description string
    facility string
    groupId number
    id string
    The ID of this resource.
    name string
    regionId number
    siteId number
    slug string
    status string
    tenantId number
    timeZone string
    asn_ids Sequence[float]
    comments str
    description str
    facility str
    group_id float
    id str
    The ID of this resource.
    name str
    region_id float
    site_id float
    slug str
    status str
    tenant_id float
    time_zone str
    asnIds List<Number>
    comments String
    description String
    facility String
    groupId Number
    id String
    The ID of this resource.
    name String
    regionId Number
    siteId Number
    slug String
    status String
    tenantId Number
    timeZone String

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox logo
    netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger