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

fortios.system.Speedtestsetting

Explore with Pulumi AI

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

    Configure speed test setting. Applies to FortiOS Version 7.2.6,7.4.1,7.4.2.

    Create Speedtestsetting Resource

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

    Constructor syntax

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

@overload
def Speedtestsetting(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     latency_threshold: Optional[int] = None,
                     multiple_tcp_stream: Optional[int] = None,
                     vdomparam: Optional[str] = None)
    func NewSpeedtestsetting(ctx *Context, name string, args *SpeedtestsettingArgs, opts ...ResourceOption) (*Speedtestsetting, error)
    public Speedtestsetting(string name, SpeedtestsettingArgs? args = null, CustomResourceOptions? opts = null)
    public Speedtestsetting(String name, SpeedtestsettingArgs args)
public Speedtestsetting(String name, SpeedtestsettingArgs args, CustomResourceOptions options)

    type: fortios:system:Speedtestsetting
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 SpeedtestsettingArgs
    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 SpeedtestsettingArgs
    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 SpeedtestsettingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SpeedtestsettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SpeedtestsettingArgs
    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 speedtestsettingResource = new Fortios.System.Speedtestsetting("speedtestsettingResource", new()
{
    LatencyThreshold = 0,
    MultipleTcpStream = 0,
    Vdomparam = "string",
});

    example, err := system.NewSpeedtestsetting(ctx, "speedtestsettingResource", &system.SpeedtestsettingArgs{
	LatencyThreshold:  pulumi.Int(0),
	MultipleTcpStream: pulumi.Int(0),
	Vdomparam:         pulumi.String("string"),
})

    var speedtestsettingResource = new Speedtestsetting("speedtestsettingResource", SpeedtestsettingArgs.builder()
    .latencyThreshold(0)
    .multipleTcpStream(0)
    .vdomparam("string")
    .build());

    speedtestsetting_resource = fortios.system.Speedtestsetting("speedtestsettingResource",
    latency_threshold=0,
    multiple_tcp_stream=0,
    vdomparam="string")

    const speedtestsettingResource = new fortios.system.Speedtestsetting("speedtestsettingResource", {
    latencyThreshold: 0,
    multipleTcpStream: 0,
    vdomparam: "string",
});

    type: fortios:system:Speedtestsetting
properties:
    latencyThreshold: 0
    multipleTcpStream: 0
    vdomparam: string

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

    LatencyThreshold int
    Speed test latency threshold in milliseconds (0 - 2000, default = 60) for the Auto mode. If the latency exceeds this threshold, the speed test will use the UDP protocol; otherwise, it will use the TCP protocol.
    MultipleTcpStream int
    Number of parallel client streams (1 - 64, default = 4) for the TCP protocol to run during the speed test.
    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.
    LatencyThreshold int
    Speed test latency threshold in milliseconds (0 - 2000, default = 60) for the Auto mode. If the latency exceeds this threshold, the speed test will use the UDP protocol; otherwise, it will use the TCP protocol.
    MultipleTcpStream int
    Number of parallel client streams (1 - 64, default = 4) for the TCP protocol to run during the speed test.
    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.
    latencyThreshold Integer
    Speed test latency threshold in milliseconds (0 - 2000, default = 60) for the Auto mode. If the latency exceeds this threshold, the speed test will use the UDP protocol; otherwise, it will use the TCP protocol.
    multipleTcpStream Integer
    Number of parallel client streams (1 - 64, default = 4) for the TCP protocol to run during the speed test.
    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.
    latencyThreshold number
    Speed test latency threshold in milliseconds (0 - 2000, default = 60) for the Auto mode. If the latency exceeds this threshold, the speed test will use the UDP protocol; otherwise, it will use the TCP protocol.
    multipleTcpStream number
    Number of parallel client streams (1 - 64, default = 4) for the TCP protocol to run during the speed test.
    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.
    latency_threshold int
    Speed test latency threshold in milliseconds (0 - 2000, default = 60) for the Auto mode. If the latency exceeds this threshold, the speed test will use the UDP protocol; otherwise, it will use the TCP protocol.
    multiple_tcp_stream int
    Number of parallel client streams (1 - 64, default = 4) for the TCP protocol to run during the speed test.
    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.
    latencyThreshold Number
    Speed test latency threshold in milliseconds (0 - 2000, default = 60) for the Auto mode. If the latency exceeds this threshold, the speed test will use the UDP protocol; otherwise, it will use the TCP protocol.
    multipleTcpStream Number
    Number of parallel client streams (1 - 64, default = 4) for the TCP protocol to run during the speed test.
    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 Speedtestsetting 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 Speedtestsetting Resource

    Get an existing Speedtestsetting 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?: SpeedtestsettingState, opts?: CustomResourceOptions): Speedtestsetting
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        latency_threshold: Optional[int] = None,
        multiple_tcp_stream: Optional[int] = None,
        vdomparam: Optional[str] = None) -> Speedtestsetting
    func GetSpeedtestsetting(ctx *Context, name string, id IDInput, state *SpeedtestsettingState, opts ...ResourceOption) (*Speedtestsetting, error)
    public static Speedtestsetting Get(string name, Input<string> id, SpeedtestsettingState? state, CustomResourceOptions? opts = null)
    public static Speedtestsetting get(String name, Output<String> id, SpeedtestsettingState 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:
    LatencyThreshold int
    Speed test latency threshold in milliseconds (0 - 2000, default = 60) for the Auto mode. If the latency exceeds this threshold, the speed test will use the UDP protocol; otherwise, it will use the TCP protocol.
    MultipleTcpStream int
    Number of parallel client streams (1 - 64, default = 4) for the TCP protocol to run during the speed test.
    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.
    LatencyThreshold int
    Speed test latency threshold in milliseconds (0 - 2000, default = 60) for the Auto mode. If the latency exceeds this threshold, the speed test will use the UDP protocol; otherwise, it will use the TCP protocol.
    MultipleTcpStream int
    Number of parallel client streams (1 - 64, default = 4) for the TCP protocol to run during the speed test.
    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.
    latencyThreshold Integer
    Speed test latency threshold in milliseconds (0 - 2000, default = 60) for the Auto mode. If the latency exceeds this threshold, the speed test will use the UDP protocol; otherwise, it will use the TCP protocol.
    multipleTcpStream Integer
    Number of parallel client streams (1 - 64, default = 4) for the TCP protocol to run during the speed test.
    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.
    latencyThreshold number
    Speed test latency threshold in milliseconds (0 - 2000, default = 60) for the Auto mode. If the latency exceeds this threshold, the speed test will use the UDP protocol; otherwise, it will use the TCP protocol.
    multipleTcpStream number
    Number of parallel client streams (1 - 64, default = 4) for the TCP protocol to run during the speed test.
    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.
    latency_threshold int
    Speed test latency threshold in milliseconds (0 - 2000, default = 60) for the Auto mode. If the latency exceeds this threshold, the speed test will use the UDP protocol; otherwise, it will use the TCP protocol.
    multiple_tcp_stream int
    Number of parallel client streams (1 - 64, default = 4) for the TCP protocol to run during the speed test.
    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.
    latencyThreshold Number
    Speed test latency threshold in milliseconds (0 - 2000, default = 60) for the Auto mode. If the latency exceeds this threshold, the speed test will use the UDP protocol; otherwise, it will use the TCP protocol.
    multipleTcpStream Number
    Number of parallel client streams (1 - 64, default = 4) for the TCP protocol to run during the speed test.
    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.

    Import

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

    $ pulumi import fortios:system/speedtestsetting:Speedtestsetting labelname SystemSpeedTestSetting

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/speedtestsetting:Speedtestsetting labelname SystemSpeedTestSetting

    $ 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