1. Packages
  2. Fortios
  3. API Docs
  4. firewall
  5. Shapingpolicy
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.firewall.Shapingpolicy

Explore with Pulumi AI

Configure shaping policies.

Example Usage

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

const trname = new fortios.firewall.Shapingpolicy("trname", {
    classId: 0,
    diffservForward: "disable",
    diffservReverse: "disable",
    diffservcodeForward: "000000",
    diffservcodeRev: "000000",
    dstaddrs: [{
        name: "all",
    }],
    dstintfs: [{
        name: "port4",
    }],
    fosid: 1,
    internetService: "disable",
    internetServiceSrc: "disable",
    ipVersion: "4",
    services: [{
        name: "ALL",
    }],
    srcaddrs: [{
        name: "all",
    }],
    status: "enable",
    tos: "0x00",
    tosMask: "0x00",
    tosNegate: "disable",
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.firewall.Shapingpolicy("trname",
    class_id=0,
    diffserv_forward="disable",
    diffserv_reverse="disable",
    diffservcode_forward="000000",
    diffservcode_rev="000000",
    dstaddrs=[fortios.firewall.ShapingpolicyDstaddrArgs(
        name="all",
    )],
    dstintfs=[fortios.firewall.ShapingpolicyDstintfArgs(
        name="port4",
    )],
    fosid=1,
    internet_service="disable",
    internet_service_src="disable",
    ip_version="4",
    services=[fortios.firewall.ShapingpolicyServiceArgs(
        name="ALL",
    )],
    srcaddrs=[fortios.firewall.ShapingpolicySrcaddrArgs(
        name="all",
    )],
    status="enable",
    tos="0x00",
    tos_mask="0x00",
    tos_negate="disable")
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.NewShapingpolicy(ctx, "trname", &firewall.ShapingpolicyArgs{
			ClassId:             pulumi.Int(0),
			DiffservForward:     pulumi.String("disable"),
			DiffservReverse:     pulumi.String("disable"),
			DiffservcodeForward: pulumi.String("000000"),
			DiffservcodeRev:     pulumi.String("000000"),
			Dstaddrs: firewall.ShapingpolicyDstaddrArray{
				&firewall.ShapingpolicyDstaddrArgs{
					Name: pulumi.String("all"),
				},
			},
			Dstintfs: firewall.ShapingpolicyDstintfArray{
				&firewall.ShapingpolicyDstintfArgs{
					Name: pulumi.String("port4"),
				},
			},
			Fosid:              pulumi.Int(1),
			InternetService:    pulumi.String("disable"),
			InternetServiceSrc: pulumi.String("disable"),
			IpVersion:          pulumi.String("4"),
			Services: firewall.ShapingpolicyServiceArray{
				&firewall.ShapingpolicyServiceArgs{
					Name: pulumi.String("ALL"),
				},
			},
			Srcaddrs: firewall.ShapingpolicySrcaddrArray{
				&firewall.ShapingpolicySrcaddrArgs{
					Name: pulumi.String("all"),
				},
			},
			Status:    pulumi.String("enable"),
			Tos:       pulumi.String("0x00"),
			TosMask:   pulumi.String("0x00"),
			TosNegate: pulumi.String("disable"),
		})
		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.Shapingpolicy("trname", new()
    {
        ClassId = 0,
        DiffservForward = "disable",
        DiffservReverse = "disable",
        DiffservcodeForward = "000000",
        DiffservcodeRev = "000000",
        Dstaddrs = new[]
        {
            new Fortios.Firewall.Inputs.ShapingpolicyDstaddrArgs
            {
                Name = "all",
            },
        },
        Dstintfs = new[]
        {
            new Fortios.Firewall.Inputs.ShapingpolicyDstintfArgs
            {
                Name = "port4",
            },
        },
        Fosid = 1,
        InternetService = "disable",
        InternetServiceSrc = "disable",
        IpVersion = "4",
        Services = new[]
        {
            new Fortios.Firewall.Inputs.ShapingpolicyServiceArgs
            {
                Name = "ALL",
            },
        },
        Srcaddrs = new[]
        {
            new Fortios.Firewall.Inputs.ShapingpolicySrcaddrArgs
            {
                Name = "all",
            },
        },
        Status = "enable",
        Tos = "0x00",
        TosMask = "0x00",
        TosNegate = "disable",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.firewall.Shapingpolicy;
import com.pulumi.fortios.firewall.ShapingpolicyArgs;
import com.pulumi.fortios.firewall.inputs.ShapingpolicyDstaddrArgs;
import com.pulumi.fortios.firewall.inputs.ShapingpolicyDstintfArgs;
import com.pulumi.fortios.firewall.inputs.ShapingpolicyServiceArgs;
import com.pulumi.fortios.firewall.inputs.ShapingpolicySrcaddrArgs;
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 Shapingpolicy("trname", ShapingpolicyArgs.builder()
            .classId(0)
            .diffservForward("disable")
            .diffservReverse("disable")
            .diffservcodeForward("000000")
            .diffservcodeRev("000000")
            .dstaddrs(ShapingpolicyDstaddrArgs.builder()
                .name("all")
                .build())
            .dstintfs(ShapingpolicyDstintfArgs.builder()
                .name("port4")
                .build())
            .fosid(1)
            .internetService("disable")
            .internetServiceSrc("disable")
            .ipVersion("4")
            .services(ShapingpolicyServiceArgs.builder()
                .name("ALL")
                .build())
            .srcaddrs(ShapingpolicySrcaddrArgs.builder()
                .name("all")
                .build())
            .status("enable")
            .tos("0x00")
            .tosMask("0x00")
            .tosNegate("disable")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:firewall:Shapingpolicy
    properties:
      classId: 0
      diffservForward: disable
      diffservReverse: disable
      diffservcodeForward: '000000'
      diffservcodeRev: '000000'
      dstaddrs:
        - name: all
      dstintfs:
        - name: port4
      fosid: 1
      internetService: disable
      internetServiceSrc: disable
      ipVersion: '4'
      services:
        - name: ALL
      srcaddrs:
        - name: all
      status: enable
      tos: 0x00
      tosMask: 0x00
      tosNegate: disable
Copy

Create Shapingpolicy Resource

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

Constructor syntax

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

@overload
def Shapingpolicy(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  dstintfs: Optional[Sequence[ShapingpolicyDstintfArgs]] = None,
                  srcaddrs: Optional[Sequence[ShapingpolicySrcaddrArgs]] = None,
                  dstaddrs: Optional[Sequence[ShapingpolicyDstaddrArgs]] = None,
                  dynamic_sort_subtable: Optional[str] = None,
                  comment: Optional[str] = None,
                  cos: Optional[str] = None,
                  cos_mask: Optional[str] = None,
                  diffserv_forward: Optional[str] = None,
                  diffserv_reverse: Optional[str] = None,
                  diffservcode_forward: Optional[str] = None,
                  diffservcode_rev: Optional[str] = None,
                  dstaddr6s: Optional[Sequence[ShapingpolicyDstaddr6Args]] = None,
                  app_categories: Optional[Sequence[ShapingpolicyAppCategoryArgs]] = None,
                  applications: Optional[Sequence[ShapingpolicyApplicationArgs]] = None,
                  internet_service_src_custom_groups: Optional[Sequence[ShapingpolicyInternetServiceSrcCustomGroupArgs]] = None,
                  fosid: Optional[int] = None,
                  get_all_tables: Optional[str] = None,
                  groups: Optional[Sequence[ShapingpolicyGroupArgs]] = None,
                  internet_service: Optional[str] = None,
                  internet_service_custom_groups: Optional[Sequence[ShapingpolicyInternetServiceCustomGroupArgs]] = None,
                  internet_service_customs: Optional[Sequence[ShapingpolicyInternetServiceCustomArgs]] = None,
                  internet_service_groups: Optional[Sequence[ShapingpolicyInternetServiceGroupArgs]] = None,
                  internet_service_ids: Optional[Sequence[ShapingpolicyInternetServiceIdArgs]] = None,
                  internet_service_names: Optional[Sequence[ShapingpolicyInternetServiceNameArgs]] = None,
                  class_id: Optional[int] = None,
                  internet_service_src: Optional[str] = None,
                  schedule: Optional[str] = None,
                  internet_service_src_groups: Optional[Sequence[ShapingpolicyInternetServiceSrcGroupArgs]] = None,
                  internet_service_src_ids: Optional[Sequence[ShapingpolicyInternetServiceSrcIdArgs]] = None,
                  internet_service_src_names: Optional[Sequence[ShapingpolicyInternetServiceSrcNameArgs]] = None,
                  ip_version: Optional[str] = None,
                  name: Optional[str] = None,
                  per_ip_shaper: Optional[str] = None,
                  internet_service_src_customs: Optional[Sequence[ShapingpolicyInternetServiceSrcCustomArgs]] = None,
                  services: Optional[Sequence[ShapingpolicyServiceArgs]] = None,
                  srcaddr6s: Optional[Sequence[ShapingpolicySrcaddr6Args]] = None,
                  app_groups: Optional[Sequence[ShapingpolicyAppGroupArgs]] = None,
                  srcintfs: Optional[Sequence[ShapingpolicySrcintfArgs]] = None,
                  status: Optional[str] = None,
                  tos: Optional[str] = None,
                  tos_mask: Optional[str] = None,
                  tos_negate: Optional[str] = None,
                  traffic_shaper: Optional[str] = None,
                  traffic_shaper_reverse: Optional[str] = None,
                  traffic_type: Optional[str] = None,
                  url_categories: Optional[Sequence[ShapingpolicyUrlCategoryArgs]] = None,
                  users: Optional[Sequence[ShapingpolicyUserArgs]] = None,
                  uuid: Optional[str] = None,
                  vdomparam: Optional[str] = None)
func NewShapingpolicy(ctx *Context, name string, args ShapingpolicyArgs, opts ...ResourceOption) (*Shapingpolicy, error)
public Shapingpolicy(string name, ShapingpolicyArgs args, CustomResourceOptions? opts = null)
public Shapingpolicy(String name, ShapingpolicyArgs args)
public Shapingpolicy(String name, ShapingpolicyArgs args, CustomResourceOptions options)
type: fortios:firewall:Shapingpolicy
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 This property is required. ShapingpolicyArgs
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 This property is required. ShapingpolicyArgs
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 This property is required. ShapingpolicyArgs
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 This property is required. ShapingpolicyArgs
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. ShapingpolicyArgs
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 shapingpolicyResource = new Fortios.Firewall.Shapingpolicy("shapingpolicyResource", new()
{
    Dstintfs = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyDstintfArgs
        {
            Name = "string",
        },
    },
    Srcaddrs = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicySrcaddrArgs
        {
            Name = "string",
        },
    },
    Dstaddrs = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyDstaddrArgs
        {
            Name = "string",
        },
    },
    DynamicSortSubtable = "string",
    Comment = "string",
    Cos = "string",
    CosMask = "string",
    DiffservForward = "string",
    DiffservReverse = "string",
    DiffservcodeForward = "string",
    DiffservcodeRev = "string",
    Dstaddr6s = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyDstaddr6Args
        {
            Name = "string",
        },
    },
    AppCategories = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyAppCategoryArgs
        {
            Id = 0,
        },
    },
    Applications = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyApplicationArgs
        {
            Id = 0,
        },
    },
    InternetServiceSrcCustomGroups = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcCustomGroupArgs
        {
            Name = "string",
        },
    },
    Fosid = 0,
    GetAllTables = "string",
    Groups = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyGroupArgs
        {
            Name = "string",
        },
    },
    InternetService = "string",
    InternetServiceCustomGroups = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyInternetServiceCustomGroupArgs
        {
            Name = "string",
        },
    },
    InternetServiceCustoms = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyInternetServiceCustomArgs
        {
            Name = "string",
        },
    },
    InternetServiceGroups = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyInternetServiceGroupArgs
        {
            Name = "string",
        },
    },
    InternetServiceIds = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyInternetServiceIdArgs
        {
            Id = 0,
        },
    },
    InternetServiceNames = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyInternetServiceNameArgs
        {
            Name = "string",
        },
    },
    ClassId = 0,
    InternetServiceSrc = "string",
    Schedule = "string",
    InternetServiceSrcGroups = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcGroupArgs
        {
            Name = "string",
        },
    },
    InternetServiceSrcIds = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcIdArgs
        {
            Id = 0,
        },
    },
    InternetServiceSrcNames = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcNameArgs
        {
            Name = "string",
        },
    },
    IpVersion = "string",
    Name = "string",
    PerIpShaper = "string",
    InternetServiceSrcCustoms = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcCustomArgs
        {
            Name = "string",
        },
    },
    Services = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyServiceArgs
        {
            Name = "string",
        },
    },
    Srcaddr6s = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicySrcaddr6Args
        {
            Name = "string",
        },
    },
    AppGroups = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyAppGroupArgs
        {
            Name = "string",
        },
    },
    Srcintfs = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicySrcintfArgs
        {
            Name = "string",
        },
    },
    Status = "string",
    Tos = "string",
    TosMask = "string",
    TosNegate = "string",
    TrafficShaper = "string",
    TrafficShaperReverse = "string",
    TrafficType = "string",
    UrlCategories = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyUrlCategoryArgs
        {
            Id = 0,
        },
    },
    Users = new[]
    {
        new Fortios.Firewall.Inputs.ShapingpolicyUserArgs
        {
            Name = "string",
        },
    },
    Uuid = "string",
    Vdomparam = "string",
});
Copy
example, err := firewall.NewShapingpolicy(ctx, "shapingpolicyResource", &firewall.ShapingpolicyArgs{
	Dstintfs: firewall.ShapingpolicyDstintfArray{
		&firewall.ShapingpolicyDstintfArgs{
			Name: pulumi.String("string"),
		},
	},
	Srcaddrs: firewall.ShapingpolicySrcaddrArray{
		&firewall.ShapingpolicySrcaddrArgs{
			Name: pulumi.String("string"),
		},
	},
	Dstaddrs: firewall.ShapingpolicyDstaddrArray{
		&firewall.ShapingpolicyDstaddrArgs{
			Name: pulumi.String("string"),
		},
	},
	DynamicSortSubtable: pulumi.String("string"),
	Comment:             pulumi.String("string"),
	Cos:                 pulumi.String("string"),
	CosMask:             pulumi.String("string"),
	DiffservForward:     pulumi.String("string"),
	DiffservReverse:     pulumi.String("string"),
	DiffservcodeForward: pulumi.String("string"),
	DiffservcodeRev:     pulumi.String("string"),
	Dstaddr6s: firewall.ShapingpolicyDstaddr6Array{
		&firewall.ShapingpolicyDstaddr6Args{
			Name: pulumi.String("string"),
		},
	},
	AppCategories: firewall.ShapingpolicyAppCategoryArray{
		&firewall.ShapingpolicyAppCategoryArgs{
			Id: pulumi.Int(0),
		},
	},
	Applications: firewall.ShapingpolicyApplicationArray{
		&firewall.ShapingpolicyApplicationArgs{
			Id: pulumi.Int(0),
		},
	},
	InternetServiceSrcCustomGroups: firewall.ShapingpolicyInternetServiceSrcCustomGroupArray{
		&firewall.ShapingpolicyInternetServiceSrcCustomGroupArgs{
			Name: pulumi.String("string"),
		},
	},
	Fosid:        pulumi.Int(0),
	GetAllTables: pulumi.String("string"),
	Groups: firewall.ShapingpolicyGroupArray{
		&firewall.ShapingpolicyGroupArgs{
			Name: pulumi.String("string"),
		},
	},
	InternetService: pulumi.String("string"),
	InternetServiceCustomGroups: firewall.ShapingpolicyInternetServiceCustomGroupArray{
		&firewall.ShapingpolicyInternetServiceCustomGroupArgs{
			Name: pulumi.String("string"),
		},
	},
	InternetServiceCustoms: firewall.ShapingpolicyInternetServiceCustomArray{
		&firewall.ShapingpolicyInternetServiceCustomArgs{
			Name: pulumi.String("string"),
		},
	},
	InternetServiceGroups: firewall.ShapingpolicyInternetServiceGroupArray{
		&firewall.ShapingpolicyInternetServiceGroupArgs{
			Name: pulumi.String("string"),
		},
	},
	InternetServiceIds: firewall.ShapingpolicyInternetServiceIdArray{
		&firewall.ShapingpolicyInternetServiceIdArgs{
			Id: pulumi.Int(0),
		},
	},
	InternetServiceNames: firewall.ShapingpolicyInternetServiceNameArray{
		&firewall.ShapingpolicyInternetServiceNameArgs{
			Name: pulumi.String("string"),
		},
	},
	ClassId:            pulumi.Int(0),
	InternetServiceSrc: pulumi.String("string"),
	Schedule:           pulumi.String("string"),
	InternetServiceSrcGroups: firewall.ShapingpolicyInternetServiceSrcGroupArray{
		&firewall.ShapingpolicyInternetServiceSrcGroupArgs{
			Name: pulumi.String("string"),
		},
	},
	InternetServiceSrcIds: firewall.ShapingpolicyInternetServiceSrcIdArray{
		&firewall.ShapingpolicyInternetServiceSrcIdArgs{
			Id: pulumi.Int(0),
		},
	},
	InternetServiceSrcNames: firewall.ShapingpolicyInternetServiceSrcNameArray{
		&firewall.ShapingpolicyInternetServiceSrcNameArgs{
			Name: pulumi.String("string"),
		},
	},
	IpVersion:   pulumi.String("string"),
	Name:        pulumi.String("string"),
	PerIpShaper: pulumi.String("string"),
	InternetServiceSrcCustoms: firewall.ShapingpolicyInternetServiceSrcCustomArray{
		&firewall.ShapingpolicyInternetServiceSrcCustomArgs{
			Name: pulumi.String("string"),
		},
	},
	Services: firewall.ShapingpolicyServiceArray{
		&firewall.ShapingpolicyServiceArgs{
			Name: pulumi.String("string"),
		},
	},
	Srcaddr6s: firewall.ShapingpolicySrcaddr6Array{
		&firewall.ShapingpolicySrcaddr6Args{
			Name: pulumi.String("string"),
		},
	},
	AppGroups: firewall.ShapingpolicyAppGroupArray{
		&firewall.ShapingpolicyAppGroupArgs{
			Name: pulumi.String("string"),
		},
	},
	Srcintfs: firewall.ShapingpolicySrcintfArray{
		&firewall.ShapingpolicySrcintfArgs{
			Name: pulumi.String("string"),
		},
	},
	Status:               pulumi.String("string"),
	Tos:                  pulumi.String("string"),
	TosMask:              pulumi.String("string"),
	TosNegate:            pulumi.String("string"),
	TrafficShaper:        pulumi.String("string"),
	TrafficShaperReverse: pulumi.String("string"),
	TrafficType:          pulumi.String("string"),
	UrlCategories: firewall.ShapingpolicyUrlCategoryArray{
		&firewall.ShapingpolicyUrlCategoryArgs{
			Id: pulumi.Int(0),
		},
	},
	Users: firewall.ShapingpolicyUserArray{
		&firewall.ShapingpolicyUserArgs{
			Name: pulumi.String("string"),
		},
	},
	Uuid:      pulumi.String("string"),
	Vdomparam: pulumi.String("string"),
})
Copy
var shapingpolicyResource = new Shapingpolicy("shapingpolicyResource", ShapingpolicyArgs.builder()
    .dstintfs(ShapingpolicyDstintfArgs.builder()
        .name("string")
        .build())
    .srcaddrs(ShapingpolicySrcaddrArgs.builder()
        .name("string")
        .build())
    .dstaddrs(ShapingpolicyDstaddrArgs.builder()
        .name("string")
        .build())
    .dynamicSortSubtable("string")
    .comment("string")
    .cos("string")
    .cosMask("string")
    .diffservForward("string")
    .diffservReverse("string")
    .diffservcodeForward("string")
    .diffservcodeRev("string")
    .dstaddr6s(ShapingpolicyDstaddr6Args.builder()
        .name("string")
        .build())
    .appCategories(ShapingpolicyAppCategoryArgs.builder()
        .id(0)
        .build())
    .applications(ShapingpolicyApplicationArgs.builder()
        .id(0)
        .build())
    .internetServiceSrcCustomGroups(ShapingpolicyInternetServiceSrcCustomGroupArgs.builder()
        .name("string")
        .build())
    .fosid(0)
    .getAllTables("string")
    .groups(ShapingpolicyGroupArgs.builder()
        .name("string")
        .build())
    .internetService("string")
    .internetServiceCustomGroups(ShapingpolicyInternetServiceCustomGroupArgs.builder()
        .name("string")
        .build())
    .internetServiceCustoms(ShapingpolicyInternetServiceCustomArgs.builder()
        .name("string")
        .build())
    .internetServiceGroups(ShapingpolicyInternetServiceGroupArgs.builder()
        .name("string")
        .build())
    .internetServiceIds(ShapingpolicyInternetServiceIdArgs.builder()
        .id(0)
        .build())
    .internetServiceNames(ShapingpolicyInternetServiceNameArgs.builder()
        .name("string")
        .build())
    .classId(0)
    .internetServiceSrc("string")
    .schedule("string")
    .internetServiceSrcGroups(ShapingpolicyInternetServiceSrcGroupArgs.builder()
        .name("string")
        .build())
    .internetServiceSrcIds(ShapingpolicyInternetServiceSrcIdArgs.builder()
        .id(0)
        .build())
    .internetServiceSrcNames(ShapingpolicyInternetServiceSrcNameArgs.builder()
        .name("string")
        .build())
    .ipVersion("string")
    .name("string")
    .perIpShaper("string")
    .internetServiceSrcCustoms(ShapingpolicyInternetServiceSrcCustomArgs.builder()
        .name("string")
        .build())
    .services(ShapingpolicyServiceArgs.builder()
        .name("string")
        .build())
    .srcaddr6s(ShapingpolicySrcaddr6Args.builder()
        .name("string")
        .build())
    .appGroups(ShapingpolicyAppGroupArgs.builder()
        .name("string")
        .build())
    .srcintfs(ShapingpolicySrcintfArgs.builder()
        .name("string")
        .build())
    .status("string")
    .tos("string")
    .tosMask("string")
    .tosNegate("string")
    .trafficShaper("string")
    .trafficShaperReverse("string")
    .trafficType("string")
    .urlCategories(ShapingpolicyUrlCategoryArgs.builder()
        .id(0)
        .build())
    .users(ShapingpolicyUserArgs.builder()
        .name("string")
        .build())
    .uuid("string")
    .vdomparam("string")
    .build());
Copy
shapingpolicy_resource = fortios.firewall.Shapingpolicy("shapingpolicyResource",
    dstintfs=[{
        "name": "string",
    }],
    srcaddrs=[{
        "name": "string",
    }],
    dstaddrs=[{
        "name": "string",
    }],
    dynamic_sort_subtable="string",
    comment="string",
    cos="string",
    cos_mask="string",
    diffserv_forward="string",
    diffserv_reverse="string",
    diffservcode_forward="string",
    diffservcode_rev="string",
    dstaddr6s=[{
        "name": "string",
    }],
    app_categories=[{
        "id": 0,
    }],
    applications=[{
        "id": 0,
    }],
    internet_service_src_custom_groups=[{
        "name": "string",
    }],
    fosid=0,
    get_all_tables="string",
    groups=[{
        "name": "string",
    }],
    internet_service="string",
    internet_service_custom_groups=[{
        "name": "string",
    }],
    internet_service_customs=[{
        "name": "string",
    }],
    internet_service_groups=[{
        "name": "string",
    }],
    internet_service_ids=[{
        "id": 0,
    }],
    internet_service_names=[{
        "name": "string",
    }],
    class_id=0,
    internet_service_src="string",
    schedule="string",
    internet_service_src_groups=[{
        "name": "string",
    }],
    internet_service_src_ids=[{
        "id": 0,
    }],
    internet_service_src_names=[{
        "name": "string",
    }],
    ip_version="string",
    name="string",
    per_ip_shaper="string",
    internet_service_src_customs=[{
        "name": "string",
    }],
    services=[{
        "name": "string",
    }],
    srcaddr6s=[{
        "name": "string",
    }],
    app_groups=[{
        "name": "string",
    }],
    srcintfs=[{
        "name": "string",
    }],
    status="string",
    tos="string",
    tos_mask="string",
    tos_negate="string",
    traffic_shaper="string",
    traffic_shaper_reverse="string",
    traffic_type="string",
    url_categories=[{
        "id": 0,
    }],
    users=[{
        "name": "string",
    }],
    uuid="string",
    vdomparam="string")
Copy
const shapingpolicyResource = new fortios.firewall.Shapingpolicy("shapingpolicyResource", {
    dstintfs: [{
        name: "string",
    }],
    srcaddrs: [{
        name: "string",
    }],
    dstaddrs: [{
        name: "string",
    }],
    dynamicSortSubtable: "string",
    comment: "string",
    cos: "string",
    cosMask: "string",
    diffservForward: "string",
    diffservReverse: "string",
    diffservcodeForward: "string",
    diffservcodeRev: "string",
    dstaddr6s: [{
        name: "string",
    }],
    appCategories: [{
        id: 0,
    }],
    applications: [{
        id: 0,
    }],
    internetServiceSrcCustomGroups: [{
        name: "string",
    }],
    fosid: 0,
    getAllTables: "string",
    groups: [{
        name: "string",
    }],
    internetService: "string",
    internetServiceCustomGroups: [{
        name: "string",
    }],
    internetServiceCustoms: [{
        name: "string",
    }],
    internetServiceGroups: [{
        name: "string",
    }],
    internetServiceIds: [{
        id: 0,
    }],
    internetServiceNames: [{
        name: "string",
    }],
    classId: 0,
    internetServiceSrc: "string",
    schedule: "string",
    internetServiceSrcGroups: [{
        name: "string",
    }],
    internetServiceSrcIds: [{
        id: 0,
    }],
    internetServiceSrcNames: [{
        name: "string",
    }],
    ipVersion: "string",
    name: "string",
    perIpShaper: "string",
    internetServiceSrcCustoms: [{
        name: "string",
    }],
    services: [{
        name: "string",
    }],
    srcaddr6s: [{
        name: "string",
    }],
    appGroups: [{
        name: "string",
    }],
    srcintfs: [{
        name: "string",
    }],
    status: "string",
    tos: "string",
    tosMask: "string",
    tosNegate: "string",
    trafficShaper: "string",
    trafficShaperReverse: "string",
    trafficType: "string",
    urlCategories: [{
        id: 0,
    }],
    users: [{
        name: "string",
    }],
    uuid: "string",
    vdomparam: "string",
});
Copy
type: fortios:firewall:Shapingpolicy
properties:
    appCategories:
        - id: 0
    appGroups:
        - name: string
    applications:
        - id: 0
    classId: 0
    comment: string
    cos: string
    cosMask: string
    diffservForward: string
    diffservReverse: string
    diffservcodeForward: string
    diffservcodeRev: string
    dstaddr6s:
        - name: string
    dstaddrs:
        - name: string
    dstintfs:
        - name: string
    dynamicSortSubtable: string
    fosid: 0
    getAllTables: string
    groups:
        - name: string
    internetService: string
    internetServiceCustomGroups:
        - name: string
    internetServiceCustoms:
        - name: string
    internetServiceGroups:
        - name: string
    internetServiceIds:
        - id: 0
    internetServiceNames:
        - name: string
    internetServiceSrc: string
    internetServiceSrcCustomGroups:
        - name: string
    internetServiceSrcCustoms:
        - name: string
    internetServiceSrcGroups:
        - name: string
    internetServiceSrcIds:
        - id: 0
    internetServiceSrcNames:
        - name: string
    ipVersion: string
    name: string
    perIpShaper: string
    schedule: string
    services:
        - name: string
    srcaddr6s:
        - name: string
    srcaddrs:
        - name: string
    srcintfs:
        - name: string
    status: string
    tos: string
    tosMask: string
    tosNegate: string
    trafficShaper: string
    trafficShaperReverse: string
    trafficType: string
    urlCategories:
        - id: 0
    users:
        - name: string
    uuid: string
    vdomparam: string
Copy

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

Dstintfs This property is required. List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyDstintf>
One or more outgoing (egress) interfaces. The structure of dstintf block is documented below.
Srcaddrs This property is required. List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicySrcaddr>
IPv4 source address and address group names. The structure of srcaddr block is documented below.
AppCategories List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyAppCategory>
IDs of one or more application categories that this shaper applies application control traffic shaping to. The structure of app_category block is documented below.
AppGroups List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyAppGroup>
One or more application group names. The structure of app_group block is documented below.
Applications List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyApplication>
IDs of one or more applications that this shaper applies application control traffic shaping to. The structure of application block is documented below.
ClassId int
Traffic class ID.
Comment string
Comments.
Cos string
VLAN CoS bit pattern.
CosMask string
VLAN CoS evaluated bits.
DiffservForward string
Enable to change packet's DiffServ values to the specified diffservcode-forward value. Valid values: enable, disable.
DiffservReverse string
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value. Valid values: enable, disable.
DiffservcodeForward string
Change packet's DiffServ to this value.
DiffservcodeRev string
Change packet's reverse (reply) DiffServ to this value.
Dstaddr6s List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyDstaddr6>
IPv6 destination address and address group names. The structure of dstaddr6 block is documented below.
Dstaddrs List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyDstaddr>
IPv4 destination address and address group names. The structure of dstaddr block is documented below.
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 ].
Fosid Changes to this property will trigger replacement. int
Shaping policy ID.
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.
Groups List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyGroup>
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. The structure of groups block is documented below.
InternetService string
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Valid values: enable, disable.
InternetServiceCustomGroups List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceCustomGroup>
Custom Internet Service group name. The structure of internet_service_custom_group block is documented below.
InternetServiceCustoms List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceCustom>
Custom Internet Service name. The structure of internet_service_custom block is documented below.
InternetServiceGroups List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceGroup>
Internet Service group name. The structure of internet_service_group block is documented below.
InternetServiceIds List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceId>
Internet Service ID. The structure of internet_service_id block is documented below.
InternetServiceNames List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceName>
Internet Service ID. The structure of internet_service_name block is documented below.
InternetServiceSrc string
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Valid values: enable, disable.
InternetServiceSrcCustomGroups List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcCustomGroup>
Custom Internet Service source group name. The structure of internet_service_src_custom_group block is documented below.
InternetServiceSrcCustoms List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcCustom>
Custom Internet Service source name. The structure of internet_service_src_custom block is documented below.
InternetServiceSrcGroups List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcGroup>
Internet Service source group name. The structure of internet_service_src_group block is documented below.
InternetServiceSrcIds List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcId>
Internet Service source ID. The structure of internet_service_src_id block is documented below.
InternetServiceSrcNames List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcName>
Internet Service source name. The structure of internet_service_src_name block is documented below.
IpVersion string
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Valid values: 4, 6.
Name string
Shaping policy name.
PerIpShaper string
Per-IP traffic shaper to apply with this policy.
Schedule string
Schedule name.
Services List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyService>
Service and service group names. The structure of service block is documented below.
Srcaddr6s List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicySrcaddr6>
IPv6 source address and address group names. The structure of srcaddr6 block is documented below.
Srcintfs List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicySrcintf>
One or more incoming (ingress) interfaces. The structure of srcintf block is documented below.
Status string
Enable/disable this traffic shaping policy. Valid values: enable, disable.
Tos string
ToS (Type of Service) value used for comparison.
TosMask string
Non-zero bit positions are used for comparison while zero bit positions are ignored.
TosNegate string
Enable negated TOS match. Valid values: enable, disable.
TrafficShaper string
Traffic shaper to apply to traffic forwarded by the firewall policy.
TrafficShaperReverse string
Traffic shaper to apply to response traffic received by the firewall policy.
TrafficType string
Traffic type. Valid values: forwarding, local-in, local-out.
UrlCategories List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyUrlCategory>
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. The structure of url_category block is documented below.
Users List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyUser>
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. The structure of users block is documented below.
Uuid string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
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.
Dstintfs This property is required. []ShapingpolicyDstintfArgs
One or more outgoing (egress) interfaces. The structure of dstintf block is documented below.
Srcaddrs This property is required. []ShapingpolicySrcaddrArgs
IPv4 source address and address group names. The structure of srcaddr block is documented below.
AppCategories []ShapingpolicyAppCategoryArgs
IDs of one or more application categories that this shaper applies application control traffic shaping to. The structure of app_category block is documented below.
AppGroups []ShapingpolicyAppGroupArgs
One or more application group names. The structure of app_group block is documented below.
Applications []ShapingpolicyApplicationArgs
IDs of one or more applications that this shaper applies application control traffic shaping to. The structure of application block is documented below.
ClassId int
Traffic class ID.
Comment string
Comments.
Cos string
VLAN CoS bit pattern.
CosMask string
VLAN CoS evaluated bits.
DiffservForward string
Enable to change packet's DiffServ values to the specified diffservcode-forward value. Valid values: enable, disable.
DiffservReverse string
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value. Valid values: enable, disable.
DiffservcodeForward string
Change packet's DiffServ to this value.
DiffservcodeRev string
Change packet's reverse (reply) DiffServ to this value.
Dstaddr6s []ShapingpolicyDstaddr6Args
IPv6 destination address and address group names. The structure of dstaddr6 block is documented below.
Dstaddrs []ShapingpolicyDstaddrArgs
IPv4 destination address and address group names. The structure of dstaddr block is documented below.
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 ].
Fosid Changes to this property will trigger replacement. int
Shaping policy ID.
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.
Groups []ShapingpolicyGroupArgs
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. The structure of groups block is documented below.
InternetService string
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Valid values: enable, disable.
InternetServiceCustomGroups []ShapingpolicyInternetServiceCustomGroupArgs
Custom Internet Service group name. The structure of internet_service_custom_group block is documented below.
InternetServiceCustoms []ShapingpolicyInternetServiceCustomArgs
Custom Internet Service name. The structure of internet_service_custom block is documented below.
InternetServiceGroups []ShapingpolicyInternetServiceGroupArgs
Internet Service group name. The structure of internet_service_group block is documented below.
InternetServiceIds []ShapingpolicyInternetServiceIdArgs
Internet Service ID. The structure of internet_service_id block is documented below.
InternetServiceNames []ShapingpolicyInternetServiceNameArgs
Internet Service ID. The structure of internet_service_name block is documented below.
InternetServiceSrc string
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Valid values: enable, disable.
InternetServiceSrcCustomGroups []ShapingpolicyInternetServiceSrcCustomGroupArgs
Custom Internet Service source group name. The structure of internet_service_src_custom_group block is documented below.
InternetServiceSrcCustoms []ShapingpolicyInternetServiceSrcCustomArgs
Custom Internet Service source name. The structure of internet_service_src_custom block is documented below.
InternetServiceSrcGroups []ShapingpolicyInternetServiceSrcGroupArgs
Internet Service source group name. The structure of internet_service_src_group block is documented below.
InternetServiceSrcIds []ShapingpolicyInternetServiceSrcIdArgs
Internet Service source ID. The structure of internet_service_src_id block is documented below.
InternetServiceSrcNames []ShapingpolicyInternetServiceSrcNameArgs
Internet Service source name. The structure of internet_service_src_name block is documented below.
IpVersion string
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Valid values: 4, 6.
Name string
Shaping policy name.
PerIpShaper string
Per-IP traffic shaper to apply with this policy.
Schedule string
Schedule name.
Services []ShapingpolicyServiceArgs
Service and service group names. The structure of service block is documented below.
Srcaddr6s []ShapingpolicySrcaddr6Args
IPv6 source address and address group names. The structure of srcaddr6 block is documented below.
Srcintfs []ShapingpolicySrcintfArgs
One or more incoming (ingress) interfaces. The structure of srcintf block is documented below.
Status string
Enable/disable this traffic shaping policy. Valid values: enable, disable.
Tos string
ToS (Type of Service) value used for comparison.
TosMask string
Non-zero bit positions are used for comparison while zero bit positions are ignored.
TosNegate string
Enable negated TOS match. Valid values: enable, disable.
TrafficShaper string
Traffic shaper to apply to traffic forwarded by the firewall policy.
TrafficShaperReverse string
Traffic shaper to apply to response traffic received by the firewall policy.
TrafficType string
Traffic type. Valid values: forwarding, local-in, local-out.
UrlCategories []ShapingpolicyUrlCategoryArgs
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. The structure of url_category block is documented below.
Users []ShapingpolicyUserArgs
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. The structure of users block is documented below.
Uuid string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
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.
dstintfs This property is required. List<ShapingpolicyDstintf>
One or more outgoing (egress) interfaces. The structure of dstintf block is documented below.
srcaddrs This property is required. List<ShapingpolicySrcaddr>
IPv4 source address and address group names. The structure of srcaddr block is documented below.
appCategories List<ShapingpolicyAppCategory>
IDs of one or more application categories that this shaper applies application control traffic shaping to. The structure of app_category block is documented below.
appGroups List<ShapingpolicyAppGroup>
One or more application group names. The structure of app_group block is documented below.
applications List<ShapingpolicyApplication>
IDs of one or more applications that this shaper applies application control traffic shaping to. The structure of application block is documented below.
classId Integer
Traffic class ID.
comment String
Comments.
cos String
VLAN CoS bit pattern.
cosMask String
VLAN CoS evaluated bits.
diffservForward String
Enable to change packet's DiffServ values to the specified diffservcode-forward value. Valid values: enable, disable.
diffservReverse String
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value. Valid values: enable, disable.
diffservcodeForward String
Change packet's DiffServ to this value.
diffservcodeRev String
Change packet's reverse (reply) DiffServ to this value.
dstaddr6s List<ShapingpolicyDstaddr6>
IPv6 destination address and address group names. The structure of dstaddr6 block is documented below.
dstaddrs List<ShapingpolicyDstaddr>
IPv4 destination address and address group names. The structure of dstaddr block is documented below.
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 ].
fosid Changes to this property will trigger replacement. Integer
Shaping policy ID.
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.
groups List<ShapingpolicyGroup>
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. The structure of groups block is documented below.
internetService String
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Valid values: enable, disable.
internetServiceCustomGroups List<ShapingpolicyInternetServiceCustomGroup>
Custom Internet Service group name. The structure of internet_service_custom_group block is documented below.
internetServiceCustoms List<ShapingpolicyInternetServiceCustom>
Custom Internet Service name. The structure of internet_service_custom block is documented below.
internetServiceGroups List<ShapingpolicyInternetServiceGroup>
Internet Service group name. The structure of internet_service_group block is documented below.
internetServiceIds List<ShapingpolicyInternetServiceId>
Internet Service ID. The structure of internet_service_id block is documented below.
internetServiceNames List<ShapingpolicyInternetServiceName>
Internet Service ID. The structure of internet_service_name block is documented below.
internetServiceSrc String
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Valid values: enable, disable.
internetServiceSrcCustomGroups List<ShapingpolicyInternetServiceSrcCustomGroup>
Custom Internet Service source group name. The structure of internet_service_src_custom_group block is documented below.
internetServiceSrcCustoms List<ShapingpolicyInternetServiceSrcCustom>
Custom Internet Service source name. The structure of internet_service_src_custom block is documented below.
internetServiceSrcGroups List<ShapingpolicyInternetServiceSrcGroup>
Internet Service source group name. The structure of internet_service_src_group block is documented below.
internetServiceSrcIds List<ShapingpolicyInternetServiceSrcId>
Internet Service source ID. The structure of internet_service_src_id block is documented below.
internetServiceSrcNames List<ShapingpolicyInternetServiceSrcName>
Internet Service source name. The structure of internet_service_src_name block is documented below.
ipVersion String
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Valid values: 4, 6.
name String
Shaping policy name.
perIpShaper String
Per-IP traffic shaper to apply with this policy.
schedule String
Schedule name.
services List<ShapingpolicyService>
Service and service group names. The structure of service block is documented below.
srcaddr6s List<ShapingpolicySrcaddr6>
IPv6 source address and address group names. The structure of srcaddr6 block is documented below.
srcintfs List<ShapingpolicySrcintf>
One or more incoming (ingress) interfaces. The structure of srcintf block is documented below.
status String
Enable/disable this traffic shaping policy. Valid values: enable, disable.
tos String
ToS (Type of Service) value used for comparison.
tosMask String
Non-zero bit positions are used for comparison while zero bit positions are ignored.
tosNegate String
Enable negated TOS match. Valid values: enable, disable.
trafficShaper String
Traffic shaper to apply to traffic forwarded by the firewall policy.
trafficShaperReverse String
Traffic shaper to apply to response traffic received by the firewall policy.
trafficType String
Traffic type. Valid values: forwarding, local-in, local-out.
urlCategories List<ShapingpolicyUrlCategory>
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. The structure of url_category block is documented below.
users List<ShapingpolicyUser>
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. The structure of users block is documented below.
uuid String
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
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.
dstintfs This property is required. ShapingpolicyDstintf[]
One or more outgoing (egress) interfaces. The structure of dstintf block is documented below.
srcaddrs This property is required. ShapingpolicySrcaddr[]
IPv4 source address and address group names. The structure of srcaddr block is documented below.
appCategories ShapingpolicyAppCategory[]
IDs of one or more application categories that this shaper applies application control traffic shaping to. The structure of app_category block is documented below.
appGroups ShapingpolicyAppGroup[]
One or more application group names. The structure of app_group block is documented below.
applications ShapingpolicyApplication[]
IDs of one or more applications that this shaper applies application control traffic shaping to. The structure of application block is documented below.
classId number
Traffic class ID.
comment string
Comments.
cos string
VLAN CoS bit pattern.
cosMask string
VLAN CoS evaluated bits.
diffservForward string
Enable to change packet's DiffServ values to the specified diffservcode-forward value. Valid values: enable, disable.
diffservReverse string
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value. Valid values: enable, disable.
diffservcodeForward string
Change packet's DiffServ to this value.
diffservcodeRev string
Change packet's reverse (reply) DiffServ to this value.
dstaddr6s ShapingpolicyDstaddr6[]
IPv6 destination address and address group names. The structure of dstaddr6 block is documented below.
dstaddrs ShapingpolicyDstaddr[]
IPv4 destination address and address group names. The structure of dstaddr block is documented below.
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 ].
fosid Changes to this property will trigger replacement. number
Shaping policy ID.
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.
groups ShapingpolicyGroup[]
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. The structure of groups block is documented below.
internetService string
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Valid values: enable, disable.
internetServiceCustomGroups ShapingpolicyInternetServiceCustomGroup[]
Custom Internet Service group name. The structure of internet_service_custom_group block is documented below.
internetServiceCustoms ShapingpolicyInternetServiceCustom[]
Custom Internet Service name. The structure of internet_service_custom block is documented below.
internetServiceGroups ShapingpolicyInternetServiceGroup[]
Internet Service group name. The structure of internet_service_group block is documented below.
internetServiceIds ShapingpolicyInternetServiceId[]
Internet Service ID. The structure of internet_service_id block is documented below.
internetServiceNames ShapingpolicyInternetServiceName[]
Internet Service ID. The structure of internet_service_name block is documented below.
internetServiceSrc string
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Valid values: enable, disable.
internetServiceSrcCustomGroups ShapingpolicyInternetServiceSrcCustomGroup[]
Custom Internet Service source group name. The structure of internet_service_src_custom_group block is documented below.
internetServiceSrcCustoms ShapingpolicyInternetServiceSrcCustom[]
Custom Internet Service source name. The structure of internet_service_src_custom block is documented below.
internetServiceSrcGroups ShapingpolicyInternetServiceSrcGroup[]
Internet Service source group name. The structure of internet_service_src_group block is documented below.
internetServiceSrcIds ShapingpolicyInternetServiceSrcId[]
Internet Service source ID. The structure of internet_service_src_id block is documented below.
internetServiceSrcNames ShapingpolicyInternetServiceSrcName[]
Internet Service source name. The structure of internet_service_src_name block is documented below.
ipVersion string
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Valid values: 4, 6.
name string
Shaping policy name.
perIpShaper string
Per-IP traffic shaper to apply with this policy.
schedule string
Schedule name.
services ShapingpolicyService[]
Service and service group names. The structure of service block is documented below.
srcaddr6s ShapingpolicySrcaddr6[]
IPv6 source address and address group names. The structure of srcaddr6 block is documented below.
srcintfs ShapingpolicySrcintf[]
One or more incoming (ingress) interfaces. The structure of srcintf block is documented below.
status string
Enable/disable this traffic shaping policy. Valid values: enable, disable.
tos string
ToS (Type of Service) value used for comparison.
tosMask string
Non-zero bit positions are used for comparison while zero bit positions are ignored.
tosNegate string
Enable negated TOS match. Valid values: enable, disable.
trafficShaper string
Traffic shaper to apply to traffic forwarded by the firewall policy.
trafficShaperReverse string
Traffic shaper to apply to response traffic received by the firewall policy.
trafficType string
Traffic type. Valid values: forwarding, local-in, local-out.
urlCategories ShapingpolicyUrlCategory[]
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. The structure of url_category block is documented below.
users ShapingpolicyUser[]
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. The structure of users block is documented below.
uuid string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
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.
dstintfs This property is required. Sequence[ShapingpolicyDstintfArgs]
One or more outgoing (egress) interfaces. The structure of dstintf block is documented below.
srcaddrs This property is required. Sequence[ShapingpolicySrcaddrArgs]
IPv4 source address and address group names. The structure of srcaddr block is documented below.
app_categories Sequence[ShapingpolicyAppCategoryArgs]
IDs of one or more application categories that this shaper applies application control traffic shaping to. The structure of app_category block is documented below.
app_groups Sequence[ShapingpolicyAppGroupArgs]
One or more application group names. The structure of app_group block is documented below.
applications Sequence[ShapingpolicyApplicationArgs]
IDs of one or more applications that this shaper applies application control traffic shaping to. The structure of application block is documented below.
class_id int
Traffic class ID.
comment str
Comments.
cos str
VLAN CoS bit pattern.
cos_mask str
VLAN CoS evaluated bits.
diffserv_forward str
Enable to change packet's DiffServ values to the specified diffservcode-forward value. Valid values: enable, disable.
diffserv_reverse str
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value. Valid values: enable, disable.
diffservcode_forward str
Change packet's DiffServ to this value.
diffservcode_rev str
Change packet's reverse (reply) DiffServ to this value.
dstaddr6s Sequence[ShapingpolicyDstaddr6Args]
IPv6 destination address and address group names. The structure of dstaddr6 block is documented below.
dstaddrs Sequence[ShapingpolicyDstaddrArgs]
IPv4 destination address and address group names. The structure of dstaddr block is documented below.
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 ].
fosid Changes to this property will trigger replacement. int
Shaping policy ID.
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.
groups Sequence[ShapingpolicyGroupArgs]
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. The structure of groups block is documented below.
internet_service str
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Valid values: enable, disable.
internet_service_custom_groups Sequence[ShapingpolicyInternetServiceCustomGroupArgs]
Custom Internet Service group name. The structure of internet_service_custom_group block is documented below.
internet_service_customs Sequence[ShapingpolicyInternetServiceCustomArgs]
Custom Internet Service name. The structure of internet_service_custom block is documented below.
internet_service_groups Sequence[ShapingpolicyInternetServiceGroupArgs]
Internet Service group name. The structure of internet_service_group block is documented below.
internet_service_ids Sequence[ShapingpolicyInternetServiceIdArgs]
Internet Service ID. The structure of internet_service_id block is documented below.
internet_service_names Sequence[ShapingpolicyInternetServiceNameArgs]
Internet Service ID. The structure of internet_service_name block is documented below.
internet_service_src str
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Valid values: enable, disable.
internet_service_src_custom_groups Sequence[ShapingpolicyInternetServiceSrcCustomGroupArgs]
Custom Internet Service source group name. The structure of internet_service_src_custom_group block is documented below.
internet_service_src_customs Sequence[ShapingpolicyInternetServiceSrcCustomArgs]
Custom Internet Service source name. The structure of internet_service_src_custom block is documented below.
internet_service_src_groups Sequence[ShapingpolicyInternetServiceSrcGroupArgs]
Internet Service source group name. The structure of internet_service_src_group block is documented below.
internet_service_src_ids Sequence[ShapingpolicyInternetServiceSrcIdArgs]
Internet Service source ID. The structure of internet_service_src_id block is documented below.
internet_service_src_names Sequence[ShapingpolicyInternetServiceSrcNameArgs]
Internet Service source name. The structure of internet_service_src_name block is documented below.
ip_version str
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Valid values: 4, 6.
name str
Shaping policy name.
per_ip_shaper str
Per-IP traffic shaper to apply with this policy.
schedule str
Schedule name.
services Sequence[ShapingpolicyServiceArgs]
Service and service group names. The structure of service block is documented below.
srcaddr6s Sequence[ShapingpolicySrcaddr6Args]
IPv6 source address and address group names. The structure of srcaddr6 block is documented below.
srcintfs Sequence[ShapingpolicySrcintfArgs]
One or more incoming (ingress) interfaces. The structure of srcintf block is documented below.
status str
Enable/disable this traffic shaping policy. Valid values: enable, disable.
tos str
ToS (Type of Service) value used for comparison.
tos_mask str
Non-zero bit positions are used for comparison while zero bit positions are ignored.
tos_negate str
Enable negated TOS match. Valid values: enable, disable.
traffic_shaper str
Traffic shaper to apply to traffic forwarded by the firewall policy.
traffic_shaper_reverse str
Traffic shaper to apply to response traffic received by the firewall policy.
traffic_type str
Traffic type. Valid values: forwarding, local-in, local-out.
url_categories Sequence[ShapingpolicyUrlCategoryArgs]
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. The structure of url_category block is documented below.
users Sequence[ShapingpolicyUserArgs]
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. The structure of users block is documented below.
uuid str
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
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.
dstintfs This property is required. List<Property Map>
One or more outgoing (egress) interfaces. The structure of dstintf block is documented below.
srcaddrs This property is required. List<Property Map>
IPv4 source address and address group names. The structure of srcaddr block is documented below.
appCategories List<Property Map>
IDs of one or more application categories that this shaper applies application control traffic shaping to. The structure of app_category block is documented below.
appGroups List<Property Map>
One or more application group names. The structure of app_group block is documented below.
applications List<Property Map>
IDs of one or more applications that this shaper applies application control traffic shaping to. The structure of application block is documented below.
classId Number
Traffic class ID.
comment String
Comments.
cos String
VLAN CoS bit pattern.
cosMask String
VLAN CoS evaluated bits.
diffservForward String
Enable to change packet's DiffServ values to the specified diffservcode-forward value. Valid values: enable, disable.
diffservReverse String
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value. Valid values: enable, disable.
diffservcodeForward String
Change packet's DiffServ to this value.
diffservcodeRev String
Change packet's reverse (reply) DiffServ to this value.
dstaddr6s List<Property Map>
IPv6 destination address and address group names. The structure of dstaddr6 block is documented below.
dstaddrs List<Property Map>
IPv4 destination address and address group names. The structure of dstaddr block is documented below.
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 ].
fosid Changes to this property will trigger replacement. Number
Shaping policy ID.
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.
groups List<Property Map>
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. The structure of groups block is documented below.
internetService String
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Valid values: enable, disable.
internetServiceCustomGroups List<Property Map>
Custom Internet Service group name. The structure of internet_service_custom_group block is documented below.
internetServiceCustoms List<Property Map>
Custom Internet Service name. The structure of internet_service_custom block is documented below.
internetServiceGroups List<Property Map>
Internet Service group name. The structure of internet_service_group block is documented below.
internetServiceIds List<Property Map>
Internet Service ID. The structure of internet_service_id block is documented below.
internetServiceNames List<Property Map>
Internet Service ID. The structure of internet_service_name block is documented below.
internetServiceSrc String
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Valid values: enable, disable.
internetServiceSrcCustomGroups List<Property Map>
Custom Internet Service source group name. The structure of internet_service_src_custom_group block is documented below.
internetServiceSrcCustoms List<Property Map>
Custom Internet Service source name. The structure of internet_service_src_custom block is documented below.
internetServiceSrcGroups List<Property Map>
Internet Service source group name. The structure of internet_service_src_group block is documented below.
internetServiceSrcIds List<Property Map>
Internet Service source ID. The structure of internet_service_src_id block is documented below.
internetServiceSrcNames List<Property Map>
Internet Service source name. The structure of internet_service_src_name block is documented below.
ipVersion String
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Valid values: 4, 6.
name String
Shaping policy name.
perIpShaper String
Per-IP traffic shaper to apply with this policy.
schedule String
Schedule name.
services List<Property Map>
Service and service group names. The structure of service block is documented below.
srcaddr6s List<Property Map>
IPv6 source address and address group names. The structure of srcaddr6 block is documented below.
srcintfs List<Property Map>
One or more incoming (ingress) interfaces. The structure of srcintf block is documented below.
status String
Enable/disable this traffic shaping policy. Valid values: enable, disable.
tos String
ToS (Type of Service) value used for comparison.
tosMask String
Non-zero bit positions are used for comparison while zero bit positions are ignored.
tosNegate String
Enable negated TOS match. Valid values: enable, disable.
trafficShaper String
Traffic shaper to apply to traffic forwarded by the firewall policy.
trafficShaperReverse String
Traffic shaper to apply to response traffic received by the firewall policy.
trafficType String
Traffic type. Valid values: forwarding, local-in, local-out.
urlCategories List<Property Map>
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. The structure of url_category block is documented below.
users List<Property Map>
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. The structure of users block is documented below.
uuid String
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
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 Shapingpolicy 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 Shapingpolicy Resource

Get an existing Shapingpolicy 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?: ShapingpolicyState, opts?: CustomResourceOptions): Shapingpolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_categories: Optional[Sequence[ShapingpolicyAppCategoryArgs]] = None,
        app_groups: Optional[Sequence[ShapingpolicyAppGroupArgs]] = None,
        applications: Optional[Sequence[ShapingpolicyApplicationArgs]] = None,
        class_id: Optional[int] = None,
        comment: Optional[str] = None,
        cos: Optional[str] = None,
        cos_mask: Optional[str] = None,
        diffserv_forward: Optional[str] = None,
        diffserv_reverse: Optional[str] = None,
        diffservcode_forward: Optional[str] = None,
        diffservcode_rev: Optional[str] = None,
        dstaddr6s: Optional[Sequence[ShapingpolicyDstaddr6Args]] = None,
        dstaddrs: Optional[Sequence[ShapingpolicyDstaddrArgs]] = None,
        dstintfs: Optional[Sequence[ShapingpolicyDstintfArgs]] = None,
        dynamic_sort_subtable: Optional[str] = None,
        fosid: Optional[int] = None,
        get_all_tables: Optional[str] = None,
        groups: Optional[Sequence[ShapingpolicyGroupArgs]] = None,
        internet_service: Optional[str] = None,
        internet_service_custom_groups: Optional[Sequence[ShapingpolicyInternetServiceCustomGroupArgs]] = None,
        internet_service_customs: Optional[Sequence[ShapingpolicyInternetServiceCustomArgs]] = None,
        internet_service_groups: Optional[Sequence[ShapingpolicyInternetServiceGroupArgs]] = None,
        internet_service_ids: Optional[Sequence[ShapingpolicyInternetServiceIdArgs]] = None,
        internet_service_names: Optional[Sequence[ShapingpolicyInternetServiceNameArgs]] = None,
        internet_service_src: Optional[str] = None,
        internet_service_src_custom_groups: Optional[Sequence[ShapingpolicyInternetServiceSrcCustomGroupArgs]] = None,
        internet_service_src_customs: Optional[Sequence[ShapingpolicyInternetServiceSrcCustomArgs]] = None,
        internet_service_src_groups: Optional[Sequence[ShapingpolicyInternetServiceSrcGroupArgs]] = None,
        internet_service_src_ids: Optional[Sequence[ShapingpolicyInternetServiceSrcIdArgs]] = None,
        internet_service_src_names: Optional[Sequence[ShapingpolicyInternetServiceSrcNameArgs]] = None,
        ip_version: Optional[str] = None,
        name: Optional[str] = None,
        per_ip_shaper: Optional[str] = None,
        schedule: Optional[str] = None,
        services: Optional[Sequence[ShapingpolicyServiceArgs]] = None,
        srcaddr6s: Optional[Sequence[ShapingpolicySrcaddr6Args]] = None,
        srcaddrs: Optional[Sequence[ShapingpolicySrcaddrArgs]] = None,
        srcintfs: Optional[Sequence[ShapingpolicySrcintfArgs]] = None,
        status: Optional[str] = None,
        tos: Optional[str] = None,
        tos_mask: Optional[str] = None,
        tos_negate: Optional[str] = None,
        traffic_shaper: Optional[str] = None,
        traffic_shaper_reverse: Optional[str] = None,
        traffic_type: Optional[str] = None,
        url_categories: Optional[Sequence[ShapingpolicyUrlCategoryArgs]] = None,
        users: Optional[Sequence[ShapingpolicyUserArgs]] = None,
        uuid: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Shapingpolicy
func GetShapingpolicy(ctx *Context, name string, id IDInput, state *ShapingpolicyState, opts ...ResourceOption) (*Shapingpolicy, error)
public static Shapingpolicy Get(string name, Input<string> id, ShapingpolicyState? state, CustomResourceOptions? opts = null)
public static Shapingpolicy get(String name, Output<String> id, ShapingpolicyState state, CustomResourceOptions options)
resources:  _:    type: fortios:firewall:Shapingpolicy    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:
AppCategories List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyAppCategory>
IDs of one or more application categories that this shaper applies application control traffic shaping to. The structure of app_category block is documented below.
AppGroups List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyAppGroup>
One or more application group names. The structure of app_group block is documented below.
Applications List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyApplication>
IDs of one or more applications that this shaper applies application control traffic shaping to. The structure of application block is documented below.
ClassId int
Traffic class ID.
Comment string
Comments.
Cos string
VLAN CoS bit pattern.
CosMask string
VLAN CoS evaluated bits.
DiffservForward string
Enable to change packet's DiffServ values to the specified diffservcode-forward value. Valid values: enable, disable.
DiffservReverse string
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value. Valid values: enable, disable.
DiffservcodeForward string
Change packet's DiffServ to this value.
DiffservcodeRev string
Change packet's reverse (reply) DiffServ to this value.
Dstaddr6s List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyDstaddr6>
IPv6 destination address and address group names. The structure of dstaddr6 block is documented below.
Dstaddrs List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyDstaddr>
IPv4 destination address and address group names. The structure of dstaddr block is documented below.
Dstintfs List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyDstintf>
One or more outgoing (egress) interfaces. The structure of dstintf block is documented below.
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 ].
Fosid Changes to this property will trigger replacement. int
Shaping policy ID.
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.
Groups List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyGroup>
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. The structure of groups block is documented below.
InternetService string
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Valid values: enable, disable.
InternetServiceCustomGroups List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceCustomGroup>
Custom Internet Service group name. The structure of internet_service_custom_group block is documented below.
InternetServiceCustoms List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceCustom>
Custom Internet Service name. The structure of internet_service_custom block is documented below.
InternetServiceGroups List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceGroup>
Internet Service group name. The structure of internet_service_group block is documented below.
InternetServiceIds List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceId>
Internet Service ID. The structure of internet_service_id block is documented below.
InternetServiceNames List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceName>
Internet Service ID. The structure of internet_service_name block is documented below.
InternetServiceSrc string
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Valid values: enable, disable.
InternetServiceSrcCustomGroups List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcCustomGroup>
Custom Internet Service source group name. The structure of internet_service_src_custom_group block is documented below.
InternetServiceSrcCustoms List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcCustom>
Custom Internet Service source name. The structure of internet_service_src_custom block is documented below.
InternetServiceSrcGroups List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcGroup>
Internet Service source group name. The structure of internet_service_src_group block is documented below.
InternetServiceSrcIds List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcId>
Internet Service source ID. The structure of internet_service_src_id block is documented below.
InternetServiceSrcNames List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyInternetServiceSrcName>
Internet Service source name. The structure of internet_service_src_name block is documented below.
IpVersion string
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Valid values: 4, 6.
Name string
Shaping policy name.
PerIpShaper string
Per-IP traffic shaper to apply with this policy.
Schedule string
Schedule name.
Services List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyService>
Service and service group names. The structure of service block is documented below.
Srcaddr6s List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicySrcaddr6>
IPv6 source address and address group names. The structure of srcaddr6 block is documented below.
Srcaddrs List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicySrcaddr>
IPv4 source address and address group names. The structure of srcaddr block is documented below.
Srcintfs List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicySrcintf>
One or more incoming (ingress) interfaces. The structure of srcintf block is documented below.
Status string
Enable/disable this traffic shaping policy. Valid values: enable, disable.
Tos string
ToS (Type of Service) value used for comparison.
TosMask string
Non-zero bit positions are used for comparison while zero bit positions are ignored.
TosNegate string
Enable negated TOS match. Valid values: enable, disable.
TrafficShaper string
Traffic shaper to apply to traffic forwarded by the firewall policy.
TrafficShaperReverse string
Traffic shaper to apply to response traffic received by the firewall policy.
TrafficType string
Traffic type. Valid values: forwarding, local-in, local-out.
UrlCategories List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyUrlCategory>
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. The structure of url_category block is documented below.
Users List<Pulumiverse.Fortios.Firewall.Inputs.ShapingpolicyUser>
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. The structure of users block is documented below.
Uuid string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
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.
AppCategories []ShapingpolicyAppCategoryArgs
IDs of one or more application categories that this shaper applies application control traffic shaping to. The structure of app_category block is documented below.
AppGroups []ShapingpolicyAppGroupArgs
One or more application group names. The structure of app_group block is documented below.
Applications []ShapingpolicyApplicationArgs
IDs of one or more applications that this shaper applies application control traffic shaping to. The structure of application block is documented below.
ClassId int
Traffic class ID.
Comment string
Comments.
Cos string
VLAN CoS bit pattern.
CosMask string
VLAN CoS evaluated bits.
DiffservForward string
Enable to change packet's DiffServ values to the specified diffservcode-forward value. Valid values: enable, disable.
DiffservReverse string
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value. Valid values: enable, disable.
DiffservcodeForward string
Change packet's DiffServ to this value.
DiffservcodeRev string
Change packet's reverse (reply) DiffServ to this value.
Dstaddr6s []ShapingpolicyDstaddr6Args
IPv6 destination address and address group names. The structure of dstaddr6 block is documented below.
Dstaddrs []ShapingpolicyDstaddrArgs
IPv4 destination address and address group names. The structure of dstaddr block is documented below.
Dstintfs []ShapingpolicyDstintfArgs
One or more outgoing (egress) interfaces. The structure of dstintf block is documented below.
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 ].
Fosid Changes to this property will trigger replacement. int
Shaping policy ID.
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.
Groups []ShapingpolicyGroupArgs
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. The structure of groups block is documented below.
InternetService string
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Valid values: enable, disable.
InternetServiceCustomGroups []ShapingpolicyInternetServiceCustomGroupArgs
Custom Internet Service group name. The structure of internet_service_custom_group block is documented below.
InternetServiceCustoms []ShapingpolicyInternetServiceCustomArgs
Custom Internet Service name. The structure of internet_service_custom block is documented below.
InternetServiceGroups []ShapingpolicyInternetServiceGroupArgs
Internet Service group name. The structure of internet_service_group block is documented below.
InternetServiceIds []ShapingpolicyInternetServiceIdArgs
Internet Service ID. The structure of internet_service_id block is documented below.
InternetServiceNames []ShapingpolicyInternetServiceNameArgs
Internet Service ID. The structure of internet_service_name block is documented below.
InternetServiceSrc string
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Valid values: enable, disable.
InternetServiceSrcCustomGroups []ShapingpolicyInternetServiceSrcCustomGroupArgs
Custom Internet Service source group name. The structure of internet_service_src_custom_group block is documented below.
InternetServiceSrcCustoms []ShapingpolicyInternetServiceSrcCustomArgs
Custom Internet Service source name. The structure of internet_service_src_custom block is documented below.
InternetServiceSrcGroups []ShapingpolicyInternetServiceSrcGroupArgs
Internet Service source group name. The structure of internet_service_src_group block is documented below.
InternetServiceSrcIds []ShapingpolicyInternetServiceSrcIdArgs
Internet Service source ID. The structure of internet_service_src_id block is documented below.
InternetServiceSrcNames []ShapingpolicyInternetServiceSrcNameArgs
Internet Service source name. The structure of internet_service_src_name block is documented below.
IpVersion string
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Valid values: 4, 6.
Name string
Shaping policy name.
PerIpShaper string
Per-IP traffic shaper to apply with this policy.
Schedule string
Schedule name.
Services []ShapingpolicyServiceArgs
Service and service group names. The structure of service block is documented below.
Srcaddr6s []ShapingpolicySrcaddr6Args
IPv6 source address and address group names. The structure of srcaddr6 block is documented below.
Srcaddrs []ShapingpolicySrcaddrArgs
IPv4 source address and address group names. The structure of srcaddr block is documented below.
Srcintfs []ShapingpolicySrcintfArgs
One or more incoming (ingress) interfaces. The structure of srcintf block is documented below.
Status string
Enable/disable this traffic shaping policy. Valid values: enable, disable.
Tos string
ToS (Type of Service) value used for comparison.
TosMask string
Non-zero bit positions are used for comparison while zero bit positions are ignored.
TosNegate string
Enable negated TOS match. Valid values: enable, disable.
TrafficShaper string
Traffic shaper to apply to traffic forwarded by the firewall policy.
TrafficShaperReverse string
Traffic shaper to apply to response traffic received by the firewall policy.
TrafficType string
Traffic type. Valid values: forwarding, local-in, local-out.
UrlCategories []ShapingpolicyUrlCategoryArgs
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. The structure of url_category block is documented below.
Users []ShapingpolicyUserArgs
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. The structure of users block is documented below.
Uuid string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
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.
appCategories List<ShapingpolicyAppCategory>
IDs of one or more application categories that this shaper applies application control traffic shaping to. The structure of app_category block is documented below.
appGroups List<ShapingpolicyAppGroup>
One or more application group names. The structure of app_group block is documented below.
applications List<ShapingpolicyApplication>
IDs of one or more applications that this shaper applies application control traffic shaping to. The structure of application block is documented below.
classId Integer
Traffic class ID.
comment String
Comments.
cos String
VLAN CoS bit pattern.
cosMask String
VLAN CoS evaluated bits.
diffservForward String
Enable to change packet's DiffServ values to the specified diffservcode-forward value. Valid values: enable, disable.
diffservReverse String
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value. Valid values: enable, disable.
diffservcodeForward String
Change packet's DiffServ to this value.
diffservcodeRev String
Change packet's reverse (reply) DiffServ to this value.
dstaddr6s List<ShapingpolicyDstaddr6>
IPv6 destination address and address group names. The structure of dstaddr6 block is documented below.
dstaddrs List<ShapingpolicyDstaddr>
IPv4 destination address and address group names. The structure of dstaddr block is documented below.
dstintfs List<ShapingpolicyDstintf>
One or more outgoing (egress) interfaces. The structure of dstintf block is documented below.
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 ].
fosid Changes to this property will trigger replacement. Integer
Shaping policy ID.
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.
groups List<ShapingpolicyGroup>
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. The structure of groups block is documented below.
internetService String
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Valid values: enable, disable.
internetServiceCustomGroups List<ShapingpolicyInternetServiceCustomGroup>
Custom Internet Service group name. The structure of internet_service_custom_group block is documented below.
internetServiceCustoms List<ShapingpolicyInternetServiceCustom>
Custom Internet Service name. The structure of internet_service_custom block is documented below.
internetServiceGroups List<ShapingpolicyInternetServiceGroup>
Internet Service group name. The structure of internet_service_group block is documented below.
internetServiceIds List<ShapingpolicyInternetServiceId>
Internet Service ID. The structure of internet_service_id block is documented below.
internetServiceNames List<ShapingpolicyInternetServiceName>
Internet Service ID. The structure of internet_service_name block is documented below.
internetServiceSrc String
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Valid values: enable, disable.
internetServiceSrcCustomGroups List<ShapingpolicyInternetServiceSrcCustomGroup>
Custom Internet Service source group name. The structure of internet_service_src_custom_group block is documented below.
internetServiceSrcCustoms List<ShapingpolicyInternetServiceSrcCustom>
Custom Internet Service source name. The structure of internet_service_src_custom block is documented below.
internetServiceSrcGroups List<ShapingpolicyInternetServiceSrcGroup>
Internet Service source group name. The structure of internet_service_src_group block is documented below.
internetServiceSrcIds List<ShapingpolicyInternetServiceSrcId>
Internet Service source ID. The structure of internet_service_src_id block is documented below.
internetServiceSrcNames List<ShapingpolicyInternetServiceSrcName>
Internet Service source name. The structure of internet_service_src_name block is documented below.
ipVersion String
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Valid values: 4, 6.
name String
Shaping policy name.
perIpShaper String
Per-IP traffic shaper to apply with this policy.
schedule String
Schedule name.
services List<ShapingpolicyService>
Service and service group names. The structure of service block is documented below.
srcaddr6s List<ShapingpolicySrcaddr6>
IPv6 source address and address group names. The structure of srcaddr6 block is documented below.
srcaddrs List<ShapingpolicySrcaddr>
IPv4 source address and address group names. The structure of srcaddr block is documented below.
srcintfs List<ShapingpolicySrcintf>
One or more incoming (ingress) interfaces. The structure of srcintf block is documented below.
status String
Enable/disable this traffic shaping policy. Valid values: enable, disable.
tos String
ToS (Type of Service) value used for comparison.
tosMask String
Non-zero bit positions are used for comparison while zero bit positions are ignored.
tosNegate String
Enable negated TOS match. Valid values: enable, disable.
trafficShaper String
Traffic shaper to apply to traffic forwarded by the firewall policy.
trafficShaperReverse String
Traffic shaper to apply to response traffic received by the firewall policy.
trafficType String
Traffic type. Valid values: forwarding, local-in, local-out.
urlCategories List<ShapingpolicyUrlCategory>
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. The structure of url_category block is documented below.
users List<ShapingpolicyUser>
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. The structure of users block is documented below.
uuid String
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
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.
appCategories ShapingpolicyAppCategory[]
IDs of one or more application categories that this shaper applies application control traffic shaping to. The structure of app_category block is documented below.
appGroups ShapingpolicyAppGroup[]
One or more application group names. The structure of app_group block is documented below.
applications ShapingpolicyApplication[]
IDs of one or more applications that this shaper applies application control traffic shaping to. The structure of application block is documented below.
classId number
Traffic class ID.
comment string
Comments.
cos string
VLAN CoS bit pattern.
cosMask string
VLAN CoS evaluated bits.
diffservForward string
Enable to change packet's DiffServ values to the specified diffservcode-forward value. Valid values: enable, disable.
diffservReverse string
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value. Valid values: enable, disable.
diffservcodeForward string
Change packet's DiffServ to this value.
diffservcodeRev string
Change packet's reverse (reply) DiffServ to this value.
dstaddr6s ShapingpolicyDstaddr6[]
IPv6 destination address and address group names. The structure of dstaddr6 block is documented below.
dstaddrs ShapingpolicyDstaddr[]
IPv4 destination address and address group names. The structure of dstaddr block is documented below.
dstintfs ShapingpolicyDstintf[]
One or more outgoing (egress) interfaces. The structure of dstintf block is documented below.
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 ].
fosid Changes to this property will trigger replacement. number
Shaping policy ID.
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.
groups ShapingpolicyGroup[]
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. The structure of groups block is documented below.
internetService string
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Valid values: enable, disable.
internetServiceCustomGroups ShapingpolicyInternetServiceCustomGroup[]
Custom Internet Service group name. The structure of internet_service_custom_group block is documented below.
internetServiceCustoms ShapingpolicyInternetServiceCustom[]
Custom Internet Service name. The structure of internet_service_custom block is documented below.
internetServiceGroups ShapingpolicyInternetServiceGroup[]
Internet Service group name. The structure of internet_service_group block is documented below.
internetServiceIds ShapingpolicyInternetServiceId[]
Internet Service ID. The structure of internet_service_id block is documented below.
internetServiceNames ShapingpolicyInternetServiceName[]
Internet Service ID. The structure of internet_service_name block is documented below.
internetServiceSrc string
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Valid values: enable, disable.
internetServiceSrcCustomGroups ShapingpolicyInternetServiceSrcCustomGroup[]
Custom Internet Service source group name. The structure of internet_service_src_custom_group block is documented below.
internetServiceSrcCustoms ShapingpolicyInternetServiceSrcCustom[]
Custom Internet Service source name. The structure of internet_service_src_custom block is documented below.
internetServiceSrcGroups ShapingpolicyInternetServiceSrcGroup[]
Internet Service source group name. The structure of internet_service_src_group block is documented below.
internetServiceSrcIds ShapingpolicyInternetServiceSrcId[]
Internet Service source ID. The structure of internet_service_src_id block is documented below.
internetServiceSrcNames ShapingpolicyInternetServiceSrcName[]
Internet Service source name. The structure of internet_service_src_name block is documented below.
ipVersion string
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Valid values: 4, 6.
name string
Shaping policy name.
perIpShaper string
Per-IP traffic shaper to apply with this policy.
schedule string
Schedule name.
services ShapingpolicyService[]
Service and service group names. The structure of service block is documented below.
srcaddr6s ShapingpolicySrcaddr6[]
IPv6 source address and address group names. The structure of srcaddr6 block is documented below.
srcaddrs ShapingpolicySrcaddr[]
IPv4 source address and address group names. The structure of srcaddr block is documented below.
srcintfs ShapingpolicySrcintf[]
One or more incoming (ingress) interfaces. The structure of srcintf block is documented below.
status string
Enable/disable this traffic shaping policy. Valid values: enable, disable.
tos string
ToS (Type of Service) value used for comparison.
tosMask string
Non-zero bit positions are used for comparison while zero bit positions are ignored.
tosNegate string
Enable negated TOS match. Valid values: enable, disable.
trafficShaper string
Traffic shaper to apply to traffic forwarded by the firewall policy.
trafficShaperReverse string
Traffic shaper to apply to response traffic received by the firewall policy.
trafficType string
Traffic type. Valid values: forwarding, local-in, local-out.
urlCategories ShapingpolicyUrlCategory[]
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. The structure of url_category block is documented below.
users ShapingpolicyUser[]
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. The structure of users block is documented below.
uuid string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
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.
app_categories Sequence[ShapingpolicyAppCategoryArgs]
IDs of one or more application categories that this shaper applies application control traffic shaping to. The structure of app_category block is documented below.
app_groups Sequence[ShapingpolicyAppGroupArgs]
One or more application group names. The structure of app_group block is documented below.
applications Sequence[ShapingpolicyApplicationArgs]
IDs of one or more applications that this shaper applies application control traffic shaping to. The structure of application block is documented below.
class_id int
Traffic class ID.
comment str
Comments.
cos str
VLAN CoS bit pattern.
cos_mask str
VLAN CoS evaluated bits.
diffserv_forward str
Enable to change packet's DiffServ values to the specified diffservcode-forward value. Valid values: enable, disable.
diffserv_reverse str
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value. Valid values: enable, disable.
diffservcode_forward str
Change packet's DiffServ to this value.
diffservcode_rev str
Change packet's reverse (reply) DiffServ to this value.
dstaddr6s Sequence[ShapingpolicyDstaddr6Args]
IPv6 destination address and address group names. The structure of dstaddr6 block is documented below.
dstaddrs Sequence[ShapingpolicyDstaddrArgs]
IPv4 destination address and address group names. The structure of dstaddr block is documented below.
dstintfs Sequence[ShapingpolicyDstintfArgs]
One or more outgoing (egress) interfaces. The structure of dstintf block is documented below.
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 ].
fosid Changes to this property will trigger replacement. int
Shaping policy ID.
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.
groups Sequence[ShapingpolicyGroupArgs]
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. The structure of groups block is documented below.
internet_service str
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Valid values: enable, disable.
internet_service_custom_groups Sequence[ShapingpolicyInternetServiceCustomGroupArgs]
Custom Internet Service group name. The structure of internet_service_custom_group block is documented below.
internet_service_customs Sequence[ShapingpolicyInternetServiceCustomArgs]
Custom Internet Service name. The structure of internet_service_custom block is documented below.
internet_service_groups Sequence[ShapingpolicyInternetServiceGroupArgs]
Internet Service group name. The structure of internet_service_group block is documented below.
internet_service_ids Sequence[ShapingpolicyInternetServiceIdArgs]
Internet Service ID. The structure of internet_service_id block is documented below.
internet_service_names Sequence[ShapingpolicyInternetServiceNameArgs]
Internet Service ID. The structure of internet_service_name block is documented below.
internet_service_src str
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Valid values: enable, disable.
internet_service_src_custom_groups Sequence[ShapingpolicyInternetServiceSrcCustomGroupArgs]
Custom Internet Service source group name. The structure of internet_service_src_custom_group block is documented below.
internet_service_src_customs Sequence[ShapingpolicyInternetServiceSrcCustomArgs]
Custom Internet Service source name. The structure of internet_service_src_custom block is documented below.
internet_service_src_groups Sequence[ShapingpolicyInternetServiceSrcGroupArgs]
Internet Service source group name. The structure of internet_service_src_group block is documented below.
internet_service_src_ids Sequence[ShapingpolicyInternetServiceSrcIdArgs]
Internet Service source ID. The structure of internet_service_src_id block is documented below.
internet_service_src_names Sequence[ShapingpolicyInternetServiceSrcNameArgs]
Internet Service source name. The structure of internet_service_src_name block is documented below.
ip_version str
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Valid values: 4, 6.
name str
Shaping policy name.
per_ip_shaper str
Per-IP traffic shaper to apply with this policy.
schedule str
Schedule name.
services Sequence[ShapingpolicyServiceArgs]
Service and service group names. The structure of service block is documented below.
srcaddr6s Sequence[ShapingpolicySrcaddr6Args]
IPv6 source address and address group names. The structure of srcaddr6 block is documented below.
srcaddrs Sequence[ShapingpolicySrcaddrArgs]
IPv4 source address and address group names. The structure of srcaddr block is documented below.
srcintfs Sequence[ShapingpolicySrcintfArgs]
One or more incoming (ingress) interfaces. The structure of srcintf block is documented below.
status str
Enable/disable this traffic shaping policy. Valid values: enable, disable.
tos str
ToS (Type of Service) value used for comparison.
tos_mask str
Non-zero bit positions are used for comparison while zero bit positions are ignored.
tos_negate str
Enable negated TOS match. Valid values: enable, disable.
traffic_shaper str
Traffic shaper to apply to traffic forwarded by the firewall policy.
traffic_shaper_reverse str
Traffic shaper to apply to response traffic received by the firewall policy.
traffic_type str
Traffic type. Valid values: forwarding, local-in, local-out.
url_categories Sequence[ShapingpolicyUrlCategoryArgs]
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. The structure of url_category block is documented below.
users Sequence[ShapingpolicyUserArgs]
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. The structure of users block is documented below.
uuid str
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
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.
appCategories List<Property Map>
IDs of one or more application categories that this shaper applies application control traffic shaping to. The structure of app_category block is documented below.
appGroups List<Property Map>
One or more application group names. The structure of app_group block is documented below.
applications List<Property Map>
IDs of one or more applications that this shaper applies application control traffic shaping to. The structure of application block is documented below.
classId Number
Traffic class ID.
comment String
Comments.
cos String
VLAN CoS bit pattern.
cosMask String
VLAN CoS evaluated bits.
diffservForward String
Enable to change packet's DiffServ values to the specified diffservcode-forward value. Valid values: enable, disable.
diffservReverse String
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value. Valid values: enable, disable.
diffservcodeForward String
Change packet's DiffServ to this value.
diffservcodeRev String
Change packet's reverse (reply) DiffServ to this value.
dstaddr6s List<Property Map>
IPv6 destination address and address group names. The structure of dstaddr6 block is documented below.
dstaddrs List<Property Map>
IPv4 destination address and address group names. The structure of dstaddr block is documented below.
dstintfs List<Property Map>
One or more outgoing (egress) interfaces. The structure of dstintf block is documented below.
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 ].
fosid Changes to this property will trigger replacement. Number
Shaping policy ID.
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.
groups List<Property Map>
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. The structure of groups block is documented below.
internetService String
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Valid values: enable, disable.
internetServiceCustomGroups List<Property Map>
Custom Internet Service group name. The structure of internet_service_custom_group block is documented below.
internetServiceCustoms List<Property Map>
Custom Internet Service name. The structure of internet_service_custom block is documented below.
internetServiceGroups List<Property Map>
Internet Service group name. The structure of internet_service_group block is documented below.
internetServiceIds List<Property Map>
Internet Service ID. The structure of internet_service_id block is documented below.
internetServiceNames List<Property Map>
Internet Service ID. The structure of internet_service_name block is documented below.
internetServiceSrc String
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Valid values: enable, disable.
internetServiceSrcCustomGroups List<Property Map>
Custom Internet Service source group name. The structure of internet_service_src_custom_group block is documented below.
internetServiceSrcCustoms List<Property Map>
Custom Internet Service source name. The structure of internet_service_src_custom block is documented below.
internetServiceSrcGroups List<Property Map>
Internet Service source group name. The structure of internet_service_src_group block is documented below.
internetServiceSrcIds List<Property Map>
Internet Service source ID. The structure of internet_service_src_id block is documented below.
internetServiceSrcNames List<Property Map>
Internet Service source name. The structure of internet_service_src_name block is documented below.
ipVersion String
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Valid values: 4, 6.
name String
Shaping policy name.
perIpShaper String
Per-IP traffic shaper to apply with this policy.
schedule String
Schedule name.
services List<Property Map>
Service and service group names. The structure of service block is documented below.
srcaddr6s List<Property Map>
IPv6 source address and address group names. The structure of srcaddr6 block is documented below.
srcaddrs List<Property Map>
IPv4 source address and address group names. The structure of srcaddr block is documented below.
srcintfs List<Property Map>
One or more incoming (ingress) interfaces. The structure of srcintf block is documented below.
status String
Enable/disable this traffic shaping policy. Valid values: enable, disable.
tos String
ToS (Type of Service) value used for comparison.
tosMask String
Non-zero bit positions are used for comparison while zero bit positions are ignored.
tosNegate String
Enable negated TOS match. Valid values: enable, disable.
trafficShaper String
Traffic shaper to apply to traffic forwarded by the firewall policy.
trafficShaperReverse String
Traffic shaper to apply to response traffic received by the firewall policy.
trafficType String
Traffic type. Valid values: forwarding, local-in, local-out.
urlCategories List<Property Map>
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. The structure of url_category block is documented below.
users List<Property Map>
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. The structure of users block is documented below.
uuid String
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
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.

Supporting Types

ShapingpolicyAppCategory
, ShapingpolicyAppCategoryArgs

Id int
Category IDs.
Id int
Category IDs.
id Integer
Category IDs.
id number
Category IDs.
id int
Category IDs.
id Number
Category IDs.

ShapingpolicyAppGroup
, ShapingpolicyAppGroupArgs

Name string
Application group name.
Name string
Application group name.
name String
Application group name.
name string
Application group name.
name str
Application group name.
name String
Application group name.

ShapingpolicyApplication
, ShapingpolicyApplicationArgs

Id int
Application IDs.
Id int
Application IDs.
id Integer
Application IDs.
id number
Application IDs.
id int
Application IDs.
id Number
Application IDs.

ShapingpolicyDstaddr
, ShapingpolicyDstaddrArgs

Name string
Address name.
Name string
Address name.
name String
Address name.
name string
Address name.
name str
Address name.
name String
Address name.

ShapingpolicyDstaddr6
, ShapingpolicyDstaddr6Args

Name string
Shaping policy name.
Name string
Shaping policy name.
name String
Shaping policy name.
name string
Shaping policy name.
name str
Shaping policy name.
name String
Shaping policy name.

ShapingpolicyDstintf
, ShapingpolicyDstintfArgs

Name string
Interface name.
Name string
Interface name.
name String
Interface name.
name string
Interface name.
name str
Interface name.
name String
Interface name.

ShapingpolicyGroup
, ShapingpolicyGroupArgs

Name string
Group name.
Name string
Group name.
name String
Group name.
name string
Group name.
name str
Group name.
name String
Group name.

ShapingpolicyInternetServiceCustom
, ShapingpolicyInternetServiceCustomArgs

Name string
Custom Internet Service name.
Name string
Custom Internet Service name.
name String
Custom Internet Service name.
name string
Custom Internet Service name.
name str
Custom Internet Service name.
name String
Custom Internet Service name.

ShapingpolicyInternetServiceCustomGroup
, ShapingpolicyInternetServiceCustomGroupArgs

Name string
Custom Internet Service group name.
Name string
Custom Internet Service group name.
name String
Custom Internet Service group name.
name string
Custom Internet Service group name.
name str
Custom Internet Service group name.
name String
Custom Internet Service group name.

ShapingpolicyInternetServiceGroup
, ShapingpolicyInternetServiceGroupArgs

Name string
Internet Service group name.
Name string
Internet Service group name.
name String
Internet Service group name.
name string
Internet Service group name.
name str
Internet Service group name.
name String
Internet Service group name.

ShapingpolicyInternetServiceId
, ShapingpolicyInternetServiceIdArgs

Id int
Internet Service ID.
Id int
Internet Service ID.
id Integer
Internet Service ID.
id number
Internet Service ID.
id int
Internet Service ID.
id Number
Internet Service ID.

ShapingpolicyInternetServiceName
, ShapingpolicyInternetServiceNameArgs

Name string
Internet Service name.
Name string
Internet Service name.
name String
Internet Service name.
name string
Internet Service name.
name str
Internet Service name.
name String
Internet Service name.

ShapingpolicyInternetServiceSrcCustom
, ShapingpolicyInternetServiceSrcCustomArgs

Name string
Custom Internet Service name.
Name string
Custom Internet Service name.
name String
Custom Internet Service name.
name string
Custom Internet Service name.
name str
Custom Internet Service name.
name String
Custom Internet Service name.

ShapingpolicyInternetServiceSrcCustomGroup
, ShapingpolicyInternetServiceSrcCustomGroupArgs

Name string
Custom Internet Service group name.
Name string
Custom Internet Service group name.
name String
Custom Internet Service group name.
name string
Custom Internet Service group name.
name str
Custom Internet Service group name.
name String
Custom Internet Service group name.

ShapingpolicyInternetServiceSrcGroup
, ShapingpolicyInternetServiceSrcGroupArgs

Name string
Internet Service group name.
Name string
Internet Service group name.
name String
Internet Service group name.
name string
Internet Service group name.
name str
Internet Service group name.
name String
Internet Service group name.

ShapingpolicyInternetServiceSrcId
, ShapingpolicyInternetServiceSrcIdArgs

Id int
Internet Service ID.
Id int
Internet Service ID.
id Integer
Internet Service ID.
id number
Internet Service ID.
id int
Internet Service ID.
id Number
Internet Service ID.

ShapingpolicyInternetServiceSrcName
, ShapingpolicyInternetServiceSrcNameArgs

Name string
Internet Service name.
Name string
Internet Service name.
name String
Internet Service name.
name string
Internet Service name.
name str
Internet Service name.
name String
Internet Service name.

ShapingpolicyService
, ShapingpolicyServiceArgs

Name string
Service name.
Name string
Service name.
name String
Service name.
name string
Service name.
name str
Service name.
name String
Service name.

ShapingpolicySrcaddr
, ShapingpolicySrcaddrArgs

Name string
Address name.
Name string
Address name.
name String
Address name.
name string
Address name.
name str
Address name.
name String
Address name.

ShapingpolicySrcaddr6
, ShapingpolicySrcaddr6Args

Name string
Shaping policy name.
Name string
Shaping policy name.
name String
Shaping policy name.
name string
Shaping policy name.
name str
Shaping policy name.
name String
Shaping policy name.

ShapingpolicySrcintf
, ShapingpolicySrcintfArgs

Name string
Interface name.
Name string
Interface name.
name String
Interface name.
name string
Interface name.
name str
Interface name.
name String
Interface name.

ShapingpolicyUrlCategory
, ShapingpolicyUrlCategoryArgs

Id int
URL category ID.
Id int
URL category ID.
id Integer
URL category ID.
id number
URL category ID.
id int
URL category ID.
id Number
URL category ID.

ShapingpolicyUser
, ShapingpolicyUserArgs

Name string
User name.
Name string
User name.
name String
User name.
name string
User name.
name str
User name.
name String
User name.

Import

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

$ pulumi import fortios:firewall/shapingpolicy:Shapingpolicy labelname {{fosid}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:firewall/shapingpolicy:Shapingpolicy labelname {{fosid}}
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.