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

iosxe.Ospf

Explore with Pulumi AI

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

    This resource can manage the OSPF configuration.

    Example Usage

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.Ospf;
import com.pulumi.iosxe.OspfArgs;
import com.pulumi.iosxe.inputs.OspfAreaArgs;
import com.pulumi.iosxe.inputs.OspfNeighborArgs;
import com.pulumi.iosxe.inputs.OspfNetworkArgs;
import com.pulumi.iosxe.inputs.OspfSummaryAddressArgs;
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) {
        var example = new Ospf("example", OspfArgs.builder()        
            .areas(OspfAreaArgs.builder()
                .area_id("5")
                .authentication_message_digest(true)
                .nssa(true)
                .nssa_default_information_originate(true)
                .nssa_default_information_originate_metric(100)
                .nssa_default_information_originate_metric_type(1)
                .nssa_no_redistribution(true)
                .nssa_no_summary(true)
                .build())
            .bfdAllInterfaces(true)
            .defaultInformationOriginate(true)
            .defaultInformationOriginateAlways(true)
            .defaultMetric(21)
            .distance(120)
            .domainTag(10)
            .neighbors(OspfNeighborArgs.builder()
                .cost(100)
                .ip("2.2.2.2")
                .priority(10)
                .build())
            .networks(OspfNetworkArgs.builder()
                .area("0")
                .ip("3.3.3.0")
                .wildcard("0.0.0.255")
                .build())
            .passiveInterfaceDefault(true)
            .priority(100)
            .processId(1)
            .routerId("1.2.3.4")
            .shutdown(false)
            .summaryAddresses(OspfSummaryAddressArgs.builder()
                .ip("3.3.3.0")
                .mask("255.255.255.0")
                .build())
            .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  example:
    type: iosxe:Ospf
    properties:
      areas:
        - area_id: '5'
          authentication_message_digest: true
          nssa: true
          nssa_default_information_originate: true
          nssa_default_information_originate_metric: 100
          nssa_default_information_originate_metric_type: 1
          nssa_no_redistribution: true
          nssa_no_summary: true
      bfdAllInterfaces: true
      defaultInformationOriginate: true
      defaultInformationOriginateAlways: true
      defaultMetric: 21
      distance: 120
      domainTag: 10
      neighbors:
        - cost: 100
          ip: 2.2.2.2
          priority: 10
      networks:
        - area: '0'
          ip: 3.3.3.0
          wildcard: 0.0.0.255
      passiveInterfaceDefault: true
      priority: 100
      processId: 1
      routerId: 1.2.3.4
      shutdown: false
      summaryAddresses:
        - ip: 3.3.3.0
          mask: 255.255.255.0

    Create Ospf Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Ospf(name: string, args: OspfArgs, opts?: CustomResourceOptions);
    @overload
def Ospf(resource_name: str,
         args: OspfArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Ospf(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         process_id: Optional[int] = None,
         domain_tag: Optional[int] = None,
         default_information_originate_always: Optional[bool] = None,
         mpls_ldp_sync: Optional[bool] = None,
         neighbors: Optional[Sequence[OspfNeighborArgs]] = None,
         delete_mode: Optional[str] = None,
         device: Optional[str] = None,
         distance: Optional[int] = None,
         areas: Optional[Sequence[OspfAreaArgs]] = None,
         summary_addresses: Optional[Sequence[OspfSummaryAddressArgs]] = None,
         default_information_originate: Optional[bool] = None,
         default_metric: Optional[int] = None,
         networks: Optional[Sequence[OspfNetworkArgs]] = None,
         passive_interface_default: Optional[bool] = None,
         priority: Optional[int] = None,
         bfd_all_interfaces: Optional[bool] = None,
         router_id: Optional[str] = None,
         shutdown: Optional[bool] = None,
         mpls_ldp_autoconfig: Optional[bool] = None)
    func NewOspf(ctx *Context, name string, args OspfArgs, opts ...ResourceOption) (*Ospf, error)
    public Ospf(string name, OspfArgs args, CustomResourceOptions? opts = null)
    public Ospf(String name, OspfArgs args)
public Ospf(String name, OspfArgs args, CustomResourceOptions options)

    type: iosxe:Ospf
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OspfArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OspfArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OspfArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OspfArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OspfArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ospfResource = new Iosxe.Ospf("ospfResource", new()
{
    ProcessId = 0,
    DomainTag = 0,
    DefaultInformationOriginateAlways = false,
    MplsLdpSync = false,
    Neighbors = new[]
    {
        new Iosxe.Inputs.OspfNeighborArgs
        {
            Ip = "string",
            Cost = 0,
            Priority = 0,
        },
    },
    DeleteMode = "string",
    Device = "string",
    Distance = 0,
    Areas = new[]
    {
        new Iosxe.Inputs.OspfAreaArgs
        {
            AreaId = "string",
            AuthenticationMessageDigest = false,
            Nssa = false,
            NssaDefaultInformationOriginate = false,
            NssaDefaultInformationOriginateMetric = 0,
            NssaDefaultInformationOriginateMetricType = 0,
            NssaNoRedistribution = false,
            NssaNoSummary = false,
        },
    },
    SummaryAddresses = new[]
    {
        new Iosxe.Inputs.OspfSummaryAddressArgs
        {
            Ip = "string",
            Mask = "string",
        },
    },
    DefaultInformationOriginate = false,
    DefaultMetric = 0,
    Networks = new[]
    {
        new Iosxe.Inputs.OspfNetworkArgs
        {
            Ip = "string",
            Area = "string",
            Wildcard = "string",
        },
    },
    PassiveInterfaceDefault = false,
    Priority = 0,
    BfdAllInterfaces = false,
    RouterId = "string",
    Shutdown = false,
    MplsLdpAutoconfig = false,
});

    example, err := iosxe.NewOspf(ctx, "ospfResource", &iosxe.OspfArgs{
	ProcessId:                         pulumi.Int(0),
	DomainTag:                         pulumi.Int(0),
	DefaultInformationOriginateAlways: pulumi.Bool(false),
	MplsLdpSync:                       pulumi.Bool(false),
	Neighbors: iosxe.OspfNeighborArray{
		&iosxe.OspfNeighborArgs{
			Ip:       pulumi.String("string"),
			Cost:     pulumi.Int(0),
			Priority: pulumi.Int(0),
		},
	},
	DeleteMode: pulumi.String("string"),
	Device:     pulumi.String("string"),
	Distance:   pulumi.Int(0),
	Areas: iosxe.OspfAreaArray{
		&iosxe.OspfAreaArgs{
			AreaId:                                pulumi.String("string"),
			AuthenticationMessageDigest:           pulumi.Bool(false),
			Nssa:                                  pulumi.Bool(false),
			NssaDefaultInformationOriginate:       pulumi.Bool(false),
			NssaDefaultInformationOriginateMetric: pulumi.Int(0),
			NssaDefaultInformationOriginateMetricType: pulumi.Int(0),
			NssaNoRedistribution:                      pulumi.Bool(false),
			NssaNoSummary:                             pulumi.Bool(false),
		},
	},
	SummaryAddresses: iosxe.OspfSummaryAddressArray{
		&iosxe.OspfSummaryAddressArgs{
			Ip:   pulumi.String("string"),
			Mask: pulumi.String("string"),
		},
	},
	DefaultInformationOriginate: pulumi.Bool(false),
	DefaultMetric:               pulumi.Int(0),
	Networks: iosxe.OspfNetworkArray{
		&iosxe.OspfNetworkArgs{
			Ip:       pulumi.String("string"),
			Area:     pulumi.String("string"),
			Wildcard: pulumi.String("string"),
		},
	},
	PassiveInterfaceDefault: pulumi.Bool(false),
	Priority:                pulumi.Int(0),
	BfdAllInterfaces:        pulumi.Bool(false),
	RouterId:                pulumi.String("string"),
	Shutdown:                pulumi.Bool(false),
	MplsLdpAutoconfig:       pulumi.Bool(false),
})

    var ospfResource = new Ospf("ospfResource", OspfArgs.builder()
    .processId(0)
    .domainTag(0)
    .defaultInformationOriginateAlways(false)
    .mplsLdpSync(false)
    .neighbors(OspfNeighborArgs.builder()
        .ip("string")
        .cost(0)
        .priority(0)
        .build())
    .deleteMode("string")
    .device("string")
    .distance(0)
    .areas(OspfAreaArgs.builder()
        .areaId("string")
        .authenticationMessageDigest(false)
        .nssa(false)
        .nssaDefaultInformationOriginate(false)
        .nssaDefaultInformationOriginateMetric(0)
        .nssaDefaultInformationOriginateMetricType(0)
        .nssaNoRedistribution(false)
        .nssaNoSummary(false)
        .build())
    .summaryAddresses(OspfSummaryAddressArgs.builder()
        .ip("string")
        .mask("string")
        .build())
    .defaultInformationOriginate(false)
    .defaultMetric(0)
    .networks(OspfNetworkArgs.builder()
        .ip("string")
        .area("string")
        .wildcard("string")
        .build())
    .passiveInterfaceDefault(false)
    .priority(0)
    .bfdAllInterfaces(false)
    .routerId("string")
    .shutdown(false)
    .mplsLdpAutoconfig(false)
    .build());

    ospf_resource = iosxe.Ospf("ospfResource",
    process_id=0,
    domain_tag=0,
    default_information_originate_always=False,
    mpls_ldp_sync=False,
    neighbors=[{
        "ip": "string",
        "cost": 0,
        "priority": 0,
    }],
    delete_mode="string",
    device="string",
    distance=0,
    areas=[{
        "area_id": "string",
        "authentication_message_digest": False,
        "nssa": False,
        "nssa_default_information_originate": False,
        "nssa_default_information_originate_metric": 0,
        "nssa_default_information_originate_metric_type": 0,
        "nssa_no_redistribution": False,
        "nssa_no_summary": False,
    }],
    summary_addresses=[{
        "ip": "string",
        "mask": "string",
    }],
    default_information_originate=False,
    default_metric=0,
    networks=[{
        "ip": "string",
        "area": "string",
        "wildcard": "string",
    }],
    passive_interface_default=False,
    priority=0,
    bfd_all_interfaces=False,
    router_id="string",
    shutdown=False,
    mpls_ldp_autoconfig=False)

    const ospfResource = new iosxe.Ospf("ospfResource", {
    processId: 0,
    domainTag: 0,
    defaultInformationOriginateAlways: false,
    mplsLdpSync: false,
    neighbors: [{
        ip: "string",
        cost: 0,
        priority: 0,
    }],
    deleteMode: "string",
    device: "string",
    distance: 0,
    areas: [{
        areaId: "string",
        authenticationMessageDigest: false,
        nssa: false,
        nssaDefaultInformationOriginate: false,
        nssaDefaultInformationOriginateMetric: 0,
        nssaDefaultInformationOriginateMetricType: 0,
        nssaNoRedistribution: false,
        nssaNoSummary: false,
    }],
    summaryAddresses: [{
        ip: "string",
        mask: "string",
    }],
    defaultInformationOriginate: false,
    defaultMetric: 0,
    networks: [{
        ip: "string",
        area: "string",
        wildcard: "string",
    }],
    passiveInterfaceDefault: false,
    priority: 0,
    bfdAllInterfaces: false,
    routerId: "string",
    shutdown: false,
    mplsLdpAutoconfig: false,
});

    type: iosxe:Ospf
properties:
    areas:
        - areaId: string
          authenticationMessageDigest: false
          nssa: false
          nssaDefaultInformationOriginate: false
          nssaDefaultInformationOriginateMetric: 0
          nssaDefaultInformationOriginateMetricType: 0
          nssaNoRedistribution: false
          nssaNoSummary: false
    bfdAllInterfaces: false
    defaultInformationOriginate: false
    defaultInformationOriginateAlways: false
    defaultMetric: 0
    deleteMode: string
    device: string
    distance: 0
    domainTag: 0
    mplsLdpAutoconfig: false
    mplsLdpSync: false
    neighbors:
        - cost: 0
          ip: string
          priority: 0
    networks:
        - area: string
          ip: string
          wildcard: string
    passiveInterfaceDefault: false
    priority: 0
    processId: 0
    routerId: string
    shutdown: false
    summaryAddresses:
        - ip: string
          mask: string

    Ospf Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Ospf resource accepts the following input properties:

    ProcessId int
    Process ID - Range: 1-65535
    Areas List<Lbrlabs.PulumiPackage.Iosxe.Inputs.OspfArea>
    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 - Range: 1-16777214
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    Distance int
    Administrative distance - Range: 1-255
    DomainTag int
    OSPF domain-tag - Range: 1-4294967295
    MplsLdpAutoconfig bool
    Configure LDP automatic configuration
    MplsLdpSync bool
    Configure LDP-IGP Synchronization
    Neighbors List<Lbrlabs.PulumiPackage.Iosxe.Inputs.OspfNeighbor>
    Specify a neighbor router
    Networks List<Lbrlabs.PulumiPackage.Iosxe.Inputs.OspfNetwork>
    Enable routing on an IP network
    PassiveInterfaceDefault bool
    Suppress routing updates on all interfaces
    Priority int
    OSPF topology priority - Range: 0-127
    RouterId string
    Override configured router identifier (peers will reset)
    Shutdown bool
    Shutdown the OSPF protocol under the current instance
    SummaryAddresses List<Lbrlabs.PulumiPackage.Iosxe.Inputs.OspfSummaryAddress>
    Configure IP address summaries
    ProcessId int
    Process ID - Range: 1-65535
    Areas []OspfAreaArgs
    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 - Range: 1-16777214
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    Distance int
    Administrative distance - Range: 1-255
    DomainTag int
    OSPF domain-tag - Range: 1-4294967295
    MplsLdpAutoconfig bool
    Configure LDP automatic configuration
    MplsLdpSync bool
    Configure LDP-IGP Synchronization
    Neighbors []OspfNeighborArgs
    Specify a neighbor router
    Networks []OspfNetworkArgs
    Enable routing on an IP network
    PassiveInterfaceDefault bool
    Suppress routing updates on all interfaces
    Priority int
    OSPF topology priority - Range: 0-127
    RouterId string
    Override configured router identifier (peers will reset)
    Shutdown bool
    Shutdown the OSPF protocol under the current instance
    SummaryAddresses []OspfSummaryAddressArgs
    Configure IP address summaries
    processId Integer
    Process ID - Range: 1-65535
    areas List<OspfArea>
    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 - Range: 1-16777214
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    distance Integer
    Administrative distance - Range: 1-255
    domainTag Integer
    OSPF domain-tag - Range: 1-4294967295
    mplsLdpAutoconfig Boolean
    Configure LDP automatic configuration
    mplsLdpSync Boolean
    Configure LDP-IGP Synchronization
    neighbors List<OspfNeighbor>
    Specify a neighbor router
    networks List<OspfNetwork>
    Enable routing on an IP network
    passiveInterfaceDefault Boolean
    Suppress routing updates on all interfaces
    priority Integer
    OSPF topology priority - Range: 0-127
    routerId String
    Override configured router identifier (peers will reset)
    shutdown Boolean
    Shutdown the OSPF protocol under the current instance
    summaryAddresses List<OspfSummaryAddress>
    Configure IP address summaries
    processId number
    Process ID - Range: 1-65535
    areas OspfArea[]
    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 - Range: 1-16777214
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device string
    A device name from the provider configuration.
    distance number
    Administrative distance - Range: 1-255
    domainTag number
    OSPF domain-tag - Range: 1-4294967295
    mplsLdpAutoconfig boolean
    Configure LDP automatic configuration
    mplsLdpSync boolean
    Configure LDP-IGP Synchronization
    neighbors OspfNeighbor[]
    Specify a neighbor router
    networks OspfNetwork[]
    Enable routing on an IP network
    passiveInterfaceDefault boolean
    Suppress routing updates on all interfaces
    priority number
    OSPF topology priority - Range: 0-127
    routerId string
    Override configured router identifier (peers will reset)
    shutdown boolean
    Shutdown the OSPF protocol under the current instance
    summaryAddresses OspfSummaryAddress[]
    Configure IP address summaries
    process_id int
    Process ID - Range: 1-65535
    areas Sequence[OspfAreaArgs]
    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 - Range: 1-16777214
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device str
    A device name from the provider configuration.
    distance int
    Administrative distance - Range: 1-255
    domain_tag int
    OSPF domain-tag - Range: 1-4294967295
    mpls_ldp_autoconfig bool
    Configure LDP automatic configuration
    mpls_ldp_sync bool
    Configure LDP-IGP Synchronization
    neighbors Sequence[OspfNeighborArgs]
    Specify a neighbor router
    networks Sequence[OspfNetworkArgs]
    Enable routing on an IP network
    passive_interface_default bool
    Suppress routing updates on all interfaces
    priority int
    OSPF topology priority - Range: 0-127
    router_id str
    Override configured router identifier (peers will reset)
    shutdown bool
    Shutdown the OSPF protocol under the current instance
    summary_addresses Sequence[OspfSummaryAddressArgs]
    Configure IP address summaries
    processId Number
    Process ID - Range: 1-65535
    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 - Range: 1-16777214
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    distance Number
    Administrative distance - Range: 1-255
    domainTag Number
    OSPF domain-tag - Range: 1-4294967295
    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 - Range: 0-127
    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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Ospf resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Ospf Resource

    Get an existing Ospf resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OspfState, opts?: CustomResourceOptions): Ospf
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        areas: Optional[Sequence[OspfAreaArgs]] = None,
        bfd_all_interfaces: Optional[bool] = None,
        default_information_originate: Optional[bool] = None,
        default_information_originate_always: Optional[bool] = None,
        default_metric: Optional[int] = None,
        delete_mode: Optional[str] = None,
        device: Optional[str] = None,
        distance: Optional[int] = None,
        domain_tag: Optional[int] = None,
        mpls_ldp_autoconfig: Optional[bool] = None,
        mpls_ldp_sync: Optional[bool] = None,
        neighbors: Optional[Sequence[OspfNeighborArgs]] = None,
        networks: Optional[Sequence[OspfNetworkArgs]] = None,
        passive_interface_default: Optional[bool] = None,
        priority: Optional[int] = None,
        process_id: Optional[int] = None,
        router_id: Optional[str] = None,
        shutdown: Optional[bool] = None,
        summary_addresses: Optional[Sequence[OspfSummaryAddressArgs]] = None) -> Ospf
    func GetOspf(ctx *Context, name string, id IDInput, state *OspfState, opts ...ResourceOption) (*Ospf, error)
    public static Ospf Get(string name, Input<string> id, OspfState? state, CustomResourceOptions? opts = null)
    public static Ospf get(String name, Output<String> id, OspfState state, CustomResourceOptions options)
    resources:  _:    type: iosxe:Ospf    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Areas List<Lbrlabs.PulumiPackage.Iosxe.Inputs.OspfArea>
    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 - Range: 1-16777214
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    Distance int
    Administrative distance - Range: 1-255
    DomainTag int
    OSPF domain-tag - Range: 1-4294967295
    MplsLdpAutoconfig bool
    Configure LDP automatic configuration
    MplsLdpSync bool
    Configure LDP-IGP Synchronization
    Neighbors List<Lbrlabs.PulumiPackage.Iosxe.Inputs.OspfNeighbor>
    Specify a neighbor router
    Networks List<Lbrlabs.PulumiPackage.Iosxe.Inputs.OspfNetwork>
    Enable routing on an IP network
    PassiveInterfaceDefault bool
    Suppress routing updates on all interfaces
    Priority int
    OSPF topology priority - Range: 0-127
    ProcessId int
    Process ID - Range: 1-65535
    RouterId string
    Override configured router identifier (peers will reset)
    Shutdown bool
    Shutdown the OSPF protocol under the current instance
    SummaryAddresses List<Lbrlabs.PulumiPackage.Iosxe.Inputs.OspfSummaryAddress>
    Configure IP address summaries
    Areas []OspfAreaArgs
    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 - Range: 1-16777214
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    Distance int
    Administrative distance - Range: 1-255
    DomainTag int
    OSPF domain-tag - Range: 1-4294967295
    MplsLdpAutoconfig bool
    Configure LDP automatic configuration
    MplsLdpSync bool
    Configure LDP-IGP Synchronization
    Neighbors []OspfNeighborArgs
    Specify a neighbor router
    Networks []OspfNetworkArgs
    Enable routing on an IP network
    PassiveInterfaceDefault bool
    Suppress routing updates on all interfaces
    Priority int
    OSPF topology priority - Range: 0-127
    ProcessId int
    Process ID - Range: 1-65535
    RouterId string
    Override configured router identifier (peers will reset)
    Shutdown bool
    Shutdown the OSPF protocol under the current instance
    SummaryAddresses []OspfSummaryAddressArgs
    Configure IP address summaries
    areas List<OspfArea>
    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 - Range: 1-16777214
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    distance Integer
    Administrative distance - Range: 1-255
    domainTag Integer
    OSPF domain-tag - Range: 1-4294967295
    mplsLdpAutoconfig Boolean
    Configure LDP automatic configuration
    mplsLdpSync Boolean
    Configure LDP-IGP Synchronization
    neighbors List<OspfNeighbor>
    Specify a neighbor router
    networks List<OspfNetwork>
    Enable routing on an IP network
    passiveInterfaceDefault Boolean
    Suppress routing updates on all interfaces
    priority Integer
    OSPF topology priority - Range: 0-127
    processId Integer
    Process ID - Range: 1-65535
    routerId String
    Override configured router identifier (peers will reset)
    shutdown Boolean
    Shutdown the OSPF protocol under the current instance
    summaryAddresses List<OspfSummaryAddress>
    Configure IP address summaries
    areas OspfArea[]
    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 - Range: 1-16777214
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device string
    A device name from the provider configuration.
    distance number
    Administrative distance - Range: 1-255
    domainTag number
    OSPF domain-tag - Range: 1-4294967295
    mplsLdpAutoconfig boolean
    Configure LDP automatic configuration
    mplsLdpSync boolean
    Configure LDP-IGP Synchronization
    neighbors OspfNeighbor[]
    Specify a neighbor router
    networks OspfNetwork[]
    Enable routing on an IP network
    passiveInterfaceDefault boolean
    Suppress routing updates on all interfaces
    priority number
    OSPF topology priority - Range: 0-127
    processId number
    Process ID - Range: 1-65535
    routerId string
    Override configured router identifier (peers will reset)
    shutdown boolean
    Shutdown the OSPF protocol under the current instance
    summaryAddresses OspfSummaryAddress[]
    Configure IP address summaries
    areas Sequence[OspfAreaArgs]
    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 - Range: 1-16777214
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device str
    A device name from the provider configuration.
    distance int
    Administrative distance - Range: 1-255
    domain_tag int
    OSPF domain-tag - Range: 1-4294967295
    mpls_ldp_autoconfig bool
    Configure LDP automatic configuration
    mpls_ldp_sync bool
    Configure LDP-IGP Synchronization
    neighbors Sequence[OspfNeighborArgs]
    Specify a neighbor router
    networks Sequence[OspfNetworkArgs]
    Enable routing on an IP network
    passive_interface_default bool
    Suppress routing updates on all interfaces
    priority int
    OSPF topology priority - Range: 0-127
    process_id int
    Process ID - Range: 1-65535
    router_id str
    Override configured router identifier (peers will reset)
    shutdown bool
    Shutdown the OSPF protocol under the current instance
    summary_addresses Sequence[OspfSummaryAddressArgs]
    Configure IP address summaries
    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 - Range: 1-16777214
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    distance Number
    Administrative distance - Range: 1-255
    domainTag Number
    OSPF domain-tag - Range: 1-4294967295
    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 - Range: 0-127
    processId Number
    Process ID - Range: 1-65535
    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

    Supporting Types

    OspfArea, OspfAreaArgs

    OspfNeighbor, OspfNeighborArgs

    Ip string
    Cost int
    Priority int
    Ip string
    Cost int
    Priority int
    ip String
    cost Integer
    priority Integer
    ip string
    cost number
    priority number
    ip str
    cost int
    priority int
    ip String
    cost Number
    priority Number

    OspfNetwork, OspfNetworkArgs

    Ip string
    Area string
    Wildcard string
    Ip string
    Area string
    Wildcard string
    ip String
    area String
    wildcard String
    ip string
    area string
    wildcard string
    ip str
    area str
    wildcard str
    ip String
    area String
    wildcard String

    OspfSummaryAddress, OspfSummaryAddressArgs

    Ip string
    Mask string
    Ip string
    Mask string
    ip String
    mask String
    ip string
    mask string
    ip str
    mask str
    ip String
    mask String

    Import

     $ pulumi import iosxe:index/ospf:Ospf example "Cisco-IOS-XE-native:native/router/Cisco-IOS-XE-ospf:router-ospf/ospf/process-id=1"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

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