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

fortios.firewall/shaper.Trafficshaper

Explore with Pulumi AI

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

Configure shared traffic shaper.

Example Usage

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

const trname = new fortios.firewall.shaper.Trafficshaper("trname", {
    bandwidthUnit: "kbps",
    diffserv: "disable",
    diffservcode: "000000",
    guaranteedBandwidth: 0,
    maximumBandwidth: 1024,
    perPolicy: "disable",
    priority: "low",
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.firewall.shaper.Trafficshaper("trname",
    bandwidth_unit="kbps",
    diffserv="disable",
    diffservcode="000000",
    guaranteed_bandwidth=0,
    maximum_bandwidth=1024,
    per_policy="disable",
    priority="low")
Copy
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.NewTrafficshaper(ctx, "trname", &firewall.TrafficshaperArgs{
			BandwidthUnit:       pulumi.String("kbps"),
			Diffserv:            pulumi.String("disable"),
			Diffservcode:        pulumi.String("000000"),
			GuaranteedBandwidth: pulumi.Int(0),
			MaximumBandwidth:    pulumi.Int(1024),
			PerPolicy:           pulumi.String("disable"),
			Priority:            pulumi.String("low"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.Firewall.Shaper.Trafficshaper("trname", new()
    {
        BandwidthUnit = "kbps",
        Diffserv = "disable",
        Diffservcode = "000000",
        GuaranteedBandwidth = 0,
        MaximumBandwidth = 1024,
        PerPolicy = "disable",
        Priority = "low",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.firewall.Trafficshaper;
import com.pulumi.fortios.firewall.TrafficshaperArgs;
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 Trafficshaper("trname", TrafficshaperArgs.builder()
            .bandwidthUnit("kbps")
            .diffserv("disable")
            .diffservcode("000000")
            .guaranteedBandwidth(0)
            .maximumBandwidth(1024)
            .perPolicy("disable")
            .priority("low")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:firewall/shaper:Trafficshaper
    properties:
      bandwidthUnit: kbps
      diffserv: disable
      diffservcode: '000000'
      guaranteedBandwidth: 0
      maximumBandwidth: 1024
      perPolicy: disable
      priority: low
Copy

Create Trafficshaper Resource

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

Constructor syntax

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

@overload
def Trafficshaper(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  bandwidth_unit: Optional[str] = None,
                  cos: Optional[str] = None,
                  cos_marking: Optional[str] = None,
                  cos_marking_method: Optional[str] = None,
                  diffserv: Optional[str] = None,
                  diffservcode: Optional[str] = None,
                  dscp_marking_method: Optional[str] = None,
                  exceed_bandwidth: Optional[int] = None,
                  exceed_class_id: Optional[int] = None,
                  exceed_cos: Optional[str] = None,
                  exceed_dscp: Optional[str] = None,
                  guaranteed_bandwidth: Optional[int] = None,
                  maximum_bandwidth: Optional[int] = None,
                  maximum_cos: Optional[str] = None,
                  maximum_dscp: Optional[str] = None,
                  name: Optional[str] = None,
                  overhead: Optional[int] = None,
                  per_policy: Optional[str] = None,
                  priority: Optional[str] = None,
                  vdomparam: Optional[str] = None)
func NewTrafficshaper(ctx *Context, name string, args *TrafficshaperArgs, opts ...ResourceOption) (*Trafficshaper, error)
public Trafficshaper(string name, TrafficshaperArgs? args = null, CustomResourceOptions? opts = null)
public Trafficshaper(String name, TrafficshaperArgs args)
public Trafficshaper(String name, TrafficshaperArgs args, CustomResourceOptions options)

type: fortios:firewall/shaper/trafficshaper:Trafficshaper
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args TrafficshaperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args TrafficshaperArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args TrafficshaperArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args TrafficshaperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TrafficshaperArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

BandwidthUnit string
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
Cos string
VLAN CoS mark.
CosMarking string
Enable/disable VLAN CoS marking. Valid values: enable, disable.
CosMarkingMethod string
Select VLAN CoS marking method. Valid values: multi-stage, static.
Diffserv string
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: enable, disable.
Diffservcode string
DiffServ setting to be applied to traffic accepted by this shaper.
DscpMarkingMethod string
Select DSCP marking method. Valid values: multi-stage, static.
ExceedBandwidth int
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
ExceedClassId int
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
ExceedCos string
VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
ExceedDscp string
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
GuaranteedBandwidth int
Amount of bandwidth guaranteed for this shaper. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
MaximumBandwidth int
Upper bandwidth limit enforced by this shaper. 0 means no limit. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
MaximumCos string
VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
MaximumDscp string
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
Name string
Traffic shaper name.
Overhead int
Per-packet size overhead used in rate computations.
PerPolicy string
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
Priority string
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: low, medium, high.
Vdomparam Changes to this property will trigger replacement. 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.
BandwidthUnit string
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
Cos string
VLAN CoS mark.
CosMarking string
Enable/disable VLAN CoS marking. Valid values: enable, disable.
CosMarkingMethod string
Select VLAN CoS marking method. Valid values: multi-stage, static.
Diffserv string
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: enable, disable.
Diffservcode string
DiffServ setting to be applied to traffic accepted by this shaper.
DscpMarkingMethod string
Select DSCP marking method. Valid values: multi-stage, static.
ExceedBandwidth int
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
ExceedClassId int
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
ExceedCos string
VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
ExceedDscp string
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
GuaranteedBandwidth int
Amount of bandwidth guaranteed for this shaper. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
MaximumBandwidth int
Upper bandwidth limit enforced by this shaper. 0 means no limit. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
MaximumCos string
VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
MaximumDscp string
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
Name string
Traffic shaper name.
Overhead int
Per-packet size overhead used in rate computations.
PerPolicy string
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
Priority string
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: low, medium, high.
Vdomparam Changes to this property will trigger replacement. 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.
bandwidthUnit String
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
cos String
VLAN CoS mark.
cosMarking String
Enable/disable VLAN CoS marking. Valid values: enable, disable.
cosMarkingMethod String
Select VLAN CoS marking method. Valid values: multi-stage, static.
diffserv String
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: enable, disable.
diffservcode String
DiffServ setting to be applied to traffic accepted by this shaper.
dscpMarkingMethod String
Select DSCP marking method. Valid values: multi-stage, static.
exceedBandwidth Integer
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
exceedClassId Integer
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
exceedCos String
VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
exceedDscp String
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
guaranteedBandwidth Integer
Amount of bandwidth guaranteed for this shaper. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximumBandwidth Integer
Upper bandwidth limit enforced by this shaper. 0 means no limit. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximumCos String
VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
maximumDscp String
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
name String
Traffic shaper name.
overhead Integer
Per-packet size overhead used in rate computations.
perPolicy String
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
priority String
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: low, medium, high.
vdomparam Changes to this property will trigger replacement. 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.
bandwidthUnit string
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
cos string
VLAN CoS mark.
cosMarking string
Enable/disable VLAN CoS marking. Valid values: enable, disable.
cosMarkingMethod string
Select VLAN CoS marking method. Valid values: multi-stage, static.
diffserv string
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: enable, disable.
diffservcode string
DiffServ setting to be applied to traffic accepted by this shaper.
dscpMarkingMethod string
Select DSCP marking method. Valid values: multi-stage, static.
exceedBandwidth number
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
exceedClassId number
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
exceedCos string
VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
exceedDscp string
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
guaranteedBandwidth number
Amount of bandwidth guaranteed for this shaper. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximumBandwidth number
Upper bandwidth limit enforced by this shaper. 0 means no limit. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximumCos string
VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
maximumDscp string
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
name string
Traffic shaper name.
overhead number
Per-packet size overhead used in rate computations.
perPolicy string
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
priority string
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: low, medium, high.
vdomparam Changes to this property will trigger replacement. 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.
bandwidth_unit str
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
cos str
VLAN CoS mark.
cos_marking str
Enable/disable VLAN CoS marking. Valid values: enable, disable.
cos_marking_method str
Select VLAN CoS marking method. Valid values: multi-stage, static.
diffserv str
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: enable, disable.
diffservcode str
DiffServ setting to be applied to traffic accepted by this shaper.
dscp_marking_method str
Select DSCP marking method. Valid values: multi-stage, static.
exceed_bandwidth int
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
exceed_class_id int
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
exceed_cos str
VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
exceed_dscp str
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
guaranteed_bandwidth int
Amount of bandwidth guaranteed for this shaper. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximum_bandwidth int
Upper bandwidth limit enforced by this shaper. 0 means no limit. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximum_cos str
VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
maximum_dscp str
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
name str
Traffic shaper name.
overhead int
Per-packet size overhead used in rate computations.
per_policy str
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
priority str
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: low, medium, high.
vdomparam Changes to this property will trigger replacement. 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.
bandwidthUnit String
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
cos String
VLAN CoS mark.
cosMarking String
Enable/disable VLAN CoS marking. Valid values: enable, disable.
cosMarkingMethod String
Select VLAN CoS marking method. Valid values: multi-stage, static.
diffserv String
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: enable, disable.
diffservcode String
DiffServ setting to be applied to traffic accepted by this shaper.
dscpMarkingMethod String
Select DSCP marking method. Valid values: multi-stage, static.
exceedBandwidth Number
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
exceedClassId Number
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
exceedCos String
VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
exceedDscp String
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
guaranteedBandwidth Number
Amount of bandwidth guaranteed for this shaper. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximumBandwidth Number
Upper bandwidth limit enforced by this shaper. 0 means no limit. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximumCos String
VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
maximumDscp String
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
name String
Traffic shaper name.
overhead Number
Per-packet size overhead used in rate computations.
perPolicy String
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
priority String
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: low, medium, high.
vdomparam Changes to this property will trigger replacement. 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 Trafficshaper 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 Trafficshaper Resource

Get an existing Trafficshaper 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?: TrafficshaperState, opts?: CustomResourceOptions): Trafficshaper
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bandwidth_unit: Optional[str] = None,
        cos: Optional[str] = None,
        cos_marking: Optional[str] = None,
        cos_marking_method: Optional[str] = None,
        diffserv: Optional[str] = None,
        diffservcode: Optional[str] = None,
        dscp_marking_method: Optional[str] = None,
        exceed_bandwidth: Optional[int] = None,
        exceed_class_id: Optional[int] = None,
        exceed_cos: Optional[str] = None,
        exceed_dscp: Optional[str] = None,
        guaranteed_bandwidth: Optional[int] = None,
        maximum_bandwidth: Optional[int] = None,
        maximum_cos: Optional[str] = None,
        maximum_dscp: Optional[str] = None,
        name: Optional[str] = None,
        overhead: Optional[int] = None,
        per_policy: Optional[str] = None,
        priority: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Trafficshaper
func GetTrafficshaper(ctx *Context, name string, id IDInput, state *TrafficshaperState, opts ...ResourceOption) (*Trafficshaper, error)
public static Trafficshaper Get(string name, Input<string> id, TrafficshaperState? state, CustomResourceOptions? opts = null)
public static Trafficshaper get(String name, Output<String> id, TrafficshaperState state, CustomResourceOptions options)
resources:  _:    type: fortios:firewall/shaper/trafficshaper:Trafficshaper    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
BandwidthUnit string
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
Cos string
VLAN CoS mark.
CosMarking string
Enable/disable VLAN CoS marking. Valid values: enable, disable.
CosMarkingMethod string
Select VLAN CoS marking method. Valid values: multi-stage, static.
Diffserv string
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: enable, disable.
Diffservcode string
DiffServ setting to be applied to traffic accepted by this shaper.
DscpMarkingMethod string
Select DSCP marking method. Valid values: multi-stage, static.
ExceedBandwidth int
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
ExceedClassId int
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
ExceedCos string
VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
ExceedDscp string
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
GuaranteedBandwidth int
Amount of bandwidth guaranteed for this shaper. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
MaximumBandwidth int
Upper bandwidth limit enforced by this shaper. 0 means no limit. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
MaximumCos string
VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
MaximumDscp string
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
Name string
Traffic shaper name.
Overhead int
Per-packet size overhead used in rate computations.
PerPolicy string
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
Priority string
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: low, medium, high.
Vdomparam Changes to this property will trigger replacement. 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.
BandwidthUnit string
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
Cos string
VLAN CoS mark.
CosMarking string
Enable/disable VLAN CoS marking. Valid values: enable, disable.
CosMarkingMethod string
Select VLAN CoS marking method. Valid values: multi-stage, static.
Diffserv string
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: enable, disable.
Diffservcode string
DiffServ setting to be applied to traffic accepted by this shaper.
DscpMarkingMethod string
Select DSCP marking method. Valid values: multi-stage, static.
ExceedBandwidth int
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
ExceedClassId int
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
ExceedCos string
VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
ExceedDscp string
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
GuaranteedBandwidth int
Amount of bandwidth guaranteed for this shaper. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
MaximumBandwidth int
Upper bandwidth limit enforced by this shaper. 0 means no limit. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
MaximumCos string
VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
MaximumDscp string
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
Name string
Traffic shaper name.
Overhead int
Per-packet size overhead used in rate computations.
PerPolicy string
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
Priority string
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: low, medium, high.
Vdomparam Changes to this property will trigger replacement. 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.
bandwidthUnit String
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
cos String
VLAN CoS mark.
cosMarking String
Enable/disable VLAN CoS marking. Valid values: enable, disable.
cosMarkingMethod String
Select VLAN CoS marking method. Valid values: multi-stage, static.
diffserv String
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: enable, disable.
diffservcode String
DiffServ setting to be applied to traffic accepted by this shaper.
dscpMarkingMethod String
Select DSCP marking method. Valid values: multi-stage, static.
exceedBandwidth Integer
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
exceedClassId Integer
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
exceedCos String
VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
exceedDscp String
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
guaranteedBandwidth Integer
Amount of bandwidth guaranteed for this shaper. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximumBandwidth Integer
Upper bandwidth limit enforced by this shaper. 0 means no limit. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximumCos String
VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
maximumDscp String
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
name String
Traffic shaper name.
overhead Integer
Per-packet size overhead used in rate computations.
perPolicy String
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
priority String
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: low, medium, high.
vdomparam Changes to this property will trigger replacement. 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.
bandwidthUnit string
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
cos string
VLAN CoS mark.
cosMarking string
Enable/disable VLAN CoS marking. Valid values: enable, disable.
cosMarkingMethod string
Select VLAN CoS marking method. Valid values: multi-stage, static.
diffserv string
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: enable, disable.
diffservcode string
DiffServ setting to be applied to traffic accepted by this shaper.
dscpMarkingMethod string
Select DSCP marking method. Valid values: multi-stage, static.
exceedBandwidth number
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
exceedClassId number
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
exceedCos string
VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
exceedDscp string
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
guaranteedBandwidth number
Amount of bandwidth guaranteed for this shaper. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximumBandwidth number
Upper bandwidth limit enforced by this shaper. 0 means no limit. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximumCos string
VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
maximumDscp string
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
name string
Traffic shaper name.
overhead number
Per-packet size overhead used in rate computations.
perPolicy string
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
priority string
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: low, medium, high.
vdomparam Changes to this property will trigger replacement. 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.
bandwidth_unit str
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
cos str
VLAN CoS mark.
cos_marking str
Enable/disable VLAN CoS marking. Valid values: enable, disable.
cos_marking_method str
Select VLAN CoS marking method. Valid values: multi-stage, static.
diffserv str
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: enable, disable.
diffservcode str
DiffServ setting to be applied to traffic accepted by this shaper.
dscp_marking_method str
Select DSCP marking method. Valid values: multi-stage, static.
exceed_bandwidth int
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
exceed_class_id int
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
exceed_cos str
VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
exceed_dscp str
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
guaranteed_bandwidth int
Amount of bandwidth guaranteed for this shaper. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximum_bandwidth int
Upper bandwidth limit enforced by this shaper. 0 means no limit. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximum_cos str
VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
maximum_dscp str
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
name str
Traffic shaper name.
overhead int
Per-packet size overhead used in rate computations.
per_policy str
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
priority str
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: low, medium, high.
vdomparam Changes to this property will trigger replacement. 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.
bandwidthUnit String
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps). Valid values: kbps, mbps, gbps.
cos String
VLAN CoS mark.
cosMarking String
Enable/disable VLAN CoS marking. Valid values: enable, disable.
cosMarkingMethod String
Select VLAN CoS marking method. Valid values: multi-stage, static.
diffserv String
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Valid values: enable, disable.
diffservcode String
DiffServ setting to be applied to traffic accepted by this shaper.
dscpMarkingMethod String
Select DSCP marking method. Valid values: multi-stage, static.
exceedBandwidth Number
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
exceedClassId Number
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
exceedCos String
VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
exceedDscp String
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
guaranteedBandwidth Number
Amount of bandwidth guaranteed for this shaper. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximumBandwidth Number
Upper bandwidth limit enforced by this shaper. 0 means no limit. Units depend on the bandwidth-unit setting. On FortiOS versions 6.2.0-6.4.2, 7.0.0-7.0.5, 7.2.0: 0 - 16776000. On FortiOS versions 6.4.10-6.4.15, 7.0.6-7.0.15, >= 7.2.1: 0 - 80000000.
maximumCos String
VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
maximumDscp String
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
name String
Traffic shaper name.
overhead Number
Per-packet size overhead used in rate computations.
perPolicy String
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy. Valid values: disable, enable.
priority String
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Valid values: low, medium, high.
vdomparam Changes to this property will trigger replacement. 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

FirewallShaper TrafficShaper can be imported using any of these accepted formats:

$ pulumi import fortios:firewall/shaper/trafficshaper:Trafficshaper labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:firewall/shaper/trafficshaper:Trafficshaper labelname {{name}}
Copy

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