1. Packages
  2. Fortios
  3. API Docs
  4. switchcontroller
  5. Vlanpolicy
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.switchcontroller.Vlanpolicy

Explore with Pulumi AI

Configure VLAN policy to be applied on the managed FortiSwitch ports through port-policy. Applies to FortiOS Version >= 6.4.0.

Create Vlanpolicy Resource

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

Constructor syntax

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

@overload
def Vlanpolicy(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               allowed_vlans: Optional[Sequence[VlanpolicyAllowedVlanArgs]] = None,
               allowed_vlans_all: Optional[str] = None,
               description: Optional[str] = None,
               discard_mode: Optional[str] = None,
               dynamic_sort_subtable: Optional[str] = None,
               fortilink: Optional[str] = None,
               get_all_tables: Optional[str] = None,
               name: Optional[str] = None,
               untagged_vlans: Optional[Sequence[VlanpolicyUntaggedVlanArgs]] = None,
               vdomparam: Optional[str] = None,
               vlan: Optional[str] = None)
func NewVlanpolicy(ctx *Context, name string, args *VlanpolicyArgs, opts ...ResourceOption) (*Vlanpolicy, error)
public Vlanpolicy(string name, VlanpolicyArgs? args = null, CustomResourceOptions? opts = null)
public Vlanpolicy(String name, VlanpolicyArgs args)
public Vlanpolicy(String name, VlanpolicyArgs args, CustomResourceOptions options)
type: fortios:switchcontroller:Vlanpolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args VlanpolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args VlanpolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args VlanpolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args VlanpolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VlanpolicyArgs
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 vlanpolicyResource = new Fortios.Switchcontroller.Vlanpolicy("vlanpolicyResource", new()
{
    AllowedVlans = new[]
    {
        new Fortios.Switchcontroller.Inputs.VlanpolicyAllowedVlanArgs
        {
            VlanName = "string",
        },
    },
    AllowedVlansAll = "string",
    Description = "string",
    DiscardMode = "string",
    DynamicSortSubtable = "string",
    Fortilink = "string",
    GetAllTables = "string",
    Name = "string",
    UntaggedVlans = new[]
    {
        new Fortios.Switchcontroller.Inputs.VlanpolicyUntaggedVlanArgs
        {
            VlanName = "string",
        },
    },
    Vdomparam = "string",
    Vlan = "string",
});
Copy
example, err := switchcontroller.NewVlanpolicy(ctx, "vlanpolicyResource", &switchcontroller.VlanpolicyArgs{
	AllowedVlans: switchcontroller.VlanpolicyAllowedVlanArray{
		&switchcontroller.VlanpolicyAllowedVlanArgs{
			VlanName: pulumi.String("string"),
		},
	},
	AllowedVlansAll:     pulumi.String("string"),
	Description:         pulumi.String("string"),
	DiscardMode:         pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	Fortilink:           pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Name:                pulumi.String("string"),
	UntaggedVlans: switchcontroller.VlanpolicyUntaggedVlanArray{
		&switchcontroller.VlanpolicyUntaggedVlanArgs{
			VlanName: pulumi.String("string"),
		},
	},
	Vdomparam: pulumi.String("string"),
	Vlan:      pulumi.String("string"),
})
Copy
var vlanpolicyResource = new Vlanpolicy("vlanpolicyResource", VlanpolicyArgs.builder()
    .allowedVlans(VlanpolicyAllowedVlanArgs.builder()
        .vlanName("string")
        .build())
    .allowedVlansAll("string")
    .description("string")
    .discardMode("string")
    .dynamicSortSubtable("string")
    .fortilink("string")
    .getAllTables("string")
    .name("string")
    .untaggedVlans(VlanpolicyUntaggedVlanArgs.builder()
        .vlanName("string")
        .build())
    .vdomparam("string")
    .vlan("string")
    .build());
Copy
vlanpolicy_resource = fortios.switchcontroller.Vlanpolicy("vlanpolicyResource",
    allowed_vlans=[{
        "vlan_name": "string",
    }],
    allowed_vlans_all="string",
    description="string",
    discard_mode="string",
    dynamic_sort_subtable="string",
    fortilink="string",
    get_all_tables="string",
    name="string",
    untagged_vlans=[{
        "vlan_name": "string",
    }],
    vdomparam="string",
    vlan="string")
Copy
const vlanpolicyResource = new fortios.switchcontroller.Vlanpolicy("vlanpolicyResource", {
    allowedVlans: [{
        vlanName: "string",
    }],
    allowedVlansAll: "string",
    description: "string",
    discardMode: "string",
    dynamicSortSubtable: "string",
    fortilink: "string",
    getAllTables: "string",
    name: "string",
    untaggedVlans: [{
        vlanName: "string",
    }],
    vdomparam: "string",
    vlan: "string",
});
Copy
type: fortios:switchcontroller:Vlanpolicy
properties:
    allowedVlans:
        - vlanName: string
    allowedVlansAll: string
    description: string
    discardMode: string
    dynamicSortSubtable: string
    fortilink: string
    getAllTables: string
    name: string
    untaggedVlans:
        - vlanName: string
    vdomparam: string
    vlan: string
Copy

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

AllowedVlans List<Pulumiverse.Fortios.Switchcontroller.Inputs.VlanpolicyAllowedVlan>
Allowed VLANs to be applied when using this VLAN policy. The structure of allowed_vlans block is documented below.
AllowedVlansAll string
Enable/disable all defined VLANs when using this VLAN policy. Valid values: enable, disable.
Description string
Description for the VLAN policy.
DiscardMode string
Discard mode to be applied when using this VLAN policy. Valid values: none, all-untagged, all-tagged.
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 ].
Fortilink string
FortiLink interface for which this VLAN policy belongs to.
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 Changes to this property will trigger replacement. string
VLAN policy name.
UntaggedVlans List<Pulumiverse.Fortios.Switchcontroller.Inputs.VlanpolicyUntaggedVlan>
Untagged VLANs to be applied when using this VLAN policy. The structure of untagged_vlans block is documented below.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Vlan string
Native VLAN to be applied when using this VLAN policy.
AllowedVlans []VlanpolicyAllowedVlanArgs
Allowed VLANs to be applied when using this VLAN policy. The structure of allowed_vlans block is documented below.
AllowedVlansAll string
Enable/disable all defined VLANs when using this VLAN policy. Valid values: enable, disable.
Description string
Description for the VLAN policy.
DiscardMode string
Discard mode to be applied when using this VLAN policy. Valid values: none, all-untagged, all-tagged.
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 ].
Fortilink string
FortiLink interface for which this VLAN policy belongs to.
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 Changes to this property will trigger replacement. string
VLAN policy name.
UntaggedVlans []VlanpolicyUntaggedVlanArgs
Untagged VLANs to be applied when using this VLAN policy. The structure of untagged_vlans block is documented below.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Vlan string
Native VLAN to be applied when using this VLAN policy.
allowedVlans List<VlanpolicyAllowedVlan>
Allowed VLANs to be applied when using this VLAN policy. The structure of allowed_vlans block is documented below.
allowedVlansAll String
Enable/disable all defined VLANs when using this VLAN policy. Valid values: enable, disable.
description String
Description for the VLAN policy.
discardMode String
Discard mode to be applied when using this VLAN policy. Valid values: none, all-untagged, all-tagged.
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 ].
fortilink String
FortiLink interface for which this VLAN policy belongs to.
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 Changes to this property will trigger replacement. String
VLAN policy name.
untaggedVlans List<VlanpolicyUntaggedVlan>
Untagged VLANs to be applied when using this VLAN policy. The structure of untagged_vlans block is documented below.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlan String
Native VLAN to be applied when using this VLAN policy.
allowedVlans VlanpolicyAllowedVlan[]
Allowed VLANs to be applied when using this VLAN policy. The structure of allowed_vlans block is documented below.
allowedVlansAll string
Enable/disable all defined VLANs when using this VLAN policy. Valid values: enable, disable.
description string
Description for the VLAN policy.
discardMode string
Discard mode to be applied when using this VLAN policy. Valid values: none, all-untagged, all-tagged.
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 ].
fortilink string
FortiLink interface for which this VLAN policy belongs to.
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 Changes to this property will trigger replacement. string
VLAN policy name.
untaggedVlans VlanpolicyUntaggedVlan[]
Untagged VLANs to be applied when using this VLAN policy. The structure of untagged_vlans block is documented below.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlan string
Native VLAN to be applied when using this VLAN policy.
allowed_vlans Sequence[VlanpolicyAllowedVlanArgs]
Allowed VLANs to be applied when using this VLAN policy. The structure of allowed_vlans block is documented below.
allowed_vlans_all str
Enable/disable all defined VLANs when using this VLAN policy. Valid values: enable, disable.
description str
Description for the VLAN policy.
discard_mode str
Discard mode to be applied when using this VLAN policy. Valid values: none, all-untagged, all-tagged.
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 ].
fortilink str
FortiLink interface for which this VLAN policy belongs to.
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 Changes to this property will trigger replacement. str
VLAN policy name.
untagged_vlans Sequence[VlanpolicyUntaggedVlanArgs]
Untagged VLANs to be applied when using this VLAN policy. The structure of untagged_vlans block is documented below.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlan str
Native VLAN to be applied when using this VLAN policy.
allowedVlans List<Property Map>
Allowed VLANs to be applied when using this VLAN policy. The structure of allowed_vlans block is documented below.
allowedVlansAll String
Enable/disable all defined VLANs when using this VLAN policy. Valid values: enable, disable.
description String
Description for the VLAN policy.
discardMode String
Discard mode to be applied when using this VLAN policy. Valid values: none, all-untagged, all-tagged.
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 ].
fortilink String
FortiLink interface for which this VLAN policy belongs to.
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 Changes to this property will trigger replacement. String
VLAN policy name.
untaggedVlans List<Property Map>
Untagged VLANs to be applied when using this VLAN policy. The structure of untagged_vlans block is documented below.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlan String
Native VLAN to be applied when using this VLAN policy.

Outputs

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

Get an existing Vlanpolicy 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?: VlanpolicyState, opts?: CustomResourceOptions): Vlanpolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_vlans: Optional[Sequence[VlanpolicyAllowedVlanArgs]] = None,
        allowed_vlans_all: Optional[str] = None,
        description: Optional[str] = None,
        discard_mode: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        fortilink: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        untagged_vlans: Optional[Sequence[VlanpolicyUntaggedVlanArgs]] = None,
        vdomparam: Optional[str] = None,
        vlan: Optional[str] = None) -> Vlanpolicy
func GetVlanpolicy(ctx *Context, name string, id IDInput, state *VlanpolicyState, opts ...ResourceOption) (*Vlanpolicy, error)
public static Vlanpolicy Get(string name, Input<string> id, VlanpolicyState? state, CustomResourceOptions? opts = null)
public static Vlanpolicy get(String name, Output<String> id, VlanpolicyState state, CustomResourceOptions options)
resources:  _:    type: fortios:switchcontroller:Vlanpolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AllowedVlans List<Pulumiverse.Fortios.Switchcontroller.Inputs.VlanpolicyAllowedVlan>
Allowed VLANs to be applied when using this VLAN policy. The structure of allowed_vlans block is documented below.
AllowedVlansAll string
Enable/disable all defined VLANs when using this VLAN policy. Valid values: enable, disable.
Description string
Description for the VLAN policy.
DiscardMode string
Discard mode to be applied when using this VLAN policy. Valid values: none, all-untagged, all-tagged.
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 ].
Fortilink string
FortiLink interface for which this VLAN policy belongs to.
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 Changes to this property will trigger replacement. string
VLAN policy name.
UntaggedVlans List<Pulumiverse.Fortios.Switchcontroller.Inputs.VlanpolicyUntaggedVlan>
Untagged VLANs to be applied when using this VLAN policy. The structure of untagged_vlans block is documented below.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Vlan string
Native VLAN to be applied when using this VLAN policy.
AllowedVlans []VlanpolicyAllowedVlanArgs
Allowed VLANs to be applied when using this VLAN policy. The structure of allowed_vlans block is documented below.
AllowedVlansAll string
Enable/disable all defined VLANs when using this VLAN policy. Valid values: enable, disable.
Description string
Description for the VLAN policy.
DiscardMode string
Discard mode to be applied when using this VLAN policy. Valid values: none, all-untagged, all-tagged.
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 ].
Fortilink string
FortiLink interface for which this VLAN policy belongs to.
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 Changes to this property will trigger replacement. string
VLAN policy name.
UntaggedVlans []VlanpolicyUntaggedVlanArgs
Untagged VLANs to be applied when using this VLAN policy. The structure of untagged_vlans block is documented below.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Vlan string
Native VLAN to be applied when using this VLAN policy.
allowedVlans List<VlanpolicyAllowedVlan>
Allowed VLANs to be applied when using this VLAN policy. The structure of allowed_vlans block is documented below.
allowedVlansAll String
Enable/disable all defined VLANs when using this VLAN policy. Valid values: enable, disable.
description String
Description for the VLAN policy.
discardMode String
Discard mode to be applied when using this VLAN policy. Valid values: none, all-untagged, all-tagged.
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 ].
fortilink String
FortiLink interface for which this VLAN policy belongs to.
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 Changes to this property will trigger replacement. String
VLAN policy name.
untaggedVlans List<VlanpolicyUntaggedVlan>
Untagged VLANs to be applied when using this VLAN policy. The structure of untagged_vlans block is documented below.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlan String
Native VLAN to be applied when using this VLAN policy.
allowedVlans VlanpolicyAllowedVlan[]
Allowed VLANs to be applied when using this VLAN policy. The structure of allowed_vlans block is documented below.
allowedVlansAll string
Enable/disable all defined VLANs when using this VLAN policy. Valid values: enable, disable.
description string
Description for the VLAN policy.
discardMode string
Discard mode to be applied when using this VLAN policy. Valid values: none, all-untagged, all-tagged.
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 ].
fortilink string
FortiLink interface for which this VLAN policy belongs to.
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 Changes to this property will trigger replacement. string
VLAN policy name.
untaggedVlans VlanpolicyUntaggedVlan[]
Untagged VLANs to be applied when using this VLAN policy. The structure of untagged_vlans block is documented below.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlan string
Native VLAN to be applied when using this VLAN policy.
allowed_vlans Sequence[VlanpolicyAllowedVlanArgs]
Allowed VLANs to be applied when using this VLAN policy. The structure of allowed_vlans block is documented below.
allowed_vlans_all str
Enable/disable all defined VLANs when using this VLAN policy. Valid values: enable, disable.
description str
Description for the VLAN policy.
discard_mode str
Discard mode to be applied when using this VLAN policy. Valid values: none, all-untagged, all-tagged.
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 ].
fortilink str
FortiLink interface for which this VLAN policy belongs to.
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 Changes to this property will trigger replacement. str
VLAN policy name.
untagged_vlans Sequence[VlanpolicyUntaggedVlanArgs]
Untagged VLANs to be applied when using this VLAN policy. The structure of untagged_vlans block is documented below.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlan str
Native VLAN to be applied when using this VLAN policy.
allowedVlans List<Property Map>
Allowed VLANs to be applied when using this VLAN policy. The structure of allowed_vlans block is documented below.
allowedVlansAll String
Enable/disable all defined VLANs when using this VLAN policy. Valid values: enable, disable.
description String
Description for the VLAN policy.
discardMode String
Discard mode to be applied when using this VLAN policy. Valid values: none, all-untagged, all-tagged.
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 ].
fortilink String
FortiLink interface for which this VLAN policy belongs to.
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 Changes to this property will trigger replacement. String
VLAN policy name.
untaggedVlans List<Property Map>
Untagged VLANs to be applied when using this VLAN policy. The structure of untagged_vlans block is documented below.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlan String
Native VLAN to be applied when using this VLAN policy.

Supporting Types

VlanpolicyAllowedVlan
, VlanpolicyAllowedVlanArgs

VlanName string
VLAN name.
VlanName string
VLAN name.
vlanName String
VLAN name.
vlanName string
VLAN name.
vlan_name str
VLAN name.
vlanName String
VLAN name.

VlanpolicyUntaggedVlan
, VlanpolicyUntaggedVlanArgs

VlanName string
VLAN name.
VlanName string
VLAN name.
vlanName String
VLAN name.
vlanName string
VLAN name.
vlan_name str
VLAN name.
vlanName String
VLAN name.

Import

SwitchController VlanPolicy can be imported using any of these accepted formats:

$ pulumi import fortios:switchcontroller/vlanpolicy:Vlanpolicy labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:switchcontroller/vlanpolicy:Vlanpolicy labelname {{name}}
Copy

$ unset “FORTIOS_IMPORT_TABLE”

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

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.