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

nxos.getOspfArea

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 Area configuration.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetOspfArea.Invoke(new()
    {
        AreaId = "0.0.0.10",
        InstanceName = "OSPF1",
        VrfName = "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.LookupOspfArea(ctx, &nxos.LookupOspfAreaArgs{
			AreaId:       "0.0.0.10",
			InstanceName: "OSPF1",
			VrfName:      "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.GetOspfAreaArgs;
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.getOspfArea(GetOspfAreaArgs.builder()
            .areaId("0.0.0.10")
            .instanceName("OSPF1")
            .vrfName("VRF1")
            .build());

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

const example = nxos.getOspfArea({
    areaId: "0.0.0.10",
    instanceName: "OSPF1",
    vrfName: "VRF1",
});
Copy
import pulumi
import pulumi_nxos as nxos

example = nxos.get_ospf_area(area_id="0.0.0.10",
    instance_name="OSPF1",
    vrf_name="VRF1")
Copy
variables:
  example:
    fn::invoke:
      Function: nxos:getOspfArea
      Arguments:
        areaId: 0.0.0.10
        instanceName: OSPF1
        vrfName: VRF1
Copy

Using getOspfArea

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 getOspfArea(args: GetOspfAreaArgs, opts?: InvokeOptions): Promise<GetOspfAreaResult>
function getOspfAreaOutput(args: GetOspfAreaOutputArgs, opts?: InvokeOptions): Output<GetOspfAreaResult>
Copy
def get_ospf_area(area_id: Optional[str] = None,
                  device: Optional[str] = None,
                  instance_name: Optional[str] = None,
                  vrf_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetOspfAreaResult
def get_ospf_area_output(area_id: Optional[pulumi.Input[str]] = None,
                  device: Optional[pulumi.Input[str]] = None,
                  instance_name: Optional[pulumi.Input[str]] = None,
                  vrf_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetOspfAreaResult]
Copy
func LookupOspfArea(ctx *Context, args *LookupOspfAreaArgs, opts ...InvokeOption) (*LookupOspfAreaResult, error)
func LookupOspfAreaOutput(ctx *Context, args *LookupOspfAreaOutputArgs, opts ...InvokeOption) LookupOspfAreaResultOutput
Copy

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

public static class GetOspfArea 
{
    public static Task<GetOspfAreaResult> InvokeAsync(GetOspfAreaArgs args, InvokeOptions? opts = null)
    public static Output<GetOspfAreaResult> Invoke(GetOspfAreaInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOspfAreaResult> getOspfArea(GetOspfAreaArgs args, InvokeOptions options)
public static Output<GetOspfAreaResult> getOspfArea(GetOspfAreaArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nxos:index/getOspfArea:getOspfArea
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AreaId This property is required. string
Area identifier to which a network or interface belongs in IPv4 address format.
InstanceName This property is required. string
OSPF instance name.
VrfName This property is required. string
VRF name.
Device string
A device name from the provider configuration.
AreaId This property is required. string
Area identifier to which a network or interface belongs in IPv4 address format.
InstanceName This property is required. string
OSPF instance name.
VrfName This property is required. string
VRF name.
Device string
A device name from the provider configuration.
areaId This property is required. String
Area identifier to which a network or interface belongs in IPv4 address format.
instanceName This property is required. String
OSPF instance name.
vrfName This property is required. String
VRF name.
device String
A device name from the provider configuration.
areaId This property is required. string
Area identifier to which a network or interface belongs in IPv4 address format.
instanceName This property is required. string
OSPF instance name.
vrfName This property is required. string
VRF name.
device string
A device name from the provider configuration.
area_id This property is required. str
Area identifier to which a network or interface belongs in IPv4 address format.
instance_name This property is required. str
OSPF instance name.
vrf_name This property is required. str
VRF name.
device str
A device name from the provider configuration.
areaId This property is required. String
Area identifier to which a network or interface belongs in IPv4 address format.
instanceName This property is required. String
OSPF instance name.
vrfName This property is required. String
VRF name.
device String
A device name from the provider configuration.

getOspfArea Result

The following output properties are available:

AreaId string
Area identifier to which a network or interface belongs in IPv4 address format.
AuthenticationType string
Authentication type.
Cost int
Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types.
Id string
The distinguished name of the object.
InstanceName string
OSPF instance name.
Type string
Area type.
VrfName string
VRF name.
Device string
A device name from the provider configuration.
AreaId string
Area identifier to which a network or interface belongs in IPv4 address format.
AuthenticationType string
Authentication type.
Cost int
Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types.
Id string
The distinguished name of the object.
InstanceName string
OSPF instance name.
Type string
Area type.
VrfName string
VRF name.
Device string
A device name from the provider configuration.
areaId String
Area identifier to which a network or interface belongs in IPv4 address format.
authenticationType String
Authentication type.
cost Integer
Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types.
id String
The distinguished name of the object.
instanceName String
OSPF instance name.
type String
Area type.
vrfName String
VRF name.
device String
A device name from the provider configuration.
areaId string
Area identifier to which a network or interface belongs in IPv4 address format.
authenticationType string
Authentication type.
cost number
Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types.
id string
The distinguished name of the object.
instanceName string
OSPF instance name.
type string
Area type.
vrfName string
VRF name.
device string
A device name from the provider configuration.
area_id str
Area identifier to which a network or interface belongs in IPv4 address format.
authentication_type str
Authentication type.
cost int
Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types.
id str
The distinguished name of the object.
instance_name str
OSPF instance name.
type str
Area type.
vrf_name str
VRF name.
device str
A device name from the provider configuration.
areaId String
Area identifier to which a network or interface belongs in IPv4 address format.
authenticationType String
Authentication type.
cost Number
Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types.
id String
The distinguished name of the object.
instanceName String
OSPF instance name.
type String
Area type.
vrfName String
VRF name.
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