@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
372 lines (371 loc) • 16.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Configure WiFi quality of service (QoS) profiles.
*
* ## Import
*
* WirelessController QosProfile can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:wirelesscontroller/qosprofile:Qosprofile labelname {{name}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:wirelesscontroller/qosprofile:Qosprofile labelname {{name}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Qosprofile extends pulumi.CustomResource {
/**
* Get an existing Qosprofile resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QosprofileState, opts?: pulumi.CustomResourceOptions): Qosprofile;
/**
* Returns true if the given object is an instance of Qosprofile. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Qosprofile;
/**
* Enable/disable WMM bandwidth admission control. Valid values: `enable`, `disable`.
*/
readonly bandwidthAdmissionControl: pulumi.Output<string>;
/**
* Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000).
*/
readonly bandwidthCapacity: pulumi.Output<number>;
/**
* Enable/disable client rate burst. Valid values: `enable`, `disable`.
*/
readonly burst: pulumi.Output<string>;
/**
* Enable/disable WMM call admission control. Valid values: `enable`, `disable`.
*/
readonly callAdmissionControl: pulumi.Output<string>;
/**
* Maximum number of Voice over WLAN (VoWLAN) phones allowed (0 - 60, default = 10).
*/
readonly callCapacity: pulumi.Output<number>;
/**
* Comment.
*/
readonly comment: pulumi.Output<string>;
/**
* Maximum downlink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit).
*/
readonly downlink: pulumi.Output<number>;
/**
* Maximum downlink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit).
*/
readonly downlinkSta: pulumi.Output<number>;
/**
* DSCP mapping for best effort access (default = 0 24). The structure of `dscpWmmBe` block is documented below.
*/
readonly dscpWmmBes: pulumi.Output<outputs.wirelesscontroller.QosprofileDscpWmmBe[] | undefined>;
/**
* DSCP mapping for background access (default = 8 16). The structure of `dscpWmmBk` block is documented below.
*/
readonly dscpWmmBks: pulumi.Output<outputs.wirelesscontroller.QosprofileDscpWmmBk[] | undefined>;
/**
* Enable/disable Differentiated Services Code Point (DSCP) mapping. Valid values: `enable`, `disable`.
*/
readonly dscpWmmMapping: pulumi.Output<string>;
/**
* DSCP mapping for video access (default = 32 40). The structure of `dscpWmmVi` block is documented below.
*/
readonly dscpWmmVis: pulumi.Output<outputs.wirelesscontroller.QosprofileDscpWmmVi[] | undefined>;
/**
* DSCP mapping for voice access (default = 48 56). The structure of `dscpWmmVo` block is documented below.
*/
readonly dscpWmmVos: pulumi.Output<outputs.wirelesscontroller.QosprofileDscpWmmVo[] | undefined>;
/**
* 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 ].
*/
readonly dynamicSortSubtable: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly getAllTables: pulumi.Output<string | undefined>;
/**
* WiFi QoS profile name.
*/
readonly name: pulumi.Output<string>;
/**
* Maximum uplink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit).
*/
readonly uplink: pulumi.Output<number>;
/**
* Maximum uplink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit).
*/
readonly uplinkSta: pulumi.Output<number>;
/**
* 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.
*/
readonly vdomparam: pulumi.Output<string>;
/**
* Enable/disable WiFi multi-media (WMM) control. Valid values: `enable`, `disable`.
*/
readonly wmm: pulumi.Output<string>;
/**
* DSCP marking for best effort access (default = 0).
*/
readonly wmmBeDscp: pulumi.Output<number>;
/**
* DSCP marking for background access (default = 8).
*/
readonly wmmBkDscp: pulumi.Output<number>;
/**
* Enable/disable WMM Differentiated Services Code Point (DSCP) marking. Valid values: `enable`, `disable`.
*/
readonly wmmDscpMarking: pulumi.Output<string>;
/**
* Enable/disable WMM Unscheduled Automatic Power Save Delivery (U-APSD) power save mode. Valid values: `enable`, `disable`.
*/
readonly wmmUapsd: pulumi.Output<string>;
/**
* DSCP marking for video access (default = 32).
*/
readonly wmmViDscp: pulumi.Output<number>;
/**
* DSCP marking for voice access (default = 48).
*/
readonly wmmVoDscp: pulumi.Output<number>;
/**
* Create a Qosprofile resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: QosprofileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Qosprofile resources.
*/
export interface QosprofileState {
/**
* Enable/disable WMM bandwidth admission control. Valid values: `enable`, `disable`.
*/
bandwidthAdmissionControl?: pulumi.Input<string>;
/**
* Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000).
*/
bandwidthCapacity?: pulumi.Input<number>;
/**
* Enable/disable client rate burst. Valid values: `enable`, `disable`.
*/
burst?: pulumi.Input<string>;
/**
* Enable/disable WMM call admission control. Valid values: `enable`, `disable`.
*/
callAdmissionControl?: pulumi.Input<string>;
/**
* Maximum number of Voice over WLAN (VoWLAN) phones allowed (0 - 60, default = 10).
*/
callCapacity?: pulumi.Input<number>;
/**
* Comment.
*/
comment?: pulumi.Input<string>;
/**
* Maximum downlink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit).
*/
downlink?: pulumi.Input<number>;
/**
* Maximum downlink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit).
*/
downlinkSta?: pulumi.Input<number>;
/**
* DSCP mapping for best effort access (default = 0 24). The structure of `dscpWmmBe` block is documented below.
*/
dscpWmmBes?: pulumi.Input<pulumi.Input<inputs.wirelesscontroller.QosprofileDscpWmmBe>[]>;
/**
* DSCP mapping for background access (default = 8 16). The structure of `dscpWmmBk` block is documented below.
*/
dscpWmmBks?: pulumi.Input<pulumi.Input<inputs.wirelesscontroller.QosprofileDscpWmmBk>[]>;
/**
* Enable/disable Differentiated Services Code Point (DSCP) mapping. Valid values: `enable`, `disable`.
*/
dscpWmmMapping?: pulumi.Input<string>;
/**
* DSCP mapping for video access (default = 32 40). The structure of `dscpWmmVi` block is documented below.
*/
dscpWmmVis?: pulumi.Input<pulumi.Input<inputs.wirelesscontroller.QosprofileDscpWmmVi>[]>;
/**
* DSCP mapping for voice access (default = 48 56). The structure of `dscpWmmVo` block is documented below.
*/
dscpWmmVos?: pulumi.Input<pulumi.Input<inputs.wirelesscontroller.QosprofileDscpWmmVo>[]>;
/**
* 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 ].
*/
dynamicSortSubtable?: pulumi.Input<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.
*/
getAllTables?: pulumi.Input<string>;
/**
* WiFi QoS profile name.
*/
name?: pulumi.Input<string>;
/**
* Maximum uplink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit).
*/
uplink?: pulumi.Input<number>;
/**
* Maximum uplink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit).
*/
uplinkSta?: pulumi.Input<number>;
/**
* 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.
*/
vdomparam?: pulumi.Input<string>;
/**
* Enable/disable WiFi multi-media (WMM) control. Valid values: `enable`, `disable`.
*/
wmm?: pulumi.Input<string>;
/**
* DSCP marking for best effort access (default = 0).
*/
wmmBeDscp?: pulumi.Input<number>;
/**
* DSCP marking for background access (default = 8).
*/
wmmBkDscp?: pulumi.Input<number>;
/**
* Enable/disable WMM Differentiated Services Code Point (DSCP) marking. Valid values: `enable`, `disable`.
*/
wmmDscpMarking?: pulumi.Input<string>;
/**
* Enable/disable WMM Unscheduled Automatic Power Save Delivery (U-APSD) power save mode. Valid values: `enable`, `disable`.
*/
wmmUapsd?: pulumi.Input<string>;
/**
* DSCP marking for video access (default = 32).
*/
wmmViDscp?: pulumi.Input<number>;
/**
* DSCP marking for voice access (default = 48).
*/
wmmVoDscp?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Qosprofile resource.
*/
export interface QosprofileArgs {
/**
* Enable/disable WMM bandwidth admission control. Valid values: `enable`, `disable`.
*/
bandwidthAdmissionControl?: pulumi.Input<string>;
/**
* Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000).
*/
bandwidthCapacity?: pulumi.Input<number>;
/**
* Enable/disable client rate burst. Valid values: `enable`, `disable`.
*/
burst?: pulumi.Input<string>;
/**
* Enable/disable WMM call admission control. Valid values: `enable`, `disable`.
*/
callAdmissionControl?: pulumi.Input<string>;
/**
* Maximum number of Voice over WLAN (VoWLAN) phones allowed (0 - 60, default = 10).
*/
callCapacity?: pulumi.Input<number>;
/**
* Comment.
*/
comment?: pulumi.Input<string>;
/**
* Maximum downlink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit).
*/
downlink?: pulumi.Input<number>;
/**
* Maximum downlink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit).
*/
downlinkSta?: pulumi.Input<number>;
/**
* DSCP mapping for best effort access (default = 0 24). The structure of `dscpWmmBe` block is documented below.
*/
dscpWmmBes?: pulumi.Input<pulumi.Input<inputs.wirelesscontroller.QosprofileDscpWmmBe>[]>;
/**
* DSCP mapping for background access (default = 8 16). The structure of `dscpWmmBk` block is documented below.
*/
dscpWmmBks?: pulumi.Input<pulumi.Input<inputs.wirelesscontroller.QosprofileDscpWmmBk>[]>;
/**
* Enable/disable Differentiated Services Code Point (DSCP) mapping. Valid values: `enable`, `disable`.
*/
dscpWmmMapping?: pulumi.Input<string>;
/**
* DSCP mapping for video access (default = 32 40). The structure of `dscpWmmVi` block is documented below.
*/
dscpWmmVis?: pulumi.Input<pulumi.Input<inputs.wirelesscontroller.QosprofileDscpWmmVi>[]>;
/**
* DSCP mapping for voice access (default = 48 56). The structure of `dscpWmmVo` block is documented below.
*/
dscpWmmVos?: pulumi.Input<pulumi.Input<inputs.wirelesscontroller.QosprofileDscpWmmVo>[]>;
/**
* 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 ].
*/
dynamicSortSubtable?: pulumi.Input<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.
*/
getAllTables?: pulumi.Input<string>;
/**
* WiFi QoS profile name.
*/
name?: pulumi.Input<string>;
/**
* Maximum uplink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit).
*/
uplink?: pulumi.Input<number>;
/**
* Maximum uplink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit).
*/
uplinkSta?: pulumi.Input<number>;
/**
* 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.
*/
vdomparam?: pulumi.Input<string>;
/**
* Enable/disable WiFi multi-media (WMM) control. Valid values: `enable`, `disable`.
*/
wmm?: pulumi.Input<string>;
/**
* DSCP marking for best effort access (default = 0).
*/
wmmBeDscp?: pulumi.Input<number>;
/**
* DSCP marking for background access (default = 8).
*/
wmmBkDscp?: pulumi.Input<number>;
/**
* Enable/disable WMM Differentiated Services Code Point (DSCP) marking. Valid values: `enable`, `disable`.
*/
wmmDscpMarking?: pulumi.Input<string>;
/**
* Enable/disable WMM Unscheduled Automatic Power Save Delivery (U-APSD) power save mode. Valid values: `enable`, `disable`.
*/
wmmUapsd?: pulumi.Input<string>;
/**
* DSCP marking for video access (default = 32).
*/
wmmViDscp?: pulumi.Input<number>;
/**
* DSCP marking for voice access (default = 48).
*/
wmmVoDscp?: pulumi.Input<number>;
}