1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getInterfaceOspf
Viewing docs for Cisco IOS XE v0.0.1
published on Friday, Sep 22, 2023 by lbrlabs
Schema (JSON)
lbrlabs/pulumi-iosxe

iosxe.getInterfaceOspf

iosxe logo
Viewing docs for Cisco IOS XE v0.0.1
published on Friday, Sep 22, 2023 by lbrlabs
Schema (JSON)
lbrlabs/pulumi-iosxe

    This data source can read the Interface OSPF configuration.

    Example Usage

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

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

});

    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.LookupInterfaceOspf(ctx, &iosxe.LookupInterfaceOspfArgs{
			Name: "1",
			Type: "Loopback",
		}, 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.iosxe.IosxeFunctions;
import com.pulumi.iosxe.inputs.GetInterfaceOspfArgs;
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.getInterfaceOspf(GetInterfaceOspfArgs.builder()
            .name("1")
            .type("Loopback")
            .build());

    }
}

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

const example = iosxe.getInterfaceOspf({
    name: "1",
    type: "Loopback",
});

    import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_interface_ospf(name="1",
    type="Loopback")

    variables:
  example:
    fn::invoke:
      Function: iosxe:getInterfaceOspf
      Arguments:
        name: '1'
        type: Loopback

    Using getInterfaceOspf

    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 getInterfaceOspf(args: GetInterfaceOspfArgs, opts?: InvokeOptions): Promise<GetInterfaceOspfResult>
function getInterfaceOspfOutput(args: GetInterfaceOspfOutputArgs, opts?: InvokeOptions): Output<GetInterfaceOspfResult>
    def get_interface_ospf(device: Optional[str] = None,
                       name: Optional[str] = None,
                       type: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetInterfaceOspfResult
def get_interface_ospf_output(device: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       type: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetInterfaceOspfResult]
    func LookupInterfaceOspf(ctx *Context, args *LookupInterfaceOspfArgs, opts ...InvokeOption) (*LookupInterfaceOspfResult, error)
func LookupInterfaceOspfOutput(ctx *Context, args *LookupInterfaceOspfOutputArgs, opts ...InvokeOption) LookupInterfaceOspfResultOutput

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

    public static class GetInterfaceOspf 
{
    public static Task<GetInterfaceOspfResult> InvokeAsync(GetInterfaceOspfArgs args, InvokeOptions? opts = null)
    public static Output<GetInterfaceOspfResult> Invoke(GetInterfaceOspfInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInterfaceOspfResult> getInterfaceOspf(GetInterfaceOspfArgs args, InvokeOptions options)
public static Output<GetInterfaceOspfResult> getInterfaceOspf(GetInterfaceOspfArgs args, InvokeOptions options)

    fn::invoke:
  function: iosxe:index/getInterfaceOspf:getInterfaceOspf
  arguments:
    # arguments dictionary

    The following arguments are supported:

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

    getInterfaceOspf Result

    The following output properties are available:

    Cost int
    Route cost of this interface
    DeadInterval int
    Interval after which a neighbor is declared dead
    HelloInterval int
    Time between HELLO packets
    Id string
    The path of the retrieved object.
    MessageDigestKeys List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetInterfaceOspfMessageDigestKey>
    Message digest authentication password (key)
    MtuIgnore bool
    Ignores the MTU in DBD packets
    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
    Priority int
    Router priority
    ProcessIds List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetInterfaceOspfProcessId>
    TtlSecurityHops int
    IP hops
    Type string
    Interface type
    Device string
    A device name from the provider configuration.
    Cost int
    Route cost of this interface
    DeadInterval int
    Interval after which a neighbor is declared dead
    HelloInterval int
    Time between HELLO packets
    Id string
    The path of the retrieved object.
    MessageDigestKeys []GetInterfaceOspfMessageDigestKey
    Message digest authentication password (key)
    MtuIgnore bool
    Ignores the MTU in DBD packets
    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
    Priority int
    Router priority
    ProcessIds []GetInterfaceOspfProcessId
    TtlSecurityHops int
    IP hops
    Type string
    Interface type
    Device string
    A device name from the provider configuration.
    cost Integer
    Route cost of this interface
    deadInterval Integer
    Interval after which a neighbor is declared dead
    helloInterval Integer
    Time between HELLO packets
    id String
    The path of the retrieved object.
    messageDigestKeys List<GetInterfaceOspfMessageDigestKey>
    Message digest authentication password (key)
    mtuIgnore Boolean
    Ignores the MTU in DBD packets
    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
    priority Integer
    Router priority
    processIds List<GetInterfaceOspfProcessId>
    ttlSecurityHops Integer
    IP hops
    type String
    Interface type
    device String
    A device name from the provider configuration.
    cost number
    Route cost of this interface
    deadInterval number
    Interval after which a neighbor is declared dead
    helloInterval number
    Time between HELLO packets
    id string
    The path of the retrieved object.
    messageDigestKeys GetInterfaceOspfMessageDigestKey[]
    Message digest authentication password (key)
    mtuIgnore boolean
    Ignores the MTU in DBD packets
    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
    priority number
    Router priority
    processIds GetInterfaceOspfProcessId[]
    ttlSecurityHops number
    IP hops
    type string
    Interface type
    device string
    A device name from the provider configuration.
    cost int
    Route cost of this interface
    dead_interval int
    Interval after which a neighbor is declared dead
    hello_interval int
    Time between HELLO packets
    id str
    The path of the retrieved object.
    message_digest_keys Sequence[GetInterfaceOspfMessageDigestKey]
    Message digest authentication password (key)
    mtu_ignore bool
    Ignores the MTU in DBD packets
    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
    priority int
    Router priority
    process_ids Sequence[GetInterfaceOspfProcessId]
    ttl_security_hops int
    IP hops
    type str
    Interface type
    device str
    A device name from the provider configuration.
    cost Number
    Route cost of this interface
    deadInterval Number
    Interval after which a neighbor is declared dead
    helloInterval Number
    Time between HELLO packets
    id String
    The path of the retrieved object.
    messageDigestKeys List<Property Map>
    Message digest authentication password (key)
    mtuIgnore Boolean
    Ignores the MTU in DBD packets
    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
    priority Number
    Router priority
    processIds List<Property Map>
    ttlSecurityHops Number
    IP hops
    type String
    Interface type
    device String
    A device name from the provider configuration.

    Supporting Types

    GetInterfaceOspfMessageDigestKey

    Id int
    Key ID
    Md5AuthKey string
    The OSPF password (key) (only the first 16 characters are used)
    Md5AuthType int
    Encryption type (0 for not yet encrypted, 7 for proprietary)
    Id int
    Key ID
    Md5AuthKey string
    The OSPF password (key) (only the first 16 characters are used)
    Md5AuthType int
    Encryption type (0 for not yet encrypted, 7 for proprietary)
    id Integer
    Key ID
    md5AuthKey String
    The OSPF password (key) (only the first 16 characters are used)
    md5AuthType Integer
    Encryption type (0 for not yet encrypted, 7 for proprietary)
    id number
    Key ID
    md5AuthKey string
    The OSPF password (key) (only the first 16 characters are used)
    md5AuthType number
    Encryption type (0 for not yet encrypted, 7 for proprietary)
    id int
    Key ID
    md5_auth_key str
    The OSPF password (key) (only the first 16 characters are used)
    md5_auth_type int
    Encryption type (0 for not yet encrypted, 7 for proprietary)
    id Number
    Key ID
    md5AuthKey String
    The OSPF password (key) (only the first 16 characters are used)
    md5AuthType Number
    Encryption type (0 for not yet encrypted, 7 for proprietary)

    GetInterfaceOspfProcessId

    areas List<Property Map>
    id Number
    Process ID

    GetInterfaceOspfProcessIdArea

    AreaId string
    AreaId string
    areaId String
    areaId string
    areaId String

    Package Details

    Repository
    iosxe lbrlabs/pulumi-iosxe
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the iosxe Terraform Provider.
    iosxe logo
    Viewing docs for Cisco IOS XE v0.0.1
    published on Friday, Sep 22, 2023 by lbrlabs
    Schema (JSON)
    lbrlabs/pulumi-iosxe
      Try Pulumi Cloud free. Your team will thank you.