Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. getOspfVrf
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.getOspfVrf

Explore with Pulumi AI

Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

This data source can read the OSPF VRF configuration.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetOspfVrf.Invoke(new()
    {
        InstanceName = "OSPF1",
        Name = "VRF1",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nxos.LookupOspfVrf(ctx, &nxos.LookupOspfVrfArgs{
			InstanceName: "OSPF1",
			Name:         "VRF1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nxos.NxosFunctions;
import com.pulumi.nxos.inputs.GetOspfVrfArgs;
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 = NxosFunctions.getOspfVrf(GetOspfVrfArgs.builder()
            .instanceName("OSPF1")
            .name("VRF1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as nxos from "@pulumi/nxos";

const example = nxos.getOspfVrf({
    instanceName: "OSPF1",
    name: "VRF1",
});
Copy
import pulumi
import pulumi_nxos as nxos

example = nxos.get_ospf_vrf(instance_name="OSPF1",
    name="VRF1")
Copy
variables:
  example:
    fn::invoke:
      Function: nxos:getOspfVrf
      Arguments:
        instanceName: OSPF1
        name: VRF1
Copy

Using getOspfVrf

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 getOspfVrf(args: GetOspfVrfArgs, opts?: InvokeOptions): Promise<GetOspfVrfResult>
function getOspfVrfOutput(args: GetOspfVrfOutputArgs, opts?: InvokeOptions): Output<GetOspfVrfResult>
Copy
def get_ospf_vrf(device: Optional[str] = None,
                 instance_name: Optional[str] = None,
                 name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetOspfVrfResult
def get_ospf_vrf_output(device: Optional[pulumi.Input[str]] = None,
                 instance_name: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetOspfVrfResult]
Copy
func LookupOspfVrf(ctx *Context, args *LookupOspfVrfArgs, opts ...InvokeOption) (*LookupOspfVrfResult, error)
func LookupOspfVrfOutput(ctx *Context, args *LookupOspfVrfOutputArgs, opts ...InvokeOption) LookupOspfVrfResultOutput
Copy

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

public static class GetOspfVrf 
{
    public static Task<GetOspfVrfResult> InvokeAsync(GetOspfVrfArgs args, InvokeOptions? opts = null)
    public static Output<GetOspfVrfResult> Invoke(GetOspfVrfInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOspfVrfResult> getOspfVrf(GetOspfVrfArgs args, InvokeOptions options)
public static Output<GetOspfVrfResult> getOspfVrf(GetOspfVrfArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nxos:index/getOspfVrf:getOspfVrf
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceName This property is required. string
OSPF instance name.
Name This property is required. string
VRF name.
Device string
A device name from the provider configuration.
InstanceName This property is required. string
OSPF instance name.
Name This property is required. string
VRF name.
Device string
A device name from the provider configuration.
instanceName This property is required. String
OSPF instance name.
name This property is required. String
VRF name.
device String
A device name from the provider configuration.
instanceName This property is required. string
OSPF instance name.
name This property is required. string
VRF name.
device string
A device name from the provider configuration.
instance_name This property is required. str
OSPF instance name.
name This property is required. str
VRF name.
device str
A device name from the provider configuration.
instanceName This property is required. String
OSPF instance name.
name This property is required. String
VRF name.
device String
A device name from the provider configuration.

getOspfVrf Result

The following output properties are available:

AdminState string
Administrative state.
BandwidthReference int
Bandwidth reference value.
BanwidthReferenceUnit string
Bandwidth reference unit.
Distance int
Administrative distance preference.
Id string
The distinguished name of the object.
InstanceName string
OSPF instance name.
Name string
VRF name.
RouterId string
Router ID.
Device string
A device name from the provider configuration.
AdminState string
Administrative state.
BandwidthReference int
Bandwidth reference value.
BanwidthReferenceUnit string
Bandwidth reference unit.
Distance int
Administrative distance preference.
Id string
The distinguished name of the object.
InstanceName string
OSPF instance name.
Name string
VRF name.
RouterId string
Router ID.
Device string
A device name from the provider configuration.
adminState String
Administrative state.
bandwidthReference Integer
Bandwidth reference value.
banwidthReferenceUnit String
Bandwidth reference unit.
distance Integer
Administrative distance preference.
id String
The distinguished name of the object.
instanceName String
OSPF instance name.
name String
VRF name.
routerId String
Router ID.
device String
A device name from the provider configuration.
adminState string
Administrative state.
bandwidthReference number
Bandwidth reference value.
banwidthReferenceUnit string
Bandwidth reference unit.
distance number
Administrative distance preference.
id string
The distinguished name of the object.
instanceName string
OSPF instance name.
name string
VRF name.
routerId string
Router ID.
device string
A device name from the provider configuration.
admin_state str
Administrative state.
bandwidth_reference int
Bandwidth reference value.
banwidth_reference_unit str
Bandwidth reference unit.
distance int
Administrative distance preference.
id str
The distinguished name of the object.
instance_name str
OSPF instance name.
name str
VRF name.
router_id str
Router ID.
device str
A device name from the provider configuration.
adminState String
Administrative state.
bandwidthReference Number
Bandwidth reference value.
banwidthReferenceUnit String
Bandwidth reference unit.
distance Number
Administrative distance preference.
id String
The distinguished name of the object.
instanceName String
OSPF instance name.
name String
VRF name.
routerId String
Router ID.
device String
A device name from the provider configuration.

Package Details

Repository
nxos lbrlabs/pulumi-nxos
License
Apache-2.0
Notes
This Pulumi package is based on the nxos Terraform Provider.
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos