@pulumiverse/fortios/wirelesscontroller/arrpprofile.d.ts

A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles. Applies to FortiOS Version `>= 6.4.2`.
 *
 * ## Import
 *
 * WirelessController ArrpProfile can be imported using any of these accepted formats:
 *
 * ```sh
 * $ pulumi import fortios:wirelesscontroller/arrpprofile:Arrpprofile labelname {{name}}
 * ```
 *
 * If you do not want to import arguments of block:
 *
 * $ export "FORTIOS_IMPORT_TABLE"="false"
 *
 * ```sh
 * $ pulumi import fortios:wirelesscontroller/arrpprofile:Arrpprofile labelname {{name}}
 * ```
 *
 * $ unset "FORTIOS_IMPORT_TABLE"
 */
export declare class Arrpprofile extends pulumi.CustomResource {
    /**
     * Get an existing Arrpprofile 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?: ArrpprofileState, opts?: pulumi.CustomResourceOptions): Arrpprofile;
    /**
     * Returns true if the given object is an instance of Arrpprofile.  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 Arrpprofile;
    /**
     * Comment.
     */
    readonly comment: pulumi.Output<string | undefined>;
    /**
     * Time for running Distributed Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec, default = 86400, 0 = disable).
     */
    readonly darrpOptimize: pulumi.Output<number>;
    /**
     * Firewall schedules for DARRP running time. DARRP will run periodically based on darrp-optimize within the schedules. Separate multiple schedule names with a space. The structure of `darrpOptimizeSchedules` block is documented below.
     */
    readonly darrpOptimizeSchedules: pulumi.Output<outputs.wirelesscontroller.ArrpprofileDarrpOptimizeSchedule[] | 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>;
    /**
     * Enable/disable use of DFS channel in DARRP channel selection phase 1 (default = disable).
     */
    readonly includeDfsChannel: pulumi.Output<string>;
    /**
     * Enable/disable use of weather channel in DARRP channel selection phase 1 (default = disable).
     */
    readonly includeWeatherChannel: pulumi.Output<string>;
    /**
     * Period in seconds to measure average transmit retries and receive errors (default = 300).
     */
    readonly monitorPeriod: pulumi.Output<number>;
    /**
     * WiFi ARRP profile name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Enable to override setting darrp-optimize and darrp-optimize-schedules (default = disable). Valid values: `enable`, `disable`.
     */
    readonly overrideDarrpOptimize: pulumi.Output<string>;
    /**
     * Period in seconds to measure average channel load, noise floor, spectral RSSI (default = 3600).
     */
    readonly selectionPeriod: pulumi.Output<number>;
    /**
     * Threshold to reject channel in DARRP channel selection phase 1 due to surrounding APs (0 - 500, default = 250).
     */
    readonly thresholdAp: pulumi.Output<number>;
    /**
     * Threshold in percentage to reject channel in DARRP channel selection phase 1 due to channel load (0 - 100, default = 60).
     */
    readonly thresholdChannelLoad: pulumi.Output<number>;
    /**
     * Threshold in dBm to reject channel in DARRP channel selection phase 1 due to noise floor (-95 to -20, default = -85).
     */
    readonly thresholdNoiseFloor: pulumi.Output<string>;
    /**
     * Threshold in percentage for receive errors to trigger channel reselection in DARRP monitor stage (0 - 100, default = 50).
     */
    readonly thresholdRxErrors: pulumi.Output<number>;
    /**
     * Threshold in dBm to reject channel in DARRP channel selection phase 1 due to spectral RSSI (-95 to -20, default = -65).
     */
    readonly thresholdSpectralRssi: pulumi.Output<string>;
    /**
     * Threshold in percentage for transmit retries to trigger channel reselection in DARRP monitor stage (0 - 1000, default = 300).
     */
    readonly thresholdTxRetries: 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>;
    /**
     * Weight in DARRP channel score calculation for channel load (0 - 2000, default = 20).
     */
    readonly weightChannelLoad: pulumi.Output<number>;
    /**
     * Weight in DARRP channel score calculation for DFS channel (0 - 2000, default = 500).
     */
    readonly weightDfsChannel: pulumi.Output<number>;
    /**
     * Weight in DARRP channel score calculation for managed APs (0 - 2000, default = 50).
     */
    readonly weightManagedAp: pulumi.Output<number>;
    /**
     * Weight in DARRP channel score calculation for noise floor (0 - 2000, default = 40).
     */
    readonly weightNoiseFloor: pulumi.Output<number>;
    /**
     * Weight in DARRP channel score calculation for rogue APs (0 - 2000, default = 10).
     */
    readonly weightRogueAp: pulumi.Output<number>;
    /**
     * Weight in DARRP channel score calculation for spectral RSSI (0 - 2000, default = 40).
     */
    readonly weightSpectralRssi: pulumi.Output<number>;
    /**
     * Weight in DARRP channel score calculation for weather channel (0 - 2000, default = 1000).
     */
    readonly weightWeatherChannel: pulumi.Output<number>;
    /**
     * Create a Arrpprofile 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?: ArrpprofileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Arrpprofile resources.
 */
export interface ArrpprofileState {
    /**
     * Comment.
     */
    comment?: pulumi.Input<string>;
    /**
     * Time for running Distributed Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec, default = 86400, 0 = disable).
     */
    darrpOptimize?: pulumi.Input<number>;
    /**
     * Firewall schedules for DARRP running time. DARRP will run periodically based on darrp-optimize within the schedules. Separate multiple schedule names with a space. The structure of `darrpOptimizeSchedules` block is documented below.
     */
    darrpOptimizeSchedules?: pulumi.Input<pulumi.Input<inputs.wirelesscontroller.ArrpprofileDarrpOptimizeSchedule>[]>;
    /**
     * 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>;
    /**
     * Enable/disable use of DFS channel in DARRP channel selection phase 1 (default = disable).
     */
    includeDfsChannel?: pulumi.Input<string>;
    /**
     * Enable/disable use of weather channel in DARRP channel selection phase 1 (default = disable).
     */
    includeWeatherChannel?: pulumi.Input<string>;
    /**
     * Period in seconds to measure average transmit retries and receive errors (default = 300).
     */
    monitorPeriod?: pulumi.Input<number>;
    /**
     * WiFi ARRP profile name.
     */
    name?: pulumi.Input<string>;
    /**
     * Enable to override setting darrp-optimize and darrp-optimize-schedules (default = disable). Valid values: `enable`, `disable`.
     */
    overrideDarrpOptimize?: pulumi.Input<string>;
    /**
     * Period in seconds to measure average channel load, noise floor, spectral RSSI (default = 3600).
     */
    selectionPeriod?: pulumi.Input<number>;
    /**
     * Threshold to reject channel in DARRP channel selection phase 1 due to surrounding APs (0 - 500, default = 250).
     */
    thresholdAp?: pulumi.Input<number>;
    /**
     * Threshold in percentage to reject channel in DARRP channel selection phase 1 due to channel load (0 - 100, default = 60).
     */
    thresholdChannelLoad?: pulumi.Input<number>;
    /**
     * Threshold in dBm to reject channel in DARRP channel selection phase 1 due to noise floor (-95 to -20, default = -85).
     */
    thresholdNoiseFloor?: pulumi.Input<string>;
    /**
     * Threshold in percentage for receive errors to trigger channel reselection in DARRP monitor stage (0 - 100, default = 50).
     */
    thresholdRxErrors?: pulumi.Input<number>;
    /**
     * Threshold in dBm to reject channel in DARRP channel selection phase 1 due to spectral RSSI (-95 to -20, default = -65).
     */
    thresholdSpectralRssi?: pulumi.Input<string>;
    /**
     * Threshold in percentage for transmit retries to trigger channel reselection in DARRP monitor stage (0 - 1000, default = 300).
     */
    thresholdTxRetries?: 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>;
    /**
     * Weight in DARRP channel score calculation for channel load (0 - 2000, default = 20).
     */
    weightChannelLoad?: pulumi.Input<number>;
    /**
     * Weight in DARRP channel score calculation for DFS channel (0 - 2000, default = 500).
     */
    weightDfsChannel?: pulumi.Input<number>;
    /**
     * Weight in DARRP channel score calculation for managed APs (0 - 2000, default = 50).
     */
    weightManagedAp?: pulumi.Input<number>;
    /**
     * Weight in DARRP channel score calculation for noise floor (0 - 2000, default = 40).
     */
    weightNoiseFloor?: pulumi.Input<number>;
    /**
     * Weight in DARRP channel score calculation for rogue APs (0 - 2000, default = 10).
     */
    weightRogueAp?: pulumi.Input<number>;
    /**
     * Weight in DARRP channel score calculation for spectral RSSI (0 - 2000, default = 40).
     */
    weightSpectralRssi?: pulumi.Input<number>;
    /**
     * Weight in DARRP channel score calculation for weather channel (0 - 2000, default = 1000).
     */
    weightWeatherChannel?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a Arrpprofile resource.
 */
export interface ArrpprofileArgs {
    /**
     * Comment.
     */
    comment?: pulumi.Input<string>;
    /**
     * Time for running Distributed Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec, default = 86400, 0 = disable).
     */
    darrpOptimize?: pulumi.Input<number>;
    /**
     * Firewall schedules for DARRP running time. DARRP will run periodically based on darrp-optimize within the schedules. Separate multiple schedule names with a space. The structure of `darrpOptimizeSchedules` block is documented below.
     */
    darrpOptimizeSchedules?: pulumi.Input<pulumi.Input<inputs.wirelesscontroller.ArrpprofileDarrpOptimizeSchedule>[]>;
    /**
     * 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>;
    /**
     * Enable/disable use of DFS channel in DARRP channel selection phase 1 (default = disable).
     */
    includeDfsChannel?: pulumi.Input<string>;
    /**
     * Enable/disable use of weather channel in DARRP channel selection phase 1 (default = disable).
     */
    includeWeatherChannel?: pulumi.Input<string>;
    /**
     * Period in seconds to measure average transmit retries and receive errors (default = 300).
     */
    monitorPeriod?: pulumi.Input<number>;
    /**
     * WiFi ARRP profile name.
     */
    name?: pulumi.Input<string>;
    /**
     * Enable to override setting darrp-optimize and darrp-optimize-schedules (default = disable). Valid values: `enable`, `disable`.
     */
    overrideDarrpOptimize?: pulumi.Input<string>;
    /**
     * Period in seconds to measure average channel load, noise floor, spectral RSSI (default = 3600).
     */
    selectionPeriod?: pulumi.Input<number>;
    /**
     * Threshold to reject channel in DARRP channel selection phase 1 due to surrounding APs (0 - 500, default = 250).
     */
    thresholdAp?: pulumi.Input<number>;
    /**
     * Threshold in percentage to reject channel in DARRP channel selection phase 1 due to channel load (0 - 100, default = 60).
     */
    thresholdChannelLoad?: pulumi.Input<number>;
    /**
     * Threshold in dBm to reject channel in DARRP channel selection phase 1 due to noise floor (-95 to -20, default = -85).
     */
    thresholdNoiseFloor?: pulumi.Input<string>;
    /**
     * Threshold in percentage for receive errors to trigger channel reselection in DARRP monitor stage (0 - 100, default = 50).
     */
    thresholdRxErrors?: pulumi.Input<number>;
    /**
     * Threshold in dBm to reject channel in DARRP channel selection phase 1 due to spectral RSSI (-95 to -20, default = -65).
     */
    thresholdSpectralRssi?: pulumi.Input<string>;
    /**
     * Threshold in percentage for transmit retries to trigger channel reselection in DARRP monitor stage (0 - 1000, default = 300).
     */
    thresholdTxRetries?: 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>;
    /**
     * Weight in DARRP channel score calculation for channel load (0 - 2000, default = 20).
     */
    weightChannelLoad?: pulumi.Input<number>;
    /**
     * Weight in DARRP channel score calculation for DFS channel (0 - 2000, default = 500).
     */
    weightDfsChannel?: pulumi.Input<number>;
    /**
     * Weight in DARRP channel score calculation for managed APs (0 - 2000, default = 50).
     */
    weightManagedAp?: pulumi.Input<number>;
    /**
     * Weight in DARRP channel score calculation for noise floor (0 - 2000, default = 40).
     */
    weightNoiseFloor?: pulumi.Input<number>;
    /**
     * Weight in DARRP channel score calculation for rogue APs (0 - 2000, default = 10).
     */
    weightRogueAp?: pulumi.Input<number>;
    /**
     * Weight in DARRP channel score calculation for spectral RSSI (0 - 2000, default = 40).
     */
    weightSpectralRssi?: pulumi.Input<number>;
    /**
     * Weight in DARRP channel score calculation for weather channel (0 - 2000, default = 1000).
     */
    weightWeatherChannel?: pulumi.Input<number>;
}