1. Packages
  2. Fortios
  3. API Docs
  4. switchcontroller
  5. switchcontroller/autoconfig
  6. Custom
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.switchcontroller/autoconfig.Custom

Explore with Pulumi AI

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

    Configure FortiSwitch Auto-Config custom QoS policy.

    Create Custom Resource

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

    Constructor syntax

    new Custom(name: string, args?: CustomArgs, opts?: CustomResourceOptions);
    @overload
    def Custom(resource_name: str,
               args: Optional[CustomArgs] = None,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Custom(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               dynamic_sort_subtable: Optional[str] = None,
               get_all_tables: Optional[str] = None,
               name: Optional[str] = None,
               switch_bindings: Optional[Sequence[CustomSwitchBindingArgs]] = None,
               vdomparam: Optional[str] = None)
    func NewCustom(ctx *Context, name string, args *CustomArgs, opts ...ResourceOption) (*Custom, error)
    public Custom(string name, CustomArgs? args = null, CustomResourceOptions? opts = null)
    public Custom(String name, CustomArgs args)
    public Custom(String name, CustomArgs args, CustomResourceOptions options)
    
    type: fortios:switchcontroller/autoconfig/custom:Custom
    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 CustomArgs
    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 CustomArgs
    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 CustomArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var examplecustomResourceResourceFromSwitchcontrollerautoconfigcustom = new Fortios.Switchcontroller.Autoconfig.Custom("examplecustomResourceResourceFromSwitchcontrollerautoconfigcustom", new()
    {
        DynamicSortSubtable = "string",
        GetAllTables = "string",
        Name = "string",
        SwitchBindings = new[]
        {
            new Fortios.Switchcontroller.Autoconfig.Inputs.CustomSwitchBindingArgs
            {
                Policy = "string",
                SwitchId = "string",
            },
        },
        Vdomparam = "string",
    });
    
    example, err := switchcontroller.NewCustom(ctx, "examplecustomResourceResourceFromSwitchcontrollerautoconfigcustom", &switchcontroller.CustomArgs{
    	DynamicSortSubtable: pulumi.String("string"),
    	GetAllTables:        pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	SwitchBindings: autoconfig.CustomSwitchBindingArray{
    		&autoconfig.CustomSwitchBindingArgs{
    			Policy:   pulumi.String("string"),
    			SwitchId: pulumi.String("string"),
    		},
    	},
    	Vdomparam: pulumi.String("string"),
    })
    
    var examplecustomResourceResourceFromSwitchcontrollerautoconfigcustom = new Custom("examplecustomResourceResourceFromSwitchcontrollerautoconfigcustom", CustomArgs.builder()        
        .dynamicSortSubtable("string")
        .getAllTables("string")
        .name("string")
        .switchBindings(CustomSwitchBindingArgs.builder()
            .policy("string")
            .switchId("string")
            .build())
        .vdomparam("string")
        .build());
    
    examplecustom_resource_resource_from_switchcontrollerautoconfigcustom = fortios.switchcontroller.autoconfig.Custom("examplecustomResourceResourceFromSwitchcontrollerautoconfigcustom",
        dynamic_sort_subtable="string",
        get_all_tables="string",
        name="string",
        switch_bindings=[fortios.switchcontroller.autoconfig.CustomSwitchBindingArgs(
            policy="string",
            switch_id="string",
        )],
        vdomparam="string")
    
    const examplecustomResourceResourceFromSwitchcontrollerautoconfigcustom = new fortios.switchcontroller.autoconfig.Custom("examplecustomResourceResourceFromSwitchcontrollerautoconfigcustom", {
        dynamicSortSubtable: "string",
        getAllTables: "string",
        name: "string",
        switchBindings: [{
            policy: "string",
            switchId: "string",
        }],
        vdomparam: "string",
    });
    
    Coming soon!
    

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

    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Auto-Config FortiLink or ISL/ICL interface name.
    SwitchBindings List<Pulumiverse.Fortios.Switchcontroller.Autoconfig.Inputs.CustomSwitchBinding>
    Switch binding list. The structure of switch_binding block is documented below.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Auto-Config FortiLink or ISL/ICL interface name.
    SwitchBindings []CustomSwitchBindingArgs
    Switch binding list. The structure of switch_binding block is documented below.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Auto-Config FortiLink or ISL/ICL interface name.
    switchBindings List<CustomSwitchBinding>
    Switch binding list. The structure of switch_binding block is documented below.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name string
    Auto-Config FortiLink or ISL/ICL interface name.
    switchBindings CustomSwitchBinding[]
    Switch binding list. The structure of switch_binding block is documented below.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name str
    Auto-Config FortiLink or ISL/ICL interface name.
    switch_bindings Sequence[CustomSwitchBindingArgs]
    Switch binding list. The structure of switch_binding block is documented below.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Auto-Config FortiLink or ISL/ICL interface name.
    switchBindings List<Property Map>
    Switch binding list. The structure of switch_binding block is documented below.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

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

    Get an existing Custom 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?: CustomState, opts?: CustomResourceOptions): Custom
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dynamic_sort_subtable: Optional[str] = None,
            get_all_tables: Optional[str] = None,
            name: Optional[str] = None,
            switch_bindings: Optional[Sequence[CustomSwitchBindingArgs]] = None,
            vdomparam: Optional[str] = None) -> Custom
    func GetCustom(ctx *Context, name string, id IDInput, state *CustomState, opts ...ResourceOption) (*Custom, error)
    public static Custom Get(string name, Input<string> id, CustomState? state, CustomResourceOptions? opts = null)
    public static Custom get(String name, Output<String> id, CustomState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Auto-Config FortiLink or ISL/ICL interface name.
    SwitchBindings List<Pulumiverse.Fortios.Switchcontroller.Autoconfig.Inputs.CustomSwitchBinding>
    Switch binding list. The structure of switch_binding block is documented below.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Auto-Config FortiLink or ISL/ICL interface name.
    SwitchBindings []CustomSwitchBindingArgs
    Switch binding list. The structure of switch_binding block is documented below.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Auto-Config FortiLink or ISL/ICL interface name.
    switchBindings List<CustomSwitchBinding>
    Switch binding list. The structure of switch_binding block is documented below.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name string
    Auto-Config FortiLink or ISL/ICL interface name.
    switchBindings CustomSwitchBinding[]
    Switch binding list. The structure of switch_binding block is documented below.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name str
    Auto-Config FortiLink or ISL/ICL interface name.
    switch_bindings Sequence[CustomSwitchBindingArgs]
    Switch binding list. The structure of switch_binding block is documented below.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Auto-Config FortiLink or ISL/ICL interface name.
    switchBindings List<Property Map>
    Switch binding list. The structure of switch_binding block is documented below.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Supporting Types

    CustomSwitchBinding, CustomSwitchBindingArgs

    Policy string
    Custom auto-config policy.
    SwitchId string
    Switch name.
    Policy string
    Custom auto-config policy.
    SwitchId string
    Switch name.
    policy String
    Custom auto-config policy.
    switchId String
    Switch name.
    policy string
    Custom auto-config policy.
    switchId string
    Switch name.
    policy str
    Custom auto-config policy.
    switch_id str
    Switch name.
    policy String
    Custom auto-config policy.
    switchId String
    Switch name.

    Import

    SwitchControllerAutoConfig Custom can be imported using any of these accepted formats:

    $ pulumi import fortios:switchcontroller/autoconfig/custom:Custom labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:switchcontroller/autoconfig/custom:Custom labelname {{name}}
    

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse