Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getInterfaceOspfv3
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

iosxe.getInterfaceOspfv3

Explore with Pulumi AI

Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

This data source can read the Interface OSPFv3 configuration.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetInterfaceOspfv3.Invoke(new()
    {
        Name = "1",
        Type = "Loopback",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iosxe.LookupInterfaceOspfv3(ctx, &iosxe.LookupInterfaceOspfv3Args{
			Name: "1",
			Type: "Loopback",
		}, 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.iosxe.IosxeFunctions;
import com.pulumi.iosxe.inputs.GetInterfaceOspfv3Args;
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 = IosxeFunctions.getInterfaceOspfv3(GetInterfaceOspfv3Args.builder()
            .name("1")
            .type("Loopback")
            .build());

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

const example = iosxe.getInterfaceOspfv3({
    name: "1",
    type: "Loopback",
});
Copy
import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_interface_ospfv3(name="1",
    type="Loopback")
Copy
variables:
  example:
    fn::invoke:
      Function: iosxe:getInterfaceOspfv3
      Arguments:
        name: '1'
        type: Loopback
Copy

Using getInterfaceOspfv3

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 getInterfaceOspfv3(args: GetInterfaceOspfv3Args, opts?: InvokeOptions): Promise<GetInterfaceOspfv3Result>
function getInterfaceOspfv3Output(args: GetInterfaceOspfv3OutputArgs, opts?: InvokeOptions): Output<GetInterfaceOspfv3Result>
Copy
def get_interface_ospfv3(device: Optional[str] = None,
                         name: Optional[str] = None,
                         type: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetInterfaceOspfv3Result
def get_interface_ospfv3_output(device: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         type: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetInterfaceOspfv3Result]
Copy
func LookupInterfaceOspfv3(ctx *Context, args *LookupInterfaceOspfv3Args, opts ...InvokeOption) (*LookupInterfaceOspfv3Result, error)
func LookupInterfaceOspfv3Output(ctx *Context, args *LookupInterfaceOspfv3OutputArgs, opts ...InvokeOption) LookupInterfaceOspfv3ResultOutput
Copy

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

public static class GetInterfaceOspfv3 
{
    public static Task<GetInterfaceOspfv3Result> InvokeAsync(GetInterfaceOspfv3Args args, InvokeOptions? opts = null)
    public static Output<GetInterfaceOspfv3Result> Invoke(GetInterfaceOspfv3InvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetInterfaceOspfv3Result> getInterfaceOspfv3(GetInterfaceOspfv3Args args, InvokeOptions options)
public static Output<GetInterfaceOspfv3Result> getInterfaceOspfv3(GetInterfaceOspfv3Args args, InvokeOptions options)
Copy
fn::invoke:
  function: iosxe:index/getInterfaceOspfv3:getInterfaceOspfv3
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Type This property is required. string
Interface type
Device string
A device name from the provider configuration.
Name This property is required. string
Type This property is required. string
Interface type
Device string
A device name from the provider configuration.
name This property is required. String
type This property is required. String
Interface type
device String
A device name from the provider configuration.
name This property is required. string
type This property is required. string
Interface type
device string
A device name from the provider configuration.
name This property is required. str
type This property is required. str
Interface type
device str
A device name from the provider configuration.
name This property is required. String
type This property is required. String
Interface type
device String
A device name from the provider configuration.

getInterfaceOspfv3 Result

The following output properties are available:

Cost int
Static route cost value of the interface
Id string
The path of the retrieved object.
Name string
NetworkTypeBroadcast bool
Specify OSPF broadcast multi-access network
NetworkTypeNonBroadcast bool
Specify OSPF NBMA network
NetworkTypePointToMultipoint bool
Specify OSPF point-to-multipoint network
NetworkTypePointToPoint bool
Specify OSPF point-to-point network
Type string
Interface type
Device string
A device name from the provider configuration.
Cost int
Static route cost value of the interface
Id string
The path of the retrieved object.
Name string
NetworkTypeBroadcast bool
Specify OSPF broadcast multi-access network
NetworkTypeNonBroadcast bool
Specify OSPF NBMA network
NetworkTypePointToMultipoint bool
Specify OSPF point-to-multipoint network
NetworkTypePointToPoint bool
Specify OSPF point-to-point network
Type string
Interface type
Device string
A device name from the provider configuration.
cost Integer
Static route cost value of the interface
id String
The path of the retrieved object.
name String
networkTypeBroadcast Boolean
Specify OSPF broadcast multi-access network
networkTypeNonBroadcast Boolean
Specify OSPF NBMA network
networkTypePointToMultipoint Boolean
Specify OSPF point-to-multipoint network
networkTypePointToPoint Boolean
Specify OSPF point-to-point network
type String
Interface type
device String
A device name from the provider configuration.
cost number
Static route cost value of the interface
id string
The path of the retrieved object.
name string
networkTypeBroadcast boolean
Specify OSPF broadcast multi-access network
networkTypeNonBroadcast boolean
Specify OSPF NBMA network
networkTypePointToMultipoint boolean
Specify OSPF point-to-multipoint network
networkTypePointToPoint boolean
Specify OSPF point-to-point network
type string
Interface type
device string
A device name from the provider configuration.
cost int
Static route cost value of the interface
id str
The path of the retrieved object.
name str
network_type_broadcast bool
Specify OSPF broadcast multi-access network
network_type_non_broadcast bool
Specify OSPF NBMA network
network_type_point_to_multipoint bool
Specify OSPF point-to-multipoint network
network_type_point_to_point bool
Specify OSPF point-to-point network
type str
Interface type
device str
A device name from the provider configuration.
cost Number
Static route cost value of the interface
id String
The path of the retrieved object.
name String
networkTypeBroadcast Boolean
Specify OSPF broadcast multi-access network
networkTypeNonBroadcast Boolean
Specify OSPF NBMA network
networkTypePointToMultipoint Boolean
Specify OSPF point-to-multipoint network
networkTypePointToPoint Boolean
Specify OSPF point-to-point network
type String
Interface type
device String
A device name from the provider configuration.

Package Details

Repository
iosxe lbrlabs/pulumi-iosxe
License
Apache-2.0
Notes
This Pulumi package is based on the iosxe Terraform Provider.
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe