@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
442 lines (441 loc) • 16.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Configure FortiClient Enterprise Management Server (EMS) entries. Applies to FortiOS Version `>= 6.2.4`.
*
* ## Import
*
* EndpointControl Fctems can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:endpointcontrol/fctems:Fctems labelname {{name}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:endpointcontrol/fctems:Fctems labelname {{name}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Fctems extends pulumi.CustomResource {
/**
* Get an existing Fctems 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?: FctemsState, opts?: pulumi.CustomResourceOptions): Fctems;
/**
* Returns true if the given object is an instance of Fctems. 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 Fctems;
/**
* FortiClient EMS admin password.
*/
readonly adminPassword: pulumi.Output<string | undefined>;
/**
* FortiClient EMS admin username.
*/
readonly adminUsername: pulumi.Output<string>;
/**
* FortiClient EMS call timeout. On FortiOS versions 6.2.4-6.2.6: 500 - 30000 milliseconds, default = 5000. On FortiOS versions 6.4.0: 500 - 50000 milliseconds, default = 5000. On FortiOS versions >= 6.4.2: 1 - 180 seconds, default = 30. On FortiOS versions 6.4.1: 500 - 180000 milliseconds, default = 30000.
*/
readonly callTimeout: pulumi.Output<number>;
/**
* List of EMS capabilities.
*/
readonly capabilities: pulumi.Output<string>;
/**
* FortiClient EMS certificate.
*/
readonly certificate: pulumi.Output<string>;
/**
* FortiClient EMS Cloud multitenancy access key
*/
readonly cloudAuthenticationAccessKey: pulumi.Output<string>;
/**
* Cloud server type. Valid values: `production`, `alpha`, `beta`.
*/
readonly cloudServerType: pulumi.Output<string>;
/**
* Dirty Reason for FortiClient EMS. Valid values: `none`, `mismatched-ems-sn`.
*/
readonly dirtyReason: pulumi.Output<string>;
/**
* EMS ID in order. On FortiOS versions 7.0.8-7.0.15, 7.2.1-7.2.3: 1 - 5. On FortiOS versions >= 7.2.4: 1 - 7.
*/
readonly emsId: pulumi.Output<number>;
/**
* Enable/disable authentication of FortiClient EMS Cloud through FortiCloud account. Valid values: `enable`, `disable`.
*/
readonly fortinetoneCloudAuthentication: pulumi.Output<string>;
/**
* FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
*/
readonly httpsPort: pulumi.Output<number>;
/**
* Specify outgoing interface to reach server.
*/
readonly interface: pulumi.Output<string>;
/**
* Specify how to select outgoing interface to reach server. Valid values: `auto`, `sdwan`, `specify`.
*/
readonly interfaceSelectMethod: pulumi.Output<string>;
/**
* FortiClient Enterprise Management Server (EMS) name.
*/
readonly name: pulumi.Output<string>;
/**
* Outdated resource threshold in seconds (10 - 3600, default = 180).
*/
readonly outOfSyncThreshold: pulumi.Output<number>;
/**
* Enable/disable preservation of EMS SSL session connection. WARNING: Most users should not touch this setting! Valid values: `enable`, `disable`.
*/
readonly preserveSslSession: pulumi.Output<string>;
/**
* Enable/disable pulling avatars from EMS. Valid values: `enable`, `disable`.
*/
readonly pullAvatars: pulumi.Output<string>;
/**
* Enable/disable pulling FortiClient malware hash from EMS. Valid values: `enable`, `disable`.
*/
readonly pullMalwareHash: pulumi.Output<string>;
/**
* Enable/disable pulling SysInfo from EMS. Valid values: `enable`, `disable`.
*/
readonly pullSysinfo: pulumi.Output<string>;
/**
* Enable/disable pulling FortiClient user tags from EMS. Valid values: `enable`, `disable`.
*/
readonly pullTags: pulumi.Output<string>;
/**
* Enable/disable pulling vulnerabilities from EMS. Valid values: `enable`, `disable`.
*/
readonly pullVulnerabilities: pulumi.Output<string>;
/**
* Relax restrictions on tags to send all EMS tags to all VDOMs Valid values: `enable`, `disable`.
*/
readonly sendTagsToAllVdoms: pulumi.Output<string>;
/**
* FortiClient EMS Serial Number.
*/
readonly serialNumber: pulumi.Output<string>;
/**
* FortiClient EMS FQDN or IPv4 address.
*/
readonly server: pulumi.Output<string>;
/**
* REST API call source IP.
*/
readonly sourceIp: pulumi.Output<string>;
/**
* Enable or disable this EMS configuration. Valid values: `enable`, `disable`.
*/
readonly status: pulumi.Output<string>;
/**
* FortiClient EMS call timeout in seconds (1 - 120 seconds, default = 5).
*/
readonly statusCheckInterval: pulumi.Output<number>;
/**
* EMS Tenant ID.
*/
readonly tenantId: pulumi.Output<string>;
/**
* Enable/disable trust of the EMS certificate issuer(CA) and common name(CN) for certificate auto-renewal. Valid values: `enable`, `disable`.
*/
readonly trustCaCn: 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>;
/**
* Lowest CA cert on Fortigate in verified EMS cert chain.
*/
readonly verifyingCa: pulumi.Output<string>;
/**
* Enable/disable override behavior for how this FortiGate unit connects to EMS using a WebSocket connection. Valid values: `disable`, `enable`.
*/
readonly websocketOverride: pulumi.Output<string>;
/**
* Create a Fctems 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?: FctemsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Fctems resources.
*/
export interface FctemsState {
/**
* FortiClient EMS admin password.
*/
adminPassword?: pulumi.Input<string>;
/**
* FortiClient EMS admin username.
*/
adminUsername?: pulumi.Input<string>;
/**
* FortiClient EMS call timeout. On FortiOS versions 6.2.4-6.2.6: 500 - 30000 milliseconds, default = 5000. On FortiOS versions 6.4.0: 500 - 50000 milliseconds, default = 5000. On FortiOS versions >= 6.4.2: 1 - 180 seconds, default = 30. On FortiOS versions 6.4.1: 500 - 180000 milliseconds, default = 30000.
*/
callTimeout?: pulumi.Input<number>;
/**
* List of EMS capabilities.
*/
capabilities?: pulumi.Input<string>;
/**
* FortiClient EMS certificate.
*/
certificate?: pulumi.Input<string>;
/**
* FortiClient EMS Cloud multitenancy access key
*/
cloudAuthenticationAccessKey?: pulumi.Input<string>;
/**
* Cloud server type. Valid values: `production`, `alpha`, `beta`.
*/
cloudServerType?: pulumi.Input<string>;
/**
* Dirty Reason for FortiClient EMS. Valid values: `none`, `mismatched-ems-sn`.
*/
dirtyReason?: pulumi.Input<string>;
/**
* EMS ID in order. On FortiOS versions 7.0.8-7.0.15, 7.2.1-7.2.3: 1 - 5. On FortiOS versions >= 7.2.4: 1 - 7.
*/
emsId?: pulumi.Input<number>;
/**
* Enable/disable authentication of FortiClient EMS Cloud through FortiCloud account. Valid values: `enable`, `disable`.
*/
fortinetoneCloudAuthentication?: pulumi.Input<string>;
/**
* FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
*/
httpsPort?: pulumi.Input<number>;
/**
* Specify outgoing interface to reach server.
*/
interface?: pulumi.Input<string>;
/**
* Specify how to select outgoing interface to reach server. Valid values: `auto`, `sdwan`, `specify`.
*/
interfaceSelectMethod?: pulumi.Input<string>;
/**
* FortiClient Enterprise Management Server (EMS) name.
*/
name?: pulumi.Input<string>;
/**
* Outdated resource threshold in seconds (10 - 3600, default = 180).
*/
outOfSyncThreshold?: pulumi.Input<number>;
/**
* Enable/disable preservation of EMS SSL session connection. WARNING: Most users should not touch this setting! Valid values: `enable`, `disable`.
*/
preserveSslSession?: pulumi.Input<string>;
/**
* Enable/disable pulling avatars from EMS. Valid values: `enable`, `disable`.
*/
pullAvatars?: pulumi.Input<string>;
/**
* Enable/disable pulling FortiClient malware hash from EMS. Valid values: `enable`, `disable`.
*/
pullMalwareHash?: pulumi.Input<string>;
/**
* Enable/disable pulling SysInfo from EMS. Valid values: `enable`, `disable`.
*/
pullSysinfo?: pulumi.Input<string>;
/**
* Enable/disable pulling FortiClient user tags from EMS. Valid values: `enable`, `disable`.
*/
pullTags?: pulumi.Input<string>;
/**
* Enable/disable pulling vulnerabilities from EMS. Valid values: `enable`, `disable`.
*/
pullVulnerabilities?: pulumi.Input<string>;
/**
* Relax restrictions on tags to send all EMS tags to all VDOMs Valid values: `enable`, `disable`.
*/
sendTagsToAllVdoms?: pulumi.Input<string>;
/**
* FortiClient EMS Serial Number.
*/
serialNumber?: pulumi.Input<string>;
/**
* FortiClient EMS FQDN or IPv4 address.
*/
server?: pulumi.Input<string>;
/**
* REST API call source IP.
*/
sourceIp?: pulumi.Input<string>;
/**
* Enable or disable this EMS configuration. Valid values: `enable`, `disable`.
*/
status?: pulumi.Input<string>;
/**
* FortiClient EMS call timeout in seconds (1 - 120 seconds, default = 5).
*/
statusCheckInterval?: pulumi.Input<number>;
/**
* EMS Tenant ID.
*/
tenantId?: pulumi.Input<string>;
/**
* Enable/disable trust of the EMS certificate issuer(CA) and common name(CN) for certificate auto-renewal. Valid values: `enable`, `disable`.
*/
trustCaCn?: 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>;
/**
* Lowest CA cert on Fortigate in verified EMS cert chain.
*/
verifyingCa?: pulumi.Input<string>;
/**
* Enable/disable override behavior for how this FortiGate unit connects to EMS using a WebSocket connection. Valid values: `disable`, `enable`.
*/
websocketOverride?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Fctems resource.
*/
export interface FctemsArgs {
/**
* FortiClient EMS admin password.
*/
adminPassword?: pulumi.Input<string>;
/**
* FortiClient EMS admin username.
*/
adminUsername?: pulumi.Input<string>;
/**
* FortiClient EMS call timeout. On FortiOS versions 6.2.4-6.2.6: 500 - 30000 milliseconds, default = 5000. On FortiOS versions 6.4.0: 500 - 50000 milliseconds, default = 5000. On FortiOS versions >= 6.4.2: 1 - 180 seconds, default = 30. On FortiOS versions 6.4.1: 500 - 180000 milliseconds, default = 30000.
*/
callTimeout?: pulumi.Input<number>;
/**
* List of EMS capabilities.
*/
capabilities?: pulumi.Input<string>;
/**
* FortiClient EMS certificate.
*/
certificate?: pulumi.Input<string>;
/**
* FortiClient EMS Cloud multitenancy access key
*/
cloudAuthenticationAccessKey?: pulumi.Input<string>;
/**
* Cloud server type. Valid values: `production`, `alpha`, `beta`.
*/
cloudServerType?: pulumi.Input<string>;
/**
* Dirty Reason for FortiClient EMS. Valid values: `none`, `mismatched-ems-sn`.
*/
dirtyReason?: pulumi.Input<string>;
/**
* EMS ID in order. On FortiOS versions 7.0.8-7.0.15, 7.2.1-7.2.3: 1 - 5. On FortiOS versions >= 7.2.4: 1 - 7.
*/
emsId?: pulumi.Input<number>;
/**
* Enable/disable authentication of FortiClient EMS Cloud through FortiCloud account. Valid values: `enable`, `disable`.
*/
fortinetoneCloudAuthentication?: pulumi.Input<string>;
/**
* FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
*/
httpsPort?: pulumi.Input<number>;
/**
* Specify outgoing interface to reach server.
*/
interface?: pulumi.Input<string>;
/**
* Specify how to select outgoing interface to reach server. Valid values: `auto`, `sdwan`, `specify`.
*/
interfaceSelectMethod?: pulumi.Input<string>;
/**
* FortiClient Enterprise Management Server (EMS) name.
*/
name?: pulumi.Input<string>;
/**
* Outdated resource threshold in seconds (10 - 3600, default = 180).
*/
outOfSyncThreshold?: pulumi.Input<number>;
/**
* Enable/disable preservation of EMS SSL session connection. WARNING: Most users should not touch this setting! Valid values: `enable`, `disable`.
*/
preserveSslSession?: pulumi.Input<string>;
/**
* Enable/disable pulling avatars from EMS. Valid values: `enable`, `disable`.
*/
pullAvatars?: pulumi.Input<string>;
/**
* Enable/disable pulling FortiClient malware hash from EMS. Valid values: `enable`, `disable`.
*/
pullMalwareHash?: pulumi.Input<string>;
/**
* Enable/disable pulling SysInfo from EMS. Valid values: `enable`, `disable`.
*/
pullSysinfo?: pulumi.Input<string>;
/**
* Enable/disable pulling FortiClient user tags from EMS. Valid values: `enable`, `disable`.
*/
pullTags?: pulumi.Input<string>;
/**
* Enable/disable pulling vulnerabilities from EMS. Valid values: `enable`, `disable`.
*/
pullVulnerabilities?: pulumi.Input<string>;
/**
* Relax restrictions on tags to send all EMS tags to all VDOMs Valid values: `enable`, `disable`.
*/
sendTagsToAllVdoms?: pulumi.Input<string>;
/**
* FortiClient EMS Serial Number.
*/
serialNumber?: pulumi.Input<string>;
/**
* FortiClient EMS FQDN or IPv4 address.
*/
server?: pulumi.Input<string>;
/**
* REST API call source IP.
*/
sourceIp?: pulumi.Input<string>;
/**
* Enable or disable this EMS configuration. Valid values: `enable`, `disable`.
*/
status?: pulumi.Input<string>;
/**
* FortiClient EMS call timeout in seconds (1 - 120 seconds, default = 5).
*/
statusCheckInterval?: pulumi.Input<number>;
/**
* EMS Tenant ID.
*/
tenantId?: pulumi.Input<string>;
/**
* Enable/disable trust of the EMS certificate issuer(CA) and common name(CN) for certificate auto-renewal. Valid values: `enable`, `disable`.
*/
trustCaCn?: 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>;
/**
* Lowest CA cert on Fortigate in verified EMS cert chain.
*/
verifyingCa?: pulumi.Input<string>;
/**
* Enable/disable override behavior for how this FortiGate unit connects to EMS using a WebSocket connection. Valid values: `disable`, `enable`.
*/
websocketOverride?: pulumi.Input<string>;
}