Docs Packages
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. getOspfInstance
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.getOspfInstance

Explore with Pulumi AI

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

    This data source can read the OSPF instance configuration.

    Example Usage

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

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

});

    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.LookupOspfInstance(ctx, &nxos.LookupOspfInstanceArgs{
			Name: "OSPF1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    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.GetOspfInstanceArgs;
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.getOspfInstance(GetOspfInstanceArgs.builder()
            .name("OSPF1")
            .build());

    }
}

    import pulumi
import pulumi_nxos as nxos

example = nxos.get_ospf_instance(name="OSPF1")

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

const example = nxos.getOspfInstance({
    name: "OSPF1",
});

    variables:
  example:
    fn::invoke:
      Function: nxos:getOspfInstance
      Arguments:
        name: OSPF1

    Using getOspfInstance

    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 getOspfInstance(args: GetOspfInstanceArgs, opts?: InvokeOptions): Promise<GetOspfInstanceResult>
function getOspfInstanceOutput(args: GetOspfInstanceOutputArgs, opts?: InvokeOptions): Output<GetOspfInstanceResult>
    def get_ospf_instance(device: Optional[str] = None,
                      name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetOspfInstanceResult
def get_ospf_instance_output(device: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetOspfInstanceResult]
    func LookupOspfInstance(ctx *Context, args *LookupOspfInstanceArgs, opts ...InvokeOption) (*LookupOspfInstanceResult, error)
func LookupOspfInstanceOutput(ctx *Context, args *LookupOspfInstanceOutputArgs, opts ...InvokeOption) LookupOspfInstanceResultOutput

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

    public static class GetOspfInstance 
{
    public static Task<GetOspfInstanceResult> InvokeAsync(GetOspfInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetOspfInstanceResult> Invoke(GetOspfInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOspfInstanceResult> getOspfInstance(GetOspfInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: nxos:index/getOspfInstance:getOspfInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    OSPF instance name.
    Device string
    A device name from the provider configuration.
    Name string
    OSPF instance name.
    Device string
    A device name from the provider configuration.
    name String
    OSPF instance name.
    device String
    A device name from the provider configuration.
    name string
    OSPF instance name.
    device string
    A device name from the provider configuration.
    name str
    OSPF instance name.
    device str
    A device name from the provider configuration.
    name String
    OSPF instance name.
    device String
    A device name from the provider configuration.

    getOspfInstance Result

    The following output properties are available:

    AdminState string
    Administrative state.
    Id string
    The distinguished name of the object.
    Name string
    OSPF instance name.
    Device string
    A device name from the provider configuration.
    AdminState string
    Administrative state.
    Id string
    The distinguished name of the object.
    Name string
    OSPF instance name.
    Device string
    A device name from the provider configuration.
    adminState String
    Administrative state.
    id String
    The distinguished name of the object.
    name String
    OSPF instance name.
    device String
    A device name from the provider configuration.
    adminState string
    Administrative state.
    id string
    The distinguished name of the object.
    name string
    OSPF instance name.
    device string
    A device name from the provider configuration.
    admin_state str
    Administrative state.
    id str
    The distinguished name of the object.
    name str
    OSPF instance name.
    device str
    A device name from the provider configuration.
    adminState String
    Administrative state.
    id String
    The distinguished name of the object.
    name String
    OSPF instance 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.
    nxos logo
    Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
    lbrlabs/pulumi-nxos