fortios.authentication.Setting
Explore with Pulumi AI
Configure authentication setting.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";
const trname = new fortios.authentication.Setting("trname", {
authHttps: "enable",
captivePortalIp: "0.0.0.0",
captivePortalIp6: "::",
captivePortalPort: 7830,
captivePortalSslPort: 7831,
captivePortalType: "fqdn",
});
import pulumi
import pulumiverse_fortios as fortios
trname = fortios.authentication.Setting("trname",
auth_https="enable",
captive_portal_ip="0.0.0.0",
captive_portal_ip6="::",
captive_portal_port=7830,
captive_portal_ssl_port=7831,
captive_portal_type="fqdn")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/authentication"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := authentication.NewSetting(ctx, "trname", &authentication.SettingArgs{
AuthHttps: pulumi.String("enable"),
CaptivePortalIp: pulumi.String("0.0.0.0"),
CaptivePortalIp6: pulumi.String("::"),
CaptivePortalPort: pulumi.Int(7830),
CaptivePortalSslPort: pulumi.Int(7831),
CaptivePortalType: pulumi.String("fqdn"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;
return await Deployment.RunAsync(() =>
{
var trname = new Fortios.Authentication.Setting("trname", new()
{
AuthHttps = "enable",
CaptivePortalIp = "0.0.0.0",
CaptivePortalIp6 = "::",
CaptivePortalPort = 7830,
CaptivePortalSslPort = 7831,
CaptivePortalType = "fqdn",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.authentication.Setting;
import com.pulumi.fortios.authentication.SettingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var trname = new Setting("trname", SettingArgs.builder()
.authHttps("enable")
.captivePortalIp("0.0.0.0")
.captivePortalIp6("::")
.captivePortalPort(7830)
.captivePortalSslPort(7831)
.captivePortalType("fqdn")
.build());
}
}
resources:
trname:
type: fortios:authentication:Setting
properties:
authHttps: enable
captivePortalIp: 0.0.0.0
captivePortalIp6: '::'
captivePortalPort: 7830
captivePortalSslPort: 7831
captivePortalType: fqdn
Create Setting Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Setting(name: string, args?: SettingArgs, opts?: CustomResourceOptions);
@overload
def Setting(resource_name: str,
args: Optional[SettingArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Setting(resource_name: str,
opts: Optional[ResourceOptions] = None,
active_auth_scheme: Optional[str] = None,
auth_https: Optional[str] = None,
captive_portal: Optional[str] = None,
captive_portal6: Optional[str] = None,
captive_portal_ip: Optional[str] = None,
captive_portal_ip6: Optional[str] = None,
captive_portal_port: Optional[int] = None,
captive_portal_ssl_port: Optional[int] = None,
captive_portal_type: Optional[str] = None,
cert_auth: Optional[str] = None,
cert_captive_portal: Optional[str] = None,
cert_captive_portal_ip: Optional[str] = None,
cert_captive_portal_port: Optional[int] = None,
cookie_max_age: Optional[int] = None,
cookie_refresh_div: Optional[int] = None,
dev_ranges: Optional[Sequence[SettingDevRangeArgs]] = None,
dynamic_sort_subtable: Optional[str] = None,
get_all_tables: Optional[str] = None,
ip_auth_cookie: Optional[str] = None,
persistent_cookie: Optional[str] = None,
sso_auth_scheme: Optional[str] = None,
update_time: Optional[str] = None,
user_cert_cas: Optional[Sequence[SettingUserCertCaArgs]] = None,
vdomparam: Optional[str] = None)
func NewSetting(ctx *Context, name string, args *SettingArgs, opts ...ResourceOption) (*Setting, error)
public Setting(string name, SettingArgs? args = null, CustomResourceOptions? opts = null)
public Setting(String name, SettingArgs args)
public Setting(String name, SettingArgs args, CustomResourceOptions options)
type: fortios:authentication:Setting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SettingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SettingArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SettingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SettingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SettingArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var fortiosSettingResource = new Fortios.Authentication.Setting("fortiosSettingResource", new()
{
ActiveAuthScheme = "string",
AuthHttps = "string",
CaptivePortal = "string",
CaptivePortal6 = "string",
CaptivePortalIp = "string",
CaptivePortalIp6 = "string",
CaptivePortalPort = 0,
CaptivePortalSslPort = 0,
CaptivePortalType = "string",
CertAuth = "string",
CertCaptivePortal = "string",
CertCaptivePortalIp = "string",
CertCaptivePortalPort = 0,
CookieMaxAge = 0,
CookieRefreshDiv = 0,
DevRanges = new[]
{
new Fortios.Authentication.Inputs.SettingDevRangeArgs
{
Name = "string",
},
},
DynamicSortSubtable = "string",
GetAllTables = "string",
IpAuthCookie = "string",
PersistentCookie = "string",
SsoAuthScheme = "string",
UpdateTime = "string",
UserCertCas = new[]
{
new Fortios.Authentication.Inputs.SettingUserCertCaArgs
{
Name = "string",
},
},
Vdomparam = "string",
});
example, err := authentication.NewSetting(ctx, "fortiosSettingResource", &authentication.SettingArgs{
ActiveAuthScheme: pulumi.String("string"),
AuthHttps: pulumi.String("string"),
CaptivePortal: pulumi.String("string"),
CaptivePortal6: pulumi.String("string"),
CaptivePortalIp: pulumi.String("string"),
CaptivePortalIp6: pulumi.String("string"),
CaptivePortalPort: pulumi.Int(0),
CaptivePortalSslPort: pulumi.Int(0),
CaptivePortalType: pulumi.String("string"),
CertAuth: pulumi.String("string"),
CertCaptivePortal: pulumi.String("string"),
CertCaptivePortalIp: pulumi.String("string"),
CertCaptivePortalPort: pulumi.Int(0),
CookieMaxAge: pulumi.Int(0),
CookieRefreshDiv: pulumi.Int(0),
DevRanges: authentication.SettingDevRangeArray{
&authentication.SettingDevRangeArgs{
Name: pulumi.String("string"),
},
},
DynamicSortSubtable: pulumi.String("string"),
GetAllTables: pulumi.String("string"),
IpAuthCookie: pulumi.String("string"),
PersistentCookie: pulumi.String("string"),
SsoAuthScheme: pulumi.String("string"),
UpdateTime: pulumi.String("string"),
UserCertCas: authentication.SettingUserCertCaArray{
&authentication.SettingUserCertCaArgs{
Name: pulumi.String("string"),
},
},
Vdomparam: pulumi.String("string"),
})
var fortiosSettingResource = new Setting("fortiosSettingResource", SettingArgs.builder()
.activeAuthScheme("string")
.authHttps("string")
.captivePortal("string")
.captivePortal6("string")
.captivePortalIp("string")
.captivePortalIp6("string")
.captivePortalPort(0)
.captivePortalSslPort(0)
.captivePortalType("string")
.certAuth("string")
.certCaptivePortal("string")
.certCaptivePortalIp("string")
.certCaptivePortalPort(0)
.cookieMaxAge(0)
.cookieRefreshDiv(0)
.devRanges(SettingDevRangeArgs.builder()
.name("string")
.build())
.dynamicSortSubtable("string")
.getAllTables("string")
.ipAuthCookie("string")
.persistentCookie("string")
.ssoAuthScheme("string")
.updateTime("string")
.userCertCas(SettingUserCertCaArgs.builder()
.name("string")
.build())
.vdomparam("string")
.build());
fortios_setting_resource = fortios.authentication.Setting("fortiosSettingResource",
active_auth_scheme="string",
auth_https="string",
captive_portal="string",
captive_portal6="string",
captive_portal_ip="string",
captive_portal_ip6="string",
captive_portal_port=0,
captive_portal_ssl_port=0,
captive_portal_type="string",
cert_auth="string",
cert_captive_portal="string",
cert_captive_portal_ip="string",
cert_captive_portal_port=0,
cookie_max_age=0,
cookie_refresh_div=0,
dev_ranges=[fortios.authentication.SettingDevRangeArgs(
name="string",
)],
dynamic_sort_subtable="string",
get_all_tables="string",
ip_auth_cookie="string",
persistent_cookie="string",
sso_auth_scheme="string",
update_time="string",
user_cert_cas=[fortios.authentication.SettingUserCertCaArgs(
name="string",
)],
vdomparam="string")
const fortiosSettingResource = new fortios.authentication.Setting("fortiosSettingResource", {
activeAuthScheme: "string",
authHttps: "string",
captivePortal: "string",
captivePortal6: "string",
captivePortalIp: "string",
captivePortalIp6: "string",
captivePortalPort: 0,
captivePortalSslPort: 0,
captivePortalType: "string",
certAuth: "string",
certCaptivePortal: "string",
certCaptivePortalIp: "string",
certCaptivePortalPort: 0,
cookieMaxAge: 0,
cookieRefreshDiv: 0,
devRanges: [{
name: "string",
}],
dynamicSortSubtable: "string",
getAllTables: "string",
ipAuthCookie: "string",
persistentCookie: "string",
ssoAuthScheme: "string",
updateTime: "string",
userCertCas: [{
name: "string",
}],
vdomparam: "string",
});
type: fortios:authentication:Setting
properties:
activeAuthScheme: string
authHttps: string
captivePortal: string
captivePortal6: string
captivePortalIp: string
captivePortalIp6: string
captivePortalPort: 0
captivePortalSslPort: 0
captivePortalType: string
certAuth: string
certCaptivePortal: string
certCaptivePortalIp: string
certCaptivePortalPort: 0
cookieMaxAge: 0
cookieRefreshDiv: 0
devRanges:
- name: string
dynamicSortSubtable: string
getAllTables: string
ipAuthCookie: string
persistentCookie: string
ssoAuthScheme: string
updateTime: string
userCertCas:
- name: string
vdomparam: string
Setting Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Setting resource accepts the following input properties:
- Active
Auth stringScheme - Active authentication method (scheme name).
- Auth
Https string - Enable/disable redirecting HTTP user authentication to HTTPS. Valid values:
enable
,disable
. - Captive
Portal string - Captive portal host name.
- Captive
Portal6 string - IPv6 captive portal host name.
- Captive
Portal stringIp - Captive portal IP address.
- Captive
Portal stringIp6 - Captive portal IPv6 address.
- Captive
Portal intPort - Captive portal port number (1 - 65535, default = 7830).
- Captive
Portal intSsl Port - Captive portal SSL port number (1 - 65535, default = 7831).
- Captive
Portal stringType - Captive portal type. Valid values:
fqdn
,ip
. - Cert
Auth string - Enable/disable redirecting certificate authentication to HTTPS portal. Valid values:
enable
,disable
. - Cert
Captive stringPortal - Certificate captive portal host name.
- Cert
Captive stringPortal Ip - Certificate captive portal IP address.
- Cert
Captive intPortal Port - Certificate captive portal port number (1 - 65535, default = 7832).
- int
- Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)).
- int
- Refresh rate divider of persistent web portal cookie (default = 2). Refresh value = cookie-max-age/cookie-refresh-div.
- Dev
Ranges List<Pulumiverse.Fortios. Authentication. Inputs. Setting Dev Range> - Address range for the IP based device query. The structure of
dev_range
block is documented below. - Dynamic
Sort stringSubtable - 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 ].
- Get
All stringTables - 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.
- string
- Enable/disable persistent cookie on IP based web portal authentication (default = disable). Valid values:
enable
,disable
. - string
- Enable/disable persistent cookie on web portal authentication (default = enable). Valid values:
enable
,disable
. - Sso
Auth stringScheme - Single-Sign-On authentication method (scheme name).
- Update
Time string - Time of the last update.
- User
Cert List<Pulumiverse.Cas Fortios. Authentication. Inputs. Setting User Cert Ca> - CA certificate used for client certificate verification. The structure of
user_cert_ca
block is documented below. - Vdomparam 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.
- Active
Auth stringScheme - Active authentication method (scheme name).
- Auth
Https string - Enable/disable redirecting HTTP user authentication to HTTPS. Valid values:
enable
,disable
. - Captive
Portal string - Captive portal host name.
- Captive
Portal6 string - IPv6 captive portal host name.
- Captive
Portal stringIp - Captive portal IP address.
- Captive
Portal stringIp6 - Captive portal IPv6 address.
- Captive
Portal intPort - Captive portal port number (1 - 65535, default = 7830).
- Captive
Portal intSsl Port - Captive portal SSL port number (1 - 65535, default = 7831).
- Captive
Portal stringType - Captive portal type. Valid values:
fqdn
,ip
. - Cert
Auth string - Enable/disable redirecting certificate authentication to HTTPS portal. Valid values:
enable
,disable
. - Cert
Captive stringPortal - Certificate captive portal host name.
- Cert
Captive stringPortal Ip - Certificate captive portal IP address.
- Cert
Captive intPortal Port - Certificate captive portal port number (1 - 65535, default = 7832).
- int
- Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)).
- int
- Refresh rate divider of persistent web portal cookie (default = 2). Refresh value = cookie-max-age/cookie-refresh-div.
- Dev
Ranges []SettingDev Range Args - Address range for the IP based device query. The structure of
dev_range
block is documented below. - Dynamic
Sort stringSubtable - 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 ].
- Get
All stringTables - 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.
- string
- Enable/disable persistent cookie on IP based web portal authentication (default = disable). Valid values:
enable
,disable
. - string
- Enable/disable persistent cookie on web portal authentication (default = enable). Valid values:
enable
,disable
. - Sso
Auth stringScheme - Single-Sign-On authentication method (scheme name).
- Update
Time string - Time of the last update.
- User
Cert []SettingCas User Cert Ca Args - CA certificate used for client certificate verification. The structure of
user_cert_ca
block is documented below. - Vdomparam 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.
- active
Auth StringScheme - Active authentication method (scheme name).
- auth
Https String - Enable/disable redirecting HTTP user authentication to HTTPS. Valid values:
enable
,disable
. - captive
Portal String - Captive portal host name.
- captive
Portal6 String - IPv6 captive portal host name.
- captive
Portal StringIp - Captive portal IP address.
- captive
Portal StringIp6 - Captive portal IPv6 address.
- captive
Portal IntegerPort - Captive portal port number (1 - 65535, default = 7830).
- captive
Portal IntegerSsl Port - Captive portal SSL port number (1 - 65535, default = 7831).
- captive
Portal StringType - Captive portal type. Valid values:
fqdn
,ip
. - cert
Auth String - Enable/disable redirecting certificate authentication to HTTPS portal. Valid values:
enable
,disable
. - cert
Captive StringPortal - Certificate captive portal host name.
- cert
Captive StringPortal Ip - Certificate captive portal IP address.
- cert
Captive IntegerPortal Port - Certificate captive portal port number (1 - 65535, default = 7832).
- Integer
- Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)).
- Integer
- Refresh rate divider of persistent web portal cookie (default = 2). Refresh value = cookie-max-age/cookie-refresh-div.
- dev
Ranges List<SettingDev Range> - Address range for the IP based device query. The structure of
dev_range
block is documented below. - dynamic
Sort StringSubtable - 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 ].
- get
All StringTables - 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.
- String
- Enable/disable persistent cookie on IP based web portal authentication (default = disable). Valid values:
enable
,disable
. - String
- Enable/disable persistent cookie on web portal authentication (default = enable). Valid values:
enable
,disable
. - sso
Auth StringScheme - Single-Sign-On authentication method (scheme name).
- update
Time String - Time of the last update.
- user
Cert List<SettingCas User Cert Ca> - CA certificate used for client certificate verification. The structure of
user_cert_ca
block is documented below. - vdomparam 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.
- active
Auth stringScheme - Active authentication method (scheme name).
- auth
Https string - Enable/disable redirecting HTTP user authentication to HTTPS. Valid values:
enable
,disable
. - captive
Portal string - Captive portal host name.
- captive
Portal6 string - IPv6 captive portal host name.
- captive
Portal stringIp - Captive portal IP address.
- captive
Portal stringIp6 - Captive portal IPv6 address.
- captive
Portal numberPort - Captive portal port number (1 - 65535, default = 7830).
- captive
Portal numberSsl Port - Captive portal SSL port number (1 - 65535, default = 7831).
- captive
Portal stringType - Captive portal type. Valid values:
fqdn
,ip
. - cert
Auth string - Enable/disable redirecting certificate authentication to HTTPS portal. Valid values:
enable
,disable
. - cert
Captive stringPortal - Certificate captive portal host name.
- cert
Captive stringPortal Ip - Certificate captive portal IP address.
- cert
Captive numberPortal Port - Certificate captive portal port number (1 - 65535, default = 7832).
- number
- Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)).
- number
- Refresh rate divider of persistent web portal cookie (default = 2). Refresh value = cookie-max-age/cookie-refresh-div.
- dev
Ranges SettingDev Range[] - Address range for the IP based device query. The structure of
dev_range
block is documented below. - dynamic
Sort stringSubtable - 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 ].
- get
All stringTables - 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.
- string
- Enable/disable persistent cookie on IP based web portal authentication (default = disable). Valid values:
enable
,disable
. - string
- Enable/disable persistent cookie on web portal authentication (default = enable). Valid values:
enable
,disable
. - sso
Auth stringScheme - Single-Sign-On authentication method (scheme name).
- update
Time string - Time of the last update.
- user
Cert SettingCas User Cert Ca[] - CA certificate used for client certificate verification. The structure of
user_cert_ca
block is documented below. - vdomparam 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.
- active_
auth_ strscheme - Active authentication method (scheme name).
- auth_
https str - Enable/disable redirecting HTTP user authentication to HTTPS. Valid values:
enable
,disable
. - captive_
portal str - Captive portal host name.
- captive_
portal6 str - IPv6 captive portal host name.
- captive_
portal_ strip - Captive portal IP address.
- captive_
portal_ strip6 - Captive portal IPv6 address.
- captive_
portal_ intport - Captive portal port number (1 - 65535, default = 7830).
- captive_
portal_ intssl_ port - Captive portal SSL port number (1 - 65535, default = 7831).
- captive_
portal_ strtype - Captive portal type. Valid values:
fqdn
,ip
. - cert_
auth str - Enable/disable redirecting certificate authentication to HTTPS portal. Valid values:
enable
,disable
. - cert_
captive_ strportal - Certificate captive portal host name.
- cert_
captive_ strportal_ ip - Certificate captive portal IP address.
- cert_
captive_ intportal_ port - Certificate captive portal port number (1 - 65535, default = 7832).
- int
- Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)).
- int
- Refresh rate divider of persistent web portal cookie (default = 2). Refresh value = cookie-max-age/cookie-refresh-div.
- dev_
ranges Sequence[SettingDev Range Args] - Address range for the IP based device query. The structure of
dev_range
block is documented below. - dynamic_
sort_ strsubtable - 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 ].
- get_
all_ strtables - 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.
- str
- Enable/disable persistent cookie on IP based web portal authentication (default = disable). Valid values:
enable
,disable
. - str
- Enable/disable persistent cookie on web portal authentication (default = enable). Valid values:
enable
,disable
. - sso_
auth_ strscheme - Single-Sign-On authentication method (scheme name).
- update_
time str - Time of the last update.
- user_
cert_ Sequence[Settingcas User Cert Ca Args] - CA certificate used for client certificate verification. The structure of
user_cert_ca
block is documented below. - vdomparam str
- 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.
- active
Auth StringScheme - Active authentication method (scheme name).
- auth
Https String - Enable/disable redirecting HTTP user authentication to HTTPS. Valid values:
enable
,disable
. - captive
Portal String - Captive portal host name.
- captive
Portal6 String - IPv6 captive portal host name.
- captive
Portal StringIp - Captive portal IP address.
- captive
Portal StringIp6 - Captive portal IPv6 address.
- captive
Portal NumberPort - Captive portal port number (1 - 65535, default = 7830).
- captive
Portal NumberSsl Port - Captive portal SSL port number (1 - 65535, default = 7831).
- captive
Portal StringType - Captive portal type. Valid values:
fqdn
,ip
. - cert
Auth String - Enable/disable redirecting certificate authentication to HTTPS portal. Valid values:
enable
,disable
. - cert
Captive StringPortal - Certificate captive portal host name.
- cert
Captive StringPortal Ip - Certificate captive portal IP address.
- cert
Captive NumberPortal Port - Certificate captive portal port number (1 - 65535, default = 7832).
- Number
- Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)).
- Number
- Refresh rate divider of persistent web portal cookie (default = 2). Refresh value = cookie-max-age/cookie-refresh-div.
- dev
Ranges List<Property Map> - Address range for the IP based device query. The structure of
dev_range
block is documented below. - dynamic
Sort StringSubtable - 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 ].
- get
All StringTables - 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.
- String
- Enable/disable persistent cookie on IP based web portal authentication (default = disable). Valid values:
enable
,disable
. - String
- Enable/disable persistent cookie on web portal authentication (default = enable). Valid values:
enable
,disable
. - sso
Auth StringScheme - Single-Sign-On authentication method (scheme name).
- update
Time String - Time of the last update.
- user
Cert List<Property Map>Cas - CA certificate used for client certificate verification. The structure of
user_cert_ca
block is documented below. - vdomparam 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Setting resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Setting Resource
Get an existing Setting resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SettingState, opts?: CustomResourceOptions): Setting
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
active_auth_scheme: Optional[str] = None,
auth_https: Optional[str] = None,
captive_portal: Optional[str] = None,
captive_portal6: Optional[str] = None,
captive_portal_ip: Optional[str] = None,
captive_portal_ip6: Optional[str] = None,
captive_portal_port: Optional[int] = None,
captive_portal_ssl_port: Optional[int] = None,
captive_portal_type: Optional[str] = None,
cert_auth: Optional[str] = None,
cert_captive_portal: Optional[str] = None,
cert_captive_portal_ip: Optional[str] = None,
cert_captive_portal_port: Optional[int] = None,
cookie_max_age: Optional[int] = None,
cookie_refresh_div: Optional[int] = None,
dev_ranges: Optional[Sequence[SettingDevRangeArgs]] = None,
dynamic_sort_subtable: Optional[str] = None,
get_all_tables: Optional[str] = None,
ip_auth_cookie: Optional[str] = None,
persistent_cookie: Optional[str] = None,
sso_auth_scheme: Optional[str] = None,
update_time: Optional[str] = None,
user_cert_cas: Optional[Sequence[SettingUserCertCaArgs]] = None,
vdomparam: Optional[str] = None) -> Setting
func GetSetting(ctx *Context, name string, id IDInput, state *SettingState, opts ...ResourceOption) (*Setting, error)
public static Setting Get(string name, Input<string> id, SettingState? state, CustomResourceOptions? opts = null)
public static Setting get(String name, Output<String> id, SettingState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Active
Auth stringScheme - Active authentication method (scheme name).
- Auth
Https string - Enable/disable redirecting HTTP user authentication to HTTPS. Valid values:
enable
,disable
. - Captive
Portal string - Captive portal host name.
- Captive
Portal6 string - IPv6 captive portal host name.
- Captive
Portal stringIp - Captive portal IP address.
- Captive
Portal stringIp6 - Captive portal IPv6 address.
- Captive
Portal intPort - Captive portal port number (1 - 65535, default = 7830).
- Captive
Portal intSsl Port - Captive portal SSL port number (1 - 65535, default = 7831).
- Captive
Portal stringType - Captive portal type. Valid values:
fqdn
,ip
. - Cert
Auth string - Enable/disable redirecting certificate authentication to HTTPS portal. Valid values:
enable
,disable
. - Cert
Captive stringPortal - Certificate captive portal host name.
- Cert
Captive stringPortal Ip - Certificate captive portal IP address.
- Cert
Captive intPortal Port - Certificate captive portal port number (1 - 65535, default = 7832).
- int
- Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)).
- int
- Refresh rate divider of persistent web portal cookie (default = 2). Refresh value = cookie-max-age/cookie-refresh-div.
- Dev
Ranges List<Pulumiverse.Fortios. Authentication. Inputs. Setting Dev Range> - Address range for the IP based device query. The structure of
dev_range
block is documented below. - Dynamic
Sort stringSubtable - 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 ].
- Get
All stringTables - 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.
- string
- Enable/disable persistent cookie on IP based web portal authentication (default = disable). Valid values:
enable
,disable
. - string
- Enable/disable persistent cookie on web portal authentication (default = enable). Valid values:
enable
,disable
. - Sso
Auth stringScheme - Single-Sign-On authentication method (scheme name).
- Update
Time string - Time of the last update.
- User
Cert List<Pulumiverse.Cas Fortios. Authentication. Inputs. Setting User Cert Ca> - CA certificate used for client certificate verification. The structure of
user_cert_ca
block is documented below. - Vdomparam 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.
- Active
Auth stringScheme - Active authentication method (scheme name).
- Auth
Https string - Enable/disable redirecting HTTP user authentication to HTTPS. Valid values:
enable
,disable
. - Captive
Portal string - Captive portal host name.
- Captive
Portal6 string - IPv6 captive portal host name.
- Captive
Portal stringIp - Captive portal IP address.
- Captive
Portal stringIp6 - Captive portal IPv6 address.
- Captive
Portal intPort - Captive portal port number (1 - 65535, default = 7830).
- Captive
Portal intSsl Port - Captive portal SSL port number (1 - 65535, default = 7831).
- Captive
Portal stringType - Captive portal type. Valid values:
fqdn
,ip
. - Cert
Auth string - Enable/disable redirecting certificate authentication to HTTPS portal. Valid values:
enable
,disable
. - Cert
Captive stringPortal - Certificate captive portal host name.
- Cert
Captive stringPortal Ip - Certificate captive portal IP address.
- Cert
Captive intPortal Port - Certificate captive portal port number (1 - 65535, default = 7832).
- int
- Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)).
- int
- Refresh rate divider of persistent web portal cookie (default = 2). Refresh value = cookie-max-age/cookie-refresh-div.
- Dev
Ranges []SettingDev Range Args - Address range for the IP based device query. The structure of
dev_range
block is documented below. - Dynamic
Sort stringSubtable - 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 ].
- Get
All stringTables - 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.
- string
- Enable/disable persistent cookie on IP based web portal authentication (default = disable). Valid values:
enable
,disable
. - string
- Enable/disable persistent cookie on web portal authentication (default = enable). Valid values:
enable
,disable
. - Sso
Auth stringScheme - Single-Sign-On authentication method (scheme name).
- Update
Time string - Time of the last update.
- User
Cert []SettingCas User Cert Ca Args - CA certificate used for client certificate verification. The structure of
user_cert_ca
block is documented below. - Vdomparam 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.
- active
Auth StringScheme - Active authentication method (scheme name).
- auth
Https String - Enable/disable redirecting HTTP user authentication to HTTPS. Valid values:
enable
,disable
. - captive
Portal String - Captive portal host name.
- captive
Portal6 String - IPv6 captive portal host name.
- captive
Portal StringIp - Captive portal IP address.
- captive
Portal StringIp6 - Captive portal IPv6 address.
- captive
Portal IntegerPort - Captive portal port number (1 - 65535, default = 7830).
- captive
Portal IntegerSsl Port - Captive portal SSL port number (1 - 65535, default = 7831).
- captive
Portal StringType - Captive portal type. Valid values:
fqdn
,ip
. - cert
Auth String - Enable/disable redirecting certificate authentication to HTTPS portal. Valid values:
enable
,disable
. - cert
Captive StringPortal - Certificate captive portal host name.
- cert
Captive StringPortal Ip - Certificate captive portal IP address.
- cert
Captive IntegerPortal Port - Certificate captive portal port number (1 - 65535, default = 7832).
- Integer
- Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)).
- Integer
- Refresh rate divider of persistent web portal cookie (default = 2). Refresh value = cookie-max-age/cookie-refresh-div.
- dev
Ranges List<SettingDev Range> - Address range for the IP based device query. The structure of
dev_range
block is documented below. - dynamic
Sort StringSubtable - 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 ].
- get
All StringTables - 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.
- String
- Enable/disable persistent cookie on IP based web portal authentication (default = disable). Valid values:
enable
,disable
. - String
- Enable/disable persistent cookie on web portal authentication (default = enable). Valid values:
enable
,disable
. - sso
Auth StringScheme - Single-Sign-On authentication method (scheme name).
- update
Time String - Time of the last update.
- user
Cert List<SettingCas User Cert Ca> - CA certificate used for client certificate verification. The structure of
user_cert_ca
block is documented below. - vdomparam 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.
- active
Auth stringScheme - Active authentication method (scheme name).
- auth
Https string - Enable/disable redirecting HTTP user authentication to HTTPS. Valid values:
enable
,disable
. - captive
Portal string - Captive portal host name.
- captive
Portal6 string - IPv6 captive portal host name.
- captive
Portal stringIp - Captive portal IP address.
- captive
Portal stringIp6 - Captive portal IPv6 address.
- captive
Portal numberPort - Captive portal port number (1 - 65535, default = 7830).
- captive
Portal numberSsl Port - Captive portal SSL port number (1 - 65535, default = 7831).
- captive
Portal stringType - Captive portal type. Valid values:
fqdn
,ip
. - cert
Auth string - Enable/disable redirecting certificate authentication to HTTPS portal. Valid values:
enable
,disable
. - cert
Captive stringPortal - Certificate captive portal host name.
- cert
Captive stringPortal Ip - Certificate captive portal IP address.
- cert
Captive numberPortal Port - Certificate captive portal port number (1 - 65535, default = 7832).
- number
- Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)).
- number
- Refresh rate divider of persistent web portal cookie (default = 2). Refresh value = cookie-max-age/cookie-refresh-div.
- dev
Ranges SettingDev Range[] - Address range for the IP based device query. The structure of
dev_range
block is documented below. - dynamic
Sort stringSubtable - 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 ].
- get
All stringTables - 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.
- string
- Enable/disable persistent cookie on IP based web portal authentication (default = disable). Valid values:
enable
,disable
. - string
- Enable/disable persistent cookie on web portal authentication (default = enable). Valid values:
enable
,disable
. - sso
Auth stringScheme - Single-Sign-On authentication method (scheme name).
- update
Time string - Time of the last update.
- user
Cert SettingCas User Cert Ca[] - CA certificate used for client certificate verification. The structure of
user_cert_ca
block is documented below. - vdomparam 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.
- active_
auth_ strscheme - Active authentication method (scheme name).
- auth_
https str - Enable/disable redirecting HTTP user authentication to HTTPS. Valid values:
enable
,disable
. - captive_
portal str - Captive portal host name.
- captive_
portal6 str - IPv6 captive portal host name.
- captive_
portal_ strip - Captive portal IP address.
- captive_
portal_ strip6 - Captive portal IPv6 address.
- captive_
portal_ intport - Captive portal port number (1 - 65535, default = 7830).
- captive_
portal_ intssl_ port - Captive portal SSL port number (1 - 65535, default = 7831).
- captive_
portal_ strtype - Captive portal type. Valid values:
fqdn
,ip
. - cert_
auth str - Enable/disable redirecting certificate authentication to HTTPS portal. Valid values:
enable
,disable
. - cert_
captive_ strportal - Certificate captive portal host name.
- cert_
captive_ strportal_ ip - Certificate captive portal IP address.
- cert_
captive_ intportal_ port - Certificate captive portal port number (1 - 65535, default = 7832).
- int
- Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)).
- int
- Refresh rate divider of persistent web portal cookie (default = 2). Refresh value = cookie-max-age/cookie-refresh-div.
- dev_
ranges Sequence[SettingDev Range Args] - Address range for the IP based device query. The structure of
dev_range
block is documented below. - dynamic_
sort_ strsubtable - 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 ].
- get_
all_ strtables - 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.
- str
- Enable/disable persistent cookie on IP based web portal authentication (default = disable). Valid values:
enable
,disable
. - str
- Enable/disable persistent cookie on web portal authentication (default = enable). Valid values:
enable
,disable
. - sso_
auth_ strscheme - Single-Sign-On authentication method (scheme name).
- update_
time str - Time of the last update.
- user_
cert_ Sequence[Settingcas User Cert Ca Args] - CA certificate used for client certificate verification. The structure of
user_cert_ca
block is documented below. - vdomparam str
- 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.
- active
Auth StringScheme - Active authentication method (scheme name).
- auth
Https String - Enable/disable redirecting HTTP user authentication to HTTPS. Valid values:
enable
,disable
. - captive
Portal String - Captive portal host name.
- captive
Portal6 String - IPv6 captive portal host name.
- captive
Portal StringIp - Captive portal IP address.
- captive
Portal StringIp6 - Captive portal IPv6 address.
- captive
Portal NumberPort - Captive portal port number (1 - 65535, default = 7830).
- captive
Portal NumberSsl Port - Captive portal SSL port number (1 - 65535, default = 7831).
- captive
Portal StringType - Captive portal type. Valid values:
fqdn
,ip
. - cert
Auth String - Enable/disable redirecting certificate authentication to HTTPS portal. Valid values:
enable
,disable
. - cert
Captive StringPortal - Certificate captive portal host name.
- cert
Captive StringPortal Ip - Certificate captive portal IP address.
- cert
Captive NumberPortal Port - Certificate captive portal port number (1 - 65535, default = 7832).
- Number
- Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)).
- Number
- Refresh rate divider of persistent web portal cookie (default = 2). Refresh value = cookie-max-age/cookie-refresh-div.
- dev
Ranges List<Property Map> - Address range for the IP based device query. The structure of
dev_range
block is documented below. - dynamic
Sort StringSubtable - 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 ].
- get
All StringTables - 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.
- String
- Enable/disable persistent cookie on IP based web portal authentication (default = disable). Valid values:
enable
,disable
. - String
- Enable/disable persistent cookie on web portal authentication (default = enable). Valid values:
enable
,disable
. - sso
Auth StringScheme - Single-Sign-On authentication method (scheme name).
- update
Time String - Time of the last update.
- user
Cert List<Property Map>Cas - CA certificate used for client certificate verification. The structure of
user_cert_ca
block is documented below. - vdomparam 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.
Supporting Types
SettingDevRange, SettingDevRangeArgs
- Name string
- Address name.
- Name string
- Address name.
- name String
- Address name.
- name string
- Address name.
- name str
- Address name.
- name String
- Address name.
SettingUserCertCa, SettingUserCertCaArgs
- Name string
- CA certificate list.
- Name string
- CA certificate list.
- name String
- CA certificate list.
- name string
- CA certificate list.
- name str
- CA certificate list.
- name String
- CA certificate list.
Import
Authentication Setting can be imported using any of these accepted formats:
$ pulumi import fortios:authentication/setting:Setting labelname AuthenticationSetting
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:authentication/setting:Setting labelname AuthenticationSetting
$ unset “FORTIOS_IMPORT_TABLE”
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- fortios pulumiverse/pulumi-fortios
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
fortios
Terraform Provider.