1. Packages
  2. Fortios
  3. API Docs
  4. filter
  5. filter/email
  6. Dnsbl
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.filter/email.Dnsbl

Explore with Pulumi AI

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

    Configure AntiSpam DNSBL/ORBL. Applies to FortiOS Version >= 6.2.4.

    Create Dnsbl Resource

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

    Constructor syntax

    new Dnsbl(name: string, args?: DnsblArgs, opts?: CustomResourceOptions);
    @overload
    def Dnsbl(resource_name: str,
              args: Optional[DnsblArgs] = None,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Dnsbl(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              comment: Optional[str] = None,
              dynamic_sort_subtable: Optional[str] = None,
              entries: Optional[Sequence[DnsblEntryArgs]] = None,
              fosid: Optional[int] = None,
              get_all_tables: Optional[str] = None,
              name: Optional[str] = None,
              vdomparam: Optional[str] = None)
    func NewDnsbl(ctx *Context, name string, args *DnsblArgs, opts ...ResourceOption) (*Dnsbl, error)
    public Dnsbl(string name, DnsblArgs? args = null, CustomResourceOptions? opts = null)
    public Dnsbl(String name, DnsblArgs args)
    public Dnsbl(String name, DnsblArgs args, CustomResourceOptions options)
    
    type: fortios:filter/email/dnsbl:Dnsbl
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DnsblArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DnsblArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DnsblArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DnsblArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DnsblArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var dnsblResource = new Fortios.Filter.Email.Dnsbl("dnsblResource", new()
    {
        Comment = "string",
        DynamicSortSubtable = "string",
        Entries = new[]
        {
            new Fortios.Filter.Email.Inputs.DnsblEntryArgs
            {
                Action = "string",
                Id = 0,
                Server = "string",
                Status = "string",
            },
        },
        Fosid = 0,
        GetAllTables = "string",
        Name = "string",
        Vdomparam = "string",
    });
    
    example, err := filter.NewDnsbl(ctx, "dnsblResource", &filter.DnsblArgs{
    	Comment:             pulumi.String("string"),
    	DynamicSortSubtable: pulumi.String("string"),
    	Entries: email.DnsblEntryArray{
    		&email.DnsblEntryArgs{
    			Action: pulumi.String("string"),
    			Id:     pulumi.Int(0),
    			Server: pulumi.String("string"),
    			Status: pulumi.String("string"),
    		},
    	},
    	Fosid:        pulumi.Int(0),
    	GetAllTables: pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	Vdomparam:    pulumi.String("string"),
    })
    
    var dnsblResource = new Dnsbl("dnsblResource", DnsblArgs.builder()        
        .comment("string")
        .dynamicSortSubtable("string")
        .entries(DnsblEntryArgs.builder()
            .action("string")
            .id(0)
            .server("string")
            .status("string")
            .build())
        .fosid(0)
        .getAllTables("string")
        .name("string")
        .vdomparam("string")
        .build());
    
    dnsbl_resource = fortios.filter.email.Dnsbl("dnsblResource",
        comment="string",
        dynamic_sort_subtable="string",
        entries=[fortios.filter.email.DnsblEntryArgs(
            action="string",
            id=0,
            server="string",
            status="string",
        )],
        fosid=0,
        get_all_tables="string",
        name="string",
        vdomparam="string")
    
    const dnsblResource = new fortios.filter.email.Dnsbl("dnsblResource", {
        comment: "string",
        dynamicSortSubtable: "string",
        entries: [{
            action: "string",
            id: 0,
            server: "string",
            status: "string",
        }],
        fosid: 0,
        getAllTables: "string",
        name: "string",
        vdomparam: "string",
    });
    
    Coming soon!
    

    Dnsbl Resource Properties

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

    Inputs

    The Dnsbl 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.DnsblEntry>
    Spam filter DNSBL and ORBL server. The structure of entries block is documented below.
    Fosid 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, otherwish 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 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 []DnsblEntryArgs
    Spam filter DNSBL and ORBL server. The structure of entries block is documented below.
    Fosid 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, otherwish 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 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<DnsblEntry>
    Spam filter DNSBL and ORBL server. The structure of entries block is documented below.
    fosid 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, otherwish 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 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 DnsblEntry[]
    Spam filter DNSBL and ORBL server. The structure of entries block is documented below.
    fosid 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, otherwish 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 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[DnsblEntryArgs]
    Spam filter DNSBL and ORBL server. The structure of entries block is documented below.
    fosid 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, otherwish 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 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 DNSBL and ORBL server. The structure of entries block is documented below.
    fosid 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, otherwish 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 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 Dnsbl 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 Dnsbl Resource

    Get an existing Dnsbl 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?: DnsblState, opts?: CustomResourceOptions): Dnsbl
    @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[DnsblEntryArgs]] = None,
            fosid: Optional[int] = None,
            get_all_tables: Optional[str] = None,
            name: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Dnsbl
    func GetDnsbl(ctx *Context, name string, id IDInput, state *DnsblState, opts ...ResourceOption) (*Dnsbl, error)
    public static Dnsbl Get(string name, Input<string> id, DnsblState? state, CustomResourceOptions? opts = null)
    public static Dnsbl get(String name, Output<String> id, DnsblState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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.DnsblEntry>
    Spam filter DNSBL and ORBL server. The structure of entries block is documented below.
    Fosid 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, otherwish 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 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 []DnsblEntryArgs
    Spam filter DNSBL and ORBL server. The structure of entries block is documented below.
    Fosid 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, otherwish 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 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<DnsblEntry>
    Spam filter DNSBL and ORBL server. The structure of entries block is documented below.
    fosid 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, otherwish 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 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 DnsblEntry[]
    Spam filter DNSBL and ORBL server. The structure of entries block is documented below.
    fosid 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, otherwish 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 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[DnsblEntryArgs]
    Spam filter DNSBL and ORBL server. The structure of entries block is documented below.
    fosid 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, otherwish 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 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 DNSBL and ORBL server. The structure of entries block is documented below.
    fosid 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, otherwish 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 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

    DnsblEntry, DnsblEntryArgs

    Action string
    Reject connection or mark as spam email. Valid values: reject, spam.
    Id int
    DNSBL/ORBL entry ID.
    Server string
    DNSBL or ORBL server name.
    Status string
    Enable/disable status. Valid values: enable, disable.
    Action string
    Reject connection or mark as spam email. Valid values: reject, spam.
    Id int
    DNSBL/ORBL entry ID.
    Server string
    DNSBL or ORBL server name.
    Status string
    Enable/disable status. Valid values: enable, disable.
    action String
    Reject connection or mark as spam email. Valid values: reject, spam.
    id Integer
    DNSBL/ORBL entry ID.
    server String
    DNSBL or ORBL server name.
    status String
    Enable/disable status. Valid values: enable, disable.
    action string
    Reject connection or mark as spam email. Valid values: reject, spam.
    id number
    DNSBL/ORBL entry ID.
    server string
    DNSBL or ORBL server name.
    status string
    Enable/disable status. Valid values: enable, disable.
    action str
    Reject connection or mark as spam email. Valid values: reject, spam.
    id int
    DNSBL/ORBL entry ID.
    server str
    DNSBL or ORBL server name.
    status str
    Enable/disable status. Valid values: enable, disable.
    action String
    Reject connection or mark as spam email. Valid values: reject, spam.
    id Number
    DNSBL/ORBL entry ID.
    server String
    DNSBL or ORBL server name.
    status String
    Enable/disable status. Valid values: enable, disable.

    Import

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

    $ pulumi import fortios:filter/email/dnsbl:Dnsbl labelname {{fosid}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:filter/email/dnsbl:Dnsbl labelname {{fosid}}
    

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse