fortios.router.Communitylist
Explore with Pulumi AI
Configure community lists.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";
const trname = new fortios.router.Communitylist("trname", {
rules: [{
action: "deny",
match: "123:234 345:456",
regexp: "123:234 345:456",
}],
type: "standard",
});
import pulumi
import pulumiverse_fortios as fortios
trname = fortios.router.Communitylist("trname",
rules=[fortios.router.CommunitylistRuleArgs(
action="deny",
match="123:234 345:456",
regexp="123:234 345:456",
)],
type="standard")
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.NewCommunitylist(ctx, "trname", &router.CommunitylistArgs{
Rules: router.CommunitylistRuleArray{
&router.CommunitylistRuleArgs{
Action: pulumi.String("deny"),
Match: pulumi.String("123:234 345:456"),
Regexp: pulumi.String("123:234 345:456"),
},
},
Type: pulumi.String("standard"),
})
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.Communitylist("trname", new()
{
Rules = new[]
{
new Fortios.Router.Inputs.CommunitylistRuleArgs
{
Action = "deny",
Match = "123:234 345:456",
Regexp = "123:234 345:456",
},
},
Type = "standard",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.router.Communitylist;
import com.pulumi.fortios.router.CommunitylistArgs;
import com.pulumi.fortios.router.inputs.CommunitylistRuleArgs;
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 Communitylist("trname", CommunitylistArgs.builder()
.rules(CommunitylistRuleArgs.builder()
.action("deny")
.match("123:234 345:456")
.regexp("123:234 345:456")
.build())
.type("standard")
.build());
}
}
resources:
trname:
type: fortios:router:Communitylist
properties:
rules:
- action: deny
match: 123:234 345:456
regexp: 123:234 345:456
type: standard
Create Communitylist Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Communitylist(name: string, args: CommunitylistArgs, opts?: CustomResourceOptions);
@overload
def Communitylist(resource_name: str,
args: CommunitylistArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Communitylist(resource_name: str,
opts: Optional[ResourceOptions] = None,
type: Optional[str] = None,
dynamic_sort_subtable: Optional[str] = None,
get_all_tables: Optional[str] = None,
name: Optional[str] = None,
rules: Optional[Sequence[CommunitylistRuleArgs]] = None,
vdomparam: Optional[str] = None)
func NewCommunitylist(ctx *Context, name string, args CommunitylistArgs, opts ...ResourceOption) (*Communitylist, error)
public Communitylist(string name, CommunitylistArgs args, CustomResourceOptions? opts = null)
public Communitylist(String name, CommunitylistArgs args)
public Communitylist(String name, CommunitylistArgs args, CustomResourceOptions options)
type: fortios:router:Communitylist
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 CommunitylistArgs
- 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 CommunitylistArgs
- 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 CommunitylistArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CommunitylistArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CommunitylistArgs
- 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 communitylistResource = new Fortios.Router.Communitylist("communitylistResource", new()
{
Type = "string",
DynamicSortSubtable = "string",
GetAllTables = "string",
Name = "string",
Rules = new[]
{
new Fortios.Router.Inputs.CommunitylistRuleArgs
{
Action = "string",
Id = 0,
Match = "string",
Regexp = "string",
},
},
Vdomparam = "string",
});
example, err := router.NewCommunitylist(ctx, "communitylistResource", &router.CommunitylistArgs{
Type: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
GetAllTables: pulumi.String("string"),
Name: pulumi.String("string"),
Rules: router.CommunitylistRuleArray{
&router.CommunitylistRuleArgs{
Action: pulumi.String("string"),
Id: pulumi.Int(0),
Match: pulumi.String("string"),
Regexp: pulumi.String("string"),
},
},
Vdomparam: pulumi.String("string"),
})
var communitylistResource = new Communitylist("communitylistResource", CommunitylistArgs.builder()
.type("string")
.dynamicSortSubtable("string")
.getAllTables("string")
.name("string")
.rules(CommunitylistRuleArgs.builder()
.action("string")
.id(0)
.match("string")
.regexp("string")
.build())
.vdomparam("string")
.build());
communitylist_resource = fortios.router.Communitylist("communitylistResource",
type="string",
dynamic_sort_subtable="string",
get_all_tables="string",
name="string",
rules=[{
"action": "string",
"id": 0,
"match": "string",
"regexp": "string",
}],
vdomparam="string")
const communitylistResource = new fortios.router.Communitylist("communitylistResource", {
type: "string",
dynamicSortSubtable: "string",
getAllTables: "string",
name: "string",
rules: [{
action: "string",
id: 0,
match: "string",
regexp: "string",
}],
vdomparam: "string",
});
type: fortios:router:Communitylist
properties:
dynamicSortSubtable: string
getAllTables: string
name: string
rules:
- action: string
id: 0
match: string
regexp: string
type: string
vdomparam: string
Communitylist 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 Communitylist resource accepts the following input properties:
- Type string
- Community list type (standard or expanded). Valid values:
standard
,expanded
. - Dynamic
Sort stringSubtable - 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 stringTables - 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
- Community list name.
- Rules
List<Pulumiverse.
Fortios. Router. Inputs. Communitylist Rule> - Community 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.
- Type string
- Community list type (standard or expanded). Valid values:
standard
,expanded
. - Dynamic
Sort stringSubtable - 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 stringTables - 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
- Community list name.
- Rules
[]Communitylist
Rule Args - Community 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.
- type String
- Community list type (standard or expanded). Valid values:
standard
,expanded
. - dynamic
Sort StringSubtable - 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 StringTables - 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
- Community list name.
- rules
List<Communitylist
Rule> - Community 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.
- type string
- Community list type (standard or expanded). Valid values:
standard
,expanded
. - dynamic
Sort stringSubtable - 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 stringTables - 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
- Community list name.
- rules
Communitylist
Rule[] - Community 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.
- type str
- Community list type (standard or expanded). Valid values:
standard
,expanded
. - dynamic_
sort_ strsubtable - 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_ strtables - 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
- Community list name.
- rules
Sequence[Communitylist
Rule Args] - Community 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.
- type String
- Community list type (standard or expanded). Valid values:
standard
,expanded
. - dynamic
Sort StringSubtable - 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 StringTables - 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
- Community list name.
- rules List<Property Map>
- Community 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 Communitylist 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 Communitylist Resource
Get an existing Communitylist 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?: CommunitylistState, opts?: CustomResourceOptions): Communitylist
@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[CommunitylistRuleArgs]] = None,
type: Optional[str] = None,
vdomparam: Optional[str] = None) -> Communitylist
func GetCommunitylist(ctx *Context, name string, id IDInput, state *CommunitylistState, opts ...ResourceOption) (*Communitylist, error)
public static Communitylist Get(string name, Input<string> id, CommunitylistState? state, CustomResourceOptions? opts = null)
public static Communitylist get(String name, Output<String> id, CommunitylistState 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.
- Dynamic
Sort stringSubtable - 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 stringTables - 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
- Community list name.
- Rules
List<Pulumiverse.
Fortios. Router. Inputs. Communitylist Rule> - Community list rule. The structure of
rule
block is documented below. - Type string
- 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 stringSubtable - 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 stringTables - 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
- Community list name.
- Rules
[]Communitylist
Rule Args - Community list rule. The structure of
rule
block is documented below. - Type string
- 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 StringSubtable - 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 StringTables - 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
- Community list name.
- rules
List<Communitylist
Rule> - Community list rule. The structure of
rule
block is documented below. - type String
- 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 stringSubtable - 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 stringTables - 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
- Community list name.
- rules
Communitylist
Rule[] - Community list rule. The structure of
rule
block is documented below. - type string
- 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_ strsubtable - 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_ strtables - 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
- Community list name.
- rules
Sequence[Communitylist
Rule Args] - Community list rule. The structure of
rule
block is documented below. - type str
- 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.
- dynamic
Sort StringSubtable - 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 StringTables - 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
- Community list name.
- rules List<Property Map>
- Community list rule. The structure of
rule
block is documented below. - type String
- 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
CommunitylistRule, CommunitylistRuleArgs
Import
Router CommunityList can be imported using any of these accepted formats:
$ pulumi import fortios:router/communitylist:Communitylist labelname {{name}}
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:router/communitylist:Communitylist 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.