1. Packages
  2. Fortios
  3. API Docs
  4. endpointcontrol
  5. Settings
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.endpointcontrol.Settings

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

    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.

    Example Usage

    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 pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.endpointcontrol.Settings("trname",
        download_location="fortiguard",
        forticlient_avdb_update_interval=8,
        forticlient_dereg_unsupported_client="enable",
        forticlient_ems_rest_api_call_timeout=5000,
        forticlient_keepalive_interval=60,
        forticlient_offline_grace="disable",
        forticlient_offline_grace_interval=120,
        forticlient_reg_key_enforce="disable",
        forticlient_reg_timeout=7,
        forticlient_sys_update_interval=720,
        forticlient_user_avatar="enable",
        forticlient_warning_interval=1)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/endpointcontrol"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := endpointcontrol.NewSettings(ctx, "trname", &endpointcontrol.SettingsArgs{
    			DownloadLocation:                  pulumi.String("fortiguard"),
    			ForticlientAvdbUpdateInterval:     pulumi.Int(8),
    			ForticlientDeregUnsupportedClient: pulumi.String("enable"),
    			ForticlientEmsRestApiCallTimeout:  pulumi.Int(5000),
    			ForticlientKeepaliveInterval:      pulumi.Int(60),
    			ForticlientOfflineGrace:           pulumi.String("disable"),
    			ForticlientOfflineGraceInterval:   pulumi.Int(120),
    			ForticlientRegKeyEnforce:          pulumi.String("disable"),
    			ForticlientRegTimeout:             pulumi.Int(7),
    			ForticlientSysUpdateInterval:      pulumi.Int(720),
    			ForticlientUserAvatar:             pulumi.String("enable"),
    			ForticlientWarningInterval:        pulumi.Int(1),
    		})
    		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.Endpointcontrol.Settings("trname", new()
        {
            DownloadLocation = "fortiguard",
            ForticlientAvdbUpdateInterval = 8,
            ForticlientDeregUnsupportedClient = "enable",
            ForticlientEmsRestApiCallTimeout = 5000,
            ForticlientKeepaliveInterval = 60,
            ForticlientOfflineGrace = "disable",
            ForticlientOfflineGraceInterval = 120,
            ForticlientRegKeyEnforce = "disable",
            ForticlientRegTimeout = 7,
            ForticlientSysUpdateInterval = 720,
            ForticlientUserAvatar = "enable",
            ForticlientWarningInterval = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.endpointcontrol.Settings;
    import com.pulumi.fortios.endpointcontrol.SettingsArgs;
    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 Settings("trname", SettingsArgs.builder()        
                .downloadLocation("fortiguard")
                .forticlientAvdbUpdateInterval(8)
                .forticlientDeregUnsupportedClient("enable")
                .forticlientEmsRestApiCallTimeout(5000)
                .forticlientKeepaliveInterval(60)
                .forticlientOfflineGrace("disable")
                .forticlientOfflineGraceInterval(120)
                .forticlientRegKeyEnforce("disable")
                .forticlientRegTimeout(7)
                .forticlientSysUpdateInterval(720)
                .forticlientUserAvatar("enable")
                .forticlientWarningInterval(1)
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:endpointcontrol:Settings
        properties:
          downloadLocation: fortiguard
          forticlientAvdbUpdateInterval: 8
          forticlientDeregUnsupportedClient: enable
          forticlientEmsRestApiCallTimeout: 5000
          forticlientKeepaliveInterval: 60
          forticlientOfflineGrace: disable
          forticlientOfflineGraceInterval: 120
          forticlientRegKeyEnforce: disable
          forticlientRegTimeout: 7
          forticlientSysUpdateInterval: 720
          forticlientUserAvatar: enable
          forticlientWarningInterval: 1
    

    Create Settings Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Settings(name: string, args?: SettingsArgs, opts?: CustomResourceOptions);
    @overload
    def Settings(resource_name: str,
                 args: Optional[SettingsArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Settings(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 download_custom_link: Optional[str] = None,
                 download_location: Optional[str] = None,
                 forticlient_avdb_update_interval: Optional[int] = None,
                 forticlient_dereg_unsupported_client: Optional[str] = None,
                 forticlient_disconnect_unsupported_client: Optional[str] = None,
                 forticlient_ems_rest_api_call_timeout: Optional[int] = None,
                 forticlient_keepalive_interval: Optional[int] = None,
                 forticlient_offline_grace: Optional[str] = None,
                 forticlient_offline_grace_interval: Optional[int] = None,
                 forticlient_reg_key: Optional[str] = None,
                 forticlient_reg_key_enforce: Optional[str] = None,
                 forticlient_reg_timeout: Optional[int] = None,
                 forticlient_sys_update_interval: Optional[int] = None,
                 forticlient_user_avatar: Optional[str] = None,
                 forticlient_warning_interval: Optional[int] = None,
                 override: Optional[str] = None,
                 vdomparam: Optional[str] = None)
    func NewSettings(ctx *Context, name string, args *SettingsArgs, opts ...ResourceOption) (*Settings, error)
    public Settings(string name, SettingsArgs? args = null, CustomResourceOptions? opts = null)
    public Settings(String name, SettingsArgs args)
    public Settings(String name, SettingsArgs args, CustomResourceOptions options)
    
    type: fortios:endpointcontrol:Settings
    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 SettingsArgs
    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 SettingsArgs
    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 SettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SettingsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var examplesettingsResourceResourceFromEndpointcontrolsettings = new Fortios.Endpointcontrol.Settings("examplesettingsResourceResourceFromEndpointcontrolsettings", new()
    {
        DownloadCustomLink = "string",
        DownloadLocation = "string",
        ForticlientAvdbUpdateInterval = 0,
        ForticlientDeregUnsupportedClient = "string",
        ForticlientDisconnectUnsupportedClient = "string",
        ForticlientEmsRestApiCallTimeout = 0,
        ForticlientKeepaliveInterval = 0,
        ForticlientOfflineGrace = "string",
        ForticlientOfflineGraceInterval = 0,
        ForticlientRegKey = "string",
        ForticlientRegKeyEnforce = "string",
        ForticlientRegTimeout = 0,
        ForticlientSysUpdateInterval = 0,
        ForticlientUserAvatar = "string",
        ForticlientWarningInterval = 0,
        Override = "string",
        Vdomparam = "string",
    });
    
    example, err := endpointcontrol.NewSettings(ctx, "examplesettingsResourceResourceFromEndpointcontrolsettings", &endpointcontrol.SettingsArgs{
    	DownloadCustomLink:                     pulumi.String("string"),
    	DownloadLocation:                       pulumi.String("string"),
    	ForticlientAvdbUpdateInterval:          pulumi.Int(0),
    	ForticlientDeregUnsupportedClient:      pulumi.String("string"),
    	ForticlientDisconnectUnsupportedClient: pulumi.String("string"),
    	ForticlientEmsRestApiCallTimeout:       pulumi.Int(0),
    	ForticlientKeepaliveInterval:           pulumi.Int(0),
    	ForticlientOfflineGrace:                pulumi.String("string"),
    	ForticlientOfflineGraceInterval:        pulumi.Int(0),
    	ForticlientRegKey:                      pulumi.String("string"),
    	ForticlientRegKeyEnforce:               pulumi.String("string"),
    	ForticlientRegTimeout:                  pulumi.Int(0),
    	ForticlientSysUpdateInterval:           pulumi.Int(0),
    	ForticlientUserAvatar:                  pulumi.String("string"),
    	ForticlientWarningInterval:             pulumi.Int(0),
    	Override:                               pulumi.String("string"),
    	Vdomparam:                              pulumi.String("string"),
    })
    
    var examplesettingsResourceResourceFromEndpointcontrolsettings = new Settings("examplesettingsResourceResourceFromEndpointcontrolsettings", SettingsArgs.builder()
        .downloadCustomLink("string")
        .downloadLocation("string")
        .forticlientAvdbUpdateInterval(0)
        .forticlientDeregUnsupportedClient("string")
        .forticlientDisconnectUnsupportedClient("string")
        .forticlientEmsRestApiCallTimeout(0)
        .forticlientKeepaliveInterval(0)
        .forticlientOfflineGrace("string")
        .forticlientOfflineGraceInterval(0)
        .forticlientRegKey("string")
        .forticlientRegKeyEnforce("string")
        .forticlientRegTimeout(0)
        .forticlientSysUpdateInterval(0)
        .forticlientUserAvatar("string")
        .forticlientWarningInterval(0)
        .override("string")
        .vdomparam("string")
        .build());
    
    examplesettings_resource_resource_from_endpointcontrolsettings = fortios.endpointcontrol.Settings("examplesettingsResourceResourceFromEndpointcontrolsettings",
        download_custom_link="string",
        download_location="string",
        forticlient_avdb_update_interval=0,
        forticlient_dereg_unsupported_client="string",
        forticlient_disconnect_unsupported_client="string",
        forticlient_ems_rest_api_call_timeout=0,
        forticlient_keepalive_interval=0,
        forticlient_offline_grace="string",
        forticlient_offline_grace_interval=0,
        forticlient_reg_key="string",
        forticlient_reg_key_enforce="string",
        forticlient_reg_timeout=0,
        forticlient_sys_update_interval=0,
        forticlient_user_avatar="string",
        forticlient_warning_interval=0,
        override="string",
        vdomparam="string")
    
    const examplesettingsResourceResourceFromEndpointcontrolsettings = new fortios.endpointcontrol.Settings("examplesettingsResourceResourceFromEndpointcontrolsettings", {
        downloadCustomLink: "string",
        downloadLocation: "string",
        forticlientAvdbUpdateInterval: 0,
        forticlientDeregUnsupportedClient: "string",
        forticlientDisconnectUnsupportedClient: "string",
        forticlientEmsRestApiCallTimeout: 0,
        forticlientKeepaliveInterval: 0,
        forticlientOfflineGrace: "string",
        forticlientOfflineGraceInterval: 0,
        forticlientRegKey: "string",
        forticlientRegKeyEnforce: "string",
        forticlientRegTimeout: 0,
        forticlientSysUpdateInterval: 0,
        forticlientUserAvatar: "string",
        forticlientWarningInterval: 0,
        override: "string",
        vdomparam: "string",
    });
    
    type: fortios:endpointcontrol:Settings
    properties:
        downloadCustomLink: string
        downloadLocation: string
        forticlientAvdbUpdateInterval: 0
        forticlientDeregUnsupportedClient: string
        forticlientDisconnectUnsupportedClient: string
        forticlientEmsRestApiCallTimeout: 0
        forticlientKeepaliveInterval: 0
        forticlientOfflineGrace: string
        forticlientOfflineGraceInterval: 0
        forticlientRegKey: string
        forticlientRegKeyEnforce: string
        forticlientRegTimeout: 0
        forticlientSysUpdateInterval: 0
        forticlientUserAvatar: string
        forticlientWarningInterval: 0
        override: string
        vdomparam: string
    

    Settings 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 Settings resource accepts the following input properties:

    DownloadCustomLink string
    Customized URL for downloading FortiClient.
    DownloadLocation string
    FortiClient download location (FortiGuard or custom). Valid values: fortiguard, custom.
    ForticlientAvdbUpdateInterval int
    Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
    ForticlientDeregUnsupportedClient string
    Enable/disable deregistering unsupported FortiClient endpoints. Valid values: enable, disable.
    ForticlientDisconnectUnsupportedClient string
    Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: enable, disable.
    ForticlientEmsRestApiCallTimeout int
    FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
    ForticlientKeepaliveInterval int
    Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
    ForticlientOfflineGrace string
    Enable/disable grace period for offline registered clients. Valid values: enable, disable.
    ForticlientOfflineGraceInterval int
    Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
    ForticlientRegKey string
    FortiClient registration key.
    ForticlientRegKeyEnforce string
    Enable/disable requiring or enforcing FortiClient registration keys. Valid values: enable, disable.
    ForticlientRegTimeout int
    FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
    ForticlientSysUpdateInterval int
    Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
    ForticlientUserAvatar string
    Enable/disable uploading FortiClient user avatars. Valid values: enable, disable.
    ForticlientWarningInterval int
    Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
    Override string
    Override global EMS table for this VDOM. Valid values: enable, disable.
    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.
    DownloadCustomLink string
    Customized URL for downloading FortiClient.
    DownloadLocation string
    FortiClient download location (FortiGuard or custom). Valid values: fortiguard, custom.
    ForticlientAvdbUpdateInterval int
    Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
    ForticlientDeregUnsupportedClient string
    Enable/disable deregistering unsupported FortiClient endpoints. Valid values: enable, disable.
    ForticlientDisconnectUnsupportedClient string
    Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: enable, disable.
    ForticlientEmsRestApiCallTimeout int
    FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
    ForticlientKeepaliveInterval int
    Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
    ForticlientOfflineGrace string
    Enable/disable grace period for offline registered clients. Valid values: enable, disable.
    ForticlientOfflineGraceInterval int
    Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
    ForticlientRegKey string
    FortiClient registration key.
    ForticlientRegKeyEnforce string
    Enable/disable requiring or enforcing FortiClient registration keys. Valid values: enable, disable.
    ForticlientRegTimeout int
    FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
    ForticlientSysUpdateInterval int
    Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
    ForticlientUserAvatar string
    Enable/disable uploading FortiClient user avatars. Valid values: enable, disable.
    ForticlientWarningInterval int
    Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
    Override string
    Override global EMS table for this VDOM. Valid values: enable, disable.
    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.
    downloadCustomLink String
    Customized URL for downloading FortiClient.
    downloadLocation String
    FortiClient download location (FortiGuard or custom). Valid values: fortiguard, custom.
    forticlientAvdbUpdateInterval Integer
    Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
    forticlientDeregUnsupportedClient String
    Enable/disable deregistering unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlientDisconnectUnsupportedClient String
    Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlientEmsRestApiCallTimeout Integer
    FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
    forticlientKeepaliveInterval Integer
    Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
    forticlientOfflineGrace String
    Enable/disable grace period for offline registered clients. Valid values: enable, disable.
    forticlientOfflineGraceInterval Integer
    Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
    forticlientRegKey String
    FortiClient registration key.
    forticlientRegKeyEnforce String
    Enable/disable requiring or enforcing FortiClient registration keys. Valid values: enable, disable.
    forticlientRegTimeout Integer
    FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
    forticlientSysUpdateInterval Integer
    Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
    forticlientUserAvatar String
    Enable/disable uploading FortiClient user avatars. Valid values: enable, disable.
    forticlientWarningInterval Integer
    Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
    override String
    Override global EMS table for this VDOM. Valid values: enable, disable.
    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.
    downloadCustomLink string
    Customized URL for downloading FortiClient.
    downloadLocation string
    FortiClient download location (FortiGuard or custom). Valid values: fortiguard, custom.
    forticlientAvdbUpdateInterval number
    Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
    forticlientDeregUnsupportedClient string
    Enable/disable deregistering unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlientDisconnectUnsupportedClient string
    Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlientEmsRestApiCallTimeout number
    FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
    forticlientKeepaliveInterval number
    Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
    forticlientOfflineGrace string
    Enable/disable grace period for offline registered clients. Valid values: enable, disable.
    forticlientOfflineGraceInterval number
    Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
    forticlientRegKey string
    FortiClient registration key.
    forticlientRegKeyEnforce string
    Enable/disable requiring or enforcing FortiClient registration keys. Valid values: enable, disable.
    forticlientRegTimeout number
    FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
    forticlientSysUpdateInterval number
    Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
    forticlientUserAvatar string
    Enable/disable uploading FortiClient user avatars. Valid values: enable, disable.
    forticlientWarningInterval number
    Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
    override string
    Override global EMS table for this VDOM. Valid values: enable, disable.
    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.
    download_custom_link str
    Customized URL for downloading FortiClient.
    download_location str
    FortiClient download location (FortiGuard or custom). Valid values: fortiguard, custom.
    forticlient_avdb_update_interval int
    Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
    forticlient_dereg_unsupported_client str
    Enable/disable deregistering unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlient_disconnect_unsupported_client str
    Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlient_ems_rest_api_call_timeout int
    FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
    forticlient_keepalive_interval int
    Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
    forticlient_offline_grace str
    Enable/disable grace period for offline registered clients. Valid values: enable, disable.
    forticlient_offline_grace_interval int
    Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
    forticlient_reg_key str
    FortiClient registration key.
    forticlient_reg_key_enforce str
    Enable/disable requiring or enforcing FortiClient registration keys. Valid values: enable, disable.
    forticlient_reg_timeout int
    FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
    forticlient_sys_update_interval int
    Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
    forticlient_user_avatar str
    Enable/disable uploading FortiClient user avatars. Valid values: enable, disable.
    forticlient_warning_interval int
    Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
    override str
    Override global EMS table for this VDOM. Valid values: enable, disable.
    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.
    downloadCustomLink String
    Customized URL for downloading FortiClient.
    downloadLocation String
    FortiClient download location (FortiGuard or custom). Valid values: fortiguard, custom.
    forticlientAvdbUpdateInterval Number
    Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
    forticlientDeregUnsupportedClient String
    Enable/disable deregistering unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlientDisconnectUnsupportedClient String
    Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlientEmsRestApiCallTimeout Number
    FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
    forticlientKeepaliveInterval Number
    Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
    forticlientOfflineGrace String
    Enable/disable grace period for offline registered clients. Valid values: enable, disable.
    forticlientOfflineGraceInterval Number
    Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
    forticlientRegKey String
    FortiClient registration key.
    forticlientRegKeyEnforce String
    Enable/disable requiring or enforcing FortiClient registration keys. Valid values: enable, disable.
    forticlientRegTimeout Number
    FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
    forticlientSysUpdateInterval Number
    Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
    forticlientUserAvatar String
    Enable/disable uploading FortiClient user avatars. Valid values: enable, disable.
    forticlientWarningInterval Number
    Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
    override String
    Override global EMS table for this VDOM. Valid values: enable, disable.
    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 Settings 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 Settings Resource

    Get an existing Settings 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?: SettingsState, opts?: CustomResourceOptions): Settings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            download_custom_link: Optional[str] = None,
            download_location: Optional[str] = None,
            forticlient_avdb_update_interval: Optional[int] = None,
            forticlient_dereg_unsupported_client: Optional[str] = None,
            forticlient_disconnect_unsupported_client: Optional[str] = None,
            forticlient_ems_rest_api_call_timeout: Optional[int] = None,
            forticlient_keepalive_interval: Optional[int] = None,
            forticlient_offline_grace: Optional[str] = None,
            forticlient_offline_grace_interval: Optional[int] = None,
            forticlient_reg_key: Optional[str] = None,
            forticlient_reg_key_enforce: Optional[str] = None,
            forticlient_reg_timeout: Optional[int] = None,
            forticlient_sys_update_interval: Optional[int] = None,
            forticlient_user_avatar: Optional[str] = None,
            forticlient_warning_interval: Optional[int] = None,
            override: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Settings
    func GetSettings(ctx *Context, name string, id IDInput, state *SettingsState, opts ...ResourceOption) (*Settings, error)
    public static Settings Get(string name, Input<string> id, SettingsState? state, CustomResourceOptions? opts = null)
    public static Settings get(String name, Output<String> id, SettingsState 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.
    The following state arguments are supported:
    DownloadCustomLink string
    Customized URL for downloading FortiClient.
    DownloadLocation string
    FortiClient download location (FortiGuard or custom). Valid values: fortiguard, custom.
    ForticlientAvdbUpdateInterval int
    Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
    ForticlientDeregUnsupportedClient string
    Enable/disable deregistering unsupported FortiClient endpoints. Valid values: enable, disable.
    ForticlientDisconnectUnsupportedClient string
    Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: enable, disable.
    ForticlientEmsRestApiCallTimeout int
    FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
    ForticlientKeepaliveInterval int
    Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
    ForticlientOfflineGrace string
    Enable/disable grace period for offline registered clients. Valid values: enable, disable.
    ForticlientOfflineGraceInterval int
    Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
    ForticlientRegKey string
    FortiClient registration key.
    ForticlientRegKeyEnforce string
    Enable/disable requiring or enforcing FortiClient registration keys. Valid values: enable, disable.
    ForticlientRegTimeout int
    FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
    ForticlientSysUpdateInterval int
    Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
    ForticlientUserAvatar string
    Enable/disable uploading FortiClient user avatars. Valid values: enable, disable.
    ForticlientWarningInterval int
    Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
    Override string
    Override global EMS table for this VDOM. Valid values: enable, disable.
    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.
    DownloadCustomLink string
    Customized URL for downloading FortiClient.
    DownloadLocation string
    FortiClient download location (FortiGuard or custom). Valid values: fortiguard, custom.
    ForticlientAvdbUpdateInterval int
    Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
    ForticlientDeregUnsupportedClient string
    Enable/disable deregistering unsupported FortiClient endpoints. Valid values: enable, disable.
    ForticlientDisconnectUnsupportedClient string
    Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: enable, disable.
    ForticlientEmsRestApiCallTimeout int
    FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
    ForticlientKeepaliveInterval int
    Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
    ForticlientOfflineGrace string
    Enable/disable grace period for offline registered clients. Valid values: enable, disable.
    ForticlientOfflineGraceInterval int
    Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
    ForticlientRegKey string
    FortiClient registration key.
    ForticlientRegKeyEnforce string
    Enable/disable requiring or enforcing FortiClient registration keys. Valid values: enable, disable.
    ForticlientRegTimeout int
    FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
    ForticlientSysUpdateInterval int
    Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
    ForticlientUserAvatar string
    Enable/disable uploading FortiClient user avatars. Valid values: enable, disable.
    ForticlientWarningInterval int
    Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
    Override string
    Override global EMS table for this VDOM. Valid values: enable, disable.
    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.
    downloadCustomLink String
    Customized URL for downloading FortiClient.
    downloadLocation String
    FortiClient download location (FortiGuard or custom). Valid values: fortiguard, custom.
    forticlientAvdbUpdateInterval Integer
    Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
    forticlientDeregUnsupportedClient String
    Enable/disable deregistering unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlientDisconnectUnsupportedClient String
    Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlientEmsRestApiCallTimeout Integer
    FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
    forticlientKeepaliveInterval Integer
    Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
    forticlientOfflineGrace String
    Enable/disable grace period for offline registered clients. Valid values: enable, disable.
    forticlientOfflineGraceInterval Integer
    Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
    forticlientRegKey String
    FortiClient registration key.
    forticlientRegKeyEnforce String
    Enable/disable requiring or enforcing FortiClient registration keys. Valid values: enable, disable.
    forticlientRegTimeout Integer
    FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
    forticlientSysUpdateInterval Integer
    Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
    forticlientUserAvatar String
    Enable/disable uploading FortiClient user avatars. Valid values: enable, disable.
    forticlientWarningInterval Integer
    Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
    override String
    Override global EMS table for this VDOM. Valid values: enable, disable.
    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.
    downloadCustomLink string
    Customized URL for downloading FortiClient.
    downloadLocation string
    FortiClient download location (FortiGuard or custom). Valid values: fortiguard, custom.
    forticlientAvdbUpdateInterval number
    Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
    forticlientDeregUnsupportedClient string
    Enable/disable deregistering unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlientDisconnectUnsupportedClient string
    Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlientEmsRestApiCallTimeout number
    FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
    forticlientKeepaliveInterval number
    Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
    forticlientOfflineGrace string
    Enable/disable grace period for offline registered clients. Valid values: enable, disable.
    forticlientOfflineGraceInterval number
    Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
    forticlientRegKey string
    FortiClient registration key.
    forticlientRegKeyEnforce string
    Enable/disable requiring or enforcing FortiClient registration keys. Valid values: enable, disable.
    forticlientRegTimeout number
    FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
    forticlientSysUpdateInterval number
    Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
    forticlientUserAvatar string
    Enable/disable uploading FortiClient user avatars. Valid values: enable, disable.
    forticlientWarningInterval number
    Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
    override string
    Override global EMS table for this VDOM. Valid values: enable, disable.
    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.
    download_custom_link str
    Customized URL for downloading FortiClient.
    download_location str
    FortiClient download location (FortiGuard or custom). Valid values: fortiguard, custom.
    forticlient_avdb_update_interval int
    Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
    forticlient_dereg_unsupported_client str
    Enable/disable deregistering unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlient_disconnect_unsupported_client str
    Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlient_ems_rest_api_call_timeout int
    FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
    forticlient_keepalive_interval int
    Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
    forticlient_offline_grace str
    Enable/disable grace period for offline registered clients. Valid values: enable, disable.
    forticlient_offline_grace_interval int
    Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
    forticlient_reg_key str
    FortiClient registration key.
    forticlient_reg_key_enforce str
    Enable/disable requiring or enforcing FortiClient registration keys. Valid values: enable, disable.
    forticlient_reg_timeout int
    FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
    forticlient_sys_update_interval int
    Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
    forticlient_user_avatar str
    Enable/disable uploading FortiClient user avatars. Valid values: enable, disable.
    forticlient_warning_interval int
    Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
    override str
    Override global EMS table for this VDOM. Valid values: enable, disable.
    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.
    downloadCustomLink String
    Customized URL for downloading FortiClient.
    downloadLocation String
    FortiClient download location (FortiGuard or custom). Valid values: fortiguard, custom.
    forticlientAvdbUpdateInterval Number
    Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
    forticlientDeregUnsupportedClient String
    Enable/disable deregistering unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlientDisconnectUnsupportedClient String
    Enable/disable disconnecting of unsupported FortiClient endpoints. Valid values: enable, disable.
    forticlientEmsRestApiCallTimeout Number
    FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
    forticlientKeepaliveInterval Number
    Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
    forticlientOfflineGrace String
    Enable/disable grace period for offline registered clients. Valid values: enable, disable.
    forticlientOfflineGraceInterval Number
    Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
    forticlientRegKey String
    FortiClient registration key.
    forticlientRegKeyEnforce String
    Enable/disable requiring or enforcing FortiClient registration keys. Valid values: enable, disable.
    forticlientRegTimeout Number
    FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
    forticlientSysUpdateInterval Number
    Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
    forticlientUserAvatar String
    Enable/disable uploading FortiClient user avatars. Valid values: enable, disable.
    forticlientWarningInterval Number
    Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
    override String
    Override global EMS table for this VDOM. Valid values: enable, disable.
    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.

    Import

    EndpointControl Settings can be imported using any of these accepted formats:

    $ pulumi import fortios:endpointcontrol/settings:Settings labelname EndpointControlSettings
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:endpointcontrol/settings:Settings labelname EndpointControlSettings
    

    $ 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.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse