@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
284 lines (283 loc) • 11.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Configure endpoint control settings. Applies to FortiOS Version `6.2.0,6.2.4,6.2.6,7.4.0,7.4.1,7.4.2,7.4.3,7.4.4`.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.endpointcontrol.Settings("trname", {
* downloadLocation: "fortiguard",
* forticlientAvdbUpdateInterval: 8,
* forticlientDeregUnsupportedClient: "enable",
* forticlientEmsRestApiCallTimeout: 5000,
* forticlientKeepaliveInterval: 60,
* forticlientOfflineGrace: "disable",
* forticlientOfflineGraceInterval: 120,
* forticlientRegKeyEnforce: "disable",
* forticlientRegTimeout: 7,
* forticlientSysUpdateInterval: 720,
* forticlientUserAvatar: "enable",
* forticlientWarningInterval: 1,
* });
* ```
*
* ## Import
*
* EndpointControl Settings can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:endpointcontrol/settings:Settings labelname EndpointControlSettings
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:endpointcontrol/settings:Settings labelname EndpointControlSettings
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Settings extends pulumi.CustomResource {
/**
* Get an existing Settings 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?: SettingsState, opts?: pulumi.CustomResourceOptions): Settings;
/**
* Returns true if the given object is an instance of Settings. 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 Settings;
/**
* Customized URL for downloading FortiClient.
*/
readonly downloadCustomLink: pulumi.Output<string>;
/**
* FortiClient download location (FortiGuard or custom). Valid values: `fortiguard`, `custom`.
*/
readonly downloadLocation: pulumi.Output<string>;
/**
* Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
*/
readonly forticlientAvdbUpdateInterval: pulumi.Output<number>;
/**
* Enable/disable deregistering unsupported FortiClient endpoints. Valid values: `enable`, `disable`.
*/
readonly forticlientDeregUnsupportedClient: pulumi.Output<string>;
/**
* Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: `enable`, `disable`.
*/
readonly forticlientDisconnectUnsupportedClient: pulumi.Output<string>;
/**
* FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
*/
readonly forticlientEmsRestApiCallTimeout: pulumi.Output<number>;
/**
* Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
*/
readonly forticlientKeepaliveInterval: pulumi.Output<number>;
/**
* Enable/disable grace period for offline registered clients. Valid values: `enable`, `disable`.
*/
readonly forticlientOfflineGrace: pulumi.Output<string>;
/**
* Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
*/
readonly forticlientOfflineGraceInterval: pulumi.Output<number>;
/**
* FortiClient registration key.
*/
readonly forticlientRegKey: pulumi.Output<string | undefined>;
/**
* Enable/disable requiring or enforcing FortiClient registration keys. Valid values: `enable`, `disable`.
*/
readonly forticlientRegKeyEnforce: pulumi.Output<string>;
/**
* FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
*/
readonly forticlientRegTimeout: pulumi.Output<number>;
/**
* Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
*/
readonly forticlientSysUpdateInterval: pulumi.Output<number>;
/**
* Enable/disable uploading FortiClient user avatars. Valid values: `enable`, `disable`.
*/
readonly forticlientUserAvatar: pulumi.Output<string>;
/**
* Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
*/
readonly forticlientWarningInterval: pulumi.Output<number>;
/**
* Override global EMS table for this VDOM. Valid values: `enable`, `disable`.
*/
readonly override: 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 Settings 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?: SettingsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Settings resources.
*/
export interface SettingsState {
/**
* Customized URL for downloading FortiClient.
*/
downloadCustomLink?: pulumi.Input<string>;
/**
* FortiClient download location (FortiGuard or custom). Valid values: `fortiguard`, `custom`.
*/
downloadLocation?: pulumi.Input<string>;
/**
* Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
*/
forticlientAvdbUpdateInterval?: pulumi.Input<number>;
/**
* Enable/disable deregistering unsupported FortiClient endpoints. Valid values: `enable`, `disable`.
*/
forticlientDeregUnsupportedClient?: pulumi.Input<string>;
/**
* Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: `enable`, `disable`.
*/
forticlientDisconnectUnsupportedClient?: pulumi.Input<string>;
/**
* FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
*/
forticlientEmsRestApiCallTimeout?: pulumi.Input<number>;
/**
* Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
*/
forticlientKeepaliveInterval?: pulumi.Input<number>;
/**
* Enable/disable grace period for offline registered clients. Valid values: `enable`, `disable`.
*/
forticlientOfflineGrace?: pulumi.Input<string>;
/**
* Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
*/
forticlientOfflineGraceInterval?: pulumi.Input<number>;
/**
* FortiClient registration key.
*/
forticlientRegKey?: pulumi.Input<string>;
/**
* Enable/disable requiring or enforcing FortiClient registration keys. Valid values: `enable`, `disable`.
*/
forticlientRegKeyEnforce?: pulumi.Input<string>;
/**
* FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
*/
forticlientRegTimeout?: pulumi.Input<number>;
/**
* Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
*/
forticlientSysUpdateInterval?: pulumi.Input<number>;
/**
* Enable/disable uploading FortiClient user avatars. Valid values: `enable`, `disable`.
*/
forticlientUserAvatar?: pulumi.Input<string>;
/**
* Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
*/
forticlientWarningInterval?: pulumi.Input<number>;
/**
* Override global EMS table for this VDOM. Valid values: `enable`, `disable`.
*/
override?: 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 Settings resource.
*/
export interface SettingsArgs {
/**
* Customized URL for downloading FortiClient.
*/
downloadCustomLink?: pulumi.Input<string>;
/**
* FortiClient download location (FortiGuard or custom). Valid values: `fortiguard`, `custom`.
*/
downloadLocation?: pulumi.Input<string>;
/**
* Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
*/
forticlientAvdbUpdateInterval?: pulumi.Input<number>;
/**
* Enable/disable deregistering unsupported FortiClient endpoints. Valid values: `enable`, `disable`.
*/
forticlientDeregUnsupportedClient?: pulumi.Input<string>;
/**
* Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: `enable`, `disable`.
*/
forticlientDisconnectUnsupportedClient?: pulumi.Input<string>;
/**
* FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
*/
forticlientEmsRestApiCallTimeout?: pulumi.Input<number>;
/**
* Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
*/
forticlientKeepaliveInterval?: pulumi.Input<number>;
/**
* Enable/disable grace period for offline registered clients. Valid values: `enable`, `disable`.
*/
forticlientOfflineGrace?: pulumi.Input<string>;
/**
* Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
*/
forticlientOfflineGraceInterval?: pulumi.Input<number>;
/**
* FortiClient registration key.
*/
forticlientRegKey?: pulumi.Input<string>;
/**
* Enable/disable requiring or enforcing FortiClient registration keys. Valid values: `enable`, `disable`.
*/
forticlientRegKeyEnforce?: pulumi.Input<string>;
/**
* FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
*/
forticlientRegTimeout?: pulumi.Input<number>;
/**
* Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
*/
forticlientSysUpdateInterval?: pulumi.Input<number>;
/**
* Enable/disable uploading FortiClient user avatars. Valid values: `enable`, `disable`.
*/
forticlientUserAvatar?: pulumi.Input<string>;
/**
* Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
*/
forticlientWarningInterval?: pulumi.Input<number>;
/**
* Override global EMS table for this VDOM. Valid values: `enable`, `disable`.
*/
override?: 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>;
}