1. Packages
  2. Fortios
  3. API Docs
  4. antivirus
  5. Settings
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.antivirus.Settings

Explore with Pulumi AI

Configure AntiVirus settings.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.antivirus.Settings("trname", {
    defaultDb: "extended",
    grayware: "enable",
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.antivirus.Settings("trname",
    default_db="extended",
    grayware="enable")
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/antivirus"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := antivirus.NewSettings(ctx, "trname", &antivirus.SettingsArgs{
			DefaultDb: pulumi.String("extended"),
			Grayware:  pulumi.String("enable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.Antivirus.Settings("trname", new()
    {
        DefaultDb = "extended",
        Grayware = "enable",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.antivirus.Settings;
import com.pulumi.fortios.antivirus.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()
            .defaultDb("extended")
            .grayware("enable")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:antivirus:Settings
    properties:
      defaultDb: extended
      grayware: enable
Copy

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,
             cache_clean_result: Optional[str] = None,
             cache_infected_result: Optional[str] = None,
             default_db: Optional[str] = None,
             grayware: Optional[str] = None,
             machine_learning_detection: Optional[str] = None,
             override_timeout: Optional[int] = None,
             use_extreme_db: 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:antivirus:Settings
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 SettingsArgs
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 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. SettingsArgs
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 settingsResource = new Fortios.Antivirus.Settings("settingsResource", new()
{
    CacheCleanResult = "string",
    CacheInfectedResult = "string",
    DefaultDb = "string",
    Grayware = "string",
    MachineLearningDetection = "string",
    OverrideTimeout = 0,
    UseExtremeDb = "string",
    Vdomparam = "string",
});
Copy
example, err := antivirus.NewSettings(ctx, "settingsResource", &antivirus.SettingsArgs{
	CacheCleanResult:         pulumi.String("string"),
	CacheInfectedResult:      pulumi.String("string"),
	DefaultDb:                pulumi.String("string"),
	Grayware:                 pulumi.String("string"),
	MachineLearningDetection: pulumi.String("string"),
	OverrideTimeout:          pulumi.Int(0),
	UseExtremeDb:             pulumi.String("string"),
	Vdomparam:                pulumi.String("string"),
})
Copy
var settingsResource = new com.pulumi.fortios.antivirus.Settings("settingsResource", com.pulumi.fortios.antivirus.SettingsArgs.builder()
    .cacheCleanResult("string")
    .cacheInfectedResult("string")
    .defaultDb("string")
    .grayware("string")
    .machineLearningDetection("string")
    .overrideTimeout(0)
    .useExtremeDb("string")
    .vdomparam("string")
    .build());
Copy
settings_resource = fortios.antivirus.Settings("settingsResource",
    cache_clean_result="string",
    cache_infected_result="string",
    default_db="string",
    grayware="string",
    machine_learning_detection="string",
    override_timeout=0,
    use_extreme_db="string",
    vdomparam="string")
Copy
const settingsResource = new fortios.antivirus.Settings("settingsResource", {
    cacheCleanResult: "string",
    cacheInfectedResult: "string",
    defaultDb: "string",
    grayware: "string",
    machineLearningDetection: "string",
    overrideTimeout: 0,
    useExtremeDb: "string",
    vdomparam: "string",
});
Copy
type: fortios:antivirus:Settings
properties:
    cacheCleanResult: string
    cacheInfectedResult: string
    defaultDb: string
    grayware: string
    machineLearningDetection: string
    overrideTimeout: 0
    useExtremeDb: string
    vdomparam: string
Copy

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

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

The Settings resource accepts the following input properties:

CacheCleanResult string
Enable/disable cache of clean scan results (default = enable). Valid values: enable, disable.
CacheInfectedResult string
Enable/disable cache of infected scan results (default = enable). Valid values: enable, disable.
DefaultDb string
Select the AV database to be used for AV scanning. Valid values: normal, extended, extreme.
Grayware string
Enable/disable grayware detection when an AntiVirus profile is applied to traffic. Valid values: enable, disable.
MachineLearningDetection string
Use machine learning based malware detection. Valid values: enable, monitor, disable.
OverrideTimeout int
Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size.
UseExtremeDb string
Enable/disable the use of Extreme AVDB. Valid values: enable, disable.
Vdomparam Changes to this property will trigger replacement. 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.
CacheCleanResult string
Enable/disable cache of clean scan results (default = enable). Valid values: enable, disable.
CacheInfectedResult string
Enable/disable cache of infected scan results (default = enable). Valid values: enable, disable.
DefaultDb string
Select the AV database to be used for AV scanning. Valid values: normal, extended, extreme.
Grayware string
Enable/disable grayware detection when an AntiVirus profile is applied to traffic. Valid values: enable, disable.
MachineLearningDetection string
Use machine learning based malware detection. Valid values: enable, monitor, disable.
OverrideTimeout int
Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size.
UseExtremeDb string
Enable/disable the use of Extreme AVDB. Valid values: enable, disable.
Vdomparam Changes to this property will trigger replacement. 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.
cacheCleanResult String
Enable/disable cache of clean scan results (default = enable). Valid values: enable, disable.
cacheInfectedResult String
Enable/disable cache of infected scan results (default = enable). Valid values: enable, disable.
defaultDb String
Select the AV database to be used for AV scanning. Valid values: normal, extended, extreme.
grayware String
Enable/disable grayware detection when an AntiVirus profile is applied to traffic. Valid values: enable, disable.
machineLearningDetection String
Use machine learning based malware detection. Valid values: enable, monitor, disable.
overrideTimeout Integer
Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size.
useExtremeDb String
Enable/disable the use of Extreme AVDB. Valid values: enable, disable.
vdomparam Changes to this property will trigger replacement. 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.
cacheCleanResult string
Enable/disable cache of clean scan results (default = enable). Valid values: enable, disable.
cacheInfectedResult string
Enable/disable cache of infected scan results (default = enable). Valid values: enable, disable.
defaultDb string
Select the AV database to be used for AV scanning. Valid values: normal, extended, extreme.
grayware string
Enable/disable grayware detection when an AntiVirus profile is applied to traffic. Valid values: enable, disable.
machineLearningDetection string
Use machine learning based malware detection. Valid values: enable, monitor, disable.
overrideTimeout number
Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size.
useExtremeDb string
Enable/disable the use of Extreme AVDB. Valid values: enable, disable.
vdomparam Changes to this property will trigger replacement. 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.
cache_clean_result str
Enable/disable cache of clean scan results (default = enable). Valid values: enable, disable.
cache_infected_result str
Enable/disable cache of infected scan results (default = enable). Valid values: enable, disable.
default_db str
Select the AV database to be used for AV scanning. Valid values: normal, extended, extreme.
grayware str
Enable/disable grayware detection when an AntiVirus profile is applied to traffic. Valid values: enable, disable.
machine_learning_detection str
Use machine learning based malware detection. Valid values: enable, monitor, disable.
override_timeout int
Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size.
use_extreme_db str
Enable/disable the use of Extreme AVDB. Valid values: enable, disable.
vdomparam Changes to this property will trigger replacement. 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.
cacheCleanResult String
Enable/disable cache of clean scan results (default = enable). Valid values: enable, disable.
cacheInfectedResult String
Enable/disable cache of infected scan results (default = enable). Valid values: enable, disable.
defaultDb String
Select the AV database to be used for AV scanning. Valid values: normal, extended, extreme.
grayware String
Enable/disable grayware detection when an AntiVirus profile is applied to traffic. Valid values: enable, disable.
machineLearningDetection String
Use machine learning based malware detection. Valid values: enable, monitor, disable.
overrideTimeout Number
Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size.
useExtremeDb String
Enable/disable the use of Extreme AVDB. Valid values: enable, disable.
vdomparam Changes to this property will trigger replacement. 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,
        cache_clean_result: Optional[str] = None,
        cache_infected_result: Optional[str] = None,
        default_db: Optional[str] = None,
        grayware: Optional[str] = None,
        machine_learning_detection: Optional[str] = None,
        override_timeout: Optional[int] = None,
        use_extreme_db: 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)
resources:  _:    type: fortios:antivirus:Settings    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:
CacheCleanResult string
Enable/disable cache of clean scan results (default = enable). Valid values: enable, disable.
CacheInfectedResult string
Enable/disable cache of infected scan results (default = enable). Valid values: enable, disable.
DefaultDb string
Select the AV database to be used for AV scanning. Valid values: normal, extended, extreme.
Grayware string
Enable/disable grayware detection when an AntiVirus profile is applied to traffic. Valid values: enable, disable.
MachineLearningDetection string
Use machine learning based malware detection. Valid values: enable, monitor, disable.
OverrideTimeout int
Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size.
UseExtremeDb string
Enable/disable the use of Extreme AVDB. Valid values: enable, disable.
Vdomparam Changes to this property will trigger replacement. 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.
CacheCleanResult string
Enable/disable cache of clean scan results (default = enable). Valid values: enable, disable.
CacheInfectedResult string
Enable/disable cache of infected scan results (default = enable). Valid values: enable, disable.
DefaultDb string
Select the AV database to be used for AV scanning. Valid values: normal, extended, extreme.
Grayware string
Enable/disable grayware detection when an AntiVirus profile is applied to traffic. Valid values: enable, disable.
MachineLearningDetection string
Use machine learning based malware detection. Valid values: enable, monitor, disable.
OverrideTimeout int
Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size.
UseExtremeDb string
Enable/disable the use of Extreme AVDB. Valid values: enable, disable.
Vdomparam Changes to this property will trigger replacement. 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.
cacheCleanResult String
Enable/disable cache of clean scan results (default = enable). Valid values: enable, disable.
cacheInfectedResult String
Enable/disable cache of infected scan results (default = enable). Valid values: enable, disable.
defaultDb String
Select the AV database to be used for AV scanning. Valid values: normal, extended, extreme.
grayware String
Enable/disable grayware detection when an AntiVirus profile is applied to traffic. Valid values: enable, disable.
machineLearningDetection String
Use machine learning based malware detection. Valid values: enable, monitor, disable.
overrideTimeout Integer
Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size.
useExtremeDb String
Enable/disable the use of Extreme AVDB. Valid values: enable, disable.
vdomparam Changes to this property will trigger replacement. 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.
cacheCleanResult string
Enable/disable cache of clean scan results (default = enable). Valid values: enable, disable.
cacheInfectedResult string
Enable/disable cache of infected scan results (default = enable). Valid values: enable, disable.
defaultDb string
Select the AV database to be used for AV scanning. Valid values: normal, extended, extreme.
grayware string
Enable/disable grayware detection when an AntiVirus profile is applied to traffic. Valid values: enable, disable.
machineLearningDetection string
Use machine learning based malware detection. Valid values: enable, monitor, disable.
overrideTimeout number
Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size.
useExtremeDb string
Enable/disable the use of Extreme AVDB. Valid values: enable, disable.
vdomparam Changes to this property will trigger replacement. 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.
cache_clean_result str
Enable/disable cache of clean scan results (default = enable). Valid values: enable, disable.
cache_infected_result str
Enable/disable cache of infected scan results (default = enable). Valid values: enable, disable.
default_db str
Select the AV database to be used for AV scanning. Valid values: normal, extended, extreme.
grayware str
Enable/disable grayware detection when an AntiVirus profile is applied to traffic. Valid values: enable, disable.
machine_learning_detection str
Use machine learning based malware detection. Valid values: enable, monitor, disable.
override_timeout int
Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size.
use_extreme_db str
Enable/disable the use of Extreme AVDB. Valid values: enable, disable.
vdomparam Changes to this property will trigger replacement. 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.
cacheCleanResult String
Enable/disable cache of clean scan results (default = enable). Valid values: enable, disable.
cacheInfectedResult String
Enable/disable cache of infected scan results (default = enable). Valid values: enable, disable.
defaultDb String
Select the AV database to be used for AV scanning. Valid values: normal, extended, extreme.
grayware String
Enable/disable grayware detection when an AntiVirus profile is applied to traffic. Valid values: enable, disable.
machineLearningDetection String
Use machine learning based malware detection. Valid values: enable, monitor, disable.
overrideTimeout Number
Override the large file scan timeout value in seconds (30 - 3600). Zero is the default value and is used to disable this command. When disabled, the daemon adjusts the large file scan timeout based on the file size.
useExtremeDb String
Enable/disable the use of Extreme AVDB. Valid values: enable, disable.
vdomparam Changes to this property will trigger replacement. 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

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

$ pulumi import fortios:antivirus/settings:Settings labelname AntivirusSettings
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:antivirus/settings:Settings labelname AntivirusSettings
Copy

$ 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.