Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. SystemSql
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.SystemSql

Explore with Pulumi AI

fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

SQL settings.

The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

  • custom_index: fortimanager.SystemSqlCustomindex
  • custom_skipidx: fortimanager.SystemSqlCustomskipidx
  • ts_index_field: fortimanager.SystemSqlTsindexfield

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortimanager from "@pulumi/fortimanager";

const trname = new fortimanager.SystemSql("trname", {
    passwords: ["fortinet"],
    server: "192.168.1.1",
    status: "enable",
    username: "admin",
});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.SystemSql("trname",
    passwords=["fortinet"],
    server="192.168.1.1",
    status="enable",
    username="admin")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewSystemSql(ctx, "trname", &fortimanager.SystemSqlArgs{
			Passwords: pulumi.StringArray{
				pulumi.String("fortinet"),
			},
			Server:   pulumi.String("192.168.1.1"),
			Status:   pulumi.String("enable"),
			Username: pulumi.String("admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.SystemSql("trname", new()
    {
        Passwords = new[]
        {
            "fortinet",
        },
        Server = "192.168.1.1",
        Status = "enable",
        Username = "admin",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.SystemSql;
import com.pulumi.fortimanager.SystemSqlArgs;
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 SystemSql("trname", SystemSqlArgs.builder()
            .passwords("fortinet")
            .server("192.168.1.1")
            .status("enable")
            .username("admin")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortimanager:SystemSql
    properties:
      passwords:
        - fortinet
      server: 192.168.1.1
      status: enable
      username: admin
Copy

Create SystemSql Resource

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

Constructor syntax

new SystemSql(name: string, args?: SystemSqlArgs, opts?: CustomResourceOptions);
@overload
def SystemSql(resource_name: str,
              args: Optional[SystemSqlArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def SystemSql(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              background_rebuild: Optional[str] = None,
              compress_table_min_age: Optional[float] = None,
              custom_indices: Optional[Sequence[SystemSqlCustomIndexArgs]] = None,
              custom_skipidxes: Optional[Sequence[SystemSqlCustomSkipidxArgs]] = None,
              database_name: Optional[str] = None,
              database_type: Optional[str] = None,
              device_count_high: Optional[str] = None,
              dynamic_sort_subtable: Optional[str] = None,
              event_table_partition_time: Optional[float] = None,
              fct_table_partition_time: Optional[float] = None,
              logtypes: Optional[Sequence[str]] = None,
              passwords: Optional[Sequence[str]] = None,
              prompt_sql_upgrade: Optional[str] = None,
              rebuild_event: Optional[str] = None,
              rebuild_event_start_times: Optional[Sequence[str]] = None,
              server: Optional[str] = None,
              start_times: Optional[Sequence[str]] = None,
              status: Optional[str] = None,
              system_sql_id: Optional[str] = None,
              text_search_index: Optional[str] = None,
              traffic_table_partition_time: Optional[float] = None,
              ts_index_fields: Optional[Sequence[SystemSqlTsIndexFieldArgs]] = None,
              username: Optional[str] = None,
              utm_table_partition_time: Optional[float] = None)
func NewSystemSql(ctx *Context, name string, args *SystemSqlArgs, opts ...ResourceOption) (*SystemSql, error)
public SystemSql(string name, SystemSqlArgs? args = null, CustomResourceOptions? opts = null)
public SystemSql(String name, SystemSqlArgs args)
public SystemSql(String name, SystemSqlArgs args, CustomResourceOptions options)

type: fortimanager:SystemSql
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args SystemSqlArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args SystemSqlArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args SystemSqlArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args SystemSqlArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SystemSqlArgs
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 systemSqlResource = new Fortimanager.SystemSql("systemSqlResource", new()
{
    BackgroundRebuild = "string",
    CompressTableMinAge = 0,
    CustomIndices = new[]
    {
        new Fortimanager.Inputs.SystemSqlCustomIndexArgs
        {
            CaseSensitive = "string",
            DeviceType = "string",
            Id = 0,
            IndexField = "string",
            LogType = "string",
        },
    },
    CustomSkipidxes = new[]
    {
        new Fortimanager.Inputs.SystemSqlCustomSkipidxArgs
        {
            DeviceType = "string",
            Id = 0,
            IndexField = "string",
            LogType = "string",
        },
    },
    DatabaseName = "string",
    DatabaseType = "string",
    DeviceCountHigh = "string",
    DynamicSortSubtable = "string",
    EventTablePartitionTime = 0,
    FctTablePartitionTime = 0,
    Logtypes = new[]
    {
        "string",
    },
    Passwords = new[]
    {
        "string",
    },
    PromptSqlUpgrade = "string",
    RebuildEvent = "string",
    RebuildEventStartTimes = new[]
    {
        "string",
    },
    Server = "string",
    StartTimes = new[]
    {
        "string",
    },
    Status = "string",
    SystemSqlId = "string",
    TextSearchIndex = "string",
    TrafficTablePartitionTime = 0,
    TsIndexFields = new[]
    {
        new Fortimanager.Inputs.SystemSqlTsIndexFieldArgs
        {
            Category = "string",
            Value = "string",
        },
    },
    Username = "string",
    UtmTablePartitionTime = 0,
});
Copy
example, err := fortimanager.NewSystemSql(ctx, "systemSqlResource", &fortimanager.SystemSqlArgs{
BackgroundRebuild: pulumi.String("string"),
CompressTableMinAge: pulumi.Float64(0),
CustomIndices: .SystemSqlCustomIndexTypeArray{
&.SystemSqlCustomIndexTypeArgs{
CaseSensitive: pulumi.String("string"),
DeviceType: pulumi.String("string"),
Id: pulumi.Float64(0),
IndexField: pulumi.String("string"),
LogType: pulumi.String("string"),
},
},
CustomSkipidxes: .SystemSqlCustomSkipidxTypeArray{
&.SystemSqlCustomSkipidxTypeArgs{
DeviceType: pulumi.String("string"),
Id: pulumi.Float64(0),
IndexField: pulumi.String("string"),
LogType: pulumi.String("string"),
},
},
DatabaseName: pulumi.String("string"),
DatabaseType: pulumi.String("string"),
DeviceCountHigh: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
EventTablePartitionTime: pulumi.Float64(0),
FctTablePartitionTime: pulumi.Float64(0),
Logtypes: pulumi.StringArray{
pulumi.String("string"),
},
Passwords: pulumi.StringArray{
pulumi.String("string"),
},
PromptSqlUpgrade: pulumi.String("string"),
RebuildEvent: pulumi.String("string"),
RebuildEventStartTimes: pulumi.StringArray{
pulumi.String("string"),
},
Server: pulumi.String("string"),
StartTimes: pulumi.StringArray{
pulumi.String("string"),
},
Status: pulumi.String("string"),
SystemSqlId: pulumi.String("string"),
TextSearchIndex: pulumi.String("string"),
TrafficTablePartitionTime: pulumi.Float64(0),
TsIndexFields: .SystemSqlTsIndexFieldTypeArray{
&.SystemSqlTsIndexFieldTypeArgs{
Category: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Username: pulumi.String("string"),
UtmTablePartitionTime: pulumi.Float64(0),
})
Copy
var systemSqlResource = new SystemSql("systemSqlResource", SystemSqlArgs.builder()
    .backgroundRebuild("string")
    .compressTableMinAge(0)
    .customIndices(SystemSqlCustomIndexArgs.builder()
        .caseSensitive("string")
        .deviceType("string")
        .id(0)
        .indexField("string")
        .logType("string")
        .build())
    .customSkipidxes(SystemSqlCustomSkipidxArgs.builder()
        .deviceType("string")
        .id(0)
        .indexField("string")
        .logType("string")
        .build())
    .databaseName("string")
    .databaseType("string")
    .deviceCountHigh("string")
    .dynamicSortSubtable("string")
    .eventTablePartitionTime(0)
    .fctTablePartitionTime(0)
    .logtypes("string")
    .passwords("string")
    .promptSqlUpgrade("string")
    .rebuildEvent("string")
    .rebuildEventStartTimes("string")
    .server("string")
    .startTimes("string")
    .status("string")
    .systemSqlId("string")
    .textSearchIndex("string")
    .trafficTablePartitionTime(0)
    .tsIndexFields(SystemSqlTsIndexFieldArgs.builder()
        .category("string")
        .value("string")
        .build())
    .username("string")
    .utmTablePartitionTime(0)
    .build());
Copy
system_sql_resource = fortimanager.SystemSql("systemSqlResource",
    background_rebuild="string",
    compress_table_min_age=0,
    custom_indices=[{
        "case_sensitive": "string",
        "device_type": "string",
        "id": 0,
        "index_field": "string",
        "log_type": "string",
    }],
    custom_skipidxes=[{
        "device_type": "string",
        "id": 0,
        "index_field": "string",
        "log_type": "string",
    }],
    database_name="string",
    database_type="string",
    device_count_high="string",
    dynamic_sort_subtable="string",
    event_table_partition_time=0,
    fct_table_partition_time=0,
    logtypes=["string"],
    passwords=["string"],
    prompt_sql_upgrade="string",
    rebuild_event="string",
    rebuild_event_start_times=["string"],
    server="string",
    start_times=["string"],
    status="string",
    system_sql_id="string",
    text_search_index="string",
    traffic_table_partition_time=0,
    ts_index_fields=[{
        "category": "string",
        "value": "string",
    }],
    username="string",
    utm_table_partition_time=0)
Copy
const systemSqlResource = new fortimanager.SystemSql("systemSqlResource", {
    backgroundRebuild: "string",
    compressTableMinAge: 0,
    customIndices: [{
        caseSensitive: "string",
        deviceType: "string",
        id: 0,
        indexField: "string",
        logType: "string",
    }],
    customSkipidxes: [{
        deviceType: "string",
        id: 0,
        indexField: "string",
        logType: "string",
    }],
    databaseName: "string",
    databaseType: "string",
    deviceCountHigh: "string",
    dynamicSortSubtable: "string",
    eventTablePartitionTime: 0,
    fctTablePartitionTime: 0,
    logtypes: ["string"],
    passwords: ["string"],
    promptSqlUpgrade: "string",
    rebuildEvent: "string",
    rebuildEventStartTimes: ["string"],
    server: "string",
    startTimes: ["string"],
    status: "string",
    systemSqlId: "string",
    textSearchIndex: "string",
    trafficTablePartitionTime: 0,
    tsIndexFields: [{
        category: "string",
        value: "string",
    }],
    username: "string",
    utmTablePartitionTime: 0,
});
Copy
type: fortimanager:SystemSql
properties:
    backgroundRebuild: string
    compressTableMinAge: 0
    customIndices:
        - caseSensitive: string
          deviceType: string
          id: 0
          indexField: string
          logType: string
    customSkipidxes:
        - deviceType: string
          id: 0
          indexField: string
          logType: string
    databaseName: string
    databaseType: string
    deviceCountHigh: string
    dynamicSortSubtable: string
    eventTablePartitionTime: 0
    fctTablePartitionTime: 0
    logtypes:
        - string
    passwords:
        - string
    promptSqlUpgrade: string
    rebuildEvent: string
    rebuildEventStartTimes:
        - string
    server: string
    startTimes:
        - string
    status: string
    systemSqlId: string
    textSearchIndex: string
    trafficTablePartitionTime: 0
    tsIndexFields:
        - category: string
          value: string
    username: string
    utmTablePartitionTime: 0
Copy

SystemSql Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SystemSql resource accepts the following input properties:

BackgroundRebuild string
Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Valid values: disable, enable.
CompressTableMinAge double
Minimum age in days for SQL tables to be compressed.
CustomIndices List<SystemSqlCustomIndex>
Custom-Index. The structure of custom_index block is documented below.
CustomSkipidxes List<SystemSqlCustomSkipidx>
Custom-Skipidx. The structure of custom_skipidx block is documented below.
DatabaseName string
Database name.
DatabaseType string
Database type. mysql - MySQL database. postgres - PostgreSQL local database. Valid values: mysql, postgres.
DeviceCountHigh string
Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Valid values: disable, enable.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
EventTablePartitionTime double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.
FctTablePartitionTime double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.
Logtypes List<string>
Log type. none - None. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
Passwords List<string>
Password for login remote database.
PromptSqlUpgrade string
Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Valid values: disable, enable.
RebuildEvent string
Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Valid values: disable, enable.
RebuildEventStartTimes List<string>
Rebuild event starting date and time <hh:mm yyyy/mm/dd>.
Server string
Database IP or hostname.
StartTimes List<string>
Start date and time <hh:mm yyyy/mm/dd>.
Status string
SQL database status. disable - Disable SQL database. local - Enable local database. Valid values: disable, local.
SystemSqlId string
an identifier for the resource.
TextSearchIndex string
Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Valid values: disable, enable.
TrafficTablePartitionTime double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.
TsIndexFields List<SystemSqlTsIndexField>
Ts-Index-Field. The structure of ts_index_field block is documented below.
Username string
User name for login remote database.
UtmTablePartitionTime double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.
BackgroundRebuild string
Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Valid values: disable, enable.
CompressTableMinAge float64
Minimum age in days for SQL tables to be compressed.
CustomIndices []SystemSqlCustomIndexTypeArgs
Custom-Index. The structure of custom_index block is documented below.
CustomSkipidxes []SystemSqlCustomSkipidxTypeArgs
Custom-Skipidx. The structure of custom_skipidx block is documented below.
DatabaseName string
Database name.
DatabaseType string
Database type. mysql - MySQL database. postgres - PostgreSQL local database. Valid values: mysql, postgres.
DeviceCountHigh string
Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Valid values: disable, enable.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
EventTablePartitionTime float64
Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.
FctTablePartitionTime float64
Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.
Logtypes []string
Log type. none - None. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
Passwords []string
Password for login remote database.
PromptSqlUpgrade string
Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Valid values: disable, enable.
RebuildEvent string
Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Valid values: disable, enable.
RebuildEventStartTimes []string
Rebuild event starting date and time <hh:mm yyyy/mm/dd>.
Server string
Database IP or hostname.
StartTimes []string
Start date and time <hh:mm yyyy/mm/dd>.
Status string
SQL database status. disable - Disable SQL database. local - Enable local database. Valid values: disable, local.
SystemSqlId string
an identifier for the resource.
TextSearchIndex string
Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Valid values: disable, enable.
TrafficTablePartitionTime float64
Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.
TsIndexFields []SystemSqlTsIndexFieldTypeArgs
Ts-Index-Field. The structure of ts_index_field block is documented below.
Username string
User name for login remote database.
UtmTablePartitionTime float64
Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.
backgroundRebuild String
Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Valid values: disable, enable.
compressTableMinAge Double
Minimum age in days for SQL tables to be compressed.
customIndices List<SystemSqlCustomIndex>
Custom-Index. The structure of custom_index block is documented below.
customSkipidxes List<SystemSqlCustomSkipidx>
Custom-Skipidx. The structure of custom_skipidx block is documented below.
databaseName String
Database name.
databaseType String
Database type. mysql - MySQL database. postgres - PostgreSQL local database. Valid values: mysql, postgres.
deviceCountHigh String
Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Valid values: disable, enable.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
eventTablePartitionTime Double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.
fctTablePartitionTime Double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.
logtypes List<String>
Log type. none - None. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
passwords List<String>
Password for login remote database.
promptSqlUpgrade String
Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Valid values: disable, enable.
rebuildEvent String
Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Valid values: disable, enable.
rebuildEventStartTimes List<String>
Rebuild event starting date and time <hh:mm yyyy/mm/dd>.
server String
Database IP or hostname.
startTimes List<String>
Start date and time <hh:mm yyyy/mm/dd>.
status String
SQL database status. disable - Disable SQL database. local - Enable local database. Valid values: disable, local.
systemSqlId String
an identifier for the resource.
textSearchIndex String
Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Valid values: disable, enable.
trafficTablePartitionTime Double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.
tsIndexFields List<SystemSqlTsIndexField>
Ts-Index-Field. The structure of ts_index_field block is documented below.
username String
User name for login remote database.
utmTablePartitionTime Double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.
backgroundRebuild string
Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Valid values: disable, enable.
compressTableMinAge number
Minimum age in days for SQL tables to be compressed.
customIndices SystemSqlCustomIndex[]
Custom-Index. The structure of custom_index block is documented below.
customSkipidxes SystemSqlCustomSkipidx[]
Custom-Skipidx. The structure of custom_skipidx block is documented below.
databaseName string
Database name.
databaseType string
Database type. mysql - MySQL database. postgres - PostgreSQL local database. Valid values: mysql, postgres.
deviceCountHigh string
Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Valid values: disable, enable.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
eventTablePartitionTime number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.
fctTablePartitionTime number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.
logtypes string[]
Log type. none - None. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
passwords string[]
Password for login remote database.
promptSqlUpgrade string
Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Valid values: disable, enable.
rebuildEvent string
Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Valid values: disable, enable.
rebuildEventStartTimes string[]
Rebuild event starting date and time <hh:mm yyyy/mm/dd>.
server string
Database IP or hostname.
startTimes string[]
Start date and time <hh:mm yyyy/mm/dd>.
status string
SQL database status. disable - Disable SQL database. local - Enable local database. Valid values: disable, local.
systemSqlId string
an identifier for the resource.
textSearchIndex string
Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Valid values: disable, enable.
trafficTablePartitionTime number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.
tsIndexFields SystemSqlTsIndexField[]
Ts-Index-Field. The structure of ts_index_field block is documented below.
username string
User name for login remote database.
utmTablePartitionTime number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.
background_rebuild str
Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Valid values: disable, enable.
compress_table_min_age float
Minimum age in days for SQL tables to be compressed.
custom_indices Sequence[SystemSqlCustomIndexArgs]
Custom-Index. The structure of custom_index block is documented below.
custom_skipidxes Sequence[SystemSqlCustomSkipidxArgs]
Custom-Skipidx. The structure of custom_skipidx block is documented below.
database_name str
Database name.
database_type str
Database type. mysql - MySQL database. postgres - PostgreSQL local database. Valid values: mysql, postgres.
device_count_high str
Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Valid values: disable, enable.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
event_table_partition_time float
Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.
fct_table_partition_time float
Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.
logtypes Sequence[str]
Log type. none - None. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
passwords Sequence[str]
Password for login remote database.
prompt_sql_upgrade str
Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Valid values: disable, enable.
rebuild_event str
Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Valid values: disable, enable.
rebuild_event_start_times Sequence[str]
Rebuild event starting date and time <hh:mm yyyy/mm/dd>.
server str
Database IP or hostname.
start_times Sequence[str]
Start date and time <hh:mm yyyy/mm/dd>.
status str
SQL database status. disable - Disable SQL database. local - Enable local database. Valid values: disable, local.
system_sql_id str
an identifier for the resource.
text_search_index str
Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Valid values: disable, enable.
traffic_table_partition_time float
Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.
ts_index_fields Sequence[SystemSqlTsIndexFieldArgs]
Ts-Index-Field. The structure of ts_index_field block is documented below.
username str
User name for login remote database.
utm_table_partition_time float
Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.
backgroundRebuild String
Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Valid values: disable, enable.
compressTableMinAge Number
Minimum age in days for SQL tables to be compressed.
customIndices List<Property Map>
Custom-Index. The structure of custom_index block is documented below.
customSkipidxes List<Property Map>
Custom-Skipidx. The structure of custom_skipidx block is documented below.
databaseName String
Database name.
databaseType String
Database type. mysql - MySQL database. postgres - PostgreSQL local database. Valid values: mysql, postgres.
deviceCountHigh String
Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Valid values: disable, enable.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
eventTablePartitionTime Number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.
fctTablePartitionTime Number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.
logtypes List<String>
Log type. none - None. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
passwords List<String>
Password for login remote database.
promptSqlUpgrade String
Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Valid values: disable, enable.
rebuildEvent String
Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Valid values: disable, enable.
rebuildEventStartTimes List<String>
Rebuild event starting date and time <hh:mm yyyy/mm/dd>.
server String
Database IP or hostname.
startTimes List<String>
Start date and time <hh:mm yyyy/mm/dd>.
status String
SQL database status. disable - Disable SQL database. local - Enable local database. Valid values: disable, local.
systemSqlId String
an identifier for the resource.
textSearchIndex String
Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Valid values: disable, enable.
trafficTablePartitionTime Number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.
tsIndexFields List<Property Map>
Ts-Index-Field. The structure of ts_index_field block is documented below.
username String
User name for login remote database.
utmTablePartitionTime Number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.

Outputs

All input properties are implicitly available as output properties. Additionally, the SystemSql 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 SystemSql Resource

Get an existing SystemSql 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?: SystemSqlState, opts?: CustomResourceOptions): SystemSql
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        background_rebuild: Optional[str] = None,
        compress_table_min_age: Optional[float] = None,
        custom_indices: Optional[Sequence[SystemSqlCustomIndexArgs]] = None,
        custom_skipidxes: Optional[Sequence[SystemSqlCustomSkipidxArgs]] = None,
        database_name: Optional[str] = None,
        database_type: Optional[str] = None,
        device_count_high: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        event_table_partition_time: Optional[float] = None,
        fct_table_partition_time: Optional[float] = None,
        logtypes: Optional[Sequence[str]] = None,
        passwords: Optional[Sequence[str]] = None,
        prompt_sql_upgrade: Optional[str] = None,
        rebuild_event: Optional[str] = None,
        rebuild_event_start_times: Optional[Sequence[str]] = None,
        server: Optional[str] = None,
        start_times: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        system_sql_id: Optional[str] = None,
        text_search_index: Optional[str] = None,
        traffic_table_partition_time: Optional[float] = None,
        ts_index_fields: Optional[Sequence[SystemSqlTsIndexFieldArgs]] = None,
        username: Optional[str] = None,
        utm_table_partition_time: Optional[float] = None) -> SystemSql
func GetSystemSql(ctx *Context, name string, id IDInput, state *SystemSqlState, opts ...ResourceOption) (*SystemSql, error)
public static SystemSql Get(string name, Input<string> id, SystemSqlState? state, CustomResourceOptions? opts = null)
public static SystemSql get(String name, Output<String> id, SystemSqlState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:SystemSql    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
BackgroundRebuild string
Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Valid values: disable, enable.
CompressTableMinAge double
Minimum age in days for SQL tables to be compressed.
CustomIndices List<SystemSqlCustomIndex>
Custom-Index. The structure of custom_index block is documented below.
CustomSkipidxes List<SystemSqlCustomSkipidx>
Custom-Skipidx. The structure of custom_skipidx block is documented below.
DatabaseName string
Database name.
DatabaseType string
Database type. mysql - MySQL database. postgres - PostgreSQL local database. Valid values: mysql, postgres.
DeviceCountHigh string
Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Valid values: disable, enable.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
EventTablePartitionTime double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.
FctTablePartitionTime double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.
Logtypes List<string>
Log type. none - None. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
Passwords List<string>
Password for login remote database.
PromptSqlUpgrade string
Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Valid values: disable, enable.
RebuildEvent string
Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Valid values: disable, enable.
RebuildEventStartTimes List<string>
Rebuild event starting date and time <hh:mm yyyy/mm/dd>.
Server string
Database IP or hostname.
StartTimes List<string>
Start date and time <hh:mm yyyy/mm/dd>.
Status string
SQL database status. disable - Disable SQL database. local - Enable local database. Valid values: disable, local.
SystemSqlId string
an identifier for the resource.
TextSearchIndex string
Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Valid values: disable, enable.
TrafficTablePartitionTime double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.
TsIndexFields List<SystemSqlTsIndexField>
Ts-Index-Field. The structure of ts_index_field block is documented below.
Username string
User name for login remote database.
UtmTablePartitionTime double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.
BackgroundRebuild string
Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Valid values: disable, enable.
CompressTableMinAge float64
Minimum age in days for SQL tables to be compressed.
CustomIndices []SystemSqlCustomIndexTypeArgs
Custom-Index. The structure of custom_index block is documented below.
CustomSkipidxes []SystemSqlCustomSkipidxTypeArgs
Custom-Skipidx. The structure of custom_skipidx block is documented below.
DatabaseName string
Database name.
DatabaseType string
Database type. mysql - MySQL database. postgres - PostgreSQL local database. Valid values: mysql, postgres.
DeviceCountHigh string
Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Valid values: disable, enable.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
EventTablePartitionTime float64
Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.
FctTablePartitionTime float64
Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.
Logtypes []string
Log type. none - None. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
Passwords []string
Password for login remote database.
PromptSqlUpgrade string
Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Valid values: disable, enable.
RebuildEvent string
Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Valid values: disable, enable.
RebuildEventStartTimes []string
Rebuild event starting date and time <hh:mm yyyy/mm/dd>.
Server string
Database IP or hostname.
StartTimes []string
Start date and time <hh:mm yyyy/mm/dd>.
Status string
SQL database status. disable - Disable SQL database. local - Enable local database. Valid values: disable, local.
SystemSqlId string
an identifier for the resource.
TextSearchIndex string
Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Valid values: disable, enable.
TrafficTablePartitionTime float64
Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.
TsIndexFields []SystemSqlTsIndexFieldTypeArgs
Ts-Index-Field. The structure of ts_index_field block is documented below.
Username string
User name for login remote database.
UtmTablePartitionTime float64
Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.
backgroundRebuild String
Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Valid values: disable, enable.
compressTableMinAge Double
Minimum age in days for SQL tables to be compressed.
customIndices List<SystemSqlCustomIndex>
Custom-Index. The structure of custom_index block is documented below.
customSkipidxes List<SystemSqlCustomSkipidx>
Custom-Skipidx. The structure of custom_skipidx block is documented below.
databaseName String
Database name.
databaseType String
Database type. mysql - MySQL database. postgres - PostgreSQL local database. Valid values: mysql, postgres.
deviceCountHigh String
Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Valid values: disable, enable.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
eventTablePartitionTime Double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.
fctTablePartitionTime Double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.
logtypes List<String>
Log type. none - None. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
passwords List<String>
Password for login remote database.
promptSqlUpgrade String
Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Valid values: disable, enable.
rebuildEvent String
Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Valid values: disable, enable.
rebuildEventStartTimes List<String>
Rebuild event starting date and time <hh:mm yyyy/mm/dd>.
server String
Database IP or hostname.
startTimes List<String>
Start date and time <hh:mm yyyy/mm/dd>.
status String
SQL database status. disable - Disable SQL database. local - Enable local database. Valid values: disable, local.
systemSqlId String
an identifier for the resource.
textSearchIndex String
Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Valid values: disable, enable.
trafficTablePartitionTime Double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.
tsIndexFields List<SystemSqlTsIndexField>
Ts-Index-Field. The structure of ts_index_field block is documented below.
username String
User name for login remote database.
utmTablePartitionTime Double
Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.
backgroundRebuild string
Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Valid values: disable, enable.
compressTableMinAge number
Minimum age in days for SQL tables to be compressed.
customIndices SystemSqlCustomIndex[]
Custom-Index. The structure of custom_index block is documented below.
customSkipidxes SystemSqlCustomSkipidx[]
Custom-Skipidx. The structure of custom_skipidx block is documented below.
databaseName string
Database name.
databaseType string
Database type. mysql - MySQL database. postgres - PostgreSQL local database. Valid values: mysql, postgres.
deviceCountHigh string
Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Valid values: disable, enable.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
eventTablePartitionTime number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.
fctTablePartitionTime number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.
logtypes string[]
Log type. none - None. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
passwords string[]
Password for login remote database.
promptSqlUpgrade string
Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Valid values: disable, enable.
rebuildEvent string
Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Valid values: disable, enable.
rebuildEventStartTimes string[]
Rebuild event starting date and time <hh:mm yyyy/mm/dd>.
server string
Database IP or hostname.
startTimes string[]
Start date and time <hh:mm yyyy/mm/dd>.
status string
SQL database status. disable - Disable SQL database. local - Enable local database. Valid values: disable, local.
systemSqlId string
an identifier for the resource.
textSearchIndex string
Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Valid values: disable, enable.
trafficTablePartitionTime number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.
tsIndexFields SystemSqlTsIndexField[]
Ts-Index-Field. The structure of ts_index_field block is documented below.
username string
User name for login remote database.
utmTablePartitionTime number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.
background_rebuild str
Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Valid values: disable, enable.
compress_table_min_age float
Minimum age in days for SQL tables to be compressed.
custom_indices Sequence[SystemSqlCustomIndexArgs]
Custom-Index. The structure of custom_index block is documented below.
custom_skipidxes Sequence[SystemSqlCustomSkipidxArgs]
Custom-Skipidx. The structure of custom_skipidx block is documented below.
database_name str
Database name.
database_type str
Database type. mysql - MySQL database. postgres - PostgreSQL local database. Valid values: mysql, postgres.
device_count_high str
Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Valid values: disable, enable.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
event_table_partition_time float
Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.
fct_table_partition_time float
Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.
logtypes Sequence[str]
Log type. none - None. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
passwords Sequence[str]
Password for login remote database.
prompt_sql_upgrade str
Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Valid values: disable, enable.
rebuild_event str
Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Valid values: disable, enable.
rebuild_event_start_times Sequence[str]
Rebuild event starting date and time <hh:mm yyyy/mm/dd>.
server str
Database IP or hostname.
start_times Sequence[str]
Start date and time <hh:mm yyyy/mm/dd>.
status str
SQL database status. disable - Disable SQL database. local - Enable local database. Valid values: disable, local.
system_sql_id str
an identifier for the resource.
text_search_index str
Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Valid values: disable, enable.
traffic_table_partition_time float
Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.
ts_index_fields Sequence[SystemSqlTsIndexFieldArgs]
Ts-Index-Field. The structure of ts_index_field block is documented below.
username str
User name for login remote database.
utm_table_partition_time float
Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.
backgroundRebuild String
Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Valid values: disable, enable.
compressTableMinAge Number
Minimum age in days for SQL tables to be compressed.
customIndices List<Property Map>
Custom-Index. The structure of custom_index block is documented below.
customSkipidxes List<Property Map>
Custom-Skipidx. The structure of custom_skipidx block is documented below.
databaseName String
Database name.
databaseType String
Database type. mysql - MySQL database. postgres - PostgreSQL local database. Valid values: mysql, postgres.
deviceCountHigh String
Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Valid values: disable, enable.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
eventTablePartitionTime Number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.
fctTablePartitionTime Number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.
logtypes List<String>
Log type. none - None. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
passwords List<String>
Password for login remote database.
promptSqlUpgrade String
Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Valid values: disable, enable.
rebuildEvent String
Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Valid values: disable, enable.
rebuildEventStartTimes List<String>
Rebuild event starting date and time <hh:mm yyyy/mm/dd>.
server String
Database IP or hostname.
startTimes List<String>
Start date and time <hh:mm yyyy/mm/dd>.
status String
SQL database status. disable - Disable SQL database. local - Enable local database. Valid values: disable, local.
systemSqlId String
an identifier for the resource.
textSearchIndex String
Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Valid values: disable, enable.
trafficTablePartitionTime Number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.
tsIndexFields List<Property Map>
Ts-Index-Field. The structure of ts_index_field block is documented below.
username String
User name for login remote database.
utmTablePartitionTime Number
Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.

Supporting Types

SystemSqlCustomIndex
, SystemSqlCustomIndexArgs

CaseSensitive string
Disable/Enable case sensitive index. disable - Build a case insensitive index. enable - Build a case sensitive index. Valid values: disable, enable.
DeviceType string
Device type. FortiGate - Device type to FortiGate. FortiMail - Device type to FortiMail. FortiWeb - Device type to FortiWeb. Valid values: FortiGate, FortiMail, FortiWeb.
Id double
Add or Edit log index fields.
IndexField string
Log field name to be indexed.
LogType string
Log type. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
CaseSensitive string
Disable/Enable case sensitive index. disable - Build a case insensitive index. enable - Build a case sensitive index. Valid values: disable, enable.
DeviceType string
Device type. FortiGate - Device type to FortiGate. FortiMail - Device type to FortiMail. FortiWeb - Device type to FortiWeb. Valid values: FortiGate, FortiMail, FortiWeb.
Id float64
Add or Edit log index fields.
IndexField string
Log field name to be indexed.
LogType string
Log type. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
caseSensitive String
Disable/Enable case sensitive index. disable - Build a case insensitive index. enable - Build a case sensitive index. Valid values: disable, enable.
deviceType String
Device type. FortiGate - Device type to FortiGate. FortiMail - Device type to FortiMail. FortiWeb - Device type to FortiWeb. Valid values: FortiGate, FortiMail, FortiWeb.
id Double
Add or Edit log index fields.
indexField String
Log field name to be indexed.
logType String
Log type. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
caseSensitive string
Disable/Enable case sensitive index. disable - Build a case insensitive index. enable - Build a case sensitive index. Valid values: disable, enable.
deviceType string
Device type. FortiGate - Device type to FortiGate. FortiMail - Device type to FortiMail. FortiWeb - Device type to FortiWeb. Valid values: FortiGate, FortiMail, FortiWeb.
id number
Add or Edit log index fields.
indexField string
Log field name to be indexed.
logType string
Log type. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
case_sensitive str
Disable/Enable case sensitive index. disable - Build a case insensitive index. enable - Build a case sensitive index. Valid values: disable, enable.
device_type str
Device type. FortiGate - Device type to FortiGate. FortiMail - Device type to FortiMail. FortiWeb - Device type to FortiWeb. Valid values: FortiGate, FortiMail, FortiWeb.
id float
Add or Edit log index fields.
index_field str
Log field name to be indexed.
log_type str
Log type. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
caseSensitive String
Disable/Enable case sensitive index. disable - Build a case insensitive index. enable - Build a case sensitive index. Valid values: disable, enable.
deviceType String
Device type. FortiGate - Device type to FortiGate. FortiMail - Device type to FortiMail. FortiWeb - Device type to FortiWeb. Valid values: FortiGate, FortiMail, FortiWeb.
id Number
Add or Edit log index fields.
indexField String
Log field name to be indexed.
logType String
Log type. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.

SystemSqlCustomSkipidx
, SystemSqlCustomSkipidxArgs

DeviceType string
Device type. FortiGate - Set device type to FortiGate. FortiManager - Set device type to FortiManager FortiClient - Set device type to FortiClient. FortiMail - Set device type to FortiMail. FortiWeb - Set device type to FortiWeb. FortiSandbox - Set device type to FortiSandbox FortiProxy - Set device type to FortiProxy Valid values: FortiGate, FortiManager, FortiClient, FortiMail, FortiWeb, FortiSandbox, FortiProxy.
Id double
Add or Edit log index fields.
IndexField string
Field to be added to skip index.
LogType string
Log type. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
DeviceType string
Device type. FortiGate - Set device type to FortiGate. FortiManager - Set device type to FortiManager FortiClient - Set device type to FortiClient. FortiMail - Set device type to FortiMail. FortiWeb - Set device type to FortiWeb. FortiSandbox - Set device type to FortiSandbox FortiProxy - Set device type to FortiProxy Valid values: FortiGate, FortiManager, FortiClient, FortiMail, FortiWeb, FortiSandbox, FortiProxy.
Id float64
Add or Edit log index fields.
IndexField string
Field to be added to skip index.
LogType string
Log type. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
deviceType String
Device type. FortiGate - Set device type to FortiGate. FortiManager - Set device type to FortiManager FortiClient - Set device type to FortiClient. FortiMail - Set device type to FortiMail. FortiWeb - Set device type to FortiWeb. FortiSandbox - Set device type to FortiSandbox FortiProxy - Set device type to FortiProxy Valid values: FortiGate, FortiManager, FortiClient, FortiMail, FortiWeb, FortiSandbox, FortiProxy.
id Double
Add or Edit log index fields.
indexField String
Field to be added to skip index.
logType String
Log type. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
deviceType string
Device type. FortiGate - Set device type to FortiGate. FortiManager - Set device type to FortiManager FortiClient - Set device type to FortiClient. FortiMail - Set device type to FortiMail. FortiWeb - Set device type to FortiWeb. FortiSandbox - Set device type to FortiSandbox FortiProxy - Set device type to FortiProxy Valid values: FortiGate, FortiManager, FortiClient, FortiMail, FortiWeb, FortiSandbox, FortiProxy.
id number
Add or Edit log index fields.
indexField string
Field to be added to skip index.
logType string
Log type. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
device_type str
Device type. FortiGate - Set device type to FortiGate. FortiManager - Set device type to FortiManager FortiClient - Set device type to FortiClient. FortiMail - Set device type to FortiMail. FortiWeb - Set device type to FortiWeb. FortiSandbox - Set device type to FortiSandbox FortiProxy - Set device type to FortiProxy Valid values: FortiGate, FortiManager, FortiClient, FortiMail, FortiWeb, FortiSandbox, FortiProxy.
id float
Add or Edit log index fields.
index_field str
Field to be added to skip index.
log_type str
Log type. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.
deviceType String
Device type. FortiGate - Set device type to FortiGate. FortiManager - Set device type to FortiManager FortiClient - Set device type to FortiClient. FortiMail - Set device type to FortiMail. FortiWeb - Set device type to FortiWeb. FortiSandbox - Set device type to FortiSandbox FortiProxy - Set device type to FortiProxy Valid values: FortiGate, FortiManager, FortiClient, FortiMail, FortiWeb, FortiSandbox, FortiProxy.
id Number
Add or Edit log index fields.
indexField String
Field to be added to skip index.
logType String
Log type. app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - Valid values: app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem.

SystemSqlTsIndexField
, SystemSqlTsIndexFieldArgs

Category string
Category of text search index fields.
Value string
Fields of text search index.
Category string
Category of text search index fields.
Value string
Fields of text search index.
category String
Category of text search index fields.
value String
Fields of text search index.
category string
Category of text search index fields.
value string
Fields of text search index.
category str
Category of text search index fields.
value str
Fields of text search index.
category String
Category of text search index fields.
value String
Fields of text search index.

Import

System Sql can be imported using any of these accepted formats:

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/systemSql:SystemSql labelname SystemSql
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
fortimanager fortinetdev/terraform-provider-fortimanager
License
Notes
This Pulumi package is based on the fortimanager Terraform Provider.
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager