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

fortios.filter/email.Bwl

Explore with Pulumi AI

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

Configure anti-spam black/white list. Applies to FortiOS Version 6.2.4,6.2.6,6.4.0,6.4.1,6.4.2,6.4.10,6.4.11,6.4.12,6.4.13,6.4.14,6.4.15.

Create Bwl Resource

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

Constructor syntax

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

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

type: fortios:filter/email/bwl:Bwl
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 BwlArgs
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 BwlArgs
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 BwlArgs
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 BwlArgs
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. BwlArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

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.Email.Inputs.BwlEntry>
Anti-spam black/white list entries. 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 []BwlEntryArgs
Anti-spam black/white list entries. 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<BwlEntry>
Anti-spam black/white list entries. 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 BwlEntry[]
Anti-spam black/white list entries. 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[BwlEntryArgs]
Anti-spam black/white list entries. 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>
Anti-spam black/white list entries. 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.

Outputs

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

Get an existing Bwl 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?: BwlState, opts?: CustomResourceOptions): Bwl
@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[BwlEntryArgs]] = None,
        fosid: Optional[int] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Bwl
func GetBwl(ctx *Context, name string, id IDInput, state *BwlState, opts ...ResourceOption) (*Bwl, error)
public static Bwl Get(string name, Input<string> id, BwlState? state, CustomResourceOptions? opts = null)
public static Bwl get(String name, Output<String> id, BwlState state, CustomResourceOptions options)
resources:  _:    type: fortios:filter/email/bwl:Bwl    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.Email.Inputs.BwlEntry>
Anti-spam black/white list entries. 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 []BwlEntryArgs
Anti-spam black/white list entries. 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<BwlEntry>
Anti-spam black/white list entries. 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 BwlEntry[]
Anti-spam black/white list entries. 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[BwlEntryArgs]
Anti-spam black/white list entries. 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>
Anti-spam black/white list entries. 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

BwlEntry
, BwlEntryArgs

Action string
Reject, mark as spam or good email. Valid values: reject, spam, clear.
AddrType string
IP address type. Valid values: ipv4, ipv6.
EmailPattern string
Email address pattern.
Id int
Entry ID.
Ip4Subnet string
IPv4 network address/subnet mask bits.
Ip6Subnet string
IPv6 network address/subnet mask bits.
PatternType string
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
Status string
Enable/disable status. Valid values: enable, disable.
Type string
Entry type. Valid values: ip, email.
Action string
Reject, mark as spam or good email. Valid values: reject, spam, clear.
AddrType string
IP address type. Valid values: ipv4, ipv6.
EmailPattern string
Email address pattern.
Id int
Entry ID.
Ip4Subnet string
IPv4 network address/subnet mask bits.
Ip6Subnet string
IPv6 network address/subnet mask bits.
PatternType string
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
Status string
Enable/disable status. Valid values: enable, disable.
Type string
Entry type. Valid values: ip, email.
action String
Reject, mark as spam or good email. Valid values: reject, spam, clear.
addrType String
IP address type. Valid values: ipv4, ipv6.
emailPattern String
Email address pattern.
id Integer
Entry ID.
ip4Subnet String
IPv4 network address/subnet mask bits.
ip6Subnet String
IPv6 network address/subnet mask bits.
patternType String
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
status String
Enable/disable status. Valid values: enable, disable.
type String
Entry type. Valid values: ip, email.
action string
Reject, mark as spam or good email. Valid values: reject, spam, clear.
addrType string
IP address type. Valid values: ipv4, ipv6.
emailPattern string
Email address pattern.
id number
Entry ID.
ip4Subnet string
IPv4 network address/subnet mask bits.
ip6Subnet string
IPv6 network address/subnet mask bits.
patternType string
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
status string
Enable/disable status. Valid values: enable, disable.
type string
Entry type. Valid values: ip, email.
action str
Reject, mark as spam or good email. Valid values: reject, spam, clear.
addr_type str
IP address type. Valid values: ipv4, ipv6.
email_pattern str
Email address pattern.
id int
Entry ID.
ip4_subnet str
IPv4 network address/subnet mask bits.
ip6_subnet str
IPv6 network address/subnet mask bits.
pattern_type str
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
status str
Enable/disable status. Valid values: enable, disable.
type str
Entry type. Valid values: ip, email.
action String
Reject, mark as spam or good email. Valid values: reject, spam, clear.
addrType String
IP address type. Valid values: ipv4, ipv6.
emailPattern String
Email address pattern.
id Number
Entry ID.
ip4Subnet String
IPv4 network address/subnet mask bits.
ip6Subnet String
IPv6 network address/subnet mask bits.
patternType String
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
status String
Enable/disable status. Valid values: enable, disable.
type String
Entry type. Valid values: ip, email.

Import

Emailfilter Bwl can be imported using any of these accepted formats:

$ pulumi import fortios:filter/email/bwl:Bwl labelname {{fosid}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:filter/email/bwl:Bwl 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