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

iosxe.getOspf

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 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,
    });

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

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

const example = iosxe.getOspf({
    processId: 1,
});
Copy
import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_ospf(process_id=1)
Copy
variables:
  example:
    fn::invoke:
      Function: iosxe:getOspf
      Arguments:
        processId: 1
Copy

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>
Copy
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]
Copy
func LookupOspf(ctx *Context, args *LookupOspfArgs, opts ...InvokeOption) (*LookupOspfResult, error)
func LookupOspfOutput(ctx *Context, args *LookupOspfOutputArgs, opts ...InvokeOption) LookupOspfResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetOspfResult> getOspf(GetOspfArgs args, InvokeOptions options)
public static Output<GetOspfResult> getOspf(GetOspfArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: iosxe:index/getOspf:getOspf
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ProcessId This property is required. int
Process ID
Device string
A device name from the provider configuration.
ProcessId This property is required. int
Process ID
Device string
A device name from the provider configuration.
processId This property is required. Integer
Process ID
device String
A device name from the provider configuration.
processId This property is required. number
Process ID
device string
A device name from the provider configuration.
process_id This property is required. int
Process ID
device str
A device name from the provider configuration.
processId This property is required. 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 This property is required. string
OSPF area ID
AuthenticationMessageDigest This property is required. bool
Use message-digest authentication
Nssa This property is required. bool
Specify a NSSA area
NssaDefaultInformationOriginate This property is required. bool
Originate Type 7 default into NSSA area
NssaDefaultInformationOriginateMetric This property is required. int
OSPF default metric
NssaDefaultInformationOriginateMetricType This property is required. int
OSPF metric type for default routes
NssaNoRedistribution This property is required. bool
No redistribution into this NSSA area
NssaNoSummary This property is required. bool
Do not send summary LSA into NSSA
AreaId This property is required. string
OSPF area ID
AuthenticationMessageDigest This property is required. bool
Use message-digest authentication
Nssa This property is required. bool
Specify a NSSA area
NssaDefaultInformationOriginate This property is required. bool
Originate Type 7 default into NSSA area
NssaDefaultInformationOriginateMetric This property is required. int
OSPF default metric
NssaDefaultInformationOriginateMetricType This property is required. int
OSPF metric type for default routes
NssaNoRedistribution This property is required. bool
No redistribution into this NSSA area
NssaNoSummary This property is required. bool
Do not send summary LSA into NSSA
areaId This property is required. String
OSPF area ID
authenticationMessageDigest This property is required. Boolean
Use message-digest authentication
nssa This property is required. Boolean
Specify a NSSA area
nssaDefaultInformationOriginate This property is required. Boolean
Originate Type 7 default into NSSA area
nssaDefaultInformationOriginateMetric This property is required. Integer
OSPF default metric
nssaDefaultInformationOriginateMetricType This property is required. Integer
OSPF metric type for default routes
nssaNoRedistribution This property is required. Boolean
No redistribution into this NSSA area
nssaNoSummary This property is required. Boolean
Do not send summary LSA into NSSA
areaId This property is required. string
OSPF area ID
authenticationMessageDigest This property is required. boolean
Use message-digest authentication
nssa This property is required. boolean
Specify a NSSA area
nssaDefaultInformationOriginate This property is required. boolean
Originate Type 7 default into NSSA area
nssaDefaultInformationOriginateMetric This property is required. number
OSPF default metric
nssaDefaultInformationOriginateMetricType This property is required. number
OSPF metric type for default routes
nssaNoRedistribution This property is required. boolean
No redistribution into this NSSA area
nssaNoSummary This property is required. boolean
Do not send summary LSA into NSSA
area_id This property is required. str
OSPF area ID
authentication_message_digest This property is required. bool
Use message-digest authentication
nssa This property is required. bool
Specify a NSSA area
nssa_default_information_originate This property is required. bool
Originate Type 7 default into NSSA area
nssa_default_information_originate_metric This property is required. int
OSPF default metric
nssa_default_information_originate_metric_type This property is required. int
OSPF metric type for default routes
nssa_no_redistribution This property is required. bool
No redistribution into this NSSA area
nssa_no_summary This property is required. bool
Do not send summary LSA into NSSA
areaId This property is required. String
OSPF area ID
authenticationMessageDigest This property is required. Boolean
Use message-digest authentication
nssa This property is required. Boolean
Specify a NSSA area
nssaDefaultInformationOriginate This property is required. Boolean
Originate Type 7 default into NSSA area
nssaDefaultInformationOriginateMetric This property is required. Number
OSPF default metric
nssaDefaultInformationOriginateMetricType This property is required. Number
OSPF metric type for default routes
nssaNoRedistribution This property is required. Boolean
No redistribution into this NSSA area
nssaNoSummary This property is required. Boolean
Do not send summary LSA into NSSA

GetOspfNeighbor

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

GetOspfNetwork

Area This property is required. string
Set the OSPF area ID
Ip This property is required. string
Network number
Wildcard This property is required. string
OSPF wild card bits
Area This property is required. string
Set the OSPF area ID
Ip This property is required. string
Network number
Wildcard This property is required. string
OSPF wild card bits
area This property is required. String
Set the OSPF area ID
ip This property is required. String
Network number
wildcard This property is required. String
OSPF wild card bits
area This property is required. string
Set the OSPF area ID
ip This property is required. string
Network number
wildcard This property is required. string
OSPF wild card bits
area This property is required. str
Set the OSPF area ID
ip This property is required. str
Network number
wildcard This property is required. str
OSPF wild card bits
area This property is required. String
Set the OSPF area ID
ip This property is required. String
Network number
wildcard This property is required. String
OSPF wild card bits

GetOspfSummaryAddress

Ip This property is required. string
IP summary address
Mask This property is required. string
Summary mask
Ip This property is required. string
IP summary address
Mask This property is required. string
Summary mask
ip This property is required. String
IP summary address
mask This property is required. String
Summary mask
ip This property is required. string
IP summary address
mask This property is required. string
Summary mask
ip This property is required. str
IP summary address
mask This property is required. str
Summary mask
ip This property is required. String
IP summary address
mask This property is required. 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.
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe