Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Speedtestschedule
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.system.Speedtestschedule

Explore with Pulumi AI

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

    Speed test schedule for each interface. Applies to FortiOS Version >= 7.0.0.

    Create Speedtestschedule Resource

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

    Constructor syntax

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

@overload
def Speedtestschedule(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      ctrl_port: Optional[int] = None,
                      diffserv: Optional[str] = None,
                      dynamic_server: Optional[str] = None,
                      dynamic_sort_subtable: Optional[str] = None,
                      get_all_tables: Optional[str] = None,
                      interface: Optional[str] = None,
                      mode: Optional[str] = None,
                      schedules: Optional[Sequence[SpeedtestscheduleScheduleArgs]] = None,
                      server_name: Optional[str] = None,
                      server_port: Optional[int] = None,
                      status: Optional[str] = None,
                      update_inbandwidth: Optional[str] = None,
                      update_inbandwidth_maximum: Optional[int] = None,
                      update_inbandwidth_minimum: Optional[int] = None,
                      update_outbandwidth: Optional[str] = None,
                      update_outbandwidth_maximum: Optional[int] = None,
                      update_outbandwidth_minimum: Optional[int] = None,
                      update_shaper: Optional[str] = None,
                      vdomparam: Optional[str] = None)
    func NewSpeedtestschedule(ctx *Context, name string, args *SpeedtestscheduleArgs, opts ...ResourceOption) (*Speedtestschedule, error)
    public Speedtestschedule(string name, SpeedtestscheduleArgs? args = null, CustomResourceOptions? opts = null)
    public Speedtestschedule(String name, SpeedtestscheduleArgs args)
public Speedtestschedule(String name, SpeedtestscheduleArgs args, CustomResourceOptions options)

    type: fortios:system:Speedtestschedule
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 SpeedtestscheduleArgs
    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 SpeedtestscheduleArgs
    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 SpeedtestscheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SpeedtestscheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SpeedtestscheduleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var speedtestscheduleResource = new Fortios.System.Speedtestschedule("speedtestscheduleResource", new()
{
    CtrlPort = 0,
    Diffserv = "string",
    DynamicServer = "string",
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    Interface = "string",
    Mode = "string",
    Schedules = new[]
    {
        new Fortios.System.Inputs.SpeedtestscheduleScheduleArgs
        {
            Name = "string",
        },
    },
    ServerName = "string",
    ServerPort = 0,
    Status = "string",
    UpdateInbandwidth = "string",
    UpdateInbandwidthMaximum = 0,
    UpdateInbandwidthMinimum = 0,
    UpdateOutbandwidth = "string",
    UpdateOutbandwidthMaximum = 0,
    UpdateOutbandwidthMinimum = 0,
    UpdateShaper = "string",
    Vdomparam = "string",
});

    example, err := system.NewSpeedtestschedule(ctx, "speedtestscheduleResource", &system.SpeedtestscheduleArgs{
	CtrlPort:            pulumi.Int(0),
	Diffserv:            pulumi.String("string"),
	DynamicServer:       pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Interface:           pulumi.String("string"),
	Mode:                pulumi.String("string"),
	Schedules: system.SpeedtestscheduleScheduleArray{
		&system.SpeedtestscheduleScheduleArgs{
			Name: pulumi.String("string"),
		},
	},
	ServerName:                pulumi.String("string"),
	ServerPort:                pulumi.Int(0),
	Status:                    pulumi.String("string"),
	UpdateInbandwidth:         pulumi.String("string"),
	UpdateInbandwidthMaximum:  pulumi.Int(0),
	UpdateInbandwidthMinimum:  pulumi.Int(0),
	UpdateOutbandwidth:        pulumi.String("string"),
	UpdateOutbandwidthMaximum: pulumi.Int(0),
	UpdateOutbandwidthMinimum: pulumi.Int(0),
	UpdateShaper:              pulumi.String("string"),
	Vdomparam:                 pulumi.String("string"),
})

    var speedtestscheduleResource = new Speedtestschedule("speedtestscheduleResource", SpeedtestscheduleArgs.builder()
    .ctrlPort(0)
    .diffserv("string")
    .dynamicServer("string")
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .interface_("string")
    .mode("string")
    .schedules(SpeedtestscheduleScheduleArgs.builder()
        .name("string")
        .build())
    .serverName("string")
    .serverPort(0)
    .status("string")
    .updateInbandwidth("string")
    .updateInbandwidthMaximum(0)
    .updateInbandwidthMinimum(0)
    .updateOutbandwidth("string")
    .updateOutbandwidthMaximum(0)
    .updateOutbandwidthMinimum(0)
    .updateShaper("string")
    .vdomparam("string")
    .build());

    speedtestschedule_resource = fortios.system.Speedtestschedule("speedtestscheduleResource",
    ctrl_port=0,
    diffserv="string",
    dynamic_server="string",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    interface="string",
    mode="string",
    schedules=[{
        "name": "string",
    }],
    server_name="string",
    server_port=0,
    status="string",
    update_inbandwidth="string",
    update_inbandwidth_maximum=0,
    update_inbandwidth_minimum=0,
    update_outbandwidth="string",
    update_outbandwidth_maximum=0,
    update_outbandwidth_minimum=0,
    update_shaper="string",
    vdomparam="string")

    const speedtestscheduleResource = new fortios.system.Speedtestschedule("speedtestscheduleResource", {
    ctrlPort: 0,
    diffserv: "string",
    dynamicServer: "string",
    dynamicSortSubtable: "string",
    getAllTables: "string",
    "interface": "string",
    mode: "string",
    schedules: [{
        name: "string",
    }],
    serverName: "string",
    serverPort: 0,
    status: "string",
    updateInbandwidth: "string",
    updateInbandwidthMaximum: 0,
    updateInbandwidthMinimum: 0,
    updateOutbandwidth: "string",
    updateOutbandwidthMaximum: 0,
    updateOutbandwidthMinimum: 0,
    updateShaper: "string",
    vdomparam: "string",
});

    type: fortios:system:Speedtestschedule
properties:
    ctrlPort: 0
    diffserv: string
    dynamicServer: string
    dynamicSortSubtable: string
    getAllTables: string
    interface: string
    mode: string
    schedules:
        - name: string
    serverName: string
    serverPort: 0
    status: string
    updateInbandwidth: string
    updateInbandwidthMaximum: 0
    updateInbandwidthMinimum: 0
    updateOutbandwidth: string
    updateOutbandwidthMaximum: 0
    updateOutbandwidthMinimum: 0
    updateShaper: string
    vdomparam: string

    Speedtestschedule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Speedtestschedule resource accepts the following input properties:

    CtrlPort int
    Port of the controller to get access token.
    Diffserv string
    DSCP used for speed test.
    DynamicServer string
    Enable/disable dynamic server option. Valid values: disable, enable.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Interface string
    Interface name.
    Mode string
    Protocol Auto(default), TCP or UDP used for speed test. Valid values: UDP, TCP, Auto.
    Schedules List<Pulumiverse.Fortios.System.Inputs.SpeedtestscheduleSchedule>
    Schedules for the interface. The structure of schedules block is documented below.
    ServerName string
    Speed test server name.
    ServerPort int
    Port of the server to run speed test.
    Status string
    Enable/disable scheduled speed test. Valid values: disable, enable.
    UpdateInbandwidth string
    Enable/disable bypassing interface's inbound bandwidth setting. Valid values: disable, enable.
    UpdateInbandwidthMaximum int
    Maximum downloading bandwidth (kbps) to be used in a speed test.
    UpdateInbandwidthMinimum int
    Minimum downloading bandwidth (kbps) to be considered effective.
    UpdateOutbandwidth string
    Enable/disable bypassing interface's outbound bandwidth setting. Valid values: disable, enable.
    UpdateOutbandwidthMaximum int
    Maximum uploading bandwidth (kbps) to be used in a speed test.
    UpdateOutbandwidthMinimum int
    Minimum uploading bandwidth (kbps) to be considered effective.
    UpdateShaper string
    Set egress shaper based on the test result. Valid values: disable, local, remote, both.
    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.
    CtrlPort int
    Port of the controller to get access token.
    Diffserv string
    DSCP used for speed test.
    DynamicServer string
    Enable/disable dynamic server option. Valid values: disable, enable.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Interface string
    Interface name.
    Mode string
    Protocol Auto(default), TCP or UDP used for speed test. Valid values: UDP, TCP, Auto.
    Schedules []SpeedtestscheduleScheduleArgs
    Schedules for the interface. The structure of schedules block is documented below.
    ServerName string
    Speed test server name.
    ServerPort int
    Port of the server to run speed test.
    Status string
    Enable/disable scheduled speed test. Valid values: disable, enable.
    UpdateInbandwidth string
    Enable/disable bypassing interface's inbound bandwidth setting. Valid values: disable, enable.
    UpdateInbandwidthMaximum int
    Maximum downloading bandwidth (kbps) to be used in a speed test.
    UpdateInbandwidthMinimum int
    Minimum downloading bandwidth (kbps) to be considered effective.
    UpdateOutbandwidth string
    Enable/disable bypassing interface's outbound bandwidth setting. Valid values: disable, enable.
    UpdateOutbandwidthMaximum int
    Maximum uploading bandwidth (kbps) to be used in a speed test.
    UpdateOutbandwidthMinimum int
    Minimum uploading bandwidth (kbps) to be considered effective.
    UpdateShaper string
    Set egress shaper based on the test result. Valid values: disable, local, remote, both.
    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.
    ctrlPort Integer
    Port of the controller to get access token.
    diffserv String
    DSCP used for speed test.
    dynamicServer String
    Enable/disable dynamic server option. Valid values: disable, enable.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    interface_ String
    Interface name.
    mode String
    Protocol Auto(default), TCP or UDP used for speed test. Valid values: UDP, TCP, Auto.
    schedules List<SpeedtestscheduleSchedule>
    Schedules for the interface. The structure of schedules block is documented below.
    serverName String
    Speed test server name.
    serverPort Integer
    Port of the server to run speed test.
    status String
    Enable/disable scheduled speed test. Valid values: disable, enable.
    updateInbandwidth String
    Enable/disable bypassing interface's inbound bandwidth setting. Valid values: disable, enable.
    updateInbandwidthMaximum Integer
    Maximum downloading bandwidth (kbps) to be used in a speed test.
    updateInbandwidthMinimum Integer
    Minimum downloading bandwidth (kbps) to be considered effective.
    updateOutbandwidth String
    Enable/disable bypassing interface's outbound bandwidth setting. Valid values: disable, enable.
    updateOutbandwidthMaximum Integer
    Maximum uploading bandwidth (kbps) to be used in a speed test.
    updateOutbandwidthMinimum Integer
    Minimum uploading bandwidth (kbps) to be considered effective.
    updateShaper String
    Set egress shaper based on the test result. Valid values: disable, local, remote, both.
    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.
    ctrlPort number
    Port of the controller to get access token.
    diffserv string
    DSCP used for speed test.
    dynamicServer string
    Enable/disable dynamic server option. Valid values: disable, enable.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    interface string
    Interface name.
    mode string
    Protocol Auto(default), TCP or UDP used for speed test. Valid values: UDP, TCP, Auto.
    schedules SpeedtestscheduleSchedule[]
    Schedules for the interface. The structure of schedules block is documented below.
    serverName string
    Speed test server name.
    serverPort number
    Port of the server to run speed test.
    status string
    Enable/disable scheduled speed test. Valid values: disable, enable.
    updateInbandwidth string
    Enable/disable bypassing interface's inbound bandwidth setting. Valid values: disable, enable.
    updateInbandwidthMaximum number
    Maximum downloading bandwidth (kbps) to be used in a speed test.
    updateInbandwidthMinimum number
    Minimum downloading bandwidth (kbps) to be considered effective.
    updateOutbandwidth string
    Enable/disable bypassing interface's outbound bandwidth setting. Valid values: disable, enable.
    updateOutbandwidthMaximum number
    Maximum uploading bandwidth (kbps) to be used in a speed test.
    updateOutbandwidthMinimum number
    Minimum uploading bandwidth (kbps) to be considered effective.
    updateShaper string
    Set egress shaper based on the test result. Valid values: disable, local, remote, both.
    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.
    ctrl_port int
    Port of the controller to get access token.
    diffserv str
    DSCP used for speed test.
    dynamic_server str
    Enable/disable dynamic server option. Valid values: disable, enable.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    interface str
    Interface name.
    mode str
    Protocol Auto(default), TCP or UDP used for speed test. Valid values: UDP, TCP, Auto.
    schedules Sequence[SpeedtestscheduleScheduleArgs]
    Schedules for the interface. The structure of schedules block is documented below.
    server_name str
    Speed test server name.
    server_port int
    Port of the server to run speed test.
    status str
    Enable/disable scheduled speed test. Valid values: disable, enable.
    update_inbandwidth str
    Enable/disable bypassing interface's inbound bandwidth setting. Valid values: disable, enable.
    update_inbandwidth_maximum int
    Maximum downloading bandwidth (kbps) to be used in a speed test.
    update_inbandwidth_minimum int
    Minimum downloading bandwidth (kbps) to be considered effective.
    update_outbandwidth str
    Enable/disable bypassing interface's outbound bandwidth setting. Valid values: disable, enable.
    update_outbandwidth_maximum int
    Maximum uploading bandwidth (kbps) to be used in a speed test.
    update_outbandwidth_minimum int
    Minimum uploading bandwidth (kbps) to be considered effective.
    update_shaper str
    Set egress shaper based on the test result. Valid values: disable, local, remote, both.
    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.
    ctrlPort Number
    Port of the controller to get access token.
    diffserv String
    DSCP used for speed test.
    dynamicServer String
    Enable/disable dynamic server option. Valid values: disable, enable.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    interface String
    Interface name.
    mode String
    Protocol Auto(default), TCP or UDP used for speed test. Valid values: UDP, TCP, Auto.
    schedules List<Property Map>
    Schedules for the interface. The structure of schedules block is documented below.
    serverName String
    Speed test server name.
    serverPort Number
    Port of the server to run speed test.
    status String
    Enable/disable scheduled speed test. Valid values: disable, enable.
    updateInbandwidth String
    Enable/disable bypassing interface's inbound bandwidth setting. Valid values: disable, enable.
    updateInbandwidthMaximum Number
    Maximum downloading bandwidth (kbps) to be used in a speed test.
    updateInbandwidthMinimum Number
    Minimum downloading bandwidth (kbps) to be considered effective.
    updateOutbandwidth String
    Enable/disable bypassing interface's outbound bandwidth setting. Valid values: disable, enable.
    updateOutbandwidthMaximum Number
    Maximum uploading bandwidth (kbps) to be used in a speed test.
    updateOutbandwidthMinimum Number
    Minimum uploading bandwidth (kbps) to be considered effective.
    updateShaper String
    Set egress shaper based on the test result. Valid values: disable, local, remote, both.
    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 Speedtestschedule 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 Speedtestschedule Resource

    Get an existing Speedtestschedule 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?: SpeedtestscheduleState, opts?: CustomResourceOptions): Speedtestschedule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ctrl_port: Optional[int] = None,
        diffserv: Optional[str] = None,
        dynamic_server: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        interface: Optional[str] = None,
        mode: Optional[str] = None,
        schedules: Optional[Sequence[SpeedtestscheduleScheduleArgs]] = None,
        server_name: Optional[str] = None,
        server_port: Optional[int] = None,
        status: Optional[str] = None,
        update_inbandwidth: Optional[str] = None,
        update_inbandwidth_maximum: Optional[int] = None,
        update_inbandwidth_minimum: Optional[int] = None,
        update_outbandwidth: Optional[str] = None,
        update_outbandwidth_maximum: Optional[int] = None,
        update_outbandwidth_minimum: Optional[int] = None,
        update_shaper: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Speedtestschedule
    func GetSpeedtestschedule(ctx *Context, name string, id IDInput, state *SpeedtestscheduleState, opts ...ResourceOption) (*Speedtestschedule, error)
    public static Speedtestschedule Get(string name, Input<string> id, SpeedtestscheduleState? state, CustomResourceOptions? opts = null)
    public static Speedtestschedule get(String name, Output<String> id, SpeedtestscheduleState 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:
    CtrlPort int
    Port of the controller to get access token.
    Diffserv string
    DSCP used for speed test.
    DynamicServer string
    Enable/disable dynamic server option. Valid values: disable, enable.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Interface string
    Interface name.
    Mode string
    Protocol Auto(default), TCP or UDP used for speed test. Valid values: UDP, TCP, Auto.
    Schedules List<Pulumiverse.Fortios.System.Inputs.SpeedtestscheduleSchedule>
    Schedules for the interface. The structure of schedules block is documented below.
    ServerName string
    Speed test server name.
    ServerPort int
    Port of the server to run speed test.
    Status string
    Enable/disable scheduled speed test. Valid values: disable, enable.
    UpdateInbandwidth string
    Enable/disable bypassing interface's inbound bandwidth setting. Valid values: disable, enable.
    UpdateInbandwidthMaximum int
    Maximum downloading bandwidth (kbps) to be used in a speed test.
    UpdateInbandwidthMinimum int
    Minimum downloading bandwidth (kbps) to be considered effective.
    UpdateOutbandwidth string
    Enable/disable bypassing interface's outbound bandwidth setting. Valid values: disable, enable.
    UpdateOutbandwidthMaximum int
    Maximum uploading bandwidth (kbps) to be used in a speed test.
    UpdateOutbandwidthMinimum int
    Minimum uploading bandwidth (kbps) to be considered effective.
    UpdateShaper string
    Set egress shaper based on the test result. Valid values: disable, local, remote, both.
    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.
    CtrlPort int
    Port of the controller to get access token.
    Diffserv string
    DSCP used for speed test.
    DynamicServer string
    Enable/disable dynamic server option. Valid values: disable, enable.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Interface string
    Interface name.
    Mode string
    Protocol Auto(default), TCP or UDP used for speed test. Valid values: UDP, TCP, Auto.
    Schedules []SpeedtestscheduleScheduleArgs
    Schedules for the interface. The structure of schedules block is documented below.
    ServerName string
    Speed test server name.
    ServerPort int
    Port of the server to run speed test.
    Status string
    Enable/disable scheduled speed test. Valid values: disable, enable.
    UpdateInbandwidth string
    Enable/disable bypassing interface's inbound bandwidth setting. Valid values: disable, enable.
    UpdateInbandwidthMaximum int
    Maximum downloading bandwidth (kbps) to be used in a speed test.
    UpdateInbandwidthMinimum int
    Minimum downloading bandwidth (kbps) to be considered effective.
    UpdateOutbandwidth string
    Enable/disable bypassing interface's outbound bandwidth setting. Valid values: disable, enable.
    UpdateOutbandwidthMaximum int
    Maximum uploading bandwidth (kbps) to be used in a speed test.
    UpdateOutbandwidthMinimum int
    Minimum uploading bandwidth (kbps) to be considered effective.
    UpdateShaper string
    Set egress shaper based on the test result. Valid values: disable, local, remote, both.
    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.
    ctrlPort Integer
    Port of the controller to get access token.
    diffserv String
    DSCP used for speed test.
    dynamicServer String
    Enable/disable dynamic server option. Valid values: disable, enable.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    interface_ String
    Interface name.
    mode String
    Protocol Auto(default), TCP or UDP used for speed test. Valid values: UDP, TCP, Auto.
    schedules List<SpeedtestscheduleSchedule>
    Schedules for the interface. The structure of schedules block is documented below.
    serverName String
    Speed test server name.
    serverPort Integer
    Port of the server to run speed test.
    status String
    Enable/disable scheduled speed test. Valid values: disable, enable.
    updateInbandwidth String
    Enable/disable bypassing interface's inbound bandwidth setting. Valid values: disable, enable.
    updateInbandwidthMaximum Integer
    Maximum downloading bandwidth (kbps) to be used in a speed test.
    updateInbandwidthMinimum Integer
    Minimum downloading bandwidth (kbps) to be considered effective.
    updateOutbandwidth String
    Enable/disable bypassing interface's outbound bandwidth setting. Valid values: disable, enable.
    updateOutbandwidthMaximum Integer
    Maximum uploading bandwidth (kbps) to be used in a speed test.
    updateOutbandwidthMinimum Integer
    Minimum uploading bandwidth (kbps) to be considered effective.
    updateShaper String
    Set egress shaper based on the test result. Valid values: disable, local, remote, both.
    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.
    ctrlPort number
    Port of the controller to get access token.
    diffserv string
    DSCP used for speed test.
    dynamicServer string
    Enable/disable dynamic server option. Valid values: disable, enable.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    interface string
    Interface name.
    mode string
    Protocol Auto(default), TCP or UDP used for speed test. Valid values: UDP, TCP, Auto.
    schedules SpeedtestscheduleSchedule[]
    Schedules for the interface. The structure of schedules block is documented below.
    serverName string
    Speed test server name.
    serverPort number
    Port of the server to run speed test.
    status string
    Enable/disable scheduled speed test. Valid values: disable, enable.
    updateInbandwidth string
    Enable/disable bypassing interface's inbound bandwidth setting. Valid values: disable, enable.
    updateInbandwidthMaximum number
    Maximum downloading bandwidth (kbps) to be used in a speed test.
    updateInbandwidthMinimum number
    Minimum downloading bandwidth (kbps) to be considered effective.
    updateOutbandwidth string
    Enable/disable bypassing interface's outbound bandwidth setting. Valid values: disable, enable.
    updateOutbandwidthMaximum number
    Maximum uploading bandwidth (kbps) to be used in a speed test.
    updateOutbandwidthMinimum number
    Minimum uploading bandwidth (kbps) to be considered effective.
    updateShaper string
    Set egress shaper based on the test result. Valid values: disable, local, remote, both.
    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.
    ctrl_port int
    Port of the controller to get access token.
    diffserv str
    DSCP used for speed test.
    dynamic_server str
    Enable/disable dynamic server option. Valid values: disable, enable.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    interface str
    Interface name.
    mode str
    Protocol Auto(default), TCP or UDP used for speed test. Valid values: UDP, TCP, Auto.
    schedules Sequence[SpeedtestscheduleScheduleArgs]
    Schedules for the interface. The structure of schedules block is documented below.
    server_name str
    Speed test server name.
    server_port int
    Port of the server to run speed test.
    status str
    Enable/disable scheduled speed test. Valid values: disable, enable.
    update_inbandwidth str
    Enable/disable bypassing interface's inbound bandwidth setting. Valid values: disable, enable.
    update_inbandwidth_maximum int
    Maximum downloading bandwidth (kbps) to be used in a speed test.
    update_inbandwidth_minimum int
    Minimum downloading bandwidth (kbps) to be considered effective.
    update_outbandwidth str
    Enable/disable bypassing interface's outbound bandwidth setting. Valid values: disable, enable.
    update_outbandwidth_maximum int
    Maximum uploading bandwidth (kbps) to be used in a speed test.
    update_outbandwidth_minimum int
    Minimum uploading bandwidth (kbps) to be considered effective.
    update_shaper str
    Set egress shaper based on the test result. Valid values: disable, local, remote, both.
    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.
    ctrlPort Number
    Port of the controller to get access token.
    diffserv String
    DSCP used for speed test.
    dynamicServer String
    Enable/disable dynamic server option. Valid values: disable, enable.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    interface String
    Interface name.
    mode String
    Protocol Auto(default), TCP or UDP used for speed test. Valid values: UDP, TCP, Auto.
    schedules List<Property Map>
    Schedules for the interface. The structure of schedules block is documented below.
    serverName String
    Speed test server name.
    serverPort Number
    Port of the server to run speed test.
    status String
    Enable/disable scheduled speed test. Valid values: disable, enable.
    updateInbandwidth String
    Enable/disable bypassing interface's inbound bandwidth setting. Valid values: disable, enable.
    updateInbandwidthMaximum Number
    Maximum downloading bandwidth (kbps) to be used in a speed test.
    updateInbandwidthMinimum Number
    Minimum downloading bandwidth (kbps) to be considered effective.
    updateOutbandwidth String
    Enable/disable bypassing interface's outbound bandwidth setting. Valid values: disable, enable.
    updateOutbandwidthMaximum Number
    Maximum uploading bandwidth (kbps) to be used in a speed test.
    updateOutbandwidthMinimum Number
    Minimum uploading bandwidth (kbps) to be considered effective.
    updateShaper String
    Set egress shaper based on the test result. Valid values: disable, local, remote, both.
    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

    SpeedtestscheduleSchedule, SpeedtestscheduleScheduleArgs

    Name string
    Name of a firewall recurring schedule.
    Name string
    Name of a firewall recurring schedule.
    name String
    Name of a firewall recurring schedule.
    name string
    Name of a firewall recurring schedule.
    name str
    Name of a firewall recurring schedule.
    name String
    Name of a firewall recurring schedule.

    Import

    System SpeedTestSchedule can be imported using any of these accepted formats:

    $ pulumi import fortios:system/speedtestschedule:Speedtestschedule labelname {{interface}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/speedtestschedule:Speedtestschedule labelname {{interface}}

    $ 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.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios