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

fortios.switchcontroller.Flowtracking

Explore with Pulumi AI

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

Configure FortiSwitch flow tracking and export via ipfix/netflow. Applies to FortiOS Version >= 6.2.4.

Create Flowtracking Resource

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

Constructor syntax

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

@overload
def Flowtracking(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 aggregates: Optional[Sequence[FlowtrackingAggregateArgs]] = None,
                 collector_ip: Optional[str] = None,
                 collector_port: Optional[int] = None,
                 collectors: Optional[Sequence[FlowtrackingCollectorArgs]] = None,
                 dynamic_sort_subtable: Optional[str] = None,
                 format: Optional[str] = None,
                 get_all_tables: Optional[str] = None,
                 level: Optional[str] = None,
                 max_export_pkt_size: Optional[int] = None,
                 sample_mode: Optional[str] = None,
                 sample_rate: Optional[int] = None,
                 template_export_period: Optional[int] = None,
                 timeout_general: Optional[int] = None,
                 timeout_icmp: Optional[int] = None,
                 timeout_max: Optional[int] = None,
                 timeout_tcp: Optional[int] = None,
                 timeout_tcp_fin: Optional[int] = None,
                 timeout_tcp_rst: Optional[int] = None,
                 timeout_udp: Optional[int] = None,
                 transport: Optional[str] = None,
                 vdomparam: Optional[str] = None)
func NewFlowtracking(ctx *Context, name string, args *FlowtrackingArgs, opts ...ResourceOption) (*Flowtracking, error)
public Flowtracking(string name, FlowtrackingArgs? args = null, CustomResourceOptions? opts = null)
public Flowtracking(String name, FlowtrackingArgs args)
public Flowtracking(String name, FlowtrackingArgs args, CustomResourceOptions options)

type: fortios:switchcontroller:Flowtracking
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 FlowtrackingArgs
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 FlowtrackingArgs
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 FlowtrackingArgs
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 FlowtrackingArgs
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. FlowtrackingArgs
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 flowtrackingResource = new Fortios.Switchcontroller.Flowtracking("flowtrackingResource", new()
{
    Aggregates = new[]
    {
        new Fortios.Switchcontroller.Inputs.FlowtrackingAggregateArgs
        {
            Id = 0,
            Ip = "string",
        },
    },
    CollectorIp = "string",
    CollectorPort = 0,
    Collectors = new[]
    {
        new Fortios.Switchcontroller.Inputs.FlowtrackingCollectorArgs
        {
            Ip = "string",
            Name = "string",
            Port = 0,
            Transport = "string",
        },
    },
    DynamicSortSubtable = "string",
    Format = "string",
    GetAllTables = "string",
    Level = "string",
    MaxExportPktSize = 0,
    SampleMode = "string",
    SampleRate = 0,
    TemplateExportPeriod = 0,
    TimeoutGeneral = 0,
    TimeoutIcmp = 0,
    TimeoutMax = 0,
    TimeoutTcp = 0,
    TimeoutTcpFin = 0,
    TimeoutTcpRst = 0,
    TimeoutUdp = 0,
    Transport = "string",
    Vdomparam = "string",
});
Copy
example, err := switchcontroller.NewFlowtracking(ctx, "flowtrackingResource", &switchcontroller.FlowtrackingArgs{
	Aggregates: switchcontroller.FlowtrackingAggregateArray{
		&switchcontroller.FlowtrackingAggregateArgs{
			Id: pulumi.Int(0),
			Ip: pulumi.String("string"),
		},
	},
	CollectorIp:   pulumi.String("string"),
	CollectorPort: pulumi.Int(0),
	Collectors: switchcontroller.FlowtrackingCollectorArray{
		&switchcontroller.FlowtrackingCollectorArgs{
			Ip:        pulumi.String("string"),
			Name:      pulumi.String("string"),
			Port:      pulumi.Int(0),
			Transport: pulumi.String("string"),
		},
	},
	DynamicSortSubtable:  pulumi.String("string"),
	Format:               pulumi.String("string"),
	GetAllTables:         pulumi.String("string"),
	Level:                pulumi.String("string"),
	MaxExportPktSize:     pulumi.Int(0),
	SampleMode:           pulumi.String("string"),
	SampleRate:           pulumi.Int(0),
	TemplateExportPeriod: pulumi.Int(0),
	TimeoutGeneral:       pulumi.Int(0),
	TimeoutIcmp:          pulumi.Int(0),
	TimeoutMax:           pulumi.Int(0),
	TimeoutTcp:           pulumi.Int(0),
	TimeoutTcpFin:        pulumi.Int(0),
	TimeoutTcpRst:        pulumi.Int(0),
	TimeoutUdp:           pulumi.Int(0),
	Transport:            pulumi.String("string"),
	Vdomparam:            pulumi.String("string"),
})
Copy
var flowtrackingResource = new Flowtracking("flowtrackingResource", FlowtrackingArgs.builder()
    .aggregates(FlowtrackingAggregateArgs.builder()
        .id(0)
        .ip("string")
        .build())
    .collectorIp("string")
    .collectorPort(0)
    .collectors(FlowtrackingCollectorArgs.builder()
        .ip("string")
        .name("string")
        .port(0)
        .transport("string")
        .build())
    .dynamicSortSubtable("string")
    .format("string")
    .getAllTables("string")
    .level("string")
    .maxExportPktSize(0)
    .sampleMode("string")
    .sampleRate(0)
    .templateExportPeriod(0)
    .timeoutGeneral(0)
    .timeoutIcmp(0)
    .timeoutMax(0)
    .timeoutTcp(0)
    .timeoutTcpFin(0)
    .timeoutTcpRst(0)
    .timeoutUdp(0)
    .transport("string")
    .vdomparam("string")
    .build());
Copy
flowtracking_resource = fortios.switchcontroller.Flowtracking("flowtrackingResource",
    aggregates=[{
        "id": 0,
        "ip": "string",
    }],
    collector_ip="string",
    collector_port=0,
    collectors=[{
        "ip": "string",
        "name": "string",
        "port": 0,
        "transport": "string",
    }],
    dynamic_sort_subtable="string",
    format="string",
    get_all_tables="string",
    level="string",
    max_export_pkt_size=0,
    sample_mode="string",
    sample_rate=0,
    template_export_period=0,
    timeout_general=0,
    timeout_icmp=0,
    timeout_max=0,
    timeout_tcp=0,
    timeout_tcp_fin=0,
    timeout_tcp_rst=0,
    timeout_udp=0,
    transport="string",
    vdomparam="string")
Copy
const flowtrackingResource = new fortios.switchcontroller.Flowtracking("flowtrackingResource", {
    aggregates: [{
        id: 0,
        ip: "string",
    }],
    collectorIp: "string",
    collectorPort: 0,
    collectors: [{
        ip: "string",
        name: "string",
        port: 0,
        transport: "string",
    }],
    dynamicSortSubtable: "string",
    format: "string",
    getAllTables: "string",
    level: "string",
    maxExportPktSize: 0,
    sampleMode: "string",
    sampleRate: 0,
    templateExportPeriod: 0,
    timeoutGeneral: 0,
    timeoutIcmp: 0,
    timeoutMax: 0,
    timeoutTcp: 0,
    timeoutTcpFin: 0,
    timeoutTcpRst: 0,
    timeoutUdp: 0,
    transport: "string",
    vdomparam: "string",
});
Copy
type: fortios:switchcontroller:Flowtracking
properties:
    aggregates:
        - id: 0
          ip: string
    collectorIp: string
    collectorPort: 0
    collectors:
        - ip: string
          name: string
          port: 0
          transport: string
    dynamicSortSubtable: string
    format: string
    getAllTables: string
    level: string
    maxExportPktSize: 0
    sampleMode: string
    sampleRate: 0
    templateExportPeriod: 0
    timeoutGeneral: 0
    timeoutIcmp: 0
    timeoutMax: 0
    timeoutTcp: 0
    timeoutTcpFin: 0
    timeoutTcpRst: 0
    timeoutUdp: 0
    transport: string
    vdomparam: string
Copy

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

Aggregates List<Pulumiverse.Fortios.Switchcontroller.Inputs.FlowtrackingAggregate>
Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. The structure of aggregates block is documented below.
CollectorIp string
Configure collector ip address.
CollectorPort int
Configure collector port number(0-65535, default=0).
Collectors List<Pulumiverse.Fortios.Switchcontroller.Inputs.FlowtrackingCollector>
Configure collectors for the flow. The structure of collectors 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 ].
Format string
Configure flow tracking protocol. Valid values: netflow1, netflow5, netflow9, ipfix.
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.
Level string
Configure flow tracking level. Valid values: vlan, ip, port, proto, mac.
MaxExportPktSize int
Configure flow max export packet size (512-9216, default=512 bytes).
SampleMode string
Configure sample mode for the flow tracking. Valid values: local, perimeter, device-ingress.
SampleRate int
Configure sample rate for the perimeter and device-ingress sampling(0 - 99999).
TemplateExportPeriod int
Configure template export period (1-60, default=5 minutes).
TimeoutGeneral int
Configure flow session general timeout (60-604800, default=3600 seconds).
TimeoutIcmp int
Configure flow session ICMP timeout (60-604800, default=300 seconds).
TimeoutMax int
Configure flow session max timeout (60-604800, default=604800 seconds).
TimeoutTcp int
Configure flow session TCP timeout (60-604800, default=3600 seconds).
TimeoutTcpFin int
Configure flow session TCP FIN timeout (60-604800, default=300 seconds).
TimeoutTcpRst int
Configure flow session TCP RST timeout (60-604800, default=120 seconds).
TimeoutUdp int
Configure flow session UDP timeout (60-604800, default=300 seconds).
Transport string
Configure L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
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.
Aggregates []FlowtrackingAggregateArgs
Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. The structure of aggregates block is documented below.
CollectorIp string
Configure collector ip address.
CollectorPort int
Configure collector port number(0-65535, default=0).
Collectors []FlowtrackingCollectorArgs
Configure collectors for the flow. The structure of collectors 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 ].
Format string
Configure flow tracking protocol. Valid values: netflow1, netflow5, netflow9, ipfix.
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.
Level string
Configure flow tracking level. Valid values: vlan, ip, port, proto, mac.
MaxExportPktSize int
Configure flow max export packet size (512-9216, default=512 bytes).
SampleMode string
Configure sample mode for the flow tracking. Valid values: local, perimeter, device-ingress.
SampleRate int
Configure sample rate for the perimeter and device-ingress sampling(0 - 99999).
TemplateExportPeriod int
Configure template export period (1-60, default=5 minutes).
TimeoutGeneral int
Configure flow session general timeout (60-604800, default=3600 seconds).
TimeoutIcmp int
Configure flow session ICMP timeout (60-604800, default=300 seconds).
TimeoutMax int
Configure flow session max timeout (60-604800, default=604800 seconds).
TimeoutTcp int
Configure flow session TCP timeout (60-604800, default=3600 seconds).
TimeoutTcpFin int
Configure flow session TCP FIN timeout (60-604800, default=300 seconds).
TimeoutTcpRst int
Configure flow session TCP RST timeout (60-604800, default=120 seconds).
TimeoutUdp int
Configure flow session UDP timeout (60-604800, default=300 seconds).
Transport string
Configure L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
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.
aggregates List<FlowtrackingAggregate>
Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. The structure of aggregates block is documented below.
collectorIp String
Configure collector ip address.
collectorPort Integer
Configure collector port number(0-65535, default=0).
collectors List<FlowtrackingCollector>
Configure collectors for the flow. The structure of collectors 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 ].
format String
Configure flow tracking protocol. Valid values: netflow1, netflow5, netflow9, ipfix.
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.
level String
Configure flow tracking level. Valid values: vlan, ip, port, proto, mac.
maxExportPktSize Integer
Configure flow max export packet size (512-9216, default=512 bytes).
sampleMode String
Configure sample mode for the flow tracking. Valid values: local, perimeter, device-ingress.
sampleRate Integer
Configure sample rate for the perimeter and device-ingress sampling(0 - 99999).
templateExportPeriod Integer
Configure template export period (1-60, default=5 minutes).
timeoutGeneral Integer
Configure flow session general timeout (60-604800, default=3600 seconds).
timeoutIcmp Integer
Configure flow session ICMP timeout (60-604800, default=300 seconds).
timeoutMax Integer
Configure flow session max timeout (60-604800, default=604800 seconds).
timeoutTcp Integer
Configure flow session TCP timeout (60-604800, default=3600 seconds).
timeoutTcpFin Integer
Configure flow session TCP FIN timeout (60-604800, default=300 seconds).
timeoutTcpRst Integer
Configure flow session TCP RST timeout (60-604800, default=120 seconds).
timeoutUdp Integer
Configure flow session UDP timeout (60-604800, default=300 seconds).
transport String
Configure L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
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.
aggregates FlowtrackingAggregate[]
Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. The structure of aggregates block is documented below.
collectorIp string
Configure collector ip address.
collectorPort number
Configure collector port number(0-65535, default=0).
collectors FlowtrackingCollector[]
Configure collectors for the flow. The structure of collectors 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 ].
format string
Configure flow tracking protocol. Valid values: netflow1, netflow5, netflow9, ipfix.
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.
level string
Configure flow tracking level. Valid values: vlan, ip, port, proto, mac.
maxExportPktSize number
Configure flow max export packet size (512-9216, default=512 bytes).
sampleMode string
Configure sample mode for the flow tracking. Valid values: local, perimeter, device-ingress.
sampleRate number
Configure sample rate for the perimeter and device-ingress sampling(0 - 99999).
templateExportPeriod number
Configure template export period (1-60, default=5 minutes).
timeoutGeneral number
Configure flow session general timeout (60-604800, default=3600 seconds).
timeoutIcmp number
Configure flow session ICMP timeout (60-604800, default=300 seconds).
timeoutMax number
Configure flow session max timeout (60-604800, default=604800 seconds).
timeoutTcp number
Configure flow session TCP timeout (60-604800, default=3600 seconds).
timeoutTcpFin number
Configure flow session TCP FIN timeout (60-604800, default=300 seconds).
timeoutTcpRst number
Configure flow session TCP RST timeout (60-604800, default=120 seconds).
timeoutUdp number
Configure flow session UDP timeout (60-604800, default=300 seconds).
transport string
Configure L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
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.
aggregates Sequence[FlowtrackingAggregateArgs]
Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. The structure of aggregates block is documented below.
collector_ip str
Configure collector ip address.
collector_port int
Configure collector port number(0-65535, default=0).
collectors Sequence[FlowtrackingCollectorArgs]
Configure collectors for the flow. The structure of collectors 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 ].
format str
Configure flow tracking protocol. Valid values: netflow1, netflow5, netflow9, ipfix.
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.
level str
Configure flow tracking level. Valid values: vlan, ip, port, proto, mac.
max_export_pkt_size int
Configure flow max export packet size (512-9216, default=512 bytes).
sample_mode str
Configure sample mode for the flow tracking. Valid values: local, perimeter, device-ingress.
sample_rate int
Configure sample rate for the perimeter and device-ingress sampling(0 - 99999).
template_export_period int
Configure template export period (1-60, default=5 minutes).
timeout_general int
Configure flow session general timeout (60-604800, default=3600 seconds).
timeout_icmp int
Configure flow session ICMP timeout (60-604800, default=300 seconds).
timeout_max int
Configure flow session max timeout (60-604800, default=604800 seconds).
timeout_tcp int
Configure flow session TCP timeout (60-604800, default=3600 seconds).
timeout_tcp_fin int
Configure flow session TCP FIN timeout (60-604800, default=300 seconds).
timeout_tcp_rst int
Configure flow session TCP RST timeout (60-604800, default=120 seconds).
timeout_udp int
Configure flow session UDP timeout (60-604800, default=300 seconds).
transport str
Configure L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
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.
aggregates List<Property Map>
Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. The structure of aggregates block is documented below.
collectorIp String
Configure collector ip address.
collectorPort Number
Configure collector port number(0-65535, default=0).
collectors List<Property Map>
Configure collectors for the flow. The structure of collectors 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 ].
format String
Configure flow tracking protocol. Valid values: netflow1, netflow5, netflow9, ipfix.
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.
level String
Configure flow tracking level. Valid values: vlan, ip, port, proto, mac.
maxExportPktSize Number
Configure flow max export packet size (512-9216, default=512 bytes).
sampleMode String
Configure sample mode for the flow tracking. Valid values: local, perimeter, device-ingress.
sampleRate Number
Configure sample rate for the perimeter and device-ingress sampling(0 - 99999).
templateExportPeriod Number
Configure template export period (1-60, default=5 minutes).
timeoutGeneral Number
Configure flow session general timeout (60-604800, default=3600 seconds).
timeoutIcmp Number
Configure flow session ICMP timeout (60-604800, default=300 seconds).
timeoutMax Number
Configure flow session max timeout (60-604800, default=604800 seconds).
timeoutTcp Number
Configure flow session TCP timeout (60-604800, default=3600 seconds).
timeoutTcpFin Number
Configure flow session TCP FIN timeout (60-604800, default=300 seconds).
timeoutTcpRst Number
Configure flow session TCP RST timeout (60-604800, default=120 seconds).
timeoutUdp Number
Configure flow session UDP timeout (60-604800, default=300 seconds).
transport String
Configure L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
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 Flowtracking 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 Flowtracking Resource

Get an existing Flowtracking 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?: FlowtrackingState, opts?: CustomResourceOptions): Flowtracking
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aggregates: Optional[Sequence[FlowtrackingAggregateArgs]] = None,
        collector_ip: Optional[str] = None,
        collector_port: Optional[int] = None,
        collectors: Optional[Sequence[FlowtrackingCollectorArgs]] = None,
        dynamic_sort_subtable: Optional[str] = None,
        format: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        level: Optional[str] = None,
        max_export_pkt_size: Optional[int] = None,
        sample_mode: Optional[str] = None,
        sample_rate: Optional[int] = None,
        template_export_period: Optional[int] = None,
        timeout_general: Optional[int] = None,
        timeout_icmp: Optional[int] = None,
        timeout_max: Optional[int] = None,
        timeout_tcp: Optional[int] = None,
        timeout_tcp_fin: Optional[int] = None,
        timeout_tcp_rst: Optional[int] = None,
        timeout_udp: Optional[int] = None,
        transport: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Flowtracking
func GetFlowtracking(ctx *Context, name string, id IDInput, state *FlowtrackingState, opts ...ResourceOption) (*Flowtracking, error)
public static Flowtracking Get(string name, Input<string> id, FlowtrackingState? state, CustomResourceOptions? opts = null)
public static Flowtracking get(String name, Output<String> id, FlowtrackingState state, CustomResourceOptions options)
resources:  _:    type: fortios:switchcontroller:Flowtracking    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:
Aggregates List<Pulumiverse.Fortios.Switchcontroller.Inputs.FlowtrackingAggregate>
Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. The structure of aggregates block is documented below.
CollectorIp string
Configure collector ip address.
CollectorPort int
Configure collector port number(0-65535, default=0).
Collectors List<Pulumiverse.Fortios.Switchcontroller.Inputs.FlowtrackingCollector>
Configure collectors for the flow. The structure of collectors 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 ].
Format string
Configure flow tracking protocol. Valid values: netflow1, netflow5, netflow9, ipfix.
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.
Level string
Configure flow tracking level. Valid values: vlan, ip, port, proto, mac.
MaxExportPktSize int
Configure flow max export packet size (512-9216, default=512 bytes).
SampleMode string
Configure sample mode for the flow tracking. Valid values: local, perimeter, device-ingress.
SampleRate int
Configure sample rate for the perimeter and device-ingress sampling(0 - 99999).
TemplateExportPeriod int
Configure template export period (1-60, default=5 minutes).
TimeoutGeneral int
Configure flow session general timeout (60-604800, default=3600 seconds).
TimeoutIcmp int
Configure flow session ICMP timeout (60-604800, default=300 seconds).
TimeoutMax int
Configure flow session max timeout (60-604800, default=604800 seconds).
TimeoutTcp int
Configure flow session TCP timeout (60-604800, default=3600 seconds).
TimeoutTcpFin int
Configure flow session TCP FIN timeout (60-604800, default=300 seconds).
TimeoutTcpRst int
Configure flow session TCP RST timeout (60-604800, default=120 seconds).
TimeoutUdp int
Configure flow session UDP timeout (60-604800, default=300 seconds).
Transport string
Configure L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
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.
Aggregates []FlowtrackingAggregateArgs
Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. The structure of aggregates block is documented below.
CollectorIp string
Configure collector ip address.
CollectorPort int
Configure collector port number(0-65535, default=0).
Collectors []FlowtrackingCollectorArgs
Configure collectors for the flow. The structure of collectors 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 ].
Format string
Configure flow tracking protocol. Valid values: netflow1, netflow5, netflow9, ipfix.
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.
Level string
Configure flow tracking level. Valid values: vlan, ip, port, proto, mac.
MaxExportPktSize int
Configure flow max export packet size (512-9216, default=512 bytes).
SampleMode string
Configure sample mode for the flow tracking. Valid values: local, perimeter, device-ingress.
SampleRate int
Configure sample rate for the perimeter and device-ingress sampling(0 - 99999).
TemplateExportPeriod int
Configure template export period (1-60, default=5 minutes).
TimeoutGeneral int
Configure flow session general timeout (60-604800, default=3600 seconds).
TimeoutIcmp int
Configure flow session ICMP timeout (60-604800, default=300 seconds).
TimeoutMax int
Configure flow session max timeout (60-604800, default=604800 seconds).
TimeoutTcp int
Configure flow session TCP timeout (60-604800, default=3600 seconds).
TimeoutTcpFin int
Configure flow session TCP FIN timeout (60-604800, default=300 seconds).
TimeoutTcpRst int
Configure flow session TCP RST timeout (60-604800, default=120 seconds).
TimeoutUdp int
Configure flow session UDP timeout (60-604800, default=300 seconds).
Transport string
Configure L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
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.
aggregates List<FlowtrackingAggregate>
Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. The structure of aggregates block is documented below.
collectorIp String
Configure collector ip address.
collectorPort Integer
Configure collector port number(0-65535, default=0).
collectors List<FlowtrackingCollector>
Configure collectors for the flow. The structure of collectors 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 ].
format String
Configure flow tracking protocol. Valid values: netflow1, netflow5, netflow9, ipfix.
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.
level String
Configure flow tracking level. Valid values: vlan, ip, port, proto, mac.
maxExportPktSize Integer
Configure flow max export packet size (512-9216, default=512 bytes).
sampleMode String
Configure sample mode for the flow tracking. Valid values: local, perimeter, device-ingress.
sampleRate Integer
Configure sample rate for the perimeter and device-ingress sampling(0 - 99999).
templateExportPeriod Integer
Configure template export period (1-60, default=5 minutes).
timeoutGeneral Integer
Configure flow session general timeout (60-604800, default=3600 seconds).
timeoutIcmp Integer
Configure flow session ICMP timeout (60-604800, default=300 seconds).
timeoutMax Integer
Configure flow session max timeout (60-604800, default=604800 seconds).
timeoutTcp Integer
Configure flow session TCP timeout (60-604800, default=3600 seconds).
timeoutTcpFin Integer
Configure flow session TCP FIN timeout (60-604800, default=300 seconds).
timeoutTcpRst Integer
Configure flow session TCP RST timeout (60-604800, default=120 seconds).
timeoutUdp Integer
Configure flow session UDP timeout (60-604800, default=300 seconds).
transport String
Configure L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
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.
aggregates FlowtrackingAggregate[]
Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. The structure of aggregates block is documented below.
collectorIp string
Configure collector ip address.
collectorPort number
Configure collector port number(0-65535, default=0).
collectors FlowtrackingCollector[]
Configure collectors for the flow. The structure of collectors 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 ].
format string
Configure flow tracking protocol. Valid values: netflow1, netflow5, netflow9, ipfix.
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.
level string
Configure flow tracking level. Valid values: vlan, ip, port, proto, mac.
maxExportPktSize number
Configure flow max export packet size (512-9216, default=512 bytes).
sampleMode string
Configure sample mode for the flow tracking. Valid values: local, perimeter, device-ingress.
sampleRate number
Configure sample rate for the perimeter and device-ingress sampling(0 - 99999).
templateExportPeriod number
Configure template export period (1-60, default=5 minutes).
timeoutGeneral number
Configure flow session general timeout (60-604800, default=3600 seconds).
timeoutIcmp number
Configure flow session ICMP timeout (60-604800, default=300 seconds).
timeoutMax number
Configure flow session max timeout (60-604800, default=604800 seconds).
timeoutTcp number
Configure flow session TCP timeout (60-604800, default=3600 seconds).
timeoutTcpFin number
Configure flow session TCP FIN timeout (60-604800, default=300 seconds).
timeoutTcpRst number
Configure flow session TCP RST timeout (60-604800, default=120 seconds).
timeoutUdp number
Configure flow session UDP timeout (60-604800, default=300 seconds).
transport string
Configure L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
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.
aggregates Sequence[FlowtrackingAggregateArgs]
Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. The structure of aggregates block is documented below.
collector_ip str
Configure collector ip address.
collector_port int
Configure collector port number(0-65535, default=0).
collectors Sequence[FlowtrackingCollectorArgs]
Configure collectors for the flow. The structure of collectors 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 ].
format str
Configure flow tracking protocol. Valid values: netflow1, netflow5, netflow9, ipfix.
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.
level str
Configure flow tracking level. Valid values: vlan, ip, port, proto, mac.
max_export_pkt_size int
Configure flow max export packet size (512-9216, default=512 bytes).
sample_mode str
Configure sample mode for the flow tracking. Valid values: local, perimeter, device-ingress.
sample_rate int
Configure sample rate for the perimeter and device-ingress sampling(0 - 99999).
template_export_period int
Configure template export period (1-60, default=5 minutes).
timeout_general int
Configure flow session general timeout (60-604800, default=3600 seconds).
timeout_icmp int
Configure flow session ICMP timeout (60-604800, default=300 seconds).
timeout_max int
Configure flow session max timeout (60-604800, default=604800 seconds).
timeout_tcp int
Configure flow session TCP timeout (60-604800, default=3600 seconds).
timeout_tcp_fin int
Configure flow session TCP FIN timeout (60-604800, default=300 seconds).
timeout_tcp_rst int
Configure flow session TCP RST timeout (60-604800, default=120 seconds).
timeout_udp int
Configure flow session UDP timeout (60-604800, default=300 seconds).
transport str
Configure L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
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.
aggregates List<Property Map>
Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. The structure of aggregates block is documented below.
collectorIp String
Configure collector ip address.
collectorPort Number
Configure collector port number(0-65535, default=0).
collectors List<Property Map>
Configure collectors for the flow. The structure of collectors 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 ].
format String
Configure flow tracking protocol. Valid values: netflow1, netflow5, netflow9, ipfix.
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.
level String
Configure flow tracking level. Valid values: vlan, ip, port, proto, mac.
maxExportPktSize Number
Configure flow max export packet size (512-9216, default=512 bytes).
sampleMode String
Configure sample mode for the flow tracking. Valid values: local, perimeter, device-ingress.
sampleRate Number
Configure sample rate for the perimeter and device-ingress sampling(0 - 99999).
templateExportPeriod Number
Configure template export period (1-60, default=5 minutes).
timeoutGeneral Number
Configure flow session general timeout (60-604800, default=3600 seconds).
timeoutIcmp Number
Configure flow session ICMP timeout (60-604800, default=300 seconds).
timeoutMax Number
Configure flow session max timeout (60-604800, default=604800 seconds).
timeoutTcp Number
Configure flow session TCP timeout (60-604800, default=3600 seconds).
timeoutTcpFin Number
Configure flow session TCP FIN timeout (60-604800, default=300 seconds).
timeoutTcpRst Number
Configure flow session TCP RST timeout (60-604800, default=120 seconds).
timeoutUdp Number
Configure flow session UDP timeout (60-604800, default=300 seconds).
transport String
Configure L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
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

FlowtrackingAggregate
, FlowtrackingAggregateArgs

Id int
Aggregate id.
Ip string
IP address to group all matching traffic sessions to a flow.
Id int
Aggregate id.
Ip string
IP address to group all matching traffic sessions to a flow.
id Integer
Aggregate id.
ip String
IP address to group all matching traffic sessions to a flow.
id number
Aggregate id.
ip string
IP address to group all matching traffic sessions to a flow.
id int
Aggregate id.
ip str
IP address to group all matching traffic sessions to a flow.
id Number
Aggregate id.
ip String
IP address to group all matching traffic sessions to a flow.

FlowtrackingCollector
, FlowtrackingCollectorArgs

Ip string
Collector IP address.
Name string
Collector name.
Port int
Collector port number(0-65535, default:0, netflow:2055, ipfix:4739).
Transport string
Collector L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
Ip string
Collector IP address.
Name string
Collector name.
Port int
Collector port number(0-65535, default:0, netflow:2055, ipfix:4739).
Transport string
Collector L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
ip String
Collector IP address.
name String
Collector name.
port Integer
Collector port number(0-65535, default:0, netflow:2055, ipfix:4739).
transport String
Collector L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
ip string
Collector IP address.
name string
Collector name.
port number
Collector port number(0-65535, default:0, netflow:2055, ipfix:4739).
transport string
Collector L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
ip str
Collector IP address.
name str
Collector name.
port int
Collector port number(0-65535, default:0, netflow:2055, ipfix:4739).
transport str
Collector L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.
ip String
Collector IP address.
name String
Collector name.
port Number
Collector port number(0-65535, default:0, netflow:2055, ipfix:4739).
transport String
Collector L4 transport protocol for exporting packets. Valid values: udp, tcp, sctp.

Import

SwitchController FlowTracking can be imported using any of these accepted formats:

$ pulumi import fortios:switchcontroller/flowtracking:Flowtracking labelname SwitchControllerFlowTracking
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:switchcontroller/flowtracking:Flowtracking labelname SwitchControllerFlowTracking
Copy

$ unset “FORTIOS_IMPORT_TABLE”

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios