@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
280 lines (279 loc) • 13.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Configure FortiGate Session Life Support Protocol (FGSP) session synchronization. Applies to FortiOS Version `<= 7.2.0`.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.system.Clustersync("trname", {
* hbInterval: 3,
* hbLostThreshold: 3,
* peerip: "1.1.1.1",
* peervd: "root",
* slaveAddIkeRoutes: "enable",
* syncId: 1,
* });
* ```
*
* ## Import
*
* System ClusterSync can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:system/clustersync:Clustersync labelname {{sync_id}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:system/clustersync:Clustersync labelname {{sync_id}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Clustersync extends pulumi.CustomResource {
/**
* Get an existing Clustersync 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?: ClustersyncState, opts?: pulumi.CustomResourceOptions): Clustersync;
/**
* Returns true if the given object is an instance of Clustersync. 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 Clustersync;
/**
* List of interfaces to be turned down before session synchronization is complete. The structure of `downIntfsBeforeSessSync` block is documented below.
*/
readonly downIntfsBeforeSessSyncs: pulumi.Output<outputs.system.ClustersyncDownIntfsBeforeSessSync[] | undefined>;
/**
* 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>;
/**
* Heartbeat interval. Increase to reduce false positives. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 1 - 10 sec. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15: 1 - 20 (100*ms).
*/
readonly hbInterval: pulumi.Output<number>;
/**
* Lost heartbeat threshold. Increase to reduce false positives. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 1 - 10. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15: 1 - 60.
*/
readonly hbLostThreshold: pulumi.Output<number>;
/**
* IKE heartbeat interval (1 - 60 secs).
*/
readonly ikeHeartbeatInterval: pulumi.Output<number>;
/**
* Enable/disable IKE HA monitor. Valid values: `enable`, `disable`.
*/
readonly ikeMonitor: pulumi.Output<string>;
/**
* IKE HA monitor interval (10 - 300 secs).
*/
readonly ikeMonitorInterval: pulumi.Output<number>;
/**
* Enable/disable IPsec tunnel synchronization. Valid values: `enable`, `disable`.
*/
readonly ipsecTunnelSync: pulumi.Output<string>;
/**
* IP address of the interface on the peer unit that is used for the session synchronization link.
*/
readonly peerip: pulumi.Output<string>;
/**
* VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd.
*/
readonly peervd: pulumi.Output<string>;
/**
* Enable/disable IKE route announcement on the backup unit. Valid values: `enable`, `disable`.
*/
readonly secondaryAddIpsecRoutes: pulumi.Output<string>;
/**
* Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize. The structure of `sessionSyncFilter` block is documented below.
*/
readonly sessionSyncFilter: pulumi.Output<outputs.system.ClustersyncSessionSyncFilter>;
/**
* Enable/disable IKE route announcement on the backup unit. Valid values: `enable`, `disable`.
*/
readonly slaveAddIkeRoutes: pulumi.Output<string>;
/**
* Sync ID.
*/
readonly syncId: pulumi.Output<number>;
/**
* Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of `syncvd` block is documented below.
*/
readonly syncvds: pulumi.Output<outputs.system.ClustersyncSyncvd[] | 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 Clustersync 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?: ClustersyncArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Clustersync resources.
*/
export interface ClustersyncState {
/**
* List of interfaces to be turned down before session synchronization is complete. The structure of `downIntfsBeforeSessSync` block is documented below.
*/
downIntfsBeforeSessSyncs?: pulumi.Input<pulumi.Input<inputs.system.ClustersyncDownIntfsBeforeSessSync>[]>;
/**
* 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>;
/**
* Heartbeat interval. Increase to reduce false positives. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 1 - 10 sec. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15: 1 - 20 (100*ms).
*/
hbInterval?: pulumi.Input<number>;
/**
* Lost heartbeat threshold. Increase to reduce false positives. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 1 - 10. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15: 1 - 60.
*/
hbLostThreshold?: pulumi.Input<number>;
/**
* IKE heartbeat interval (1 - 60 secs).
*/
ikeHeartbeatInterval?: pulumi.Input<number>;
/**
* Enable/disable IKE HA monitor. Valid values: `enable`, `disable`.
*/
ikeMonitor?: pulumi.Input<string>;
/**
* IKE HA monitor interval (10 - 300 secs).
*/
ikeMonitorInterval?: pulumi.Input<number>;
/**
* Enable/disable IPsec tunnel synchronization. Valid values: `enable`, `disable`.
*/
ipsecTunnelSync?: pulumi.Input<string>;
/**
* IP address of the interface on the peer unit that is used for the session synchronization link.
*/
peerip?: pulumi.Input<string>;
/**
* VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd.
*/
peervd?: pulumi.Input<string>;
/**
* Enable/disable IKE route announcement on the backup unit. Valid values: `enable`, `disable`.
*/
secondaryAddIpsecRoutes?: pulumi.Input<string>;
/**
* Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize. The structure of `sessionSyncFilter` block is documented below.
*/
sessionSyncFilter?: pulumi.Input<inputs.system.ClustersyncSessionSyncFilter>;
/**
* Enable/disable IKE route announcement on the backup unit. Valid values: `enable`, `disable`.
*/
slaveAddIkeRoutes?: pulumi.Input<string>;
/**
* Sync ID.
*/
syncId?: pulumi.Input<number>;
/**
* Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of `syncvd` block is documented below.
*/
syncvds?: pulumi.Input<pulumi.Input<inputs.system.ClustersyncSyncvd>[]>;
/**
* 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 Clustersync resource.
*/
export interface ClustersyncArgs {
/**
* List of interfaces to be turned down before session synchronization is complete. The structure of `downIntfsBeforeSessSync` block is documented below.
*/
downIntfsBeforeSessSyncs?: pulumi.Input<pulumi.Input<inputs.system.ClustersyncDownIntfsBeforeSessSync>[]>;
/**
* 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>;
/**
* Heartbeat interval. Increase to reduce false positives. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 1 - 10 sec. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15: 1 - 20 (100*ms).
*/
hbInterval?: pulumi.Input<number>;
/**
* Lost heartbeat threshold. Increase to reduce false positives. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 1 - 10. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15: 1 - 60.
*/
hbLostThreshold?: pulumi.Input<number>;
/**
* IKE heartbeat interval (1 - 60 secs).
*/
ikeHeartbeatInterval?: pulumi.Input<number>;
/**
* Enable/disable IKE HA monitor. Valid values: `enable`, `disable`.
*/
ikeMonitor?: pulumi.Input<string>;
/**
* IKE HA monitor interval (10 - 300 secs).
*/
ikeMonitorInterval?: pulumi.Input<number>;
/**
* Enable/disable IPsec tunnel synchronization. Valid values: `enable`, `disable`.
*/
ipsecTunnelSync?: pulumi.Input<string>;
/**
* IP address of the interface on the peer unit that is used for the session synchronization link.
*/
peerip?: pulumi.Input<string>;
/**
* VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd.
*/
peervd?: pulumi.Input<string>;
/**
* Enable/disable IKE route announcement on the backup unit. Valid values: `enable`, `disable`.
*/
secondaryAddIpsecRoutes?: pulumi.Input<string>;
/**
* Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize. The structure of `sessionSyncFilter` block is documented below.
*/
sessionSyncFilter?: pulumi.Input<inputs.system.ClustersyncSessionSyncFilter>;
/**
* Enable/disable IKE route announcement on the backup unit. Valid values: `enable`, `disable`.
*/
slaveAddIkeRoutes?: pulumi.Input<string>;
/**
* Sync ID.
*/
syncId?: pulumi.Input<number>;
/**
* Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of `syncvd` block is documented below.
*/
syncvds?: pulumi.Input<pulumi.Input<inputs.system.ClustersyncSyncvd>[]>;
/**
* 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>;
}