nxos.getOspfInterface

Explore with Pulumi AI

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

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetOspfInterface.Invoke(new()
    {
        InstanceName = "OSPF1",
        InterfaceId = "eth1/10",
        VrfName = "VRF1",
    });

});

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.LookupOspfInterface(ctx, &nxos.LookupOspfInterfaceArgs{
			InstanceName: "OSPF1",
			InterfaceId:  "eth1/10",
			VrfName:      "VRF1",
		}, 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.GetOspfInterfaceArgs;
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.getOspfInterface(GetOspfInterfaceArgs.builder()
            .instanceName("OSPF1")
            .interfaceId("eth1/10")
            .vrfName("VRF1")
            .build());

    }
}

import pulumi
import pulumi_nxos as nxos

example = nxos.get_ospf_interface(instance_name="OSPF1",
    interface_id="eth1/10",
    vrf_name="VRF1")

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

const example = nxos.getOspfInterface({
    instanceName: "OSPF1",
    interfaceId: "eth1/10",
    vrfName: "VRF1",
});

variables:
  example:
    fn::invoke:
      Function: nxos:getOspfInterface
      Arguments:
        instanceName: OSPF1
        interfaceId: eth1/10
        vrfName: VRF1

Using getOspfInterface

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 getOspfInterface(args: GetOspfInterfaceArgs, opts?: InvokeOptions): Promise<GetOspfInterfaceResult>
function getOspfInterfaceOutput(args: GetOspfInterfaceOutputArgs, opts?: InvokeOptions): Output<GetOspfInterfaceResult>

def get_ospf_interface(device: Optional[str] = None,
                       instance_name: Optional[str] = None,
                       interface_id: Optional[str] = None,
                       vrf_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetOspfInterfaceResult
def get_ospf_interface_output(device: Optional[pulumi.Input[str]] = None,
                       instance_name: Optional[pulumi.Input[str]] = None,
                       interface_id: Optional[pulumi.Input[str]] = None,
                       vrf_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetOspfInterfaceResult]

func LookupOspfInterface(ctx *Context, args *LookupOspfInterfaceArgs, opts ...InvokeOption) (*LookupOspfInterfaceResult, error)
func LookupOspfInterfaceOutput(ctx *Context, args *LookupOspfInterfaceOutputArgs, opts ...InvokeOption) LookupOspfInterfaceResultOutput

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

public static class GetOspfInterface 
{
    public static Task<GetOspfInterfaceResult> InvokeAsync(GetOspfInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetOspfInterfaceResult> Invoke(GetOspfInterfaceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOspfInterfaceResult> getOspfInterface(GetOspfInterfaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

InstanceName string: OSPF instance name.
InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
VrfName string: VRF name.
Device string: A device name from the provider configuration.

InstanceName string: OSPF instance name.
InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
VrfName string: VRF name.
Device string: A device name from the provider configuration.

instanceName String: OSPF instance name.
interfaceId String: Must match first field in the output of show intf brief. Example: eth1/1.
vrfName String: VRF name.
device String: A device name from the provider configuration.

instanceName string: OSPF instance name.
interfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
vrfName string: VRF name.
device string: A device name from the provider configuration.

instance_name str: OSPF instance name.
interface_id str: Must match first field in the output of show intf brief. Example: eth1/1.
vrf_name str: VRF name.
device str: A device name from the provider configuration.

instanceName String: OSPF instance name.
interfaceId String: Must match first field in the output of show intf brief. Example: eth1/1.
vrfName String: VRF name.
device String: A device name from the provider configuration.

getOspfInterface Result

The following output properties are available:

AdvertiseSecondaries bool: Advertise secondary IP addresses.
Area string: Area identifier to which a network or interface belongs in IPv4 address format.
Bfd string: Bidirectional Forwarding Detection (BFD).
Cost int: Specifies the cost of interface.
DeadInterval int: Dead interval, interval after which router declares that neighbor as down.
HelloInterval int: Hello interval, interval between hello packets that OSPF sends on the interface.
Id string: The distinguished name of the object.
InstanceName string: OSPF instance name.
InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
NetworkType string: Network type.
Passive string: Passive interface control. Interface can be configured as passive or non-passive.
Priority int: Priority, used in determining the designated router on this network.
VrfName string: VRF name.
Device string: A device name from the provider configuration.

AdvertiseSecondaries bool: Advertise secondary IP addresses.
Area string: Area identifier to which a network or interface belongs in IPv4 address format.
Bfd string: Bidirectional Forwarding Detection (BFD).
Cost int: Specifies the cost of interface.
DeadInterval int: Dead interval, interval after which router declares that neighbor as down.
HelloInterval int: Hello interval, interval between hello packets that OSPF sends on the interface.
Id string: The distinguished name of the object.
InstanceName string: OSPF instance name.
InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
NetworkType string: Network type.
Passive string: Passive interface control. Interface can be configured as passive or non-passive.
Priority int: Priority, used in determining the designated router on this network.
VrfName string: VRF name.
Device string: A device name from the provider configuration.

advertiseSecondaries Boolean: Advertise secondary IP addresses.
area String: Area identifier to which a network or interface belongs in IPv4 address format.
bfd String: Bidirectional Forwarding Detection (BFD).
cost Integer: Specifies the cost of interface.
deadInterval Integer: Dead interval, interval after which router declares that neighbor as down.
helloInterval Integer: Hello interval, interval between hello packets that OSPF sends on the interface.
id String: The distinguished name of the object.
instanceName String: OSPF instance name.
interfaceId String: Must match first field in the output of show intf brief. Example: eth1/1.
networkType String: Network type.
passive String: Passive interface control. Interface can be configured as passive or non-passive.
priority Integer: Priority, used in determining the designated router on this network.
vrfName String: VRF name.
device String: A device name from the provider configuration.

advertiseSecondaries boolean: Advertise secondary IP addresses.
area string: Area identifier to which a network or interface belongs in IPv4 address format.
bfd string: Bidirectional Forwarding Detection (BFD).
cost number: Specifies the cost of interface.
deadInterval number: Dead interval, interval after which router declares that neighbor as down.
helloInterval number: Hello interval, interval between hello packets that OSPF sends on the interface.
id string: The distinguished name of the object.
instanceName string: OSPF instance name.
interfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
networkType string: Network type.
passive string: Passive interface control. Interface can be configured as passive or non-passive.
priority number: Priority, used in determining the designated router on this network.
vrfName string: VRF name.
device string: A device name from the provider configuration.

advertise_secondaries bool: Advertise secondary IP addresses.
area str: Area identifier to which a network or interface belongs in IPv4 address format.
bfd str: Bidirectional Forwarding Detection (BFD).
cost int: Specifies the cost of interface.
dead_interval int: Dead interval, interval after which router declares that neighbor as down.
hello_interval int: Hello interval, interval between hello packets that OSPF sends on the interface.
id str: The distinguished name of the object.
instance_name str: OSPF instance name.
interface_id str: Must match first field in the output of show intf brief. Example: eth1/1.
network_type str: Network type.
passive str: Passive interface control. Interface can be configured as passive or non-passive.
priority int: Priority, used in determining the designated router on this network.
vrf_name str: VRF name.
device str: A device name from the provider configuration.

advertiseSecondaries Boolean: Advertise secondary IP addresses.
area String: Area identifier to which a network or interface belongs in IPv4 address format.
bfd String: Bidirectional Forwarding Detection (BFD).
cost Number: Specifies the cost of interface.
deadInterval Number: Dead interval, interval after which router declares that neighbor as down.
helloInterval Number: Hello interval, interval between hello packets that OSPF sends on the interface.
id String: The distinguished name of the object.
instanceName String: OSPF instance name.
interfaceId String: Must match first field in the output of show intf brief. Example: eth1/1.
networkType String: Network type.
passive String: Passive interface control. Interface can be configured as passive or non-passive.
priority Number: Priority, used in determining the designated router on this network.
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

nxos.getOspfInterface

On this page

On this page

Example Usage

Using getOspfInterface

getOspfInterface Result

Package Details

On this page

On this page