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

fortios.switchcontroller.Switchgroup

Explore with Pulumi AI

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

    Configure FortiSwitch switch groups.

    Create Switchgroup Resource

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

    Constructor syntax

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

@overload
def Switchgroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                dynamic_sort_subtable: Optional[str] = None,
                fortilink: Optional[str] = None,
                get_all_tables: Optional[str] = None,
                members: Optional[Sequence[SwitchgroupMemberArgs]] = None,
                name: Optional[str] = None,
                vdomparam: Optional[str] = None)
    func NewSwitchgroup(ctx *Context, name string, args *SwitchgroupArgs, opts ...ResourceOption) (*Switchgroup, error)
    public Switchgroup(string name, SwitchgroupArgs? args = null, CustomResourceOptions? opts = null)
    public Switchgroup(String name, SwitchgroupArgs args)
public Switchgroup(String name, SwitchgroupArgs args, CustomResourceOptions options)

    type: fortios:switchcontroller:Switchgroup
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 SwitchgroupArgs
    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 SwitchgroupArgs
    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 SwitchgroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SwitchgroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SwitchgroupArgs
    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 switchgroupResource = new Fortios.Switchcontroller.Switchgroup("switchgroupResource", new()
{
    Description = "string",
    DynamicSortSubtable = "string",
    Fortilink = "string",
    GetAllTables = "string",
    Members = new[]
    {
        new Fortios.Switchcontroller.Inputs.SwitchgroupMemberArgs
        {
            Name = "string",
            SwitchId = "string",
        },
    },
    Name = "string",
    Vdomparam = "string",
});

    example, err := switchcontroller.NewSwitchgroup(ctx, "switchgroupResource", &switchcontroller.SwitchgroupArgs{
	Description:         pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	Fortilink:           pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Members: switchcontroller.SwitchgroupMemberArray{
		&switchcontroller.SwitchgroupMemberArgs{
			Name:     pulumi.String("string"),
			SwitchId: pulumi.String("string"),
		},
	},
	Name:      pulumi.String("string"),
	Vdomparam: pulumi.String("string"),
})

    var switchgroupResource = new Switchgroup("switchgroupResource", SwitchgroupArgs.builder()
    .description("string")
    .dynamicSortSubtable("string")
    .fortilink("string")
    .getAllTables("string")
    .members(SwitchgroupMemberArgs.builder()
        .name("string")
        .switchId("string")
        .build())
    .name("string")
    .vdomparam("string")
    .build());

    switchgroup_resource = fortios.switchcontroller.Switchgroup("switchgroupResource",
    description="string",
    dynamic_sort_subtable="string",
    fortilink="string",
    get_all_tables="string",
    members=[{
        "name": "string",
        "switch_id": "string",
    }],
    name="string",
    vdomparam="string")

    const switchgroupResource = new fortios.switchcontroller.Switchgroup("switchgroupResource", {
    description: "string",
    dynamicSortSubtable: "string",
    fortilink: "string",
    getAllTables: "string",
    members: [{
        name: "string",
        switchId: "string",
    }],
    name: "string",
    vdomparam: "string",
});

    type: fortios:switchcontroller:Switchgroup
properties:
    description: string
    dynamicSortSubtable: string
    fortilink: string
    getAllTables: string
    members:
        - name: string
          switchId: string
    name: string
    vdomparam: string

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

    Description string
    Optional switch group description.
    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 to which switch group members belong.
    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.
    Members List<Pulumiverse.Fortios.Switchcontroller.Inputs.SwitchgroupMember>
    FortiSwitch members belonging to this switch group. The structure of members block is documented below.
    Name string
    Switch group name.
    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.
    Description string
    Optional switch group description.
    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 to which switch group members belong.
    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.
    Members []SwitchgroupMemberArgs
    FortiSwitch members belonging to this switch group. The structure of members block is documented below.
    Name string
    Switch group name.
    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.
    description String
    Optional switch group description.
    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 to which switch group members belong.
    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.
    members List<SwitchgroupMember>
    FortiSwitch members belonging to this switch group. The structure of members block is documented below.
    name String
    Switch group name.
    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.
    description string
    Optional switch group description.
    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 to which switch group members belong.
    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.
    members SwitchgroupMember[]
    FortiSwitch members belonging to this switch group. The structure of members block is documented below.
    name string
    Switch group name.
    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.
    description str
    Optional switch group description.
    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 to which switch group members belong.
    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.
    members Sequence[SwitchgroupMemberArgs]
    FortiSwitch members belonging to this switch group. The structure of members block is documented below.
    name str
    Switch group name.
    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.
    description String
    Optional switch group description.
    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 to which switch group members belong.
    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.
    members List<Property Map>
    FortiSwitch members belonging to this switch group. The structure of members block is documented below.
    name String
    Switch group name.
    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 Switchgroup 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 Switchgroup Resource

    Get an existing Switchgroup 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?: SwitchgroupState, opts?: CustomResourceOptions): Switchgroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        fortilink: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        members: Optional[Sequence[SwitchgroupMemberArgs]] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Switchgroup
    func GetSwitchgroup(ctx *Context, name string, id IDInput, state *SwitchgroupState, opts ...ResourceOption) (*Switchgroup, error)
    public static Switchgroup Get(string name, Input<string> id, SwitchgroupState? state, CustomResourceOptions? opts = null)
    public static Switchgroup get(String name, Output<String> id, SwitchgroupState 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:
    Description string
    Optional switch group description.
    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 to which switch group members belong.
    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.
    Members List<Pulumiverse.Fortios.Switchcontroller.Inputs.SwitchgroupMember>
    FortiSwitch members belonging to this switch group. The structure of members block is documented below.
    Name string
    Switch group name.
    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.
    Description string
    Optional switch group description.
    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 to which switch group members belong.
    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.
    Members []SwitchgroupMemberArgs
    FortiSwitch members belonging to this switch group. The structure of members block is documented below.
    Name string
    Switch group name.
    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.
    description String
    Optional switch group description.
    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 to which switch group members belong.
    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.
    members List<SwitchgroupMember>
    FortiSwitch members belonging to this switch group. The structure of members block is documented below.
    name String
    Switch group name.
    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.
    description string
    Optional switch group description.
    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 to which switch group members belong.
    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.
    members SwitchgroupMember[]
    FortiSwitch members belonging to this switch group. The structure of members block is documented below.
    name string
    Switch group name.
    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.
    description str
    Optional switch group description.
    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 to which switch group members belong.
    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.
    members Sequence[SwitchgroupMemberArgs]
    FortiSwitch members belonging to this switch group. The structure of members block is documented below.
    name str
    Switch group name.
    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.
    description String
    Optional switch group description.
    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 to which switch group members belong.
    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.
    members List<Property Map>
    FortiSwitch members belonging to this switch group. The structure of members block is documented below.
    name String
    Switch group name.
    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

    SwitchgroupMember, SwitchgroupMemberArgs

    Name string
    Managed device ID.
    SwitchId string
    Managed device ID.
    Name string
    Managed device ID.
    SwitchId string
    Managed device ID.
    name String
    Managed device ID.
    switchId String
    Managed device ID.
    name string
    Managed device ID.
    switchId string
    Managed device ID.
    name str
    Managed device ID.
    switch_id str
    Managed device ID.
    name String
    Managed device ID.
    switchId String
    Managed device ID.

    Import

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

    $ pulumi import fortios:switchcontroller/switchgroup:Switchgroup labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:switchcontroller/switchgroup:Switchgroup 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