@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
472 lines (471 loc) • 14.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Configure Fortinet Single Sign On (FSSO) agents.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.user.Fsso("trname", {
* port: 32381,
* port2: 8000,
* port3: 8000,
* port4: 8000,
* port5: 8000,
* server: "1.1.1.1",
* sourceIp: "0.0.0.0",
* sourceIp6: "::",
* });
* ```
*
* ## Import
*
* User Fsso can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:user/fsso:Fsso labelname {{name}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:user/fsso:Fsso labelname {{name}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Fsso extends pulumi.CustomResource {
/**
* Get an existing Fsso 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?: FssoState, opts?: pulumi.CustomResourceOptions): Fsso;
/**
* Returns true if the given object is an instance of Fsso. 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 Fsso;
/**
* Interval in minutes within to fetch groups from FSSO server, or unset to disable.
*/
readonly groupPollInterval: 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>;
/**
* Enable/disable automatic fetching of groups from LDAP server. Valid values: `enable`, `disable`.
*/
readonly ldapPoll: pulumi.Output<string>;
/**
* Filter used to fetch groups.
*/
readonly ldapPollFilter: pulumi.Output<string>;
/**
* Interval in minutes within to fetch groups from LDAP server.
*/
readonly ldapPollInterval: pulumi.Output<number>;
/**
* LDAP server to get group information.
*/
readonly ldapServer: pulumi.Output<string>;
/**
* Interval in minutes to keep logons after FSSO server down.
*/
readonly logonTimeout: pulumi.Output<number>;
/**
* Name.
*/
readonly name: pulumi.Output<string>;
/**
* Password of the first FSSO collector agent.
*/
readonly password: pulumi.Output<string | undefined>;
/**
* Password of the second FSSO collector agent.
*/
readonly password2: pulumi.Output<string | undefined>;
/**
* Password of the third FSSO collector agent.
*/
readonly password3: pulumi.Output<string | undefined>;
/**
* Password of the fourth FSSO collector agent.
*/
readonly password4: pulumi.Output<string | undefined>;
/**
* Password of the fifth FSSO collector agent.
*/
readonly password5: pulumi.Output<string | undefined>;
/**
* Port of the first FSSO collector agent.
*/
readonly port: pulumi.Output<number>;
/**
* Port of the second FSSO collector agent.
*/
readonly port2: pulumi.Output<number>;
/**
* Port of the third FSSO collector agent.
*/
readonly port3: pulumi.Output<number>;
/**
* Port of the fourth FSSO collector agent.
*/
readonly port4: pulumi.Output<number>;
/**
* Port of the fifth FSSO collector agent.
*/
readonly port5: pulumi.Output<number>;
/**
* Domain name or IP address of the first FSSO collector agent.
*/
readonly server: pulumi.Output<string>;
/**
* Domain name or IP address of the second FSSO collector agent.
*/
readonly server2: pulumi.Output<string>;
/**
* Domain name or IP address of the third FSSO collector agent.
*/
readonly server3: pulumi.Output<string>;
/**
* Domain name or IP address of the fourth FSSO collector agent.
*/
readonly server4: pulumi.Output<string>;
/**
* Domain name or IP address of the fifth FSSO collector agent.
*/
readonly server5: pulumi.Output<string>;
/**
* Server Name Indication.
*/
readonly sni: pulumi.Output<string>;
/**
* Source IP for communications to FSSO agent.
*/
readonly sourceIp: pulumi.Output<string>;
/**
* IPv6 source for communications to FSSO agent.
*/
readonly sourceIp6: pulumi.Output<string>;
/**
* Enable/disable use of SSL. Valid values: `enable`, `disable`.
*/
readonly ssl: pulumi.Output<string>;
/**
* Enable/disable server host/IP verification. Valid values: `enable`, `disable`.
*/
readonly sslServerHostIpCheck: pulumi.Output<string>;
/**
* Trusted server certificate or CA certificate.
*/
readonly sslTrustedCert: pulumi.Output<string>;
/**
* Server type.
*/
readonly type: pulumi.Output<string>;
/**
* LDAP server to get user information.
*/
readonly userInfoServer: 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 Fsso 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: FssoArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Fsso resources.
*/
export interface FssoState {
/**
* Interval in minutes within to fetch groups from FSSO server, or unset to disable.
*/
groupPollInterval?: 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>;
/**
* Enable/disable automatic fetching of groups from LDAP server. Valid values: `enable`, `disable`.
*/
ldapPoll?: pulumi.Input<string>;
/**
* Filter used to fetch groups.
*/
ldapPollFilter?: pulumi.Input<string>;
/**
* Interval in minutes within to fetch groups from LDAP server.
*/
ldapPollInterval?: pulumi.Input<number>;
/**
* LDAP server to get group information.
*/
ldapServer?: pulumi.Input<string>;
/**
* Interval in minutes to keep logons after FSSO server down.
*/
logonTimeout?: pulumi.Input<number>;
/**
* Name.
*/
name?: pulumi.Input<string>;
/**
* Password of the first FSSO collector agent.
*/
password?: pulumi.Input<string>;
/**
* Password of the second FSSO collector agent.
*/
password2?: pulumi.Input<string>;
/**
* Password of the third FSSO collector agent.
*/
password3?: pulumi.Input<string>;
/**
* Password of the fourth FSSO collector agent.
*/
password4?: pulumi.Input<string>;
/**
* Password of the fifth FSSO collector agent.
*/
password5?: pulumi.Input<string>;
/**
* Port of the first FSSO collector agent.
*/
port?: pulumi.Input<number>;
/**
* Port of the second FSSO collector agent.
*/
port2?: pulumi.Input<number>;
/**
* Port of the third FSSO collector agent.
*/
port3?: pulumi.Input<number>;
/**
* Port of the fourth FSSO collector agent.
*/
port4?: pulumi.Input<number>;
/**
* Port of the fifth FSSO collector agent.
*/
port5?: pulumi.Input<number>;
/**
* Domain name or IP address of the first FSSO collector agent.
*/
server?: pulumi.Input<string>;
/**
* Domain name or IP address of the second FSSO collector agent.
*/
server2?: pulumi.Input<string>;
/**
* Domain name or IP address of the third FSSO collector agent.
*/
server3?: pulumi.Input<string>;
/**
* Domain name or IP address of the fourth FSSO collector agent.
*/
server4?: pulumi.Input<string>;
/**
* Domain name or IP address of the fifth FSSO collector agent.
*/
server5?: pulumi.Input<string>;
/**
* Server Name Indication.
*/
sni?: pulumi.Input<string>;
/**
* Source IP for communications to FSSO agent.
*/
sourceIp?: pulumi.Input<string>;
/**
* IPv6 source for communications to FSSO agent.
*/
sourceIp6?: pulumi.Input<string>;
/**
* Enable/disable use of SSL. Valid values: `enable`, `disable`.
*/
ssl?: pulumi.Input<string>;
/**
* Enable/disable server host/IP verification. Valid values: `enable`, `disable`.
*/
sslServerHostIpCheck?: pulumi.Input<string>;
/**
* Trusted server certificate or CA certificate.
*/
sslTrustedCert?: pulumi.Input<string>;
/**
* Server type.
*/
type?: pulumi.Input<string>;
/**
* LDAP server to get user information.
*/
userInfoServer?: 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 Fsso resource.
*/
export interface FssoArgs {
/**
* Interval in minutes within to fetch groups from FSSO server, or unset to disable.
*/
groupPollInterval?: 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>;
/**
* Enable/disable automatic fetching of groups from LDAP server. Valid values: `enable`, `disable`.
*/
ldapPoll?: pulumi.Input<string>;
/**
* Filter used to fetch groups.
*/
ldapPollFilter?: pulumi.Input<string>;
/**
* Interval in minutes within to fetch groups from LDAP server.
*/
ldapPollInterval?: pulumi.Input<number>;
/**
* LDAP server to get group information.
*/
ldapServer?: pulumi.Input<string>;
/**
* Interval in minutes to keep logons after FSSO server down.
*/
logonTimeout?: pulumi.Input<number>;
/**
* Name.
*/
name?: pulumi.Input<string>;
/**
* Password of the first FSSO collector agent.
*/
password?: pulumi.Input<string>;
/**
* Password of the second FSSO collector agent.
*/
password2?: pulumi.Input<string>;
/**
* Password of the third FSSO collector agent.
*/
password3?: pulumi.Input<string>;
/**
* Password of the fourth FSSO collector agent.
*/
password4?: pulumi.Input<string>;
/**
* Password of the fifth FSSO collector agent.
*/
password5?: pulumi.Input<string>;
/**
* Port of the first FSSO collector agent.
*/
port?: pulumi.Input<number>;
/**
* Port of the second FSSO collector agent.
*/
port2?: pulumi.Input<number>;
/**
* Port of the third FSSO collector agent.
*/
port3?: pulumi.Input<number>;
/**
* Port of the fourth FSSO collector agent.
*/
port4?: pulumi.Input<number>;
/**
* Port of the fifth FSSO collector agent.
*/
port5?: pulumi.Input<number>;
/**
* Domain name or IP address of the first FSSO collector agent.
*/
server: pulumi.Input<string>;
/**
* Domain name or IP address of the second FSSO collector agent.
*/
server2?: pulumi.Input<string>;
/**
* Domain name or IP address of the third FSSO collector agent.
*/
server3?: pulumi.Input<string>;
/**
* Domain name or IP address of the fourth FSSO collector agent.
*/
server4?: pulumi.Input<string>;
/**
* Domain name or IP address of the fifth FSSO collector agent.
*/
server5?: pulumi.Input<string>;
/**
* Server Name Indication.
*/
sni?: pulumi.Input<string>;
/**
* Source IP for communications to FSSO agent.
*/
sourceIp?: pulumi.Input<string>;
/**
* IPv6 source for communications to FSSO agent.
*/
sourceIp6?: pulumi.Input<string>;
/**
* Enable/disable use of SSL. Valid values: `enable`, `disable`.
*/
ssl?: pulumi.Input<string>;
/**
* Enable/disable server host/IP verification. Valid values: `enable`, `disable`.
*/
sslServerHostIpCheck?: pulumi.Input<string>;
/**
* Trusted server certificate or CA certificate.
*/
sslTrustedCert?: pulumi.Input<string>;
/**
* Server type.
*/
type?: pulumi.Input<string>;
/**
* LDAP server to get user information.
*/
userInfoServer?: 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>;
}