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

fortios.switchcontroller.Vlan

Explore with Pulumi AI

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

    Configure VLANs for switch controller. Applies to FortiOS Version <= 6.2.0.

    Create Vlan Resource

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

    Constructor syntax

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

@overload
def Vlan(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         auth: Optional[str] = None,
         color: Optional[int] = None,
         comments: Optional[str] = None,
         dynamic_sort_subtable: Optional[str] = None,
         get_all_tables: Optional[str] = None,
         name: Optional[str] = None,
         portal_message_override_group: Optional[str] = None,
         portal_message_overrides: Optional[VlanPortalMessageOverridesArgs] = None,
         radius_server: Optional[str] = None,
         security: Optional[str] = None,
         selected_usergroups: Optional[Sequence[VlanSelectedUsergroupArgs]] = None,
         usergroup: Optional[str] = None,
         vdom: Optional[str] = None,
         vdomparam: Optional[str] = None,
         vlanid: Optional[int] = None)
    func NewVlan(ctx *Context, name string, args *VlanArgs, opts ...ResourceOption) (*Vlan, error)
    public Vlan(string name, VlanArgs? args = null, CustomResourceOptions? opts = null)
    public Vlan(String name, VlanArgs args)
public Vlan(String name, VlanArgs args, CustomResourceOptions options)

    type: fortios:switchcontroller:Vlan
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 VlanArgs
    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 VlanArgs
    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 VlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VlanArgs
    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 vlanResource = new Fortios.Switchcontroller.Vlan("vlanResource", new()
{
    Auth = "string",
    Color = 0,
    Comments = "string",
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    Name = "string",
    PortalMessageOverrideGroup = "string",
    PortalMessageOverrides = new Fortios.Switchcontroller.Inputs.VlanPortalMessageOverridesArgs
    {
        AuthDisclaimerPage = "string",
        AuthLoginFailedPage = "string",
        AuthLoginPage = "string",
        AuthRejectPage = "string",
    },
    RadiusServer = "string",
    Security = "string",
    SelectedUsergroups = new[]
    {
        new Fortios.Switchcontroller.Inputs.VlanSelectedUsergroupArgs
        {
            Name = "string",
        },
    },
    Usergroup = "string",
    Vdom = "string",
    Vdomparam = "string",
    Vlanid = 0,
});

    example, err := switchcontroller.NewVlan(ctx, "vlanResource", &switchcontroller.VlanArgs{
	Auth:                       pulumi.String("string"),
	Color:                      pulumi.Int(0),
	Comments:                   pulumi.String("string"),
	DynamicSortSubtable:        pulumi.String("string"),
	GetAllTables:               pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PortalMessageOverrideGroup: pulumi.String("string"),
	PortalMessageOverrides: &switchcontroller.VlanPortalMessageOverridesArgs{
		AuthDisclaimerPage:  pulumi.String("string"),
		AuthLoginFailedPage: pulumi.String("string"),
		AuthLoginPage:       pulumi.String("string"),
		AuthRejectPage:      pulumi.String("string"),
	},
	RadiusServer: pulumi.String("string"),
	Security:     pulumi.String("string"),
	SelectedUsergroups: switchcontroller.VlanSelectedUsergroupArray{
		&switchcontroller.VlanSelectedUsergroupArgs{
			Name: pulumi.String("string"),
		},
	},
	Usergroup: pulumi.String("string"),
	Vdom:      pulumi.String("string"),
	Vdomparam: pulumi.String("string"),
	Vlanid:    pulumi.Int(0),
})

    var vlanResource = new Vlan("vlanResource", VlanArgs.builder()
    .auth("string")
    .color(0)
    .comments("string")
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .name("string")
    .portalMessageOverrideGroup("string")
    .portalMessageOverrides(VlanPortalMessageOverridesArgs.builder()
        .authDisclaimerPage("string")
        .authLoginFailedPage("string")
        .authLoginPage("string")
        .authRejectPage("string")
        .build())
    .radiusServer("string")
    .security("string")
    .selectedUsergroups(VlanSelectedUsergroupArgs.builder()
        .name("string")
        .build())
    .usergroup("string")
    .vdom("string")
    .vdomparam("string")
    .vlanid(0)
    .build());

    vlan_resource = fortios.switchcontroller.Vlan("vlanResource",
    auth="string",
    color=0,
    comments="string",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    name="string",
    portal_message_override_group="string",
    portal_message_overrides=fortios.switchcontroller.VlanPortalMessageOverridesArgs(
        auth_disclaimer_page="string",
        auth_login_failed_page="string",
        auth_login_page="string",
        auth_reject_page="string",
    ),
    radius_server="string",
    security="string",
    selected_usergroups=[fortios.switchcontroller.VlanSelectedUsergroupArgs(
        name="string",
    )],
    usergroup="string",
    vdom="string",
    vdomparam="string",
    vlanid=0)

    const vlanResource = new fortios.switchcontroller.Vlan("vlanResource", {
    auth: "string",
    color: 0,
    comments: "string",
    dynamicSortSubtable: "string",
    getAllTables: "string",
    name: "string",
    portalMessageOverrideGroup: "string",
    portalMessageOverrides: {
        authDisclaimerPage: "string",
        authLoginFailedPage: "string",
        authLoginPage: "string",
        authRejectPage: "string",
    },
    radiusServer: "string",
    security: "string",
    selectedUsergroups: [{
        name: "string",
    }],
    usergroup: "string",
    vdom: "string",
    vdomparam: "string",
    vlanid: 0,
});

    type: fortios:switchcontroller:Vlan
properties:
    auth: string
    color: 0
    comments: string
    dynamicSortSubtable: string
    getAllTables: string
    name: string
    portalMessageOverrideGroup: string
    portalMessageOverrides:
        authDisclaimerPage: string
        authLoginFailedPage: string
        authLoginPage: string
        authRejectPage: string
    radiusServer: string
    security: string
    selectedUsergroups:
        - name: string
    usergroup: string
    vdom: string
    vdomparam: string
    vlanid: 0

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

    Auth string
    Authentication. Valid values: radius, usergroup.
    Color int
    Color of icon on the GUI.
    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
    Switch VLAN name.
    PortalMessageOverrideGroup string
    Specify captive portal replacement message override group.
    PortalMessageOverrides Pulumiverse.Fortios.Switchcontroller.Inputs.VlanPortalMessageOverrides
    Individual message overrides. The structure of portal_message_overrides block is documented below.
    RadiusServer string
    Authentication radius server.
    Security string
    Security. Valid values: open, captive-portal, 8021x.
    SelectedUsergroups List<Pulumiverse.Fortios.Switchcontroller.Inputs.VlanSelectedUsergroup>
    Selected user group. The structure of selected_usergroups block is documented below.
    Usergroup string
    Authentication usergroup.
    Vdom string
    Virtual domain,
    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.
    Vlanid int
    VLAN ID.
    Auth string
    Authentication. Valid values: radius, usergroup.
    Color int
    Color of icon on the GUI.
    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
    Switch VLAN name.
    PortalMessageOverrideGroup string
    Specify captive portal replacement message override group.
    PortalMessageOverrides VlanPortalMessageOverridesArgs
    Individual message overrides. The structure of portal_message_overrides block is documented below.
    RadiusServer string
    Authentication radius server.
    Security string
    Security. Valid values: open, captive-portal, 8021x.
    SelectedUsergroups []VlanSelectedUsergroupArgs
    Selected user group. The structure of selected_usergroups block is documented below.
    Usergroup string
    Authentication usergroup.
    Vdom string
    Virtual domain,
    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.
    Vlanid int
    VLAN ID.
    auth String
    Authentication. Valid values: radius, usergroup.
    color Integer
    Color of icon on the GUI.
    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
    Switch VLAN name.
    portalMessageOverrideGroup String
    Specify captive portal replacement message override group.
    portalMessageOverrides VlanPortalMessageOverrides
    Individual message overrides. The structure of portal_message_overrides block is documented below.
    radiusServer String
    Authentication radius server.
    security String
    Security. Valid values: open, captive-portal, 8021x.
    selectedUsergroups List<VlanSelectedUsergroup>
    Selected user group. The structure of selected_usergroups block is documented below.
    usergroup String
    Authentication usergroup.
    vdom String
    Virtual domain,
    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.
    vlanid Integer
    VLAN ID.
    auth string
    Authentication. Valid values: radius, usergroup.
    color number
    Color of icon on the GUI.
    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
    Switch VLAN name.
    portalMessageOverrideGroup string
    Specify captive portal replacement message override group.
    portalMessageOverrides VlanPortalMessageOverrides
    Individual message overrides. The structure of portal_message_overrides block is documented below.
    radiusServer string
    Authentication radius server.
    security string
    Security. Valid values: open, captive-portal, 8021x.
    selectedUsergroups VlanSelectedUsergroup[]
    Selected user group. The structure of selected_usergroups block is documented below.
    usergroup string
    Authentication usergroup.
    vdom string
    Virtual domain,
    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.
    vlanid number
    VLAN ID.
    auth str
    Authentication. Valid values: radius, usergroup.
    color int
    Color of icon on the GUI.
    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
    Switch VLAN name.
    portal_message_override_group str
    Specify captive portal replacement message override group.
    portal_message_overrides VlanPortalMessageOverridesArgs
    Individual message overrides. The structure of portal_message_overrides block is documented below.
    radius_server str
    Authentication radius server.
    security str
    Security. Valid values: open, captive-portal, 8021x.
    selected_usergroups Sequence[VlanSelectedUsergroupArgs]
    Selected user group. The structure of selected_usergroups block is documented below.
    usergroup str
    Authentication usergroup.
    vdom str
    Virtual domain,
    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.
    vlanid int
    VLAN ID.
    auth String
    Authentication. Valid values: radius, usergroup.
    color Number
    Color of icon on the GUI.
    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
    Switch VLAN name.
    portalMessageOverrideGroup String
    Specify captive portal replacement message override group.
    portalMessageOverrides Property Map
    Individual message overrides. The structure of portal_message_overrides block is documented below.
    radiusServer String
    Authentication radius server.
    security String
    Security. Valid values: open, captive-portal, 8021x.
    selectedUsergroups List<Property Map>
    Selected user group. The structure of selected_usergroups block is documented below.
    usergroup String
    Authentication usergroup.
    vdom String
    Virtual domain,
    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.
    vlanid Number
    VLAN ID.

    Outputs

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

    Get an existing Vlan 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?: VlanState, opts?: CustomResourceOptions): Vlan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth: Optional[str] = None,
        color: Optional[int] = None,
        comments: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        portal_message_override_group: Optional[str] = None,
        portal_message_overrides: Optional[VlanPortalMessageOverridesArgs] = None,
        radius_server: Optional[str] = None,
        security: Optional[str] = None,
        selected_usergroups: Optional[Sequence[VlanSelectedUsergroupArgs]] = None,
        usergroup: Optional[str] = None,
        vdom: Optional[str] = None,
        vdomparam: Optional[str] = None,
        vlanid: Optional[int] = None) -> Vlan
    func GetVlan(ctx *Context, name string, id IDInput, state *VlanState, opts ...ResourceOption) (*Vlan, error)
    public static Vlan Get(string name, Input<string> id, VlanState? state, CustomResourceOptions? opts = null)
    public static Vlan get(String name, Output<String> id, VlanState 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:
    Auth string
    Authentication. Valid values: radius, usergroup.
    Color int
    Color of icon on the GUI.
    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
    Switch VLAN name.
    PortalMessageOverrideGroup string
    Specify captive portal replacement message override group.
    PortalMessageOverrides Pulumiverse.Fortios.Switchcontroller.Inputs.VlanPortalMessageOverrides
    Individual message overrides. The structure of portal_message_overrides block is documented below.
    RadiusServer string
    Authentication radius server.
    Security string
    Security. Valid values: open, captive-portal, 8021x.
    SelectedUsergroups List<Pulumiverse.Fortios.Switchcontroller.Inputs.VlanSelectedUsergroup>
    Selected user group. The structure of selected_usergroups block is documented below.
    Usergroup string
    Authentication usergroup.
    Vdom string
    Virtual domain,
    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.
    Vlanid int
    VLAN ID.
    Auth string
    Authentication. Valid values: radius, usergroup.
    Color int
    Color of icon on the GUI.
    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
    Switch VLAN name.
    PortalMessageOverrideGroup string
    Specify captive portal replacement message override group.
    PortalMessageOverrides VlanPortalMessageOverridesArgs
    Individual message overrides. The structure of portal_message_overrides block is documented below.
    RadiusServer string
    Authentication radius server.
    Security string
    Security. Valid values: open, captive-portal, 8021x.
    SelectedUsergroups []VlanSelectedUsergroupArgs
    Selected user group. The structure of selected_usergroups block is documented below.
    Usergroup string
    Authentication usergroup.
    Vdom string
    Virtual domain,
    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.
    Vlanid int
    VLAN ID.
    auth String
    Authentication. Valid values: radius, usergroup.
    color Integer
    Color of icon on the GUI.
    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
    Switch VLAN name.
    portalMessageOverrideGroup String
    Specify captive portal replacement message override group.
    portalMessageOverrides VlanPortalMessageOverrides
    Individual message overrides. The structure of portal_message_overrides block is documented below.
    radiusServer String
    Authentication radius server.
    security String
    Security. Valid values: open, captive-portal, 8021x.
    selectedUsergroups List<VlanSelectedUsergroup>
    Selected user group. The structure of selected_usergroups block is documented below.
    usergroup String
    Authentication usergroup.
    vdom String
    Virtual domain,
    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.
    vlanid Integer
    VLAN ID.
    auth string
    Authentication. Valid values: radius, usergroup.
    color number
    Color of icon on the GUI.
    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
    Switch VLAN name.
    portalMessageOverrideGroup string
    Specify captive portal replacement message override group.
    portalMessageOverrides VlanPortalMessageOverrides
    Individual message overrides. The structure of portal_message_overrides block is documented below.
    radiusServer string
    Authentication radius server.
    security string
    Security. Valid values: open, captive-portal, 8021x.
    selectedUsergroups VlanSelectedUsergroup[]
    Selected user group. The structure of selected_usergroups block is documented below.
    usergroup string
    Authentication usergroup.
    vdom string
    Virtual domain,
    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.
    vlanid number
    VLAN ID.
    auth str
    Authentication. Valid values: radius, usergroup.
    color int
    Color of icon on the GUI.
    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
    Switch VLAN name.
    portal_message_override_group str
    Specify captive portal replacement message override group.
    portal_message_overrides VlanPortalMessageOverridesArgs
    Individual message overrides. The structure of portal_message_overrides block is documented below.
    radius_server str
    Authentication radius server.
    security str
    Security. Valid values: open, captive-portal, 8021x.
    selected_usergroups Sequence[VlanSelectedUsergroupArgs]
    Selected user group. The structure of selected_usergroups block is documented below.
    usergroup str
    Authentication usergroup.
    vdom str
    Virtual domain,
    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.
    vlanid int
    VLAN ID.
    auth String
    Authentication. Valid values: radius, usergroup.
    color Number
    Color of icon on the GUI.
    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
    Switch VLAN name.
    portalMessageOverrideGroup String
    Specify captive portal replacement message override group.
    portalMessageOverrides Property Map
    Individual message overrides. The structure of portal_message_overrides block is documented below.
    radiusServer String
    Authentication radius server.
    security String
    Security. Valid values: open, captive-portal, 8021x.
    selectedUsergroups List<Property Map>
    Selected user group. The structure of selected_usergroups block is documented below.
    usergroup String
    Authentication usergroup.
    vdom String
    Virtual domain,
    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.
    vlanid Number
    VLAN ID.

    Supporting Types

    VlanPortalMessageOverrides, VlanPortalMessageOverridesArgs

    AuthDisclaimerPage string
    Override auth-disclaimer-page message with message from portal-message-overrides group.
    AuthLoginFailedPage string
    Override auth-login-failed-page message with message from portal-message-overrides group.
    AuthLoginPage string
    Override auth-login-page message with message from portal-message-overrides group.
    AuthRejectPage string
    Override auth-reject-page message with message from portal-message-overrides group.
    AuthDisclaimerPage string
    Override auth-disclaimer-page message with message from portal-message-overrides group.
    AuthLoginFailedPage string
    Override auth-login-failed-page message with message from portal-message-overrides group.
    AuthLoginPage string
    Override auth-login-page message with message from portal-message-overrides group.
    AuthRejectPage string
    Override auth-reject-page message with message from portal-message-overrides group.
    authDisclaimerPage String
    Override auth-disclaimer-page message with message from portal-message-overrides group.
    authLoginFailedPage String
    Override auth-login-failed-page message with message from portal-message-overrides group.
    authLoginPage String
    Override auth-login-page message with message from portal-message-overrides group.
    authRejectPage String
    Override auth-reject-page message with message from portal-message-overrides group.
    authDisclaimerPage string
    Override auth-disclaimer-page message with message from portal-message-overrides group.
    authLoginFailedPage string
    Override auth-login-failed-page message with message from portal-message-overrides group.
    authLoginPage string
    Override auth-login-page message with message from portal-message-overrides group.
    authRejectPage string
    Override auth-reject-page message with message from portal-message-overrides group.
    auth_disclaimer_page str
    Override auth-disclaimer-page message with message from portal-message-overrides group.
    auth_login_failed_page str
    Override auth-login-failed-page message with message from portal-message-overrides group.
    auth_login_page str
    Override auth-login-page message with message from portal-message-overrides group.
    auth_reject_page str
    Override auth-reject-page message with message from portal-message-overrides group.
    authDisclaimerPage String
    Override auth-disclaimer-page message with message from portal-message-overrides group.
    authLoginFailedPage String
    Override auth-login-failed-page message with message from portal-message-overrides group.
    authLoginPage String
    Override auth-login-page message with message from portal-message-overrides group.
    authRejectPage String
    Override auth-reject-page message with message from portal-message-overrides group.

    VlanSelectedUsergroup, VlanSelectedUsergroupArgs

    Name string
    User group name.
    Name string
    User group name.
    name String
    User group name.
    name string
    User group name.
    name str
    User group name.
    name String
    User group name.

    Import

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

    $ pulumi import fortios:switchcontroller/vlan:Vlan labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:switchcontroller/vlan:Vlan 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