Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. wirelesscontroller
  5. wirelesscontroller/hotspot20
  6. Qosmap
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.wirelesscontroller/hotspot20.Qosmap

Explore with Pulumi AI

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

    Configure QoS map set.

    Create Qosmap Resource

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

    Constructor syntax

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

@overload
def Qosmap(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           dscp_excepts: Optional[Sequence[QosmapDscpExceptArgs]] = None,
           dscp_ranges: Optional[Sequence[QosmapDscpRangeArgs]] = None,
           dynamic_sort_subtable: Optional[str] = None,
           get_all_tables: Optional[str] = None,
           name: Optional[str] = None,
           vdomparam: Optional[str] = None)
    func NewQosmap(ctx *Context, name string, args *QosmapArgs, opts ...ResourceOption) (*Qosmap, error)
    public Qosmap(string name, QosmapArgs? args = null, CustomResourceOptions? opts = null)
    public Qosmap(String name, QosmapArgs args)
public Qosmap(String name, QosmapArgs args, CustomResourceOptions options)

    type: fortios:wirelesscontroller/hotspot20/qosmap:Qosmap
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 QosmapArgs
    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 QosmapArgs
    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 QosmapArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QosmapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QosmapArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    DscpExcepts List<Pulumiverse.Fortios.Wirelesscontroller.Hotspot20.Inputs.QosmapDscpExcept>
    Differentiated Services Code Point (DSCP) exceptions. The structure of dscp_except block is documented below.
    DscpRanges List<Pulumiverse.Fortios.Wirelesscontroller.Hotspot20.Inputs.QosmapDscpRange>
    Differentiated Services Code Point (DSCP) ranges. The structure of dscp_range block is documented below.
    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
    QOS-MAP 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.
    DscpExcepts []QosmapDscpExceptArgs
    Differentiated Services Code Point (DSCP) exceptions. The structure of dscp_except block is documented below.
    DscpRanges []QosmapDscpRangeArgs
    Differentiated Services Code Point (DSCP) ranges. The structure of dscp_range block is documented below.
    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
    QOS-MAP 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.
    dscpExcepts List<QosmapDscpExcept>
    Differentiated Services Code Point (DSCP) exceptions. The structure of dscp_except block is documented below.
    dscpRanges List<QosmapDscpRange>
    Differentiated Services Code Point (DSCP) ranges. The structure of dscp_range block is documented below.
    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
    QOS-MAP 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.
    dscpExcepts QosmapDscpExcept[]
    Differentiated Services Code Point (DSCP) exceptions. The structure of dscp_except block is documented below.
    dscpRanges QosmapDscpRange[]
    Differentiated Services Code Point (DSCP) ranges. The structure of dscp_range block is documented below.
    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
    QOS-MAP 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.
    dscp_excepts Sequence[QosmapDscpExceptArgs]
    Differentiated Services Code Point (DSCP) exceptions. The structure of dscp_except block is documented below.
    dscp_ranges Sequence[QosmapDscpRangeArgs]
    Differentiated Services Code Point (DSCP) ranges. The structure of dscp_range block is documented below.
    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
    QOS-MAP 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.
    dscpExcepts List<Property Map>
    Differentiated Services Code Point (DSCP) exceptions. The structure of dscp_except block is documented below.
    dscpRanges List<Property Map>
    Differentiated Services Code Point (DSCP) ranges. The structure of dscp_range block is documented below.
    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
    QOS-MAP 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 Qosmap 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 Qosmap Resource

    Get an existing Qosmap 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?: QosmapState, opts?: CustomResourceOptions): Qosmap
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dscp_excepts: Optional[Sequence[QosmapDscpExceptArgs]] = None,
        dscp_ranges: Optional[Sequence[QosmapDscpRangeArgs]] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Qosmap
    func GetQosmap(ctx *Context, name string, id IDInput, state *QosmapState, opts ...ResourceOption) (*Qosmap, error)
    public static Qosmap Get(string name, Input<string> id, QosmapState? state, CustomResourceOptions? opts = null)
    public static Qosmap get(String name, Output<String> id, QosmapState 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:
    DscpExcepts List<Pulumiverse.Fortios.Wirelesscontroller.Hotspot20.Inputs.QosmapDscpExcept>
    Differentiated Services Code Point (DSCP) exceptions. The structure of dscp_except block is documented below.
    DscpRanges List<Pulumiverse.Fortios.Wirelesscontroller.Hotspot20.Inputs.QosmapDscpRange>
    Differentiated Services Code Point (DSCP) ranges. The structure of dscp_range block is documented below.
    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
    QOS-MAP 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.
    DscpExcepts []QosmapDscpExceptArgs
    Differentiated Services Code Point (DSCP) exceptions. The structure of dscp_except block is documented below.
    DscpRanges []QosmapDscpRangeArgs
    Differentiated Services Code Point (DSCP) ranges. The structure of dscp_range block is documented below.
    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
    QOS-MAP 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.
    dscpExcepts List<QosmapDscpExcept>
    Differentiated Services Code Point (DSCP) exceptions. The structure of dscp_except block is documented below.
    dscpRanges List<QosmapDscpRange>
    Differentiated Services Code Point (DSCP) ranges. The structure of dscp_range block is documented below.
    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
    QOS-MAP 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.
    dscpExcepts QosmapDscpExcept[]
    Differentiated Services Code Point (DSCP) exceptions. The structure of dscp_except block is documented below.
    dscpRanges QosmapDscpRange[]
    Differentiated Services Code Point (DSCP) ranges. The structure of dscp_range block is documented below.
    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
    QOS-MAP 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.
    dscp_excepts Sequence[QosmapDscpExceptArgs]
    Differentiated Services Code Point (DSCP) exceptions. The structure of dscp_except block is documented below.
    dscp_ranges Sequence[QosmapDscpRangeArgs]
    Differentiated Services Code Point (DSCP) ranges. The structure of dscp_range block is documented below.
    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
    QOS-MAP 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.
    dscpExcepts List<Property Map>
    Differentiated Services Code Point (DSCP) exceptions. The structure of dscp_except block is documented below.
    dscpRanges List<Property Map>
    Differentiated Services Code Point (DSCP) ranges. The structure of dscp_range block is documented below.
    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
    QOS-MAP 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

    QosmapDscpExcept, QosmapDscpExceptArgs

    Dscp int
    DSCP value.
    Index int
    DSCP exception index.
    Up int
    User priority.
    Dscp int
    DSCP value.
    Index int
    DSCP exception index.
    Up int
    User priority.
    dscp Integer
    DSCP value.
    index Integer
    DSCP exception index.
    up Integer
    User priority.
    dscp number
    DSCP value.
    index number
    DSCP exception index.
    up number
    User priority.
    dscp int
    DSCP value.
    index int
    DSCP exception index.
    up int
    User priority.
    dscp Number
    DSCP value.
    index Number
    DSCP exception index.
    up Number
    User priority.

    QosmapDscpRange, QosmapDscpRangeArgs

    High int
    DSCP high value.
    Index int
    DSCP range index.
    Low int
    DSCP low value.
    Up int
    User priority.
    High int
    DSCP high value.
    Index int
    DSCP range index.
    Low int
    DSCP low value.
    Up int
    User priority.
    high Integer
    DSCP high value.
    index Integer
    DSCP range index.
    low Integer
    DSCP low value.
    up Integer
    User priority.
    high number
    DSCP high value.
    index number
    DSCP range index.
    low number
    DSCP low value.
    up number
    User priority.
    high int
    DSCP high value.
    index int
    DSCP range index.
    low int
    DSCP low value.
    up int
    User priority.
    high Number
    DSCP high value.
    index Number
    DSCP range index.
    low Number
    DSCP low value.
    up Number
    User priority.

    Import

    WirelessControllerHotspot20 QosMap can be imported using any of these accepted formats:

    $ pulumi import fortios:wirelesscontroller/hotspot20/qosmap:Qosmap labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:wirelesscontroller/hotspot20/qosmap:Qosmap 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
    pulumiverse/pulumi-fortios