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

netbox.getVrf

Explore with Pulumi AI

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 custAProd = netbox.getVrf({
    name: "cust-a-prod",
});
Copy
import pulumi
import pulumi_netbox as netbox

cust_a_prod = netbox.get_vrf(name="cust-a-prod")
Copy
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.LookupVrf(ctx, &netbox.LookupVrfArgs{
			Name: "cust-a-prod",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;

return await Deployment.RunAsync(() => 
{
    var custAProd = Netbox.GetVrf.Invoke(new()
    {
        Name = "cust-a-prod",
    });

});
Copy
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.GetVrfArgs;
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 custAProd = NetboxFunctions.getVrf(GetVrfArgs.builder()
            .name("cust-a-prod")
            .build());

    }
}
Copy
variables:
  custAProd:
    fn::invoke:
      function: netbox:getVrf
      arguments:
        name: cust-a-prod
Copy

Using getVrf

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 getVrf(args: GetVrfArgs, opts?: InvokeOptions): Promise<GetVrfResult>
function getVrfOutput(args: GetVrfOutputArgs, opts?: InvokeOptions): Output<GetVrfResult>
Copy
def get_vrf(id: Optional[str] = None,
            name: Optional[str] = None,
            tenant_id: Optional[float] = None,
            opts: Optional[InvokeOptions] = None) -> GetVrfResult
def get_vrf_output(id: Optional[pulumi.Input[str]] = None,
            name: Optional[pulumi.Input[str]] = None,
            tenant_id: Optional[pulumi.Input[float]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetVrfResult]
Copy
func LookupVrf(ctx *Context, args *LookupVrfArgs, opts ...InvokeOption) (*LookupVrfResult, error)
func LookupVrfOutput(ctx *Context, args *LookupVrfOutputArgs, opts ...InvokeOption) LookupVrfResultOutput
Copy

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

public static class GetVrf 
{
    public static Task<GetVrfResult> InvokeAsync(GetVrfArgs args, InvokeOptions? opts = null)
    public static Output<GetVrfResult> Invoke(GetVrfInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVrfResult> getVrf(GetVrfArgs args, InvokeOptions options)
public static Output<GetVrfResult> getVrf(GetVrfArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: netbox:index/getVrf:getVrf
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Id string
The ID of this resource.
TenantId double
Name This property is required. string
Id string
The ID of this resource.
TenantId float64
name This property is required. String
id String
The ID of this resource.
tenantId Double
name This property is required. string
id string
The ID of this resource.
tenantId number
name This property is required. str
id str
The ID of this resource.
tenant_id float
name This property is required. String
id String
The ID of this resource.
tenantId Number

getVrf Result

The following output properties are available:

Id string
The ID of this resource.
Name string
TenantId double
Id string
The ID of this resource.
Name string
TenantId float64
id String
The ID of this resource.
name String
tenantId Double
id string
The ID of this resource.
name string
tenantId number
id str
The ID of this resource.
name str
tenant_id float
id String
The ID of this resource.
name String
tenantId Number

Package Details

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