Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. router
  5. Extcommunitylist
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.router.Extcommunitylist

Explore with Pulumi AI

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

    Configure extended community lists. Applies to FortiOS Version >= 7.2.4.

    Create Extcommunitylist Resource

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

    Constructor syntax

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

@overload
def Extcommunitylist(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     dynamic_sort_subtable: Optional[str] = None,
                     get_all_tables: Optional[str] = None,
                     name: Optional[str] = None,
                     rules: Optional[Sequence[ExtcommunitylistRuleArgs]] = None,
                     type: Optional[str] = None,
                     vdomparam: Optional[str] = None)
    func NewExtcommunitylist(ctx *Context, name string, args *ExtcommunitylistArgs, opts ...ResourceOption) (*Extcommunitylist, error)
    public Extcommunitylist(string name, ExtcommunitylistArgs? args = null, CustomResourceOptions? opts = null)
    public Extcommunitylist(String name, ExtcommunitylistArgs args)
public Extcommunitylist(String name, ExtcommunitylistArgs args, CustomResourceOptions options)

    type: fortios:router:Extcommunitylist
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 ExtcommunitylistArgs
    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 ExtcommunitylistArgs
    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 ExtcommunitylistArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExtcommunitylistArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExtcommunitylistArgs
    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 extcommunitylistResource = new Fortios.Router.Extcommunitylist("extcommunitylistResource", new()
{
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    Name = "string",
    Rules = new[]
    {
        new Fortios.Router.Inputs.ExtcommunitylistRuleArgs
        {
            Action = "string",
            Id = 0,
            Match = "string",
            Regexp = "string",
            Type = "string",
        },
    },
    Type = "string",
    Vdomparam = "string",
});

    example, err := router.NewExtcommunitylist(ctx, "extcommunitylistResource", &router.ExtcommunitylistArgs{
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Name:                pulumi.String("string"),
	Rules: router.ExtcommunitylistRuleArray{
		&router.ExtcommunitylistRuleArgs{
			Action: pulumi.String("string"),
			Id:     pulumi.Int(0),
			Match:  pulumi.String("string"),
			Regexp: pulumi.String("string"),
			Type:   pulumi.String("string"),
		},
	},
	Type:      pulumi.String("string"),
	Vdomparam: pulumi.String("string"),
})

    var extcommunitylistResource = new Extcommunitylist("extcommunitylistResource", ExtcommunitylistArgs.builder()
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .name("string")
    .rules(ExtcommunitylistRuleArgs.builder()
        .action("string")
        .id(0)
        .match("string")
        .regexp("string")
        .type("string")
        .build())
    .type("string")
    .vdomparam("string")
    .build());

    extcommunitylist_resource = fortios.router.Extcommunitylist("extcommunitylistResource",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    name="string",
    rules=[fortios.router.ExtcommunitylistRuleArgs(
        action="string",
        id=0,
        match="string",
        regexp="string",
        type="string",
    )],
    type="string",
    vdomparam="string")

    const extcommunitylistResource = new fortios.router.Extcommunitylist("extcommunitylistResource", {
    dynamicSortSubtable: "string",
    getAllTables: "string",
    name: "string",
    rules: [{
        action: "string",
        id: 0,
        match: "string",
        regexp: "string",
        type: "string",
    }],
    type: "string",
    vdomparam: "string",
});

    type: fortios:router:Extcommunitylist
properties:
    dynamicSortSubtable: string
    getAllTables: string
    name: string
    rules:
        - action: string
          id: 0
          match: string
          regexp: string
          type: string
    type: string
    vdomparam: string

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

    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, 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
    Extended community list name.
    Rules List<Pulumiverse.Fortios.Router.Inputs.ExtcommunitylistRule>
    Extended community list rule. The structure of rule block is documented below.
    Type string
    Extended community list type (standard or expanded). Valid values: standard, expanded.
    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.
    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, 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
    Extended community list name.
    Rules []ExtcommunitylistRuleArgs
    Extended community list rule. The structure of rule block is documented below.
    Type string
    Extended community list type (standard or expanded). Valid values: standard, expanded.
    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.
    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, 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
    Extended community list name.
    rules List<ExtcommunitylistRule>
    Extended community list rule. The structure of rule block is documented below.
    type String
    Extended community list type (standard or expanded). Valid values: standard, expanded.
    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.
    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, 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
    Extended community list name.
    rules ExtcommunitylistRule[]
    Extended community list rule. The structure of rule block is documented below.
    type string
    Extended community list type (standard or expanded). Valid values: standard, expanded.
    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.
    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, 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
    Extended community list name.
    rules Sequence[ExtcommunitylistRuleArgs]
    Extended community list rule. The structure of rule block is documented below.
    type str
    Extended community list type (standard or expanded). Valid values: standard, expanded.
    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.
    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, 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
    Extended community list name.
    rules List<Property Map>
    Extended community list rule. The structure of rule block is documented below.
    type String
    Extended community list type (standard or expanded). Valid values: standard, expanded.
    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 Extcommunitylist 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 Extcommunitylist Resource

    Get an existing Extcommunitylist 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?: ExtcommunitylistState, opts?: CustomResourceOptions): Extcommunitylist
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        rules: Optional[Sequence[ExtcommunitylistRuleArgs]] = None,
        type: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Extcommunitylist
    func GetExtcommunitylist(ctx *Context, name string, id IDInput, state *ExtcommunitylistState, opts ...ResourceOption) (*Extcommunitylist, error)
    public static Extcommunitylist Get(string name, Input<string> id, ExtcommunitylistState? state, CustomResourceOptions? opts = null)
    public static Extcommunitylist get(String name, Output<String> id, ExtcommunitylistState 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:
    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, 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
    Extended community list name.
    Rules List<Pulumiverse.Fortios.Router.Inputs.ExtcommunitylistRule>
    Extended community list rule. The structure of rule block is documented below.
    Type string
    Extended community list type (standard or expanded). Valid values: standard, expanded.
    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.
    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, 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
    Extended community list name.
    Rules []ExtcommunitylistRuleArgs
    Extended community list rule. The structure of rule block is documented below.
    Type string
    Extended community list type (standard or expanded). Valid values: standard, expanded.
    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.
    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, 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
    Extended community list name.
    rules List<ExtcommunitylistRule>
    Extended community list rule. The structure of rule block is documented below.
    type String
    Extended community list type (standard or expanded). Valid values: standard, expanded.
    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.
    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, 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
    Extended community list name.
    rules ExtcommunitylistRule[]
    Extended community list rule. The structure of rule block is documented below.
    type string
    Extended community list type (standard or expanded). Valid values: standard, expanded.
    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.
    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, 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
    Extended community list name.
    rules Sequence[ExtcommunitylistRuleArgs]
    Extended community list rule. The structure of rule block is documented below.
    type str
    Extended community list type (standard or expanded). Valid values: standard, expanded.
    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.
    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, 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
    Extended community list name.
    rules List<Property Map>
    Extended community list rule. The structure of rule block is documented below.
    type String
    Extended community list type (standard or expanded). Valid values: standard, expanded.
    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

    ExtcommunitylistRule, ExtcommunitylistRuleArgs

    Action string
    Permit or deny route-based operations, based on the route's EXTENDED COMMUNITY attribute. Valid values: deny, permit.
    Id int
    ID.
    Match string
    Extended community specifications for matching a reserved extended community.
    Regexp string
    Ordered list of EXTENDED COMMUNITY attributes as a regular expression.
    Type string
    Type of extended community. Valid values: rt, soo.
    Action string
    Permit or deny route-based operations, based on the route's EXTENDED COMMUNITY attribute. Valid values: deny, permit.
    Id int
    ID.
    Match string
    Extended community specifications for matching a reserved extended community.
    Regexp string
    Ordered list of EXTENDED COMMUNITY attributes as a regular expression.
    Type string
    Type of extended community. Valid values: rt, soo.
    action String
    Permit or deny route-based operations, based on the route's EXTENDED COMMUNITY attribute. Valid values: deny, permit.
    id Integer
    ID.
    match String
    Extended community specifications for matching a reserved extended community.
    regexp String
    Ordered list of EXTENDED COMMUNITY attributes as a regular expression.
    type String
    Type of extended community. Valid values: rt, soo.
    action string
    Permit or deny route-based operations, based on the route's EXTENDED COMMUNITY attribute. Valid values: deny, permit.
    id number
    ID.
    match string
    Extended community specifications for matching a reserved extended community.
    regexp string
    Ordered list of EXTENDED COMMUNITY attributes as a regular expression.
    type string
    Type of extended community. Valid values: rt, soo.
    action str
    Permit or deny route-based operations, based on the route's EXTENDED COMMUNITY attribute. Valid values: deny, permit.
    id int
    ID.
    match str
    Extended community specifications for matching a reserved extended community.
    regexp str
    Ordered list of EXTENDED COMMUNITY attributes as a regular expression.
    type str
    Type of extended community. Valid values: rt, soo.
    action String
    Permit or deny route-based operations, based on the route's EXTENDED COMMUNITY attribute. Valid values: deny, permit.
    id Number
    ID.
    match String
    Extended community specifications for matching a reserved extended community.
    regexp String
    Ordered list of EXTENDED COMMUNITY attributes as a regular expression.
    type String
    Type of extended community. Valid values: rt, soo.

    Import

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

    $ pulumi import fortios:router/extcommunitylist:Extcommunitylist labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:router/extcommunitylist:Extcommunitylist 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.5 published on Tuesday, Apr 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios