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

fortios.firewall.Shapingprofile

Explore with Pulumi AI

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

    Configure shaping profiles.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.firewall.Shapingprofile("trname", {
    defaultClassId: 2,
    profileName: "shapingprofiles1",
    shapingEntries: [{
        classId: 2,
        guaranteedBandwidthPercentage: 33,
        id: 1,
        maximumBandwidthPercentage: 88,
        priority: "high",
    }],
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.firewall.Shapingprofile("trname",
    default_class_id=2,
    profile_name="shapingprofiles1",
    shaping_entries=[fortios.firewall.ShapingprofileShapingEntryArgs(
        class_id=2,
        guaranteed_bandwidth_percentage=33,
        id=1,
        maximum_bandwidth_percentage=88,
        priority="high",
    )])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/firewall"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := firewall.NewShapingprofile(ctx, "trname", &firewall.ShapingprofileArgs{
			DefaultClassId: pulumi.Int(2),
			ProfileName:    pulumi.String("shapingprofiles1"),
			ShapingEntries: firewall.ShapingprofileShapingEntryArray{
				&firewall.ShapingprofileShapingEntryArgs{
					ClassId:                       pulumi.Int(2),
					GuaranteedBandwidthPercentage: pulumi.Int(33),
					Id:                            pulumi.Int(1),
					MaximumBandwidthPercentage:    pulumi.Int(88),
					Priority:                      pulumi.String("high"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.Firewall.Shapingprofile("trname", new()
    {
        DefaultClassId = 2,
        ProfileName = "shapingprofiles1",
        ShapingEntries = new[]
        {
            new Fortios.Firewall.Inputs.ShapingprofileShapingEntryArgs
            {
                ClassId = 2,
                GuaranteedBandwidthPercentage = 33,
                Id = 1,
                MaximumBandwidthPercentage = 88,
                Priority = "high",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.firewall.Shapingprofile;
import com.pulumi.fortios.firewall.ShapingprofileArgs;
import com.pulumi.fortios.firewall.inputs.ShapingprofileShapingEntryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trname = new Shapingprofile("trname", ShapingprofileArgs.builder()
            .defaultClassId(2)
            .profileName("shapingprofiles1")
            .shapingEntries(ShapingprofileShapingEntryArgs.builder()
                .classId(2)
                .guaranteedBandwidthPercentage(33)
                .id(1)
                .maximumBandwidthPercentage(88)
                .priority("high")
                .build())
            .build());

    }
}

    resources:
  trname:
    type: fortios:firewall:Shapingprofile
    properties:
      defaultClassId: 2
      profileName: shapingprofiles1
      shapingEntries:
        - classId: 2
          guaranteedBandwidthPercentage: 33
          id: 1
          maximumBandwidthPercentage: 88
          priority: high

    Create Shapingprofile Resource

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

    Constructor syntax

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

@overload
def Shapingprofile(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   default_class_id: Optional[int] = None,
                   profile_name: Optional[str] = None,
                   comment: Optional[str] = None,
                   dynamic_sort_subtable: Optional[str] = None,
                   get_all_tables: Optional[str] = None,
                   shaping_entries: Optional[Sequence[ShapingprofileShapingEntryArgs]] = None,
                   type: Optional[str] = None,
                   vdomparam: Optional[str] = None)
    func NewShapingprofile(ctx *Context, name string, args ShapingprofileArgs, opts ...ResourceOption) (*Shapingprofile, error)
    public Shapingprofile(string name, ShapingprofileArgs args, CustomResourceOptions? opts = null)
    public Shapingprofile(String name, ShapingprofileArgs args)
public Shapingprofile(String name, ShapingprofileArgs args, CustomResourceOptions options)

    type: fortios:firewall:Shapingprofile
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 ShapingprofileArgs
    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 ShapingprofileArgs
    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 ShapingprofileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ShapingprofileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ShapingprofileArgs
    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 shapingprofileResource = new Fortios.Firewall.Shapingprofile("shapingprofileResource", new()
{
    DefaultClassId = 0,
    ProfileName = "string",
    Comment = "string",
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    ShapingEntries = new[]
    {
        new Fortios.Firewall.Inputs.ShapingprofileShapingEntryArgs
        {
            BurstInMsec = 0,
            CburstInMsec = 0,
            ClassId = 0,
            GuaranteedBandwidthPercentage = 0,
            Id = 0,
            Limit = 0,
            Max = 0,
            MaximumBandwidthPercentage = 0,
            Min = 0,
            Priority = "string",
            RedProbability = 0,
        },
    },
    Type = "string",
    Vdomparam = "string",
});

    example, err := firewall.NewShapingprofile(ctx, "shapingprofileResource", &firewall.ShapingprofileArgs{
	DefaultClassId:      pulumi.Int(0),
	ProfileName:         pulumi.String("string"),
	Comment:             pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	ShapingEntries: firewall.ShapingprofileShapingEntryArray{
		&firewall.ShapingprofileShapingEntryArgs{
			BurstInMsec:                   pulumi.Int(0),
			CburstInMsec:                  pulumi.Int(0),
			ClassId:                       pulumi.Int(0),
			GuaranteedBandwidthPercentage: pulumi.Int(0),
			Id:                            pulumi.Int(0),
			Limit:                         pulumi.Int(0),
			Max:                           pulumi.Int(0),
			MaximumBandwidthPercentage:    pulumi.Int(0),
			Min:                           pulumi.Int(0),
			Priority:                      pulumi.String("string"),
			RedProbability:                pulumi.Int(0),
		},
	},
	Type:      pulumi.String("string"),
	Vdomparam: pulumi.String("string"),
})

    var shapingprofileResource = new Shapingprofile("shapingprofileResource", ShapingprofileArgs.builder()
    .defaultClassId(0)
    .profileName("string")
    .comment("string")
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .shapingEntries(ShapingprofileShapingEntryArgs.builder()
        .burstInMsec(0)
        .cburstInMsec(0)
        .classId(0)
        .guaranteedBandwidthPercentage(0)
        .id(0)
        .limit(0)
        .max(0)
        .maximumBandwidthPercentage(0)
        .min(0)
        .priority("string")
        .redProbability(0)
        .build())
    .type("string")
    .vdomparam("string")
    .build());

    shapingprofile_resource = fortios.firewall.Shapingprofile("shapingprofileResource",
    default_class_id=0,
    profile_name="string",
    comment="string",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    shaping_entries=[{
        "burst_in_msec": 0,
        "cburst_in_msec": 0,
        "class_id": 0,
        "guaranteed_bandwidth_percentage": 0,
        "id": 0,
        "limit": 0,
        "max": 0,
        "maximum_bandwidth_percentage": 0,
        "min": 0,
        "priority": "string",
        "red_probability": 0,
    }],
    type="string",
    vdomparam="string")

    const shapingprofileResource = new fortios.firewall.Shapingprofile("shapingprofileResource", {
    defaultClassId: 0,
    profileName: "string",
    comment: "string",
    dynamicSortSubtable: "string",
    getAllTables: "string",
    shapingEntries: [{
        burstInMsec: 0,
        cburstInMsec: 0,
        classId: 0,
        guaranteedBandwidthPercentage: 0,
        id: 0,
        limit: 0,
        max: 0,
        maximumBandwidthPercentage: 0,
        min: 0,
        priority: "string",
        redProbability: 0,
    }],
    type: "string",
    vdomparam: "string",
});

    type: fortios:firewall:Shapingprofile
properties:
    comment: string
    defaultClassId: 0
    dynamicSortSubtable: string
    getAllTables: string
    profileName: string
    shapingEntries:
        - burstInMsec: 0
          cburstInMsec: 0
          classId: 0
          guaranteedBandwidthPercentage: 0
          id: 0
          limit: 0
          max: 0
          maximumBandwidthPercentage: 0
          min: 0
          priority: string
          redProbability: 0
    type: string
    vdomparam: string

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

    DefaultClassId int
    Default class ID to handle unclassified packets (including all local traffic).
    ProfileName string
    Shaping profile name.
    Comment string
    Comment.
    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.
    ShapingEntries List<Pulumiverse.Fortios.Firewall.Inputs.ShapingprofileShapingEntry>
    Define shaping entries of this shaping profile. The structure of shaping_entries block is documented below.
    Type string
    Select shaping profile type: policing / queuing. Valid values: policing, queuing.
    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.
    DefaultClassId int
    Default class ID to handle unclassified packets (including all local traffic).
    ProfileName string
    Shaping profile name.
    Comment string
    Comment.
    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.
    ShapingEntries []ShapingprofileShapingEntryArgs
    Define shaping entries of this shaping profile. The structure of shaping_entries block is documented below.
    Type string
    Select shaping profile type: policing / queuing. Valid values: policing, queuing.
    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.
    defaultClassId Integer
    Default class ID to handle unclassified packets (including all local traffic).
    profileName String
    Shaping profile name.
    comment String
    Comment.
    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.
    shapingEntries List<ShapingprofileShapingEntry>
    Define shaping entries of this shaping profile. The structure of shaping_entries block is documented below.
    type String
    Select shaping profile type: policing / queuing. Valid values: policing, queuing.
    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.
    defaultClassId number
    Default class ID to handle unclassified packets (including all local traffic).
    profileName string
    Shaping profile name.
    comment string
    Comment.
    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.
    shapingEntries ShapingprofileShapingEntry[]
    Define shaping entries of this shaping profile. The structure of shaping_entries block is documented below.
    type string
    Select shaping profile type: policing / queuing. Valid values: policing, queuing.
    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.
    default_class_id int
    Default class ID to handle unclassified packets (including all local traffic).
    profile_name str
    Shaping profile name.
    comment str
    Comment.
    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.
    shaping_entries Sequence[ShapingprofileShapingEntryArgs]
    Define shaping entries of this shaping profile. The structure of shaping_entries block is documented below.
    type str
    Select shaping profile type: policing / queuing. Valid values: policing, queuing.
    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.
    defaultClassId Number
    Default class ID to handle unclassified packets (including all local traffic).
    profileName String
    Shaping profile name.
    comment String
    Comment.
    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.
    shapingEntries List<Property Map>
    Define shaping entries of this shaping profile. The structure of shaping_entries block is documented below.
    type String
    Select shaping profile type: policing / queuing. Valid values: policing, queuing.
    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 Shapingprofile 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 Shapingprofile Resource

    Get an existing Shapingprofile 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?: ShapingprofileState, opts?: CustomResourceOptions): Shapingprofile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        default_class_id: Optional[int] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        profile_name: Optional[str] = None,
        shaping_entries: Optional[Sequence[ShapingprofileShapingEntryArgs]] = None,
        type: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Shapingprofile
    func GetShapingprofile(ctx *Context, name string, id IDInput, state *ShapingprofileState, opts ...ResourceOption) (*Shapingprofile, error)
    public static Shapingprofile Get(string name, Input<string> id, ShapingprofileState? state, CustomResourceOptions? opts = null)
    public static Shapingprofile get(String name, Output<String> id, ShapingprofileState 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:
    Comment string
    Comment.
    DefaultClassId int
    Default class ID to handle unclassified packets (including all local traffic).
    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.
    ProfileName string
    Shaping profile name.
    ShapingEntries List<Pulumiverse.Fortios.Firewall.Inputs.ShapingprofileShapingEntry>
    Define shaping entries of this shaping profile. The structure of shaping_entries block is documented below.
    Type string
    Select shaping profile type: policing / queuing. Valid values: policing, queuing.
    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.
    Comment string
    Comment.
    DefaultClassId int
    Default class ID to handle unclassified packets (including all local traffic).
    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.
    ProfileName string
    Shaping profile name.
    ShapingEntries []ShapingprofileShapingEntryArgs
    Define shaping entries of this shaping profile. The structure of shaping_entries block is documented below.
    Type string
    Select shaping profile type: policing / queuing. Valid values: policing, queuing.
    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.
    comment String
    Comment.
    defaultClassId Integer
    Default class ID to handle unclassified packets (including all local traffic).
    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.
    profileName String
    Shaping profile name.
    shapingEntries List<ShapingprofileShapingEntry>
    Define shaping entries of this shaping profile. The structure of shaping_entries block is documented below.
    type String
    Select shaping profile type: policing / queuing. Valid values: policing, queuing.
    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.
    comment string
    Comment.
    defaultClassId number
    Default class ID to handle unclassified packets (including all local traffic).
    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.
    profileName string
    Shaping profile name.
    shapingEntries ShapingprofileShapingEntry[]
    Define shaping entries of this shaping profile. The structure of shaping_entries block is documented below.
    type string
    Select shaping profile type: policing / queuing. Valid values: policing, queuing.
    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.
    comment str
    Comment.
    default_class_id int
    Default class ID to handle unclassified packets (including all local traffic).
    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.
    profile_name str
    Shaping profile name.
    shaping_entries Sequence[ShapingprofileShapingEntryArgs]
    Define shaping entries of this shaping profile. The structure of shaping_entries block is documented below.
    type str
    Select shaping profile type: policing / queuing. Valid values: policing, queuing.
    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.
    comment String
    Comment.
    defaultClassId Number
    Default class ID to handle unclassified packets (including all local traffic).
    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.
    profileName String
    Shaping profile name.
    shapingEntries List<Property Map>
    Define shaping entries of this shaping profile. The structure of shaping_entries block is documented below.
    type String
    Select shaping profile type: policing / queuing. Valid values: policing, queuing.
    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

    ShapingprofileShapingEntry, ShapingprofileShapingEntryArgs

    BurstInMsec int
    Number of bytes that can be burst at maximum-bandwidth speed. Formula: burst = maximum-bandwidth*burst-in-msec.
    CburstInMsec int
    Number of bytes that can be burst as fast as the interface can transmit. Formula: cburst = maximum-bandwidth*cburst-in-msec.
    ClassId int
    Class ID.
    GuaranteedBandwidthPercentage int
    Guaranteed bandwith in percentage.
    Id int
    ID number.
    Limit int
    Hard limit on the real queue size in packets.
    Max int
    Average queue size in packets at which RED drop probability is maximal.
    MaximumBandwidthPercentage int
    Maximum bandwith in percentage.
    Min int
    Average queue size in packets at which RED drop becomes a possibility.
    Priority string
    Priority.
    RedProbability int
    Maximum probability (in percentage) for RED marking.
    BurstInMsec int
    Number of bytes that can be burst at maximum-bandwidth speed. Formula: burst = maximum-bandwidth*burst-in-msec.
    CburstInMsec int
    Number of bytes that can be burst as fast as the interface can transmit. Formula: cburst = maximum-bandwidth*cburst-in-msec.
    ClassId int
    Class ID.
    GuaranteedBandwidthPercentage int
    Guaranteed bandwith in percentage.
    Id int
    ID number.
    Limit int
    Hard limit on the real queue size in packets.
    Max int
    Average queue size in packets at which RED drop probability is maximal.
    MaximumBandwidthPercentage int
    Maximum bandwith in percentage.
    Min int
    Average queue size in packets at which RED drop becomes a possibility.
    Priority string
    Priority.
    RedProbability int
    Maximum probability (in percentage) for RED marking.
    burstInMsec Integer
    Number of bytes that can be burst at maximum-bandwidth speed. Formula: burst = maximum-bandwidth*burst-in-msec.
    cburstInMsec Integer
    Number of bytes that can be burst as fast as the interface can transmit. Formula: cburst = maximum-bandwidth*cburst-in-msec.
    classId Integer
    Class ID.
    guaranteedBandwidthPercentage Integer
    Guaranteed bandwith in percentage.
    id Integer
    ID number.
    limit Integer
    Hard limit on the real queue size in packets.
    max Integer
    Average queue size in packets at which RED drop probability is maximal.
    maximumBandwidthPercentage Integer
    Maximum bandwith in percentage.
    min Integer
    Average queue size in packets at which RED drop becomes a possibility.
    priority String
    Priority.
    redProbability Integer
    Maximum probability (in percentage) for RED marking.
    burstInMsec number
    Number of bytes that can be burst at maximum-bandwidth speed. Formula: burst = maximum-bandwidth*burst-in-msec.
    cburstInMsec number
    Number of bytes that can be burst as fast as the interface can transmit. Formula: cburst = maximum-bandwidth*cburst-in-msec.
    classId number
    Class ID.
    guaranteedBandwidthPercentage number
    Guaranteed bandwith in percentage.
    id number
    ID number.
    limit number
    Hard limit on the real queue size in packets.
    max number
    Average queue size in packets at which RED drop probability is maximal.
    maximumBandwidthPercentage number
    Maximum bandwith in percentage.
    min number
    Average queue size in packets at which RED drop becomes a possibility.
    priority string
    Priority.
    redProbability number
    Maximum probability (in percentage) for RED marking.
    burst_in_msec int
    Number of bytes that can be burst at maximum-bandwidth speed. Formula: burst = maximum-bandwidth*burst-in-msec.
    cburst_in_msec int
    Number of bytes that can be burst as fast as the interface can transmit. Formula: cburst = maximum-bandwidth*cburst-in-msec.
    class_id int
    Class ID.
    guaranteed_bandwidth_percentage int
    Guaranteed bandwith in percentage.
    id int
    ID number.
    limit int
    Hard limit on the real queue size in packets.
    max int
    Average queue size in packets at which RED drop probability is maximal.
    maximum_bandwidth_percentage int
    Maximum bandwith in percentage.
    min int
    Average queue size in packets at which RED drop becomes a possibility.
    priority str
    Priority.
    red_probability int
    Maximum probability (in percentage) for RED marking.
    burstInMsec Number
    Number of bytes that can be burst at maximum-bandwidth speed. Formula: burst = maximum-bandwidth*burst-in-msec.
    cburstInMsec Number
    Number of bytes that can be burst as fast as the interface can transmit. Formula: cburst = maximum-bandwidth*cburst-in-msec.
    classId Number
    Class ID.
    guaranteedBandwidthPercentage Number
    Guaranteed bandwith in percentage.
    id Number
    ID number.
    limit Number
    Hard limit on the real queue size in packets.
    max Number
    Average queue size in packets at which RED drop probability is maximal.
    maximumBandwidthPercentage Number
    Maximum bandwith in percentage.
    min Number
    Average queue size in packets at which RED drop becomes a possibility.
    priority String
    Priority.
    redProbability Number
    Maximum probability (in percentage) for RED marking.

    Import

    Firewall ShapingProfile can be imported using any of these accepted formats:

    $ pulumi import fortios:firewall/shapingprofile:Shapingprofile labelname {{profile_name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:firewall/shapingprofile:Shapingprofile labelname {{profile_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