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

fortios.router.Prefixlist

Explore with Pulumi AI

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

    Configure IPv4 prefix lists.

    Example Usage

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

const trname = new fortios.router.Prefixlist("trname", {});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.router.Prefixlist("trname")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := router.NewPrefixlist(ctx, "trname", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.Router.Prefixlist("trname");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.router.Prefixlist;
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 Prefixlist("trname");

    }
}

    resources:
  trname:
    type: fortios:router:Prefixlist

    Create Prefixlist Resource

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

    Constructor syntax

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

@overload
def Prefixlist(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               comments: Optional[str] = None,
               dynamic_sort_subtable: Optional[str] = None,
               get_all_tables: Optional[str] = None,
               name: Optional[str] = None,
               rules: Optional[Sequence[PrefixlistRuleArgs]] = None,
               vdomparam: Optional[str] = None)
    func NewPrefixlist(ctx *Context, name string, args *PrefixlistArgs, opts ...ResourceOption) (*Prefixlist, error)
    public Prefixlist(string name, PrefixlistArgs? args = null, CustomResourceOptions? opts = null)
    public Prefixlist(String name, PrefixlistArgs args)
public Prefixlist(String name, PrefixlistArgs args, CustomResourceOptions options)

    type: fortios:router:Prefixlist
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 PrefixlistArgs
    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 PrefixlistArgs
    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 PrefixlistArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrefixlistArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrefixlistArgs
    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 prefixlistResource = new Fortios.Router.Prefixlist("prefixlistResource", new()
{
    Comments = "string",
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    Name = "string",
    Rules = new[]
    {
        new Fortios.Router.Inputs.PrefixlistRuleArgs
        {
            Action = "string",
            Flags = 0,
            Ge = 0,
            Id = 0,
            Le = 0,
            Prefix = "string",
        },
    },
    Vdomparam = "string",
});

    example, err := router.NewPrefixlist(ctx, "prefixlistResource", &router.PrefixlistArgs{
	Comments:            pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Name:                pulumi.String("string"),
	Rules: router.PrefixlistRuleArray{
		&router.PrefixlistRuleArgs{
			Action: pulumi.String("string"),
			Flags:  pulumi.Int(0),
			Ge:     pulumi.Int(0),
			Id:     pulumi.Int(0),
			Le:     pulumi.Int(0),
			Prefix: pulumi.String("string"),
		},
	},
	Vdomparam: pulumi.String("string"),
})

    var prefixlistResource = new Prefixlist("prefixlistResource", PrefixlistArgs.builder()
    .comments("string")
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .name("string")
    .rules(PrefixlistRuleArgs.builder()
        .action("string")
        .flags(0)
        .ge(0)
        .id(0)
        .le(0)
        .prefix("string")
        .build())
    .vdomparam("string")
    .build());

    prefixlist_resource = fortios.router.Prefixlist("prefixlistResource",
    comments="string",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    name="string",
    rules=[{
        "action": "string",
        "flags": 0,
        "ge": 0,
        "id": 0,
        "le": 0,
        "prefix": "string",
    }],
    vdomparam="string")

    const prefixlistResource = new fortios.router.Prefixlist("prefixlistResource", {
    comments: "string",
    dynamicSortSubtable: "string",
    getAllTables: "string",
    name: "string",
    rules: [{
        action: "string",
        flags: 0,
        ge: 0,
        id: 0,
        le: 0,
        prefix: "string",
    }],
    vdomparam: "string",
});

    type: fortios:router:Prefixlist
properties:
    comments: string
    dynamicSortSubtable: string
    getAllTables: string
    name: string
    rules:
        - action: string
          flags: 0
          ge: 0
          id: 0
          le: 0
          prefix: string
    vdomparam: string

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

    Comments string
    Comment.
    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 ].
    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.
    Rules List<Pulumiverse.Fortios.Router.Inputs.PrefixlistRule>
    IPv4 prefix list rule. The structure of rule block is documented below.
    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.
    Comments string
    Comment.
    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 ].
    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.
    Rules []PrefixlistRuleArgs
    IPv4 prefix list rule. The structure of rule block is documented below.
    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.
    comments String
    Comment.
    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 ].
    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.
    rules List<PrefixlistRule>
    IPv4 prefix list rule. The structure of rule block is documented below.
    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.
    comments string
    Comment.
    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 ].
    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.
    rules PrefixlistRule[]
    IPv4 prefix list rule. The structure of rule block is documented below.
    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.
    comments str
    Comment.
    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 ].
    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.
    rules Sequence[PrefixlistRuleArgs]
    IPv4 prefix list rule. The structure of rule block is documented below.
    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.
    comments String
    Comment.
    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 ].
    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.
    rules List<Property Map>
    IPv4 prefix list rule. The structure of rule block is documented below.
    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 Prefixlist 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 Prefixlist Resource

    Get an existing Prefixlist 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?: PrefixlistState, opts?: CustomResourceOptions): Prefixlist
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comments: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        rules: Optional[Sequence[PrefixlistRuleArgs]] = None,
        vdomparam: Optional[str] = None) -> Prefixlist
    func GetPrefixlist(ctx *Context, name string, id IDInput, state *PrefixlistState, opts ...ResourceOption) (*Prefixlist, error)
    public static Prefixlist Get(string name, Input<string> id, PrefixlistState? state, CustomResourceOptions? opts = null)
    public static Prefixlist get(String name, Output<String> id, PrefixlistState 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:
    Comments string
    Comment.
    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 ].
    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.
    Rules List<Pulumiverse.Fortios.Router.Inputs.PrefixlistRule>
    IPv4 prefix list rule. The structure of rule block is documented below.
    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.
    Comments string
    Comment.
    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 ].
    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.
    Rules []PrefixlistRuleArgs
    IPv4 prefix list rule. The structure of rule block is documented below.
    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.
    comments String
    Comment.
    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 ].
    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.
    rules List<PrefixlistRule>
    IPv4 prefix list rule. The structure of rule block is documented below.
    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.
    comments string
    Comment.
    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 ].
    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.
    rules PrefixlistRule[]
    IPv4 prefix list rule. The structure of rule block is documented below.
    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.
    comments str
    Comment.
    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 ].
    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.
    rules Sequence[PrefixlistRuleArgs]
    IPv4 prefix list rule. The structure of rule block is documented below.
    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.
    comments String
    Comment.
    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 ].
    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.
    rules List<Property Map>
    IPv4 prefix list rule. The structure of rule block is documented below.
    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

    PrefixlistRule, PrefixlistRuleArgs

    Action string
    Permit or deny this IP address and netmask prefix. Valid values: permit, deny.
    Flags int
    Flags.
    Ge int
    Minimum prefix length to be matched (0 - 32).
    Id int
    Rule ID.
    Le int
    Maximum prefix length to be matched (0 - 32).
    Prefix string
    IPv4 prefix to define regular filter criteria, such as "any" or subnets.
    Action string
    Permit or deny this IP address and netmask prefix. Valid values: permit, deny.
    Flags int
    Flags.
    Ge int
    Minimum prefix length to be matched (0 - 32).
    Id int
    Rule ID.
    Le int
    Maximum prefix length to be matched (0 - 32).
    Prefix string
    IPv4 prefix to define regular filter criteria, such as "any" or subnets.
    action String
    Permit or deny this IP address and netmask prefix. Valid values: permit, deny.
    flags Integer
    Flags.
    ge Integer
    Minimum prefix length to be matched (0 - 32).
    id Integer
    Rule ID.
    le Integer
    Maximum prefix length to be matched (0 - 32).
    prefix String
    IPv4 prefix to define regular filter criteria, such as "any" or subnets.
    action string
    Permit or deny this IP address and netmask prefix. Valid values: permit, deny.
    flags number
    Flags.
    ge number
    Minimum prefix length to be matched (0 - 32).
    id number
    Rule ID.
    le number
    Maximum prefix length to be matched (0 - 32).
    prefix string
    IPv4 prefix to define regular filter criteria, such as "any" or subnets.
    action str
    Permit or deny this IP address and netmask prefix. Valid values: permit, deny.
    flags int
    Flags.
    ge int
    Minimum prefix length to be matched (0 - 32).
    id int
    Rule ID.
    le int
    Maximum prefix length to be matched (0 - 32).
    prefix str
    IPv4 prefix to define regular filter criteria, such as "any" or subnets.
    action String
    Permit or deny this IP address and netmask prefix. Valid values: permit, deny.
    flags Number
    Flags.
    ge Number
    Minimum prefix length to be matched (0 - 32).
    id Number
    Rule ID.
    le Number
    Maximum prefix length to be matched (0 - 32).
    prefix String
    IPv4 prefix to define regular filter criteria, such as "any" or subnets.

    Import

    Router PrefixList can be imported using any of these accepted formats:

    $ pulumi import fortios:router/prefixlist:Prefixlist labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:router/prefixlist:Prefixlist labelname {{name}}

    $ 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.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios