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

fortios.system.Speedtestserver

Explore with Pulumi AI

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

    Configure speed test server list. Applies to FortiOS Version >= 6.2.4.

    Create Speedtestserver Resource

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

    Constructor syntax

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

@overload
def Speedtestserver(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    dynamic_sort_subtable: Optional[str] = None,
                    get_all_tables: Optional[str] = None,
                    hosts: Optional[Sequence[SpeedtestserverHostArgs]] = None,
                    name: Optional[str] = None,
                    timestamp: Optional[int] = None,
                    vdomparam: Optional[str] = None)
    func NewSpeedtestserver(ctx *Context, name string, args *SpeedtestserverArgs, opts ...ResourceOption) (*Speedtestserver, error)
    public Speedtestserver(string name, SpeedtestserverArgs? args = null, CustomResourceOptions? opts = null)
    public Speedtestserver(String name, SpeedtestserverArgs args)
public Speedtestserver(String name, SpeedtestserverArgs args, CustomResourceOptions options)

    type: fortios:system:Speedtestserver
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 SpeedtestserverArgs
    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 SpeedtestserverArgs
    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 SpeedtestserverArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SpeedtestserverArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SpeedtestserverArgs
    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 speedtestserverResource = new Fortios.System.Speedtestserver("speedtestserverResource", new()
{
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    Hosts = new[]
    {
        new Fortios.System.Inputs.SpeedtestserverHostArgs
        {
            Distance = 0,
            Id = 0,
            Ip = "string",
            Latitude = "string",
            Longitude = "string",
            Password = "string",
            Port = 0,
            User = "string",
        },
    },
    Name = "string",
    Timestamp = 0,
    Vdomparam = "string",
});

    example, err := system.NewSpeedtestserver(ctx, "speedtestserverResource", &system.SpeedtestserverArgs{
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Hosts: system.SpeedtestserverHostArray{
		&system.SpeedtestserverHostArgs{
			Distance:  pulumi.Int(0),
			Id:        pulumi.Int(0),
			Ip:        pulumi.String("string"),
			Latitude:  pulumi.String("string"),
			Longitude: pulumi.String("string"),
			Password:  pulumi.String("string"),
			Port:      pulumi.Int(0),
			User:      pulumi.String("string"),
		},
	},
	Name:      pulumi.String("string"),
	Timestamp: pulumi.Int(0),
	Vdomparam: pulumi.String("string"),
})

    var speedtestserverResource = new Speedtestserver("speedtestserverResource", SpeedtestserverArgs.builder()
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .hosts(SpeedtestserverHostArgs.builder()
        .distance(0)
        .id(0)
        .ip("string")
        .latitude("string")
        .longitude("string")
        .password("string")
        .port(0)
        .user("string")
        .build())
    .name("string")
    .timestamp(0)
    .vdomparam("string")
    .build());

    speedtestserver_resource = fortios.system.Speedtestserver("speedtestserverResource",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    hosts=[{
        "distance": 0,
        "id": 0,
        "ip": "string",
        "latitude": "string",
        "longitude": "string",
        "password": "string",
        "port": 0,
        "user": "string",
    }],
    name="string",
    timestamp=0,
    vdomparam="string")

    const speedtestserverResource = new fortios.system.Speedtestserver("speedtestserverResource", {
    dynamicSortSubtable: "string",
    getAllTables: "string",
    hosts: [{
        distance: 0,
        id: 0,
        ip: "string",
        latitude: "string",
        longitude: "string",
        password: "string",
        port: 0,
        user: "string",
    }],
    name: "string",
    timestamp: 0,
    vdomparam: "string",
});

    type: fortios:system:Speedtestserver
properties:
    dynamicSortSubtable: string
    getAllTables: string
    hosts:
        - distance: 0
          id: 0
          ip: string
          latitude: string
          longitude: string
          password: string
          port: 0
          user: string
    name: string
    timestamp: 0
    vdomparam: string

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

    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.
    Hosts List<Pulumiverse.Fortios.System.Inputs.SpeedtestserverHost>
    Hosts of the server. The structure of host block is documented below.
    Name string
    Speed test server name.
    Timestamp int
    Speed test server timestamp.
    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.
    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.
    Hosts []SpeedtestserverHostArgs
    Hosts of the server. The structure of host block is documented below.
    Name string
    Speed test server name.
    Timestamp int
    Speed test server timestamp.
    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.
    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.
    hosts List<SpeedtestserverHost>
    Hosts of the server. The structure of host block is documented below.
    name String
    Speed test server name.
    timestamp Integer
    Speed test server timestamp.
    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.
    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.
    hosts SpeedtestserverHost[]
    Hosts of the server. The structure of host block is documented below.
    name string
    Speed test server name.
    timestamp number
    Speed test server timestamp.
    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.
    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.
    hosts Sequence[SpeedtestserverHostArgs]
    Hosts of the server. The structure of host block is documented below.
    name str
    Speed test server name.
    timestamp int
    Speed test server timestamp.
    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.
    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.
    hosts List<Property Map>
    Hosts of the server. The structure of host block is documented below.
    name String
    Speed test server name.
    timestamp Number
    Speed test server timestamp.
    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 Speedtestserver 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 Speedtestserver Resource

    Get an existing Speedtestserver 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?: SpeedtestserverState, opts?: CustomResourceOptions): Speedtestserver
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        hosts: Optional[Sequence[SpeedtestserverHostArgs]] = None,
        name: Optional[str] = None,
        timestamp: Optional[int] = None,
        vdomparam: Optional[str] = None) -> Speedtestserver
    func GetSpeedtestserver(ctx *Context, name string, id IDInput, state *SpeedtestserverState, opts ...ResourceOption) (*Speedtestserver, error)
    public static Speedtestserver Get(string name, Input<string> id, SpeedtestserverState? state, CustomResourceOptions? opts = null)
    public static Speedtestserver get(String name, Output<String> id, SpeedtestserverState 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:
    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.
    Hosts List<Pulumiverse.Fortios.System.Inputs.SpeedtestserverHost>
    Hosts of the server. The structure of host block is documented below.
    Name string
    Speed test server name.
    Timestamp int
    Speed test server timestamp.
    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.
    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.
    Hosts []SpeedtestserverHostArgs
    Hosts of the server. The structure of host block is documented below.
    Name string
    Speed test server name.
    Timestamp int
    Speed test server timestamp.
    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.
    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.
    hosts List<SpeedtestserverHost>
    Hosts of the server. The structure of host block is documented below.
    name String
    Speed test server name.
    timestamp Integer
    Speed test server timestamp.
    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.
    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.
    hosts SpeedtestserverHost[]
    Hosts of the server. The structure of host block is documented below.
    name string
    Speed test server name.
    timestamp number
    Speed test server timestamp.
    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.
    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.
    hosts Sequence[SpeedtestserverHostArgs]
    Hosts of the server. The structure of host block is documented below.
    name str
    Speed test server name.
    timestamp int
    Speed test server timestamp.
    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.
    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.
    hosts List<Property Map>
    Hosts of the server. The structure of host block is documented below.
    name String
    Speed test server name.
    timestamp Number
    Speed test server timestamp.
    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

    SpeedtestserverHost, SpeedtestserverHostArgs

    Distance int
    Speed test host distance.
    Id int
    Server host ID.
    Ip string
    Server host IPv4 address.
    Latitude string
    Speed test host latitude.
    Longitude string
    Speed test host longitude.
    Password string
    Speed test host password.
    Port int
    Server host port number to communicate with client.
    User string
    Speed test host user name.
    Distance int
    Speed test host distance.
    Id int
    Server host ID.
    Ip string
    Server host IPv4 address.
    Latitude string
    Speed test host latitude.
    Longitude string
    Speed test host longitude.
    Password string
    Speed test host password.
    Port int
    Server host port number to communicate with client.
    User string
    Speed test host user name.
    distance Integer
    Speed test host distance.
    id Integer
    Server host ID.
    ip String
    Server host IPv4 address.
    latitude String
    Speed test host latitude.
    longitude String
    Speed test host longitude.
    password String
    Speed test host password.
    port Integer
    Server host port number to communicate with client.
    user String
    Speed test host user name.
    distance number
    Speed test host distance.
    id number
    Server host ID.
    ip string
    Server host IPv4 address.
    latitude string
    Speed test host latitude.
    longitude string
    Speed test host longitude.
    password string
    Speed test host password.
    port number
    Server host port number to communicate with client.
    user string
    Speed test host user name.
    distance int
    Speed test host distance.
    id int
    Server host ID.
    ip str
    Server host IPv4 address.
    latitude str
    Speed test host latitude.
    longitude str
    Speed test host longitude.
    password str
    Speed test host password.
    port int
    Server host port number to communicate with client.
    user str
    Speed test host user name.
    distance Number
    Speed test host distance.
    id Number
    Server host ID.
    ip String
    Server host IPv4 address.
    latitude String
    Speed test host latitude.
    longitude String
    Speed test host longitude.
    password String
    Speed test host password.
    port Number
    Server host port number to communicate with client.
    user String
    Speed test host user name.

    Import

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

    $ pulumi import fortios:system/speedtestserver:Speedtestserver labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/speedtestserver:Speedtestserver labelname {{name}}

    $ 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