@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
398 lines (397 loc) • 14.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Configure IPv4 static routing tables.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.router.Static("trname", {
* bfd: "disable",
* blackhole: "disable",
* device: "port4",
* distance: 10,
* dst: "1.0.0.0 255.240.0.0",
* dynamicGateway: "disable",
* gateway: "0.0.0.0",
* internetService: 0,
* linkMonitorExempt: "disable",
* priority: 22,
* seqNum: 1,
* src: "0.0.0.0 0.0.0.0",
* status: "enable",
* virtualWanLink: "disable",
* vrf: 0,
* weight: 2,
* });
* ```
*
* ## Import
*
* Router Static can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:router/static:Static labelname {{seq_num}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:router/static:Static labelname {{seq_num}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Static extends pulumi.CustomResource {
/**
* Get an existing Static 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?: StaticState, opts?: pulumi.CustomResourceOptions): Static;
/**
* Returns true if the given object is an instance of Static. 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 Static;
/**
* Enable/disable Bidirectional Forwarding Detection (BFD). Valid values: `enable`, `disable`.
*/
readonly bfd: pulumi.Output<string>;
/**
* Enable/disable black hole. Valid values: `enable`, `disable`.
*/
readonly blackhole: pulumi.Output<string>;
/**
* Optional comments.
*/
readonly comment: pulumi.Output<string | undefined>;
/**
* Gateway out interface or tunnel.
*/
readonly device: pulumi.Output<string>;
/**
* Administrative distance (1 - 255).
*/
readonly distance: pulumi.Output<number>;
/**
* Destination IP and mask for this route.
*/
readonly dst: pulumi.Output<string>;
/**
* Name of firewall address or address group.
*/
readonly dstaddr: pulumi.Output<string>;
/**
* Enable use of dynamic gateway retrieved from a DHCP or PPP server. Valid values: `enable`, `disable`.
*/
readonly dynamicGateway: 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>;
/**
* Gateway IP for this route.
*/
readonly gateway: pulumi.Output<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.
*/
readonly getAllTables: pulumi.Output<string | undefined>;
/**
* Application ID in the Internet service database.
*/
readonly internetService: pulumi.Output<number>;
/**
* Application name in the Internet service custom database.
*/
readonly internetServiceCustom: pulumi.Output<string>;
/**
* Enable/disable withdrawing this route when link monitor or health check is down. Valid values: `enable`, `disable`.
*/
readonly linkMonitorExempt: pulumi.Output<string>;
/**
* Preferred source IP for this route.
*/
readonly preferredSource: pulumi.Output<string>;
/**
* Administrative priority. On FortiOS versions 6.2.0-6.4.1: 0 - 4294967295. On FortiOS versions 6.4.2-7.0.3: 0 - 65535. On FortiOS versions >= 7.0.4: 1 - 65535.
*/
readonly priority: pulumi.Output<number>;
/**
* Enable/disable egress through SD-WAN. Valid values: `enable`, `disable`.
*/
readonly sdwan: pulumi.Output<string>;
/**
* Choose SD-WAN Zone. The structure of `sdwanZone` block is documented below.
*/
readonly sdwanZones: pulumi.Output<outputs.router.StaticSdwanZone[] | undefined>;
/**
* Sequence number.
*/
readonly seqNum: pulumi.Output<number>;
/**
* Source prefix for this route.
*/
readonly src: pulumi.Output<string>;
/**
* Enable/disable this static route. Valid values: `enable`, `disable`.
*/
readonly status: pulumi.Output<string>;
/**
* Route tag.
*/
readonly tag: pulumi.Output<number>;
/**
* 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>;
/**
* Enable/disable egress through the virtual-wan-link. Valid values: `enable`, `disable`.
*/
readonly virtualWanLink: pulumi.Output<string>;
/**
* Virtual Routing Forwarding ID.
*/
readonly vrf: pulumi.Output<number>;
/**
* Administrative weight (0 - 255).
*/
readonly weight: pulumi.Output<number>;
/**
* Create a Static 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?: StaticArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Static resources.
*/
export interface StaticState {
/**
* Enable/disable Bidirectional Forwarding Detection (BFD). Valid values: `enable`, `disable`.
*/
bfd?: pulumi.Input<string>;
/**
* Enable/disable black hole. Valid values: `enable`, `disable`.
*/
blackhole?: pulumi.Input<string>;
/**
* Optional comments.
*/
comment?: pulumi.Input<string>;
/**
* Gateway out interface or tunnel.
*/
device?: pulumi.Input<string>;
/**
* Administrative distance (1 - 255).
*/
distance?: pulumi.Input<number>;
/**
* Destination IP and mask for this route.
*/
dst?: pulumi.Input<string>;
/**
* Name of firewall address or address group.
*/
dstaddr?: pulumi.Input<string>;
/**
* Enable use of dynamic gateway retrieved from a DHCP or PPP server. Valid values: `enable`, `disable`.
*/
dynamicGateway?: 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>;
/**
* Gateway IP for this route.
*/
gateway?: 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>;
/**
* Application ID in the Internet service database.
*/
internetService?: pulumi.Input<number>;
/**
* Application name in the Internet service custom database.
*/
internetServiceCustom?: pulumi.Input<string>;
/**
* Enable/disable withdrawing this route when link monitor or health check is down. Valid values: `enable`, `disable`.
*/
linkMonitorExempt?: pulumi.Input<string>;
/**
* Preferred source IP for this route.
*/
preferredSource?: pulumi.Input<string>;
/**
* Administrative priority. On FortiOS versions 6.2.0-6.4.1: 0 - 4294967295. On FortiOS versions 6.4.2-7.0.3: 0 - 65535. On FortiOS versions >= 7.0.4: 1 - 65535.
*/
priority?: pulumi.Input<number>;
/**
* Enable/disable egress through SD-WAN. Valid values: `enable`, `disable`.
*/
sdwan?: pulumi.Input<string>;
/**
* Choose SD-WAN Zone. The structure of `sdwanZone` block is documented below.
*/
sdwanZones?: pulumi.Input<pulumi.Input<inputs.router.StaticSdwanZone>[]>;
/**
* Sequence number.
*/
seqNum?: pulumi.Input<number>;
/**
* Source prefix for this route.
*/
src?: pulumi.Input<string>;
/**
* Enable/disable this static route. Valid values: `enable`, `disable`.
*/
status?: pulumi.Input<string>;
/**
* Route tag.
*/
tag?: pulumi.Input<number>;
/**
* 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>;
/**
* Enable/disable egress through the virtual-wan-link. Valid values: `enable`, `disable`.
*/
virtualWanLink?: pulumi.Input<string>;
/**
* Virtual Routing Forwarding ID.
*/
vrf?: pulumi.Input<number>;
/**
* Administrative weight (0 - 255).
*/
weight?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Static resource.
*/
export interface StaticArgs {
/**
* Enable/disable Bidirectional Forwarding Detection (BFD). Valid values: `enable`, `disable`.
*/
bfd?: pulumi.Input<string>;
/**
* Enable/disable black hole. Valid values: `enable`, `disable`.
*/
blackhole?: pulumi.Input<string>;
/**
* Optional comments.
*/
comment?: pulumi.Input<string>;
/**
* Gateway out interface or tunnel.
*/
device?: pulumi.Input<string>;
/**
* Administrative distance (1 - 255).
*/
distance?: pulumi.Input<number>;
/**
* Destination IP and mask for this route.
*/
dst?: pulumi.Input<string>;
/**
* Name of firewall address or address group.
*/
dstaddr?: pulumi.Input<string>;
/**
* Enable use of dynamic gateway retrieved from a DHCP or PPP server. Valid values: `enable`, `disable`.
*/
dynamicGateway?: 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>;
/**
* Gateway IP for this route.
*/
gateway?: 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>;
/**
* Application ID in the Internet service database.
*/
internetService?: pulumi.Input<number>;
/**
* Application name in the Internet service custom database.
*/
internetServiceCustom?: pulumi.Input<string>;
/**
* Enable/disable withdrawing this route when link monitor or health check is down. Valid values: `enable`, `disable`.
*/
linkMonitorExempt?: pulumi.Input<string>;
/**
* Preferred source IP for this route.
*/
preferredSource?: pulumi.Input<string>;
/**
* Administrative priority. On FortiOS versions 6.2.0-6.4.1: 0 - 4294967295. On FortiOS versions 6.4.2-7.0.3: 0 - 65535. On FortiOS versions >= 7.0.4: 1 - 65535.
*/
priority?: pulumi.Input<number>;
/**
* Enable/disable egress through SD-WAN. Valid values: `enable`, `disable`.
*/
sdwan?: pulumi.Input<string>;
/**
* Choose SD-WAN Zone. The structure of `sdwanZone` block is documented below.
*/
sdwanZones?: pulumi.Input<pulumi.Input<inputs.router.StaticSdwanZone>[]>;
/**
* Sequence number.
*/
seqNum?: pulumi.Input<number>;
/**
* Source prefix for this route.
*/
src?: pulumi.Input<string>;
/**
* Enable/disable this static route. Valid values: `enable`, `disable`.
*/
status?: pulumi.Input<string>;
/**
* Route tag.
*/
tag?: pulumi.Input<number>;
/**
* 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>;
/**
* Enable/disable egress through the virtual-wan-link. Valid values: `enable`, `disable`.
*/
virtualWanLink?: pulumi.Input<string>;
/**
* Virtual Routing Forwarding ID.
*/
vrf?: pulumi.Input<number>;
/**
* Administrative weight (0 - 255).
*/
weight?: pulumi.Input<number>;
}