@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
346 lines (345 loc) • 15.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Configure IPS global parameter.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.ips.Global("trname", {
* anomalyMode: "continuous",
* database: "regular",
* deepAppInspDbLimit: 0,
* deepAppInspTimeout: 0,
* engineCount: 0,
* excludeSignatures: "industrial",
* failOpen: "disable",
* intelligentMode: "enable",
* sessionLimitMode: "heuristic",
* socketSize: 0,
* syncSessionTtl: "enable",
* trafficSubmit: "disable",
* });
* ```
*
* ## Import
*
* Ips Global can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:ips/global:Global labelname IpsGlobal
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:ips/global:Global labelname IpsGlobal
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Global extends pulumi.CustomResource {
/**
* Get an existing Global 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?: GlobalState, opts?: pulumi.CustomResourceOptions): Global;
/**
* Returns true if the given object is an instance of Global. 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 Global;
/**
* Global blocking mode for rate-based anomalies. Valid values: `periodical`, `continuous`.
*/
readonly anomalyMode: pulumi.Output<string>;
/**
* Maximum percentage of system memory allowed for use on AV scanning (10 - 50, default = zero). To disable set to zero. When disabled, there is no limit on the AV memory usage.
*/
readonly avMemLimit: pulumi.Output<number>;
/**
* IPS Pattern matching acceleration/offloading to CPx processors. Valid values: `none`, `basic`, `advanced`.
*/
readonly cpAccelMode: pulumi.Output<string>;
/**
* Regular or extended IPS database. Regular protects against the latest common and in-the-wild attacks. Extended includes protection from legacy attacks. Valid values: `regular`, `extended`.
*/
readonly database: pulumi.Output<string>;
/**
* Limit on number of entries in deep application inspection database (1 - 2147483647, use recommended setting = 0).
*/
readonly deepAppInspDbLimit: pulumi.Output<number>;
/**
* Timeout for Deep application inspection (1 - 2147483647 sec., 0 = use recommended setting).
*/
readonly deepAppInspTimeout: pulumi.Output<number>;
/**
* Number of IPS engines running. If set to the default value of 0, FortiOS sets the number to optimize performance depending on the number of CPU cores.
*/
readonly engineCount: pulumi.Output<number>;
/**
* Excluded signatures.
*/
readonly excludeSignatures: pulumi.Output<string>;
/**
* Enable to allow traffic if the IPS process crashes. Default is disable and IPS traffic is blocked when the IPS process crashes. Valid values: `enable`, `disable`.
*/
readonly failOpen: 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>;
/**
* Enable/disable IPS adaptive scanning (intelligent mode). Intelligent mode optimizes the scanning method for the type of traffic. Valid values: `enable`, `disable`.
*/
readonly intelligentMode: pulumi.Output<string>;
/**
* Enable/disable IPS daemon's use of CPUs other than CPU 0 Valid values: `disable`, `enable`.
*/
readonly ipsReserveCpu: pulumi.Output<string>;
/**
* NGFW policy-mode app detection threshold.
*/
readonly ngfwMaxScanRange: pulumi.Output<number>;
/**
* Acceleration mode for IPS processing by NPx processors. Valid values: `none`, `basic`.
*/
readonly npAccelMode: pulumi.Output<string>;
/**
* Packet/pcap log queue depth per IPS engine.
*/
readonly packetLogQueueDepth: pulumi.Output<number>;
/**
* Method of counting concurrent sessions used by session limit anomalies. Choose between greater accuracy (accurate) or improved performance (heuristics). Valid values: `accurate`, `heuristic`.
*/
readonly sessionLimitMode: pulumi.Output<string>;
/**
* Public IP addresses of your network that receive Skype sessions. Helps identify Skype sessions. Separate IP addresses with commas.
*/
readonly skypeClientPublicIpaddr: pulumi.Output<string | undefined>;
/**
* IPS socket buffer size. Max and default value depend on available memory. Can be changed to tune performance.
*/
readonly socketSize: pulumi.Output<number>;
/**
* Enable/disable use of kernel session TTL for IPS sessions. Valid values: `enable`, `disable`.
*/
readonly syncSessionTtl: pulumi.Output<string>;
/**
* TLS active probe configuration. The structure of `tlsActiveProbe` block is documented below.
*/
readonly tlsActiveProbe: pulumi.Output<outputs.ips.GlobalTlsActiveProbe>;
/**
* Enable/disable submitting attack data found by this FortiGate to FortiGuard. Valid values: `enable`, `disable`.
*/
readonly trafficSubmit: pulumi.Output<string>;
/**
* 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 Global 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?: GlobalArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Global resources.
*/
export interface GlobalState {
/**
* Global blocking mode for rate-based anomalies. Valid values: `periodical`, `continuous`.
*/
anomalyMode?: pulumi.Input<string>;
/**
* Maximum percentage of system memory allowed for use on AV scanning (10 - 50, default = zero). To disable set to zero. When disabled, there is no limit on the AV memory usage.
*/
avMemLimit?: pulumi.Input<number>;
/**
* IPS Pattern matching acceleration/offloading to CPx processors. Valid values: `none`, `basic`, `advanced`.
*/
cpAccelMode?: pulumi.Input<string>;
/**
* Regular or extended IPS database. Regular protects against the latest common and in-the-wild attacks. Extended includes protection from legacy attacks. Valid values: `regular`, `extended`.
*/
database?: pulumi.Input<string>;
/**
* Limit on number of entries in deep application inspection database (1 - 2147483647, use recommended setting = 0).
*/
deepAppInspDbLimit?: pulumi.Input<number>;
/**
* Timeout for Deep application inspection (1 - 2147483647 sec., 0 = use recommended setting).
*/
deepAppInspTimeout?: pulumi.Input<number>;
/**
* Number of IPS engines running. If set to the default value of 0, FortiOS sets the number to optimize performance depending on the number of CPU cores.
*/
engineCount?: pulumi.Input<number>;
/**
* Excluded signatures.
*/
excludeSignatures?: pulumi.Input<string>;
/**
* Enable to allow traffic if the IPS process crashes. Default is disable and IPS traffic is blocked when the IPS process crashes. Valid values: `enable`, `disable`.
*/
failOpen?: 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/disable IPS adaptive scanning (intelligent mode). Intelligent mode optimizes the scanning method for the type of traffic. Valid values: `enable`, `disable`.
*/
intelligentMode?: pulumi.Input<string>;
/**
* Enable/disable IPS daemon's use of CPUs other than CPU 0 Valid values: `disable`, `enable`.
*/
ipsReserveCpu?: pulumi.Input<string>;
/**
* NGFW policy-mode app detection threshold.
*/
ngfwMaxScanRange?: pulumi.Input<number>;
/**
* Acceleration mode for IPS processing by NPx processors. Valid values: `none`, `basic`.
*/
npAccelMode?: pulumi.Input<string>;
/**
* Packet/pcap log queue depth per IPS engine.
*/
packetLogQueueDepth?: pulumi.Input<number>;
/**
* Method of counting concurrent sessions used by session limit anomalies. Choose between greater accuracy (accurate) or improved performance (heuristics). Valid values: `accurate`, `heuristic`.
*/
sessionLimitMode?: pulumi.Input<string>;
/**
* Public IP addresses of your network that receive Skype sessions. Helps identify Skype sessions. Separate IP addresses with commas.
*/
skypeClientPublicIpaddr?: pulumi.Input<string>;
/**
* IPS socket buffer size. Max and default value depend on available memory. Can be changed to tune performance.
*/
socketSize?: pulumi.Input<number>;
/**
* Enable/disable use of kernel session TTL for IPS sessions. Valid values: `enable`, `disable`.
*/
syncSessionTtl?: pulumi.Input<string>;
/**
* TLS active probe configuration. The structure of `tlsActiveProbe` block is documented below.
*/
tlsActiveProbe?: pulumi.Input<inputs.ips.GlobalTlsActiveProbe>;
/**
* Enable/disable submitting attack data found by this FortiGate to FortiGuard. Valid values: `enable`, `disable`.
*/
trafficSubmit?: pulumi.Input<string>;
/**
* 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 Global resource.
*/
export interface GlobalArgs {
/**
* Global blocking mode for rate-based anomalies. Valid values: `periodical`, `continuous`.
*/
anomalyMode?: pulumi.Input<string>;
/**
* Maximum percentage of system memory allowed for use on AV scanning (10 - 50, default = zero). To disable set to zero. When disabled, there is no limit on the AV memory usage.
*/
avMemLimit?: pulumi.Input<number>;
/**
* IPS Pattern matching acceleration/offloading to CPx processors. Valid values: `none`, `basic`, `advanced`.
*/
cpAccelMode?: pulumi.Input<string>;
/**
* Regular or extended IPS database. Regular protects against the latest common and in-the-wild attacks. Extended includes protection from legacy attacks. Valid values: `regular`, `extended`.
*/
database?: pulumi.Input<string>;
/**
* Limit on number of entries in deep application inspection database (1 - 2147483647, use recommended setting = 0).
*/
deepAppInspDbLimit?: pulumi.Input<number>;
/**
* Timeout for Deep application inspection (1 - 2147483647 sec., 0 = use recommended setting).
*/
deepAppInspTimeout?: pulumi.Input<number>;
/**
* Number of IPS engines running. If set to the default value of 0, FortiOS sets the number to optimize performance depending on the number of CPU cores.
*/
engineCount?: pulumi.Input<number>;
/**
* Excluded signatures.
*/
excludeSignatures?: pulumi.Input<string>;
/**
* Enable to allow traffic if the IPS process crashes. Default is disable and IPS traffic is blocked when the IPS process crashes. Valid values: `enable`, `disable`.
*/
failOpen?: 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/disable IPS adaptive scanning (intelligent mode). Intelligent mode optimizes the scanning method for the type of traffic. Valid values: `enable`, `disable`.
*/
intelligentMode?: pulumi.Input<string>;
/**
* Enable/disable IPS daemon's use of CPUs other than CPU 0 Valid values: `disable`, `enable`.
*/
ipsReserveCpu?: pulumi.Input<string>;
/**
* NGFW policy-mode app detection threshold.
*/
ngfwMaxScanRange?: pulumi.Input<number>;
/**
* Acceleration mode for IPS processing by NPx processors. Valid values: `none`, `basic`.
*/
npAccelMode?: pulumi.Input<string>;
/**
* Packet/pcap log queue depth per IPS engine.
*/
packetLogQueueDepth?: pulumi.Input<number>;
/**
* Method of counting concurrent sessions used by session limit anomalies. Choose between greater accuracy (accurate) or improved performance (heuristics). Valid values: `accurate`, `heuristic`.
*/
sessionLimitMode?: pulumi.Input<string>;
/**
* Public IP addresses of your network that receive Skype sessions. Helps identify Skype sessions. Separate IP addresses with commas.
*/
skypeClientPublicIpaddr?: pulumi.Input<string>;
/**
* IPS socket buffer size. Max and default value depend on available memory. Can be changed to tune performance.
*/
socketSize?: pulumi.Input<number>;
/**
* Enable/disable use of kernel session TTL for IPS sessions. Valid values: `enable`, `disable`.
*/
syncSessionTtl?: pulumi.Input<string>;
/**
* TLS active probe configuration. The structure of `tlsActiveProbe` block is documented below.
*/
tlsActiveProbe?: pulumi.Input<inputs.ips.GlobalTlsActiveProbe>;
/**
* Enable/disable submitting attack data found by this FortiGate to FortiGuard. Valid values: `enable`, `disable`.
*/
trafficSubmit?: pulumi.Input<string>;
/**
* 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>;
}