Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. filter
  5. filter/spam
  6. Mheader
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.filter/spam.Mheader

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

Configure AntiSpam MIME header. Applies to FortiOS Version <= 6.2.0.

Example Usage

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

const trname = new fortios.filter.spam.Mheader("trname", {
    comment: "test",
    entries: [{
        action: "spam",
        fieldbody: "scstest",
        fieldname: "EIWEtest",
        id: 1,
        patternType: "wildcard",
        status: "enable",
    }],
    fosid: 1,
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.filter.spam.Mheader("trname",
    comment="test",
    entries=[fortios.filter.spam.MheaderEntryArgs(
        action="spam",
        fieldbody="scstest",
        fieldname="EIWEtest",
        id=1,
        pattern_type="wildcard",
        status="enable",
    )],
    fosid=1)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filter.NewMheader(ctx, "trname", &filter.MheaderArgs{
			Comment: pulumi.String("test"),
			Entries: spam.MheaderEntryArray{
				&spam.MheaderEntryArgs{
					Action:      pulumi.String("spam"),
					Fieldbody:   pulumi.String("scstest"),
					Fieldname:   pulumi.String("EIWEtest"),
					Id:          pulumi.Int(1),
					PatternType: pulumi.String("wildcard"),
					Status:      pulumi.String("enable"),
				},
			},
			Fosid: pulumi.Int(1),
		})
		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.Filter.Spam.Mheader("trname", new()
    {
        Comment = "test",
        Entries = new[]
        {
            new Fortios.Filter.Spam.Inputs.MheaderEntryArgs
            {
                Action = "spam",
                Fieldbody = "scstest",
                Fieldname = "EIWEtest",
                Id = 1,
                PatternType = "wildcard",
                Status = "enable",
            },
        },
        Fosid = 1,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.filter.Mheader;
import com.pulumi.fortios.filter.MheaderArgs;
import com.pulumi.fortios.filter.inputs.MheaderEntryArgs;
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 Mheader("trname", MheaderArgs.builder()
            .comment("test")
            .entries(MheaderEntryArgs.builder()
                .action("spam")
                .fieldbody("scstest")
                .fieldname("EIWEtest")
                .id(1)
                .patternType("wildcard")
                .status("enable")
                .build())
            .fosid(1)
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:filter/spam:Mheader
    properties:
      comment: test
      entries:
        - action: spam
          fieldbody: scstest
          fieldname: EIWEtest
          id: 1
          patternType: wildcard
          status: enable
      fosid: 1
Copy

Create Mheader Resource

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

Constructor syntax

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

@overload
def Mheader(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            fosid: Optional[int] = None,
            comment: Optional[str] = None,
            dynamic_sort_subtable: Optional[str] = None,
            entries: Optional[Sequence[MheaderEntryArgs]] = None,
            get_all_tables: Optional[str] = None,
            name: Optional[str] = None,
            vdomparam: Optional[str] = None)
func NewMheader(ctx *Context, name string, args MheaderArgs, opts ...ResourceOption) (*Mheader, error)
public Mheader(string name, MheaderArgs args, CustomResourceOptions? opts = null)
public Mheader(String name, MheaderArgs args)
public Mheader(String name, MheaderArgs args, CustomResourceOptions options)

type: fortios:filter/spam/mheader:Mheader
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 This property is required. MheaderArgs
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 This property is required. MheaderArgs
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 This property is required. MheaderArgs
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 This property is required. MheaderArgs
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. MheaderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

Fosid
This property is required.
Changes to this property will trigger replacement.
int
ID.
Comment string
Optional comments.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Entries List<Pulumiverse.Fortios.Filter.Spam.Inputs.MheaderEntry>
Spam filter mime header content. The structure of entries block is documented below.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Name string
Name of table.
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.
Fosid
This property is required.
Changes to this property will trigger replacement.
int
ID.
Comment string
Optional comments.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Entries []MheaderEntryArgs
Spam filter mime header content. The structure of entries block is documented below.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Name string
Name of table.
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.
fosid
This property is required.
Changes to this property will trigger replacement.
Integer
ID.
comment String
Optional comments.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries List<MheaderEntry>
Spam filter mime header content. The structure of entries block is documented below.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name String
Name of table.
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.
fosid
This property is required.
Changes to this property will trigger replacement.
number
ID.
comment string
Optional comments.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries MheaderEntry[]
Spam filter mime header content. The structure of entries block is documented below.
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name string
Name of table.
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.
fosid
This property is required.
Changes to this property will trigger replacement.
int
ID.
comment str
Optional comments.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries Sequence[MheaderEntryArgs]
Spam filter mime header content. The structure of entries block is documented below.
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name str
Name of table.
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.
fosid
This property is required.
Changes to this property will trigger replacement.
Number
ID.
comment String
Optional comments.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries List<Property Map>
Spam filter mime header content. The structure of entries block is documented below.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name String
Name of table.
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 Mheader 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 Mheader Resource

Get an existing Mheader 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?: MheaderState, opts?: CustomResourceOptions): Mheader
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        entries: Optional[Sequence[MheaderEntryArgs]] = None,
        fosid: Optional[int] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Mheader
func GetMheader(ctx *Context, name string, id IDInput, state *MheaderState, opts ...ResourceOption) (*Mheader, error)
public static Mheader Get(string name, Input<string> id, MheaderState? state, CustomResourceOptions? opts = null)
public static Mheader get(String name, Output<String> id, MheaderState state, CustomResourceOptions options)
resources:  _:    type: fortios:filter/spam/mheader:Mheader    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:
Comment string
Optional comments.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Entries List<Pulumiverse.Fortios.Filter.Spam.Inputs.MheaderEntry>
Spam filter mime header content. The structure of entries block is documented below.
Fosid Changes to this property will trigger replacement. int
ID.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Name string
Name of table.
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.
Comment string
Optional comments.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Entries []MheaderEntryArgs
Spam filter mime header content. The structure of entries block is documented below.
Fosid Changes to this property will trigger replacement. int
ID.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Name string
Name of table.
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.
comment String
Optional comments.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries List<MheaderEntry>
Spam filter mime header content. The structure of entries block is documented below.
fosid Changes to this property will trigger replacement. Integer
ID.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name String
Name of table.
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.
comment string
Optional comments.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries MheaderEntry[]
Spam filter mime header content. The structure of entries block is documented below.
fosid Changes to this property will trigger replacement. number
ID.
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name string
Name of table.
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.
comment str
Optional comments.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries Sequence[MheaderEntryArgs]
Spam filter mime header content. The structure of entries block is documented below.
fosid Changes to this property will trigger replacement. int
ID.
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name str
Name of table.
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.
comment String
Optional comments.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries List<Property Map>
Spam filter mime header content. The structure of entries block is documented below.
fosid Changes to this property will trigger replacement. Number
ID.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name String
Name of table.
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.

Supporting Types

MheaderEntry
, MheaderEntryArgs

Action string
Mark spam or good. Valid values: spam, clear.
Fieldbody string
Pattern for the header field body.
Fieldname string
Pattern for header field name.
Id int
Mime header entry ID.
PatternType string
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
Status string
Enable/disable status. Valid values: enable, disable.
Action string
Mark spam or good. Valid values: spam, clear.
Fieldbody string
Pattern for the header field body.
Fieldname string
Pattern for header field name.
Id int
Mime header entry ID.
PatternType string
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
Status string
Enable/disable status. Valid values: enable, disable.
action String
Mark spam or good. Valid values: spam, clear.
fieldbody String
Pattern for the header field body.
fieldname String
Pattern for header field name.
id Integer
Mime header entry ID.
patternType String
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
status String
Enable/disable status. Valid values: enable, disable.
action string
Mark spam or good. Valid values: spam, clear.
fieldbody string
Pattern for the header field body.
fieldname string
Pattern for header field name.
id number
Mime header entry ID.
patternType string
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
status string
Enable/disable status. Valid values: enable, disable.
action str
Mark spam or good. Valid values: spam, clear.
fieldbody str
Pattern for the header field body.
fieldname str
Pattern for header field name.
id int
Mime header entry ID.
pattern_type str
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
status str
Enable/disable status. Valid values: enable, disable.
action String
Mark spam or good. Valid values: spam, clear.
fieldbody String
Pattern for the header field body.
fieldname String
Pattern for header field name.
id Number
Mime header entry ID.
patternType String
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
status String
Enable/disable status. Valid values: enable, disable.

Import

Spamfilter Mheader can be imported using any of these accepted formats:

$ pulumi import fortios:filter/spam/mheader:Mheader labelname {{fosid}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:filter/spam/mheader:Mheader labelname {{fosid}}
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.
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios