@pulumiverse/fortios/router/ospf.d.ts

A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Configure OSPF.
 *
 * > The provider supports the definition of Ospf-Interface in Router Ospf `fortios.router.Ospf`, and also allows the definition of separate Ospf-Interface resources `fortios.router/ospf.Ospfinterface`, but do not use a `fortios.router.Ospf` with in-line Ospf-Interface in conjunction with any `fortios.router/ospf.Ospfinterface` resources, otherwise conflicts and overwrite will occur.
 *
 * > The provider supports the definition of Network in Router Ospf `fortios.router.Ospf`, and also allows the definition of separate Network resources `fortios.router/ospf.Network`, but do not use a `fortios.router.Ospf` with in-line Network in conjunction with any `fortios.router/ospf.Network` resources, otherwise conflicts and overwrite will occur.
 *
 * > The provider supports the definition of Neighbor in Router Ospf `fortios.router.Ospf`, and also allows the definition of separate Neighbor resources `fortios.router/ospf.Neighbor`, but do not use a `fortios.router.Ospf` with in-line Neighbor in conjunction with any `fortios.router/ospf.Neighbor` resources, otherwise conflicts and overwrite will occur.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fortios from "@pulumiverse/fortios";
 *
 * const trname = new fortios.router.Ospf("trname", {
 *     abrType: "standard",
 *     autoCostRefBandwidth: 1000,
 *     bfd: "disable",
 *     databaseOverflow: "disable",
 *     databaseOverflowMaxLsas: 10000,
 *     databaseOverflowTimeToRecover: 300,
 *     defaultInformationMetric: 10,
 *     defaultInformationMetricType: "2",
 *     defaultInformationOriginate: "disable",
 *     defaultMetric: 10,
 *     distance: 110,
 *     distanceExternal: 110,
 *     distanceInterArea: 110,
 *     distanceIntraArea: 110,
 *     logNeighbourChanges: "enable",
 *     redistributes: [
 *         {
 *             metric: 0,
 *             metricType: "2",
 *             name: "connected",
 *             status: "disable",
 *             tag: 0,
 *         },
 *         {
 *             metric: 0,
 *             metricType: "2",
 *             name: "static",
 *             status: "disable",
 *             tag: 0,
 *         },
 *         {
 *             metric: 0,
 *             metricType: "2",
 *             name: "rip",
 *             status: "disable",
 *             tag: 0,
 *         },
 *         {
 *             metric: 0,
 *             metricType: "2",
 *             name: "bgp",
 *             status: "disable",
 *             tag: 0,
 *         },
 *         {
 *             metric: 0,
 *             metricType: "2",
 *             name: "isis",
 *             status: "disable",
 *             tag: 0,
 *         },
 *     ],
 *     restartMode: "none",
 *     restartPeriod: 120,
 *     rfc1583Compatible: "disable",
 *     routerId: "0.0.0.0",
 *     spfTimers: "5 10",
 * });
 * ```
 *
 * ## Import
 *
 * Router Ospf can be imported using any of these accepted formats:
 *
 * ```sh
 * $ pulumi import fortios:router/ospf:Ospf labelname RouterOspf
 * ```
 *
 * If you do not want to import arguments of block:
 *
 * $ export "FORTIOS_IMPORT_TABLE"="false"
 *
 * ```sh
 * $ pulumi import fortios:router/ospf:Ospf labelname RouterOspf
 * ```
 *
 * $ unset "FORTIOS_IMPORT_TABLE"
 */
export declare class Ospf extends pulumi.CustomResource {
    /**
     * Get an existing Ospf resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OspfState, opts?: pulumi.CustomResourceOptions): Ospf;
    /**
     * Returns true if the given object is an instance of Ospf.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Ospf;
    /**
     * Area border router type. Valid values: `cisco`, `ibm`, `shortcut`, `standard`.
     */
    readonly abrType: pulumi.Output<string>;
    /**
     * OSPF area configuration. The structure of `area` block is documented below.
     */
    readonly areas: pulumi.Output<outputs.router.OspfArea[] | undefined>;
    /**
     * Reference bandwidth in terms of megabits per second.
     */
    readonly autoCostRefBandwidth: pulumi.Output<number>;
    /**
     * Bidirectional Forwarding Detection (BFD). Valid values: `enable`, `disable`.
     */
    readonly bfd: pulumi.Output<string>;
    /**
     * Enable/disable database overflow. Valid values: `enable`, `disable`.
     */
    readonly databaseOverflow: pulumi.Output<string>;
    /**
     * Database overflow maximum LSAs.
     */
    readonly databaseOverflowMaxLsas: pulumi.Output<number>;
    /**
     * Database overflow time to recover (sec).
     */
    readonly databaseOverflowTimeToRecover: pulumi.Output<number>;
    /**
     * Default information metric.
     */
    readonly defaultInformationMetric: pulumi.Output<number>;
    /**
     * Default information metric type. Valid values: `1`, `2`.
     */
    readonly defaultInformationMetricType: pulumi.Output<string>;
    /**
     * Enable/disable generation of default route. Valid values: `enable`, `always`, `disable`.
     */
    readonly defaultInformationOriginate: pulumi.Output<string>;
    /**
     * Default information route map.
     */
    readonly defaultInformationRouteMap: pulumi.Output<string>;
    /**
     * Default metric of redistribute routes.
     */
    readonly defaultMetric: pulumi.Output<number>;
    /**
     * Distance of the route.
     */
    readonly distance: pulumi.Output<number>;
    /**
     * Administrative external distance.
     */
    readonly distanceExternal: pulumi.Output<number>;
    /**
     * Administrative inter-area distance.
     */
    readonly distanceInterArea: pulumi.Output<number>;
    /**
     * Administrative intra-area distance.
     */
    readonly distanceIntraArea: pulumi.Output<number>;
    /**
     * Filter incoming routes.
     */
    readonly distributeListIn: pulumi.Output<string>;
    /**
     * Distribute list configuration. The structure of `distributeList` block is documented below.
     */
    readonly distributeLists: pulumi.Output<outputs.router.OspfDistributeList[] | undefined>;
    /**
     * Filter incoming external routes by route-map.
     */
    readonly distributeRouteMapIn: pulumi.Output<string>;
    /**
     * Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
     */
    readonly dynamicSortSubtable: pulumi.Output<string | undefined>;
    /**
     * Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
     */
    readonly getAllTables: pulumi.Output<string | undefined>;
    /**
     * Enable logging of OSPF neighbour's changes Valid values: `enable`, `disable`.
     */
    readonly logNeighbourChanges: pulumi.Output<string>;
    /**
     * OSPF neighbor configuration are used when OSPF runs on non-broadcast media The structure of `neighbor` block is documented below.
     */
    readonly neighbors: pulumi.Output<outputs.router.OspfNeighbor[] | undefined>;
    /**
     * OSPF network configuration. The structure of `network` block is documented below.
     */
    readonly networks: pulumi.Output<outputs.router.OspfNetwork[] | undefined>;
    /**
     * OSPF interface configuration. The structure of `ospfInterface` block is documented below.
     */
    readonly ospfInterfaces: pulumi.Output<outputs.router.OspfOspfInterface[] | undefined>;
    /**
     * Passive interface configuration. The structure of `passiveInterface` block is documented below.
     */
    readonly passiveInterfaces: pulumi.Output<outputs.router.OspfPassiveInterface[] | undefined>;
    /**
     * Redistribute configuration. The structure of `redistribute` block is documented below.
     */
    readonly redistributes: pulumi.Output<outputs.router.OspfRedistribute[] | undefined>;
    /**
     * OSPF restart mode (graceful or LLS). Valid values: `none`, `lls`, `graceful-restart`.
     */
    readonly restartMode: pulumi.Output<string>;
    /**
     * Enable/disable continuing graceful restart upon topology change. Valid values: `enable`, `disable`.
     */
    readonly restartOnTopologyChange: pulumi.Output<string>;
    /**
     * Graceful restart period.
     */
    readonly restartPeriod: pulumi.Output<number>;
    /**
     * Enable/disable RFC1583 compatibility. Valid values: `enable`, `disable`.
     */
    readonly rfc1583Compatible: pulumi.Output<string>;
    /**
     * Router ID.
     */
    readonly routerId: pulumi.Output<string>;
    /**
     * SPF calculation frequency.
     */
    readonly spfTimers: pulumi.Output<string>;
    /**
     * IP address summary configuration. The structure of `summaryAddress` block is documented below.
     */
    readonly summaryAddresses: pulumi.Output<outputs.router.OspfSummaryAddress[] | undefined>;
    /**
     * Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
     */
    readonly vdomparam: pulumi.Output<string>;
    /**
     * Create a Ospf resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: OspfArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Ospf resources.
 */
export interface OspfState {
    /**
     * Area border router type. Valid values: `cisco`, `ibm`, `shortcut`, `standard`.
     */
    abrType?: pulumi.Input<string>;
    /**
     * OSPF area configuration. The structure of `area` block is documented below.
     */
    areas?: pulumi.Input<pulumi.Input<inputs.router.OspfArea>[]>;
    /**
     * Reference bandwidth in terms of megabits per second.
     */
    autoCostRefBandwidth?: pulumi.Input<number>;
    /**
     * Bidirectional Forwarding Detection (BFD). Valid values: `enable`, `disable`.
     */
    bfd?: pulumi.Input<string>;
    /**
     * Enable/disable database overflow. Valid values: `enable`, `disable`.
     */
    databaseOverflow?: pulumi.Input<string>;
    /**
     * Database overflow maximum LSAs.
     */
    databaseOverflowMaxLsas?: pulumi.Input<number>;
    /**
     * Database overflow time to recover (sec).
     */
    databaseOverflowTimeToRecover?: pulumi.Input<number>;
    /**
     * Default information metric.
     */
    defaultInformationMetric?: pulumi.Input<number>;
    /**
     * Default information metric type. Valid values: `1`, `2`.
     */
    defaultInformationMetricType?: pulumi.Input<string>;
    /**
     * Enable/disable generation of default route. Valid values: `enable`, `always`, `disable`.
     */
    defaultInformationOriginate?: pulumi.Input<string>;
    /**
     * Default information route map.
     */
    defaultInformationRouteMap?: pulumi.Input<string>;
    /**
     * Default metric of redistribute routes.
     */
    defaultMetric?: pulumi.Input<number>;
    /**
     * Distance of the route.
     */
    distance?: pulumi.Input<number>;
    /**
     * Administrative external distance.
     */
    distanceExternal?: pulumi.Input<number>;
    /**
     * Administrative inter-area distance.
     */
    distanceInterArea?: pulumi.Input<number>;
    /**
     * Administrative intra-area distance.
     */
    distanceIntraArea?: pulumi.Input<number>;
    /**
     * Filter incoming routes.
     */
    distributeListIn?: pulumi.Input<string>;
    /**
     * Distribute list configuration. The structure of `distributeList` block is documented below.
     */
    distributeLists?: pulumi.Input<pulumi.Input<inputs.router.OspfDistributeList>[]>;
    /**
     * Filter incoming external routes by route-map.
     */
    distributeRouteMapIn?: pulumi.Input<string>;
    /**
     * Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
     */
    dynamicSortSubtable?: pulumi.Input<string>;
    /**
     * Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
     */
    getAllTables?: pulumi.Input<string>;
    /**
     * Enable logging of OSPF neighbour's changes Valid values: `enable`, `disable`.
     */
    logNeighbourChanges?: pulumi.Input<string>;
    /**
     * OSPF neighbor configuration are used when OSPF runs on non-broadcast media The structure of `neighbor` block is documented below.
     */
    neighbors?: pulumi.Input<pulumi.Input<inputs.router.OspfNeighbor>[]>;
    /**
     * OSPF network configuration. The structure of `network` block is documented below.
     */
    networks?: pulumi.Input<pulumi.Input<inputs.router.OspfNetwork>[]>;
    /**
     * OSPF interface configuration. The structure of `ospfInterface` block is documented below.
     */
    ospfInterfaces?: pulumi.Input<pulumi.Input<inputs.router.OspfOspfInterface>[]>;
    /**
     * Passive interface configuration. The structure of `passiveInterface` block is documented below.
     */
    passiveInterfaces?: pulumi.Input<pulumi.Input<inputs.router.OspfPassiveInterface>[]>;
    /**
     * Redistribute configuration. The structure of `redistribute` block is documented below.
     */
    redistributes?: pulumi.Input<pulumi.Input<inputs.router.OspfRedistribute>[]>;
    /**
     * OSPF restart mode (graceful or LLS). Valid values: `none`, `lls`, `graceful-restart`.
     */
    restartMode?: pulumi.Input<string>;
    /**
     * Enable/disable continuing graceful restart upon topology change. Valid values: `enable`, `disable`.
     */
    restartOnTopologyChange?: pulumi.Input<string>;
    /**
     * Graceful restart period.
     */
    restartPeriod?: pulumi.Input<number>;
    /**
     * Enable/disable RFC1583 compatibility. Valid values: `enable`, `disable`.
     */
    rfc1583Compatible?: pulumi.Input<string>;
    /**
     * Router ID.
     */
    routerId?: pulumi.Input<string>;
    /**
     * SPF calculation frequency.
     */
    spfTimers?: pulumi.Input<string>;
    /**
     * IP address summary configuration. The structure of `summaryAddress` block is documented below.
     */
    summaryAddresses?: pulumi.Input<pulumi.Input<inputs.router.OspfSummaryAddress>[]>;
    /**
     * Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
     */
    vdomparam?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Ospf resource.
 */
export interface OspfArgs {
    /**
     * Area border router type. Valid values: `cisco`, `ibm`, `shortcut`, `standard`.
     */
    abrType?: pulumi.Input<string>;
    /**
     * OSPF area configuration. The structure of `area` block is documented below.
     */
    areas?: pulumi.Input<pulumi.Input<inputs.router.OspfArea>[]>;
    /**
     * Reference bandwidth in terms of megabits per second.
     */
    autoCostRefBandwidth?: pulumi.Input<number>;
    /**
     * Bidirectional Forwarding Detection (BFD). Valid values: `enable`, `disable`.
     */
    bfd?: pulumi.Input<string>;
    /**
     * Enable/disable database overflow. Valid values: `enable`, `disable`.
     */
    databaseOverflow?: pulumi.Input<string>;
    /**
     * Database overflow maximum LSAs.
     */
    databaseOverflowMaxLsas?: pulumi.Input<number>;
    /**
     * Database overflow time to recover (sec).
     */
    databaseOverflowTimeToRecover?: pulumi.Input<number>;
    /**
     * Default information metric.
     */
    defaultInformationMetric?: pulumi.Input<number>;
    /**
     * Default information metric type. Valid values: `1`, `2`.
     */
    defaultInformationMetricType?: pulumi.Input<string>;
    /**
     * Enable/disable generation of default route. Valid values: `enable`, `always`, `disable`.
     */
    defaultInformationOriginate?: pulumi.Input<string>;
    /**
     * Default information route map.
     */
    defaultInformationRouteMap?: pulumi.Input<string>;
    /**
     * Default metric of redistribute routes.
     */
    defaultMetric?: pulumi.Input<number>;
    /**
     * Distance of the route.
     */
    distance?: pulumi.Input<number>;
    /**
     * Administrative external distance.
     */
    distanceExternal?: pulumi.Input<number>;
    /**
     * Administrative inter-area distance.
     */
    distanceInterArea?: pulumi.Input<number>;
    /**
     * Administrative intra-area distance.
     */
    distanceIntraArea?: pulumi.Input<number>;
    /**
     * Filter incoming routes.
     */
    distributeListIn?: pulumi.Input<string>;
    /**
     * Distribute list configuration. The structure of `distributeList` block is documented below.
     */
    distributeLists?: pulumi.Input<pulumi.Input<inputs.router.OspfDistributeList>[]>;
    /**
     * Filter incoming external routes by route-map.
     */
    distributeRouteMapIn?: pulumi.Input<string>;
    /**
     * Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
     */
    dynamicSortSubtable?: pulumi.Input<string>;
    /**
     * Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
     */
    getAllTables?: pulumi.Input<string>;
    /**
     * Enable logging of OSPF neighbour's changes Valid values: `enable`, `disable`.
     */
    logNeighbourChanges?: pulumi.Input<string>;
    /**
     * OSPF neighbor configuration are used when OSPF runs on non-broadcast media The structure of `neighbor` block is documented below.
     */
    neighbors?: pulumi.Input<pulumi.Input<inputs.router.OspfNeighbor>[]>;
    /**
     * OSPF network configuration. The structure of `network` block is documented below.
     */
    networks?: pulumi.Input<pulumi.Input<inputs.router.OspfNetwork>[]>;
    /**
     * OSPF interface configuration. The structure of `ospfInterface` block is documented below.
     */
    ospfInterfaces?: pulumi.Input<pulumi.Input<inputs.router.OspfOspfInterface>[]>;
    /**
     * Passive interface configuration. The structure of `passiveInterface` block is documented below.
     */
    passiveInterfaces?: pulumi.Input<pulumi.Input<inputs.router.OspfPassiveInterface>[]>;
    /**
     * Redistribute configuration. The structure of `redistribute` block is documented below.
     */
    redistributes?: pulumi.Input<pulumi.Input<inputs.router.OspfRedistribute>[]>;
    /**
     * OSPF restart mode (graceful or LLS). Valid values: `none`, `lls`, `graceful-restart`.
     */
    restartMode?: pulumi.Input<string>;
    /**
     * Enable/disable continuing graceful restart upon topology change. Valid values: `enable`, `disable`.
     */
    restartOnTopologyChange?: pulumi.Input<string>;
    /**
     * Graceful restart period.
     */
    restartPeriod?: pulumi.Input<number>;
    /**
     * Enable/disable RFC1583 compatibility. Valid values: `enable`, `disable`.
     */
    rfc1583Compatible?: pulumi.Input<string>;
    /**
     * Router ID.
     */
    routerId: pulumi.Input<string>;
    /**
     * SPF calculation frequency.
     */
    spfTimers?: pulumi.Input<string>;
    /**
     * IP address summary configuration. The structure of `summaryAddress` block is documented below.
     */
    summaryAddresses?: pulumi.Input<pulumi.Input<inputs.router.OspfSummaryAddress>[]>;
    /**
     * Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
     */
    vdomparam?: pulumi.Input<string>;
}