@pulumiverse/fortios/system/speedtestschedule.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";
/**
 * Speed test schedule for each interface. Applies to FortiOS Version `>= 7.0.0`.
 *
 * ## Import
 *
 * System SpeedTestSchedule can be imported using any of these accepted formats:
 *
 * ```sh
 * $ pulumi import fortios:system/speedtestschedule:Speedtestschedule labelname {{interface}}
 * ```
 *
 * If you do not want to import arguments of block:
 *
 * $ export "FORTIOS_IMPORT_TABLE"="false"
 *
 * ```sh
 * $ pulumi import fortios:system/speedtestschedule:Speedtestschedule labelname {{interface}}
 * ```
 *
 * $ unset "FORTIOS_IMPORT_TABLE"
 */
export declare class Speedtestschedule extends pulumi.CustomResource {
    /**
     * Get an existing Speedtestschedule 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?: SpeedtestscheduleState, opts?: pulumi.CustomResourceOptions): Speedtestschedule;
    /**
     * Returns true if the given object is an instance of Speedtestschedule.  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 Speedtestschedule;
    /**
     * Port of the controller to get access token.
     */
    readonly ctrlPort: pulumi.Output<number>;
    /**
     * DSCP used for speed test.
     */
    readonly diffserv: pulumi.Output<string>;
    /**
     * Enable/disable dynamic server option. Valid values: `disable`, `enable`.
     */
    readonly dynamicServer: pulumi.Output<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 ].
     */
    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>;
    /**
     * Interface name.
     */
    readonly interface: pulumi.Output<string>;
    /**
     * Protocol Auto(default), TCP or UDP used for speed test. Valid values: `UDP`, `TCP`, `Auto`.
     */
    readonly mode: pulumi.Output<string>;
    /**
     * Schedules for the interface. The structure of `schedules` block is documented below.
     */
    readonly schedules: pulumi.Output<outputs.system.SpeedtestscheduleSchedule[] | undefined>;
    /**
     * Speed test server name.
     */
    readonly serverName: pulumi.Output<string>;
    /**
     * Port of the server to run speed test.
     */
    readonly serverPort: pulumi.Output<number>;
    /**
     * Enable/disable scheduled speed test. Valid values: `disable`, `enable`.
     */
    readonly status: pulumi.Output<string>;
    /**
     * Enable/disable bypassing interface's inbound bandwidth setting. Valid values: `disable`, `enable`.
     */
    readonly updateInbandwidth: pulumi.Output<string>;
    /**
     * Maximum downloading bandwidth (kbps) to be used in a speed test.
     */
    readonly updateInbandwidthMaximum: pulumi.Output<number>;
    /**
     * Minimum downloading bandwidth (kbps) to be considered effective.
     */
    readonly updateInbandwidthMinimum: pulumi.Output<number>;
    /**
     * Enable/disable bypassing interface's outbound bandwidth setting. Valid values: `disable`, `enable`.
     */
    readonly updateOutbandwidth: pulumi.Output<string>;
    /**
     * Maximum uploading bandwidth (kbps) to be used in a speed test.
     */
    readonly updateOutbandwidthMaximum: pulumi.Output<number>;
    /**
     * Minimum uploading bandwidth (kbps) to be considered effective.
     */
    readonly updateOutbandwidthMinimum: pulumi.Output<number>;
    /**
     * Set egress shaper based on the test result. Valid values: `disable`, `local`, `remote`, `both`.
     */
    readonly updateShaper: pulumi.Output<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.
     */
    readonly vdomparam: pulumi.Output<string>;
    /**
     * Create a Speedtestschedule 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?: SpeedtestscheduleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Speedtestschedule resources.
 */
export interface SpeedtestscheduleState {
    /**
     * Port of the controller to get access token.
     */
    ctrlPort?: pulumi.Input<number>;
    /**
     * DSCP used for speed test.
     */
    diffserv?: pulumi.Input<string>;
    /**
     * Enable/disable dynamic server option. Valid values: `disable`, `enable`.
     */
    dynamicServer?: pulumi.Input<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 ].
     */
    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>;
    /**
     * Interface name.
     */
    interface?: pulumi.Input<string>;
    /**
     * Protocol Auto(default), TCP or UDP used for speed test. Valid values: `UDP`, `TCP`, `Auto`.
     */
    mode?: pulumi.Input<string>;
    /**
     * Schedules for the interface. The structure of `schedules` block is documented below.
     */
    schedules?: pulumi.Input<pulumi.Input<inputs.system.SpeedtestscheduleSchedule>[]>;
    /**
     * Speed test server name.
     */
    serverName?: pulumi.Input<string>;
    /**
     * Port of the server to run speed test.
     */
    serverPort?: pulumi.Input<number>;
    /**
     * Enable/disable scheduled speed test. Valid values: `disable`, `enable`.
     */
    status?: pulumi.Input<string>;
    /**
     * Enable/disable bypassing interface's inbound bandwidth setting. Valid values: `disable`, `enable`.
     */
    updateInbandwidth?: pulumi.Input<string>;
    /**
     * Maximum downloading bandwidth (kbps) to be used in a speed test.
     */
    updateInbandwidthMaximum?: pulumi.Input<number>;
    /**
     * Minimum downloading bandwidth (kbps) to be considered effective.
     */
    updateInbandwidthMinimum?: pulumi.Input<number>;
    /**
     * Enable/disable bypassing interface's outbound bandwidth setting. Valid values: `disable`, `enable`.
     */
    updateOutbandwidth?: pulumi.Input<string>;
    /**
     * Maximum uploading bandwidth (kbps) to be used in a speed test.
     */
    updateOutbandwidthMaximum?: pulumi.Input<number>;
    /**
     * Minimum uploading bandwidth (kbps) to be considered effective.
     */
    updateOutbandwidthMinimum?: pulumi.Input<number>;
    /**
     * Set egress shaper based on the test result. Valid values: `disable`, `local`, `remote`, `both`.
     */
    updateShaper?: pulumi.Input<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.
     */
    vdomparam?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Speedtestschedule resource.
 */
export interface SpeedtestscheduleArgs {
    /**
     * Port of the controller to get access token.
     */
    ctrlPort?: pulumi.Input<number>;
    /**
     * DSCP used for speed test.
     */
    diffserv?: pulumi.Input<string>;
    /**
     * Enable/disable dynamic server option. Valid values: `disable`, `enable`.
     */
    dynamicServer?: pulumi.Input<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 ].
     */
    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>;
    /**
     * Interface name.
     */
    interface?: pulumi.Input<string>;
    /**
     * Protocol Auto(default), TCP or UDP used for speed test. Valid values: `UDP`, `TCP`, `Auto`.
     */
    mode?: pulumi.Input<string>;
    /**
     * Schedules for the interface. The structure of `schedules` block is documented below.
     */
    schedules?: pulumi.Input<pulumi.Input<inputs.system.SpeedtestscheduleSchedule>[]>;
    /**
     * Speed test server name.
     */
    serverName?: pulumi.Input<string>;
    /**
     * Port of the server to run speed test.
     */
    serverPort?: pulumi.Input<number>;
    /**
     * Enable/disable scheduled speed test. Valid values: `disable`, `enable`.
     */
    status?: pulumi.Input<string>;
    /**
     * Enable/disable bypassing interface's inbound bandwidth setting. Valid values: `disable`, `enable`.
     */
    updateInbandwidth?: pulumi.Input<string>;
    /**
     * Maximum downloading bandwidth (kbps) to be used in a speed test.
     */
    updateInbandwidthMaximum?: pulumi.Input<number>;
    /**
     * Minimum downloading bandwidth (kbps) to be considered effective.
     */
    updateInbandwidthMinimum?: pulumi.Input<number>;
    /**
     * Enable/disable bypassing interface's outbound bandwidth setting. Valid values: `disable`, `enable`.
     */
    updateOutbandwidth?: pulumi.Input<string>;
    /**
     * Maximum uploading bandwidth (kbps) to be used in a speed test.
     */
    updateOutbandwidthMaximum?: pulumi.Input<number>;
    /**
     * Minimum uploading bandwidth (kbps) to be considered effective.
     */
    updateOutbandwidthMinimum?: pulumi.Input<number>;
    /**
     * Set egress shaper based on the test result. Valid values: `disable`, `local`, `remote`, `both`.
     */
    updateShaper?: pulumi.Input<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.
     */
    vdomparam?: pulumi.Input<string>;
}