1. Packages
  2. Routeros Provider
  3. API Docs
  4. RoutingOspfArea
routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros

routeros.RoutingOspfArea

Explore with Pulumi AI

routeros logo
routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as routeros from "@pulumi/routeros";
    
    const testRoutingOspfInstance = new routeros.RoutingOspfInstance("testRoutingOspfInstance", {});
    const testRoutingOspfArea = new routeros.RoutingOspfArea("testRoutingOspfArea", {instance: testRoutingOspfInstance.name});
    
    import pulumi
    import pulumi_routeros as routeros
    
    test_routing_ospf_instance = routeros.RoutingOspfInstance("testRoutingOspfInstance")
    test_routing_ospf_area = routeros.RoutingOspfArea("testRoutingOspfArea", instance=test_routing_ospf_instance.name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/routeros/routeros"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		testRoutingOspfInstance, err := routeros.NewRoutingOspfInstance(ctx, "testRoutingOspfInstance", nil)
    		if err != nil {
    			return err
    		}
    		_, err = routeros.NewRoutingOspfArea(ctx, "testRoutingOspfArea", &routeros.RoutingOspfAreaArgs{
    			Instance: testRoutingOspfInstance.Name,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Routeros = Pulumi.Routeros;
    
    return await Deployment.RunAsync(() => 
    {
        var testRoutingOspfInstance = new Routeros.RoutingOspfInstance("testRoutingOspfInstance");
    
        var testRoutingOspfArea = new Routeros.RoutingOspfArea("testRoutingOspfArea", new()
        {
            Instance = testRoutingOspfInstance.Name,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.routeros.RoutingOspfInstance;
    import com.pulumi.routeros.RoutingOspfArea;
    import com.pulumi.routeros.RoutingOspfAreaArgs;
    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 testRoutingOspfInstance = new RoutingOspfInstance("testRoutingOspfInstance");
    
            var testRoutingOspfArea = new RoutingOspfArea("testRoutingOspfArea", RoutingOspfAreaArgs.builder()
                .instance(testRoutingOspfInstance.name())
                .build());
    
        }
    }
    
    resources:
      testRoutingOspfInstance:
        type: routeros:RoutingOspfInstance
      testRoutingOspfArea:
        type: routeros:RoutingOspfArea
        properties:
          instance: ${testRoutingOspfInstance.name}
    

    Create RoutingOspfArea Resource

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

    Constructor syntax

    new RoutingOspfArea(name: string, args: RoutingOspfAreaArgs, opts?: CustomResourceOptions);
    @overload
    def RoutingOspfArea(resource_name: str,
                        args: RoutingOspfAreaArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def RoutingOspfArea(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        instance: Optional[str] = None,
                        disabled: Optional[bool] = None,
                        ___unset_: Optional[str] = None,
                        area_id: Optional[str] = None,
                        comment: Optional[str] = None,
                        default_cost: Optional[float] = None,
                        ___id_: Optional[float] = None,
                        ___path_: Optional[str] = None,
                        name: Optional[str] = None,
                        no_summaries: Optional[bool] = None,
                        nssa_translate: Optional[str] = None,
                        routing_ospf_area_id: Optional[str] = None,
                        type: Optional[str] = None)
    func NewRoutingOspfArea(ctx *Context, name string, args RoutingOspfAreaArgs, opts ...ResourceOption) (*RoutingOspfArea, error)
    public RoutingOspfArea(string name, RoutingOspfAreaArgs args, CustomResourceOptions? opts = null)
    public RoutingOspfArea(String name, RoutingOspfAreaArgs args)
    public RoutingOspfArea(String name, RoutingOspfAreaArgs args, CustomResourceOptions options)
    
    type: routeros:RoutingOspfArea
    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 RoutingOspfAreaArgs
    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 RoutingOspfAreaArgs
    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 RoutingOspfAreaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoutingOspfAreaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoutingOspfAreaArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    RoutingOspfArea 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 RoutingOspfArea resource accepts the following input properties:

    Instance string
    Name of the OSPF instance this area belongs to.
    AreaId string
    OSPF area identifier.
    Comment string
    DefaultCost double
    Default cost of injected LSAs into the area.
    Disabled bool
    Name string
    NoSummaries bool
    If set then the area will not flood summary LSAs in the stub area. \n\nThe correct value of this attribute may not be displayed in Winbox. Please check the parameters in the console!\n\n
    NssaTranslate string
    The parameter indicates which ABR will be used as a translator from type7 to type5 LSA.
    RoutingOspfAreaId string
    The ID of this resource.
    Type string
    The area type.
    ___id_ double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___unset_ string
    A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
    Instance string
    Name of the OSPF instance this area belongs to.
    AreaId string
    OSPF area identifier.
    Comment string
    DefaultCost float64
    Default cost of injected LSAs into the area.
    Disabled bool
    Name string
    NoSummaries bool
    If set then the area will not flood summary LSAs in the stub area. \n\nThe correct value of this attribute may not be displayed in Winbox. Please check the parameters in the console!\n\n
    NssaTranslate string
    The parameter indicates which ABR will be used as a translator from type7 to type5 LSA.
    RoutingOspfAreaId string
    The ID of this resource.
    Type string
    The area type.
    ___id_ float64
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___unset_ string
    A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
    instance String
    Name of the OSPF instance this area belongs to.
    ___id_ Double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___unset_ String
    A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
    areaId String
    OSPF area identifier.
    comment String
    defaultCost Double
    Default cost of injected LSAs into the area.
    disabled Boolean
    name String
    noSummaries Boolean
    If set then the area will not flood summary LSAs in the stub area. \n\nThe correct value of this attribute may not be displayed in Winbox. Please check the parameters in the console!\n\n
    nssaTranslate String
    The parameter indicates which ABR will be used as a translator from type7 to type5 LSA.
    routingOspfAreaId String
    The ID of this resource.
    type String
    The area type.
    instance string
    Name of the OSPF instance this area belongs to.
    ___id_ number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___unset_ string
    A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
    areaId string
    OSPF area identifier.
    comment string
    defaultCost number
    Default cost of injected LSAs into the area.
    disabled boolean
    name string
    noSummaries boolean
    If set then the area will not flood summary LSAs in the stub area. \n\nThe correct value of this attribute may not be displayed in Winbox. Please check the parameters in the console!\n\n
    nssaTranslate string
    The parameter indicates which ABR will be used as a translator from type7 to type5 LSA.
    routingOspfAreaId string
    The ID of this resource.
    type string
    The area type.
    instance str
    Name of the OSPF instance this area belongs to.
    ___id_ float
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ str
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___unset_ str
    A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
    area_id str
    OSPF area identifier.
    comment str
    default_cost float
    Default cost of injected LSAs into the area.
    disabled bool
    name str
    no_summaries bool
    If set then the area will not flood summary LSAs in the stub area. \n\nThe correct value of this attribute may not be displayed in Winbox. Please check the parameters in the console!\n\n
    nssa_translate str
    The parameter indicates which ABR will be used as a translator from type7 to type5 LSA.
    routing_ospf_area_id str
    The ID of this resource.
    type str
    The area type.
    instance String
    Name of the OSPF instance this area belongs to.
    ___id_ Number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___unset_ String
    A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
    areaId String
    OSPF area identifier.
    comment String
    defaultCost Number
    Default cost of injected LSAs into the area.
    disabled Boolean
    name String
    noSummaries Boolean
    If set then the area will not flood summary LSAs in the stub area. \n\nThe correct value of this attribute may not be displayed in Winbox. Please check the parameters in the console!\n\n
    nssaTranslate String
    The parameter indicates which ABR will be used as a translator from type7 to type5 LSA.
    routingOspfAreaId String
    The ID of this resource.
    type String
    The area type.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Inactive bool
    Id string
    The provider-assigned unique ID for this managed resource.
    Inactive bool
    id String
    The provider-assigned unique ID for this managed resource.
    inactive Boolean
    id string
    The provider-assigned unique ID for this managed resource.
    inactive boolean
    id str
    The provider-assigned unique ID for this managed resource.
    inactive bool
    id String
    The provider-assigned unique ID for this managed resource.
    inactive Boolean

    Look up Existing RoutingOspfArea Resource

    Get an existing RoutingOspfArea 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?: RoutingOspfAreaState, opts?: CustomResourceOptions): RoutingOspfArea
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ___id_: Optional[float] = None,
            ___path_: Optional[str] = None,
            ___unset_: Optional[str] = None,
            area_id: Optional[str] = None,
            comment: Optional[str] = None,
            default_cost: Optional[float] = None,
            disabled: Optional[bool] = None,
            inactive: Optional[bool] = None,
            instance: Optional[str] = None,
            name: Optional[str] = None,
            no_summaries: Optional[bool] = None,
            nssa_translate: Optional[str] = None,
            routing_ospf_area_id: Optional[str] = None,
            type: Optional[str] = None) -> RoutingOspfArea
    func GetRoutingOspfArea(ctx *Context, name string, id IDInput, state *RoutingOspfAreaState, opts ...ResourceOption) (*RoutingOspfArea, error)
    public static RoutingOspfArea Get(string name, Input<string> id, RoutingOspfAreaState? state, CustomResourceOptions? opts = null)
    public static RoutingOspfArea get(String name, Output<String> id, RoutingOspfAreaState state, CustomResourceOptions options)
    resources:  _:    type: routeros:RoutingOspfArea    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:
    AreaId string
    OSPF area identifier.
    Comment string
    DefaultCost double
    Default cost of injected LSAs into the area.
    Disabled bool
    Inactive bool
    Instance string
    Name of the OSPF instance this area belongs to.
    Name string
    NoSummaries bool
    If set then the area will not flood summary LSAs in the stub area. \n\nThe correct value of this attribute may not be displayed in Winbox. Please check the parameters in the console!\n\n
    NssaTranslate string
    The parameter indicates which ABR will be used as a translator from type7 to type5 LSA.
    RoutingOspfAreaId string
    The ID of this resource.
    Type string
    The area type.
    ___id_ double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___unset_ string
    A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
    AreaId string
    OSPF area identifier.
    Comment string
    DefaultCost float64
    Default cost of injected LSAs into the area.
    Disabled bool
    Inactive bool
    Instance string
    Name of the OSPF instance this area belongs to.
    Name string
    NoSummaries bool
    If set then the area will not flood summary LSAs in the stub area. \n\nThe correct value of this attribute may not be displayed in Winbox. Please check the parameters in the console!\n\n
    NssaTranslate string
    The parameter indicates which ABR will be used as a translator from type7 to type5 LSA.
    RoutingOspfAreaId string
    The ID of this resource.
    Type string
    The area type.
    ___id_ float64
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___unset_ string
    A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
    ___id_ Double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___unset_ String
    A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
    areaId String
    OSPF area identifier.
    comment String
    defaultCost Double
    Default cost of injected LSAs into the area.
    disabled Boolean
    inactive Boolean
    instance String
    Name of the OSPF instance this area belongs to.
    name String
    noSummaries Boolean
    If set then the area will not flood summary LSAs in the stub area. \n\nThe correct value of this attribute may not be displayed in Winbox. Please check the parameters in the console!\n\n
    nssaTranslate String
    The parameter indicates which ABR will be used as a translator from type7 to type5 LSA.
    routingOspfAreaId String
    The ID of this resource.
    type String
    The area type.
    ___id_ number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___unset_ string
    A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
    areaId string
    OSPF area identifier.
    comment string
    defaultCost number
    Default cost of injected LSAs into the area.
    disabled boolean
    inactive boolean
    instance string
    Name of the OSPF instance this area belongs to.
    name string
    noSummaries boolean
    If set then the area will not flood summary LSAs in the stub area. \n\nThe correct value of this attribute may not be displayed in Winbox. Please check the parameters in the console!\n\n
    nssaTranslate string
    The parameter indicates which ABR will be used as a translator from type7 to type5 LSA.
    routingOspfAreaId string
    The ID of this resource.
    type string
    The area type.
    ___id_ float
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ str
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___unset_ str
    A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
    area_id str
    OSPF area identifier.
    comment str
    default_cost float
    Default cost of injected LSAs into the area.
    disabled bool
    inactive bool
    instance str
    Name of the OSPF instance this area belongs to.
    name str
    no_summaries bool
    If set then the area will not flood summary LSAs in the stub area. \n\nThe correct value of this attribute may not be displayed in Winbox. Please check the parameters in the console!\n\n
    nssa_translate str
    The parameter indicates which ABR will be used as a translator from type7 to type5 LSA.
    routing_ospf_area_id str
    The ID of this resource.
    type str
    The area type.
    ___id_ Number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___unset_ String
    A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
    areaId String
    OSPF area identifier.
    comment String
    defaultCost Number
    Default cost of injected LSAs into the area.
    disabled Boolean
    inactive Boolean
    instance String
    Name of the OSPF instance this area belongs to.
    name String
    noSummaries Boolean
    If set then the area will not flood summary LSAs in the stub area. \n\nThe correct value of this attribute may not be displayed in Winbox. Please check the parameters in the console!\n\n
    nssaTranslate String
    The parameter indicates which ABR will be used as a translator from type7 to type5 LSA.
    routingOspfAreaId String
    The ID of this resource.
    type String
    The area type.

    Import

    #The ID can be found via API or the terminal

    #The command for the terminal is -> /routing/ospf/area/print show-ids

    $ pulumi import routeros:index/routingOspfArea:RoutingOspfArea test_routing_ospf_area "*0"
    

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

    Package Details

    Repository
    routeros terraform-routeros/terraform-provider-routeros
    License
    Notes
    This Pulumi package is based on the routeros Terraform Provider.
    routeros logo
    routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros