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

iosxe.getOspf

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

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetOspf.Invoke(new()
    {
        ProcessId = 1,
    });

});

    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.LookupOspf(ctx, &iosxe.LookupOspfArgs{
			ProcessId: 1,
		}, 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.GetOspfArgs;
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.getOspf(GetOspfArgs.builder()
            .processId(1)
            .build());

    }
}

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

const example = iosxe.getOspf({
    processId: 1,
});

    import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_ospf(process_id=1)

    variables:
  example:
    fn::invoke:
      Function: iosxe:getOspf
      Arguments:
        processId: 1

    Using getOspf

    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 getOspf(args: GetOspfArgs, opts?: InvokeOptions): Promise<GetOspfResult>
function getOspfOutput(args: GetOspfOutputArgs, opts?: InvokeOptions): Output<GetOspfResult>
    def get_ospf(device: Optional[str] = None,
             process_id: Optional[int] = None,
             opts: Optional[InvokeOptions] = None) -> GetOspfResult
def get_ospf_output(device: Optional[pulumi.Input[str]] = None,
             process_id: Optional[pulumi.Input[int]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetOspfResult]
    func LookupOspf(ctx *Context, args *LookupOspfArgs, opts ...InvokeOption) (*LookupOspfResult, error)
func LookupOspfOutput(ctx *Context, args *LookupOspfOutputArgs, opts ...InvokeOption) LookupOspfResultOutput

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

    public static class GetOspf 
{
    public static Task<GetOspfResult> InvokeAsync(GetOspfArgs args, InvokeOptions? opts = null)
    public static Output<GetOspfResult> Invoke(GetOspfInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOspfResult> getOspf(GetOspfArgs args, InvokeOptions options)
public static Output<GetOspfResult> getOspf(GetOspfArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ProcessId int
    Process ID
    Device string
    A device name from the provider configuration.
    ProcessId int
    Process ID
    Device string
    A device name from the provider configuration.
    processId Integer
    Process ID
    device String
    A device name from the provider configuration.
    processId number
    Process ID
    device string
    A device name from the provider configuration.
    process_id int
    Process ID
    device str
    A device name from the provider configuration.
    processId Number
    Process ID
    device String
    A device name from the provider configuration.

    getOspf Result

    The following output properties are available:

    Areas List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetOspfArea>
    OSPF area parameters
    BfdAllInterfaces bool
    Enable BFD on all interfaces
    DefaultInformationOriginate bool
    Distribute a default route
    DefaultInformationOriginateAlways bool
    Always advertise default route
    DefaultMetric int
    Set metric of redistributed routes
    Distance int
    Administrative distance
    DomainTag int
    OSPF domain-tag
    Id string
    The path of the retrieved object.
    MplsLdpAutoconfig bool
    Configure LDP automatic configuration
    MplsLdpSync bool
    Configure LDP-IGP Synchronization
    Neighbors List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetOspfNeighbor>
    Specify a neighbor router
    Networks List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetOspfNetwork>
    Enable routing on an IP network
    PassiveInterfaceDefault bool
    Suppress routing updates on all interfaces
    Priority int
    OSPF topology priority
    ProcessId int
    Process ID
    RouterId string
    Override configured router identifier (peers will reset)
    Shutdown bool
    Shutdown the OSPF protocol under the current instance
    SummaryAddresses List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetOspfSummaryAddress>
    Configure IP address summaries
    Device string
    A device name from the provider configuration.
    Areas []GetOspfArea
    OSPF area parameters
    BfdAllInterfaces bool
    Enable BFD on all interfaces
    DefaultInformationOriginate bool
    Distribute a default route
    DefaultInformationOriginateAlways bool
    Always advertise default route
    DefaultMetric int
    Set metric of redistributed routes
    Distance int
    Administrative distance
    DomainTag int
    OSPF domain-tag
    Id string
    The path of the retrieved object.
    MplsLdpAutoconfig bool
    Configure LDP automatic configuration
    MplsLdpSync bool
    Configure LDP-IGP Synchronization
    Neighbors []GetOspfNeighbor
    Specify a neighbor router
    Networks []GetOspfNetwork
    Enable routing on an IP network
    PassiveInterfaceDefault bool
    Suppress routing updates on all interfaces
    Priority int
    OSPF topology priority
    ProcessId int
    Process ID
    RouterId string
    Override configured router identifier (peers will reset)
    Shutdown bool
    Shutdown the OSPF protocol under the current instance
    SummaryAddresses []GetOspfSummaryAddress
    Configure IP address summaries
    Device string
    A device name from the provider configuration.
    areas List<GetOspfArea>
    OSPF area parameters
    bfdAllInterfaces Boolean
    Enable BFD on all interfaces
    defaultInformationOriginate Boolean
    Distribute a default route
    defaultInformationOriginateAlways Boolean
    Always advertise default route
    defaultMetric Integer
    Set metric of redistributed routes
    distance Integer
    Administrative distance
    domainTag Integer
    OSPF domain-tag
    id String
    The path of the retrieved object.
    mplsLdpAutoconfig Boolean
    Configure LDP automatic configuration
    mplsLdpSync Boolean
    Configure LDP-IGP Synchronization
    neighbors List<GetOspfNeighbor>
    Specify a neighbor router
    networks List<GetOspfNetwork>
    Enable routing on an IP network
    passiveInterfaceDefault Boolean
    Suppress routing updates on all interfaces
    priority Integer
    OSPF topology priority
    processId Integer
    Process ID
    routerId String
    Override configured router identifier (peers will reset)
    shutdown Boolean
    Shutdown the OSPF protocol under the current instance
    summaryAddresses List<GetOspfSummaryAddress>
    Configure IP address summaries
    device String
    A device name from the provider configuration.
    areas GetOspfArea[]
    OSPF area parameters
    bfdAllInterfaces boolean
    Enable BFD on all interfaces
    defaultInformationOriginate boolean
    Distribute a default route
    defaultInformationOriginateAlways boolean
    Always advertise default route
    defaultMetric number
    Set metric of redistributed routes
    distance number
    Administrative distance
    domainTag number
    OSPF domain-tag
    id string
    The path of the retrieved object.
    mplsLdpAutoconfig boolean
    Configure LDP automatic configuration
    mplsLdpSync boolean
    Configure LDP-IGP Synchronization
    neighbors GetOspfNeighbor[]
    Specify a neighbor router
    networks GetOspfNetwork[]
    Enable routing on an IP network
    passiveInterfaceDefault boolean
    Suppress routing updates on all interfaces
    priority number
    OSPF topology priority
    processId number
    Process ID
    routerId string
    Override configured router identifier (peers will reset)
    shutdown boolean
    Shutdown the OSPF protocol under the current instance
    summaryAddresses GetOspfSummaryAddress[]
    Configure IP address summaries
    device string
    A device name from the provider configuration.
    areas Sequence[GetOspfArea]
    OSPF area parameters
    bfd_all_interfaces bool
    Enable BFD on all interfaces
    default_information_originate bool
    Distribute a default route
    default_information_originate_always bool
    Always advertise default route
    default_metric int
    Set metric of redistributed routes
    distance int
    Administrative distance
    domain_tag int
    OSPF domain-tag
    id str
    The path of the retrieved object.
    mpls_ldp_autoconfig bool
    Configure LDP automatic configuration
    mpls_ldp_sync bool
    Configure LDP-IGP Synchronization
    neighbors Sequence[GetOspfNeighbor]
    Specify a neighbor router
    networks Sequence[GetOspfNetwork]
    Enable routing on an IP network
    passive_interface_default bool
    Suppress routing updates on all interfaces
    priority int
    OSPF topology priority
    process_id int
    Process ID
    router_id str
    Override configured router identifier (peers will reset)
    shutdown bool
    Shutdown the OSPF protocol under the current instance
    summary_addresses Sequence[GetOspfSummaryAddress]
    Configure IP address summaries
    device str
    A device name from the provider configuration.
    areas List<Property Map>
    OSPF area parameters
    bfdAllInterfaces Boolean
    Enable BFD on all interfaces
    defaultInformationOriginate Boolean
    Distribute a default route
    defaultInformationOriginateAlways Boolean
    Always advertise default route
    defaultMetric Number
    Set metric of redistributed routes
    distance Number
    Administrative distance
    domainTag Number
    OSPF domain-tag
    id String
    The path of the retrieved object.
    mplsLdpAutoconfig Boolean
    Configure LDP automatic configuration
    mplsLdpSync Boolean
    Configure LDP-IGP Synchronization
    neighbors List<Property Map>
    Specify a neighbor router
    networks List<Property Map>
    Enable routing on an IP network
    passiveInterfaceDefault Boolean
    Suppress routing updates on all interfaces
    priority Number
    OSPF topology priority
    processId Number
    Process ID
    routerId String
    Override configured router identifier (peers will reset)
    shutdown Boolean
    Shutdown the OSPF protocol under the current instance
    summaryAddresses List<Property Map>
    Configure IP address summaries
    device String
    A device name from the provider configuration.

    Supporting Types

    GetOspfArea

    AreaId string
    OSPF area ID
    AuthenticationMessageDigest bool
    Use message-digest authentication
    Nssa bool
    Specify a NSSA area
    NssaDefaultInformationOriginate bool
    Originate Type 7 default into NSSA area
    NssaDefaultInformationOriginateMetric int
    OSPF default metric
    NssaDefaultInformationOriginateMetricType int
    OSPF metric type for default routes
    NssaNoRedistribution bool
    No redistribution into this NSSA area
    NssaNoSummary bool
    Do not send summary LSA into NSSA
    AreaId string
    OSPF area ID
    AuthenticationMessageDigest bool
    Use message-digest authentication
    Nssa bool
    Specify a NSSA area
    NssaDefaultInformationOriginate bool
    Originate Type 7 default into NSSA area
    NssaDefaultInformationOriginateMetric int
    OSPF default metric
    NssaDefaultInformationOriginateMetricType int
    OSPF metric type for default routes
    NssaNoRedistribution bool
    No redistribution into this NSSA area
    NssaNoSummary bool
    Do not send summary LSA into NSSA
    areaId String
    OSPF area ID
    authenticationMessageDigest Boolean
    Use message-digest authentication
    nssa Boolean
    Specify a NSSA area
    nssaDefaultInformationOriginate Boolean
    Originate Type 7 default into NSSA area
    nssaDefaultInformationOriginateMetric Integer
    OSPF default metric
    nssaDefaultInformationOriginateMetricType Integer
    OSPF metric type for default routes
    nssaNoRedistribution Boolean
    No redistribution into this NSSA area
    nssaNoSummary Boolean
    Do not send summary LSA into NSSA
    areaId string
    OSPF area ID
    authenticationMessageDigest boolean
    Use message-digest authentication
    nssa boolean
    Specify a NSSA area
    nssaDefaultInformationOriginate boolean
    Originate Type 7 default into NSSA area
    nssaDefaultInformationOriginateMetric number
    OSPF default metric
    nssaDefaultInformationOriginateMetricType number
    OSPF metric type for default routes
    nssaNoRedistribution boolean
    No redistribution into this NSSA area
    nssaNoSummary boolean
    Do not send summary LSA into NSSA
    area_id str
    OSPF area ID
    authentication_message_digest bool
    Use message-digest authentication
    nssa bool
    Specify a NSSA area
    nssa_default_information_originate bool
    Originate Type 7 default into NSSA area
    nssa_default_information_originate_metric int
    OSPF default metric
    nssa_default_information_originate_metric_type int
    OSPF metric type for default routes
    nssa_no_redistribution bool
    No redistribution into this NSSA area
    nssa_no_summary bool
    Do not send summary LSA into NSSA
    areaId String
    OSPF area ID
    authenticationMessageDigest Boolean
    Use message-digest authentication
    nssa Boolean
    Specify a NSSA area
    nssaDefaultInformationOriginate Boolean
    Originate Type 7 default into NSSA area
    nssaDefaultInformationOriginateMetric Number
    OSPF default metric
    nssaDefaultInformationOriginateMetricType Number
    OSPF metric type for default routes
    nssaNoRedistribution Boolean
    No redistribution into this NSSA area
    nssaNoSummary Boolean
    Do not send summary LSA into NSSA

    GetOspfNeighbor

    Cost int
    OSPF cost for point-to-multipoint neighbor
    Ip string
    Neighbor address
    Priority int
    OSPF priority of non-broadcast neighbor
    Cost int
    OSPF cost for point-to-multipoint neighbor
    Ip string
    Neighbor address
    Priority int
    OSPF priority of non-broadcast neighbor
    cost Integer
    OSPF cost for point-to-multipoint neighbor
    ip String
    Neighbor address
    priority Integer
    OSPF priority of non-broadcast neighbor
    cost number
    OSPF cost for point-to-multipoint neighbor
    ip string
    Neighbor address
    priority number
    OSPF priority of non-broadcast neighbor
    cost int
    OSPF cost for point-to-multipoint neighbor
    ip str
    Neighbor address
    priority int
    OSPF priority of non-broadcast neighbor
    cost Number
    OSPF cost for point-to-multipoint neighbor
    ip String
    Neighbor address
    priority Number
    OSPF priority of non-broadcast neighbor

    GetOspfNetwork

    Area string
    Set the OSPF area ID
    Ip string
    Network number
    Wildcard string
    OSPF wild card bits
    Area string
    Set the OSPF area ID
    Ip string
    Network number
    Wildcard string
    OSPF wild card bits
    area String
    Set the OSPF area ID
    ip String
    Network number
    wildcard String
    OSPF wild card bits
    area string
    Set the OSPF area ID
    ip string
    Network number
    wildcard string
    OSPF wild card bits
    area str
    Set the OSPF area ID
    ip str
    Network number
    wildcard str
    OSPF wild card bits
    area String
    Set the OSPF area ID
    ip String
    Network number
    wildcard String
    OSPF wild card bits

    GetOspfSummaryAddress

    Ip string
    IP summary address
    Mask string
    Summary mask
    Ip string
    IP summary address
    Mask string
    Summary mask
    ip String
    IP summary address
    mask String
    Summary mask
    ip string
    IP summary address
    mask string
    Summary mask
    ip str
    IP summary address
    mask str
    Summary mask
    ip String
    IP summary address
    mask String
    Summary mask

    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.