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

fortios.system.Netflow

Explore with Pulumi AI

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

    Configure NetFlow.

    Example Usage

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

const trname = new fortios.system.Netflow("trname", {
    activeFlowTimeout: 30,
    collectorIp: "0.0.0.0",
    collectorPort: 2055,
    inactiveFlowTimeout: 15,
    sourceIp: "0.0.0.0",
    templateTxCounter: 20,
    templateTxTimeout: 30,
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.Netflow("trname",
    active_flow_timeout=30,
    collector_ip="0.0.0.0",
    collector_port=2055,
    inactive_flow_timeout=15,
    source_ip="0.0.0.0",
    template_tx_counter=20,
    template_tx_timeout=30)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := system.NewNetflow(ctx, "trname", &system.NetflowArgs{
			ActiveFlowTimeout:   pulumi.Int(30),
			CollectorIp:         pulumi.String("0.0.0.0"),
			CollectorPort:       pulumi.Int(2055),
			InactiveFlowTimeout: pulumi.Int(15),
			SourceIp:            pulumi.String("0.0.0.0"),
			TemplateTxCounter:   pulumi.Int(20),
			TemplateTxTimeout:   pulumi.Int(30),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.System.Netflow("trname", new()
    {
        ActiveFlowTimeout = 30,
        CollectorIp = "0.0.0.0",
        CollectorPort = 2055,
        InactiveFlowTimeout = 15,
        SourceIp = "0.0.0.0",
        TemplateTxCounter = 20,
        TemplateTxTimeout = 30,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Netflow;
import com.pulumi.fortios.system.NetflowArgs;
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 Netflow("trname", NetflowArgs.builder()
            .activeFlowTimeout(30)
            .collectorIp("0.0.0.0")
            .collectorPort(2055)
            .inactiveFlowTimeout(15)
            .sourceIp("0.0.0.0")
            .templateTxCounter(20)
            .templateTxTimeout(30)
            .build());

    }
}

    resources:
  trname:
    type: fortios:system:Netflow
    properties:
      activeFlowTimeout: 30
      collectorIp: 0.0.0.0
      collectorPort: 2055
      inactiveFlowTimeout: 15
      sourceIp: 0.0.0.0
      templateTxCounter: 20
      templateTxTimeout: 30

    Create Netflow Resource

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

    Constructor syntax

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

@overload
def Netflow(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            active_flow_timeout: Optional[int] = None,
            collector_ip: Optional[str] = None,
            collector_port: Optional[int] = None,
            collectors: Optional[Sequence[NetflowCollectorArgs]] = None,
            dynamic_sort_subtable: Optional[str] = None,
            get_all_tables: Optional[str] = None,
            inactive_flow_timeout: Optional[int] = None,
            interface: Optional[str] = None,
            interface_select_method: Optional[str] = None,
            source_ip: Optional[str] = None,
            template_tx_counter: Optional[int] = None,
            template_tx_timeout: Optional[int] = None,
            vdomparam: Optional[str] = None)
    func NewNetflow(ctx *Context, name string, args *NetflowArgs, opts ...ResourceOption) (*Netflow, error)
    public Netflow(string name, NetflowArgs? args = null, CustomResourceOptions? opts = null)
    public Netflow(String name, NetflowArgs args)
public Netflow(String name, NetflowArgs args, CustomResourceOptions options)

    type: fortios:system:Netflow
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args NetflowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NetflowArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NetflowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetflowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetflowArgs
    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 netflowResource = new Fortios.System.Netflow("netflowResource", new()
{
    ActiveFlowTimeout = 0,
    CollectorIp = "string",
    CollectorPort = 0,
    Collectors = new[]
    {
        new Fortios.System.Inputs.NetflowCollectorArgs
        {
            CollectorIp = "string",
            CollectorPort = 0,
            Id = 0,
            Interface = "string",
            InterfaceSelectMethod = "string",
            SourceIp = "string",
        },
    },
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    InactiveFlowTimeout = 0,
    Interface = "string",
    InterfaceSelectMethod = "string",
    SourceIp = "string",
    TemplateTxCounter = 0,
    TemplateTxTimeout = 0,
    Vdomparam = "string",
});

    example, err := system.NewNetflow(ctx, "netflowResource", &system.NetflowArgs{
	ActiveFlowTimeout: pulumi.Int(0),
	CollectorIp:       pulumi.String("string"),
	CollectorPort:     pulumi.Int(0),
	Collectors: system.NetflowCollectorArray{
		&system.NetflowCollectorArgs{
			CollectorIp:           pulumi.String("string"),
			CollectorPort:         pulumi.Int(0),
			Id:                    pulumi.Int(0),
			Interface:             pulumi.String("string"),
			InterfaceSelectMethod: pulumi.String("string"),
			SourceIp:              pulumi.String("string"),
		},
	},
	DynamicSortSubtable:   pulumi.String("string"),
	GetAllTables:          pulumi.String("string"),
	InactiveFlowTimeout:   pulumi.Int(0),
	Interface:             pulumi.String("string"),
	InterfaceSelectMethod: pulumi.String("string"),
	SourceIp:              pulumi.String("string"),
	TemplateTxCounter:     pulumi.Int(0),
	TemplateTxTimeout:     pulumi.Int(0),
	Vdomparam:             pulumi.String("string"),
})

    var netflowResource = new Netflow("netflowResource", NetflowArgs.builder()
    .activeFlowTimeout(0)
    .collectorIp("string")
    .collectorPort(0)
    .collectors(NetflowCollectorArgs.builder()
        .collectorIp("string")
        .collectorPort(0)
        .id(0)
        .interface_("string")
        .interfaceSelectMethod("string")
        .sourceIp("string")
        .build())
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .inactiveFlowTimeout(0)
    .interface_("string")
    .interfaceSelectMethod("string")
    .sourceIp("string")
    .templateTxCounter(0)
    .templateTxTimeout(0)
    .vdomparam("string")
    .build());

    netflow_resource = fortios.system.Netflow("netflowResource",
    active_flow_timeout=0,
    collector_ip="string",
    collector_port=0,
    collectors=[fortios.system.NetflowCollectorArgs(
        collector_ip="string",
        collector_port=0,
        id=0,
        interface="string",
        interface_select_method="string",
        source_ip="string",
    )],
    dynamic_sort_subtable="string",
    get_all_tables="string",
    inactive_flow_timeout=0,
    interface="string",
    interface_select_method="string",
    source_ip="string",
    template_tx_counter=0,
    template_tx_timeout=0,
    vdomparam="string")

    const netflowResource = new fortios.system.Netflow("netflowResource", {
    activeFlowTimeout: 0,
    collectorIp: "string",
    collectorPort: 0,
    collectors: [{
        collectorIp: "string",
        collectorPort: 0,
        id: 0,
        "interface": "string",
        interfaceSelectMethod: "string",
        sourceIp: "string",
    }],
    dynamicSortSubtable: "string",
    getAllTables: "string",
    inactiveFlowTimeout: 0,
    "interface": "string",
    interfaceSelectMethod: "string",
    sourceIp: "string",
    templateTxCounter: 0,
    templateTxTimeout: 0,
    vdomparam: "string",
});

    type: fortios:system:Netflow
properties:
    activeFlowTimeout: 0
    collectorIp: string
    collectorPort: 0
    collectors:
        - collectorIp: string
          collectorPort: 0
          id: 0
          interface: string
          interfaceSelectMethod: string
          sourceIp: string
    dynamicSortSubtable: string
    getAllTables: string
    inactiveFlowTimeout: 0
    interface: string
    interfaceSelectMethod: string
    sourceIp: string
    templateTxCounter: 0
    templateTxTimeout: 0
    vdomparam: string

    Netflow Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Netflow resource accepts the following input properties:

    ActiveFlowTimeout int
    Timeout to report active flows. On FortiOS versions 6.2.0-7.0.0: 1 - 60 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 3600 sec, default = 1800.
    CollectorIp string
    Collector IP.
    CollectorPort int
    NetFlow collector port number.
    Collectors List<Pulumiverse.Fortios.System.Inputs.NetflowCollector>
    Netflow collectors. 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 ].
    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.
    InactiveFlowTimeout int
    Timeout for periodic report of finished flows (10 - 600 sec, default = 15).
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    SourceIp string
    Source IP address for communication with the NetFlow agent.
    TemplateTxCounter int
    Counter of flowset records before resending a template flowset record.
    TemplateTxTimeout int
    Timeout for periodic template flowset transmission. On FortiOS versions 6.2.0-7.0.0: 1 - 1440 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 86400 sec, default = 1800.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    ActiveFlowTimeout int
    Timeout to report active flows. On FortiOS versions 6.2.0-7.0.0: 1 - 60 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 3600 sec, default = 1800.
    CollectorIp string
    Collector IP.
    CollectorPort int
    NetFlow collector port number.
    Collectors []NetflowCollectorArgs
    Netflow collectors. 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 ].
    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.
    InactiveFlowTimeout int
    Timeout for periodic report of finished flows (10 - 600 sec, default = 15).
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    SourceIp string
    Source IP address for communication with the NetFlow agent.
    TemplateTxCounter int
    Counter of flowset records before resending a template flowset record.
    TemplateTxTimeout int
    Timeout for periodic template flowset transmission. On FortiOS versions 6.2.0-7.0.0: 1 - 1440 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 86400 sec, default = 1800.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    activeFlowTimeout Integer
    Timeout to report active flows. On FortiOS versions 6.2.0-7.0.0: 1 - 60 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 3600 sec, default = 1800.
    collectorIp String
    Collector IP.
    collectorPort Integer
    NetFlow collector port number.
    collectors List<NetflowCollector>
    Netflow collectors. 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 ].
    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.
    inactiveFlowTimeout Integer
    Timeout for periodic report of finished flows (10 - 600 sec, default = 15).
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    interface_ String
    Specify outgoing interface to reach server.
    sourceIp String
    Source IP address for communication with the NetFlow agent.
    templateTxCounter Integer
    Counter of flowset records before resending a template flowset record.
    templateTxTimeout Integer
    Timeout for periodic template flowset transmission. On FortiOS versions 6.2.0-7.0.0: 1 - 1440 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 86400 sec, default = 1800.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    activeFlowTimeout number
    Timeout to report active flows. On FortiOS versions 6.2.0-7.0.0: 1 - 60 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 3600 sec, default = 1800.
    collectorIp string
    Collector IP.
    collectorPort number
    NetFlow collector port number.
    collectors NetflowCollector[]
    Netflow collectors. 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 ].
    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.
    inactiveFlowTimeout number
    Timeout for periodic report of finished flows (10 - 600 sec, default = 15).
    interface string
    Specify outgoing interface to reach server.
    interfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    sourceIp string
    Source IP address for communication with the NetFlow agent.
    templateTxCounter number
    Counter of flowset records before resending a template flowset record.
    templateTxTimeout number
    Timeout for periodic template flowset transmission. On FortiOS versions 6.2.0-7.0.0: 1 - 1440 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 86400 sec, default = 1800.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    active_flow_timeout int
    Timeout to report active flows. On FortiOS versions 6.2.0-7.0.0: 1 - 60 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 3600 sec, default = 1800.
    collector_ip str
    Collector IP.
    collector_port int
    NetFlow collector port number.
    collectors Sequence[NetflowCollectorArgs]
    Netflow collectors. 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 ].
    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.
    inactive_flow_timeout int
    Timeout for periodic report of finished flows (10 - 600 sec, default = 15).
    interface str
    Specify outgoing interface to reach server.
    interface_select_method str
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    source_ip str
    Source IP address for communication with the NetFlow agent.
    template_tx_counter int
    Counter of flowset records before resending a template flowset record.
    template_tx_timeout int
    Timeout for periodic template flowset transmission. On FortiOS versions 6.2.0-7.0.0: 1 - 1440 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 86400 sec, default = 1800.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    activeFlowTimeout Number
    Timeout to report active flows. On FortiOS versions 6.2.0-7.0.0: 1 - 60 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 3600 sec, default = 1800.
    collectorIp String
    Collector IP.
    collectorPort Number
    NetFlow collector port number.
    collectors List<Property Map>
    Netflow collectors. 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 ].
    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.
    inactiveFlowTimeout Number
    Timeout for periodic report of finished flows (10 - 600 sec, default = 15).
    interface String
    Specify outgoing interface to reach server.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    sourceIp String
    Source IP address for communication with the NetFlow agent.
    templateTxCounter Number
    Counter of flowset records before resending a template flowset record.
    templateTxTimeout Number
    Timeout for periodic template flowset transmission. On FortiOS versions 6.2.0-7.0.0: 1 - 1440 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 86400 sec, default = 1800.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Netflow 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 Netflow Resource

    Get an existing Netflow 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?: NetflowState, opts?: CustomResourceOptions): Netflow
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_flow_timeout: Optional[int] = None,
        collector_ip: Optional[str] = None,
        collector_port: Optional[int] = None,
        collectors: Optional[Sequence[NetflowCollectorArgs]] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        inactive_flow_timeout: Optional[int] = None,
        interface: Optional[str] = None,
        interface_select_method: Optional[str] = None,
        source_ip: Optional[str] = None,
        template_tx_counter: Optional[int] = None,
        template_tx_timeout: Optional[int] = None,
        vdomparam: Optional[str] = None) -> Netflow
    func GetNetflow(ctx *Context, name string, id IDInput, state *NetflowState, opts ...ResourceOption) (*Netflow, error)
    public static Netflow Get(string name, Input<string> id, NetflowState? state, CustomResourceOptions? opts = null)
    public static Netflow get(String name, Output<String> id, NetflowState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ActiveFlowTimeout int
    Timeout to report active flows. On FortiOS versions 6.2.0-7.0.0: 1 - 60 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 3600 sec, default = 1800.
    CollectorIp string
    Collector IP.
    CollectorPort int
    NetFlow collector port number.
    Collectors List<Pulumiverse.Fortios.System.Inputs.NetflowCollector>
    Netflow collectors. 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 ].
    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.
    InactiveFlowTimeout int
    Timeout for periodic report of finished flows (10 - 600 sec, default = 15).
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    SourceIp string
    Source IP address for communication with the NetFlow agent.
    TemplateTxCounter int
    Counter of flowset records before resending a template flowset record.
    TemplateTxTimeout int
    Timeout for periodic template flowset transmission. On FortiOS versions 6.2.0-7.0.0: 1 - 1440 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 86400 sec, default = 1800.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    ActiveFlowTimeout int
    Timeout to report active flows. On FortiOS versions 6.2.0-7.0.0: 1 - 60 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 3600 sec, default = 1800.
    CollectorIp string
    Collector IP.
    CollectorPort int
    NetFlow collector port number.
    Collectors []NetflowCollectorArgs
    Netflow collectors. 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 ].
    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.
    InactiveFlowTimeout int
    Timeout for periodic report of finished flows (10 - 600 sec, default = 15).
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    SourceIp string
    Source IP address for communication with the NetFlow agent.
    TemplateTxCounter int
    Counter of flowset records before resending a template flowset record.
    TemplateTxTimeout int
    Timeout for periodic template flowset transmission. On FortiOS versions 6.2.0-7.0.0: 1 - 1440 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 86400 sec, default = 1800.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    activeFlowTimeout Integer
    Timeout to report active flows. On FortiOS versions 6.2.0-7.0.0: 1 - 60 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 3600 sec, default = 1800.
    collectorIp String
    Collector IP.
    collectorPort Integer
    NetFlow collector port number.
    collectors List<NetflowCollector>
    Netflow collectors. 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 ].
    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.
    inactiveFlowTimeout Integer
    Timeout for periodic report of finished flows (10 - 600 sec, default = 15).
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    interface_ String
    Specify outgoing interface to reach server.
    sourceIp String
    Source IP address for communication with the NetFlow agent.
    templateTxCounter Integer
    Counter of flowset records before resending a template flowset record.
    templateTxTimeout Integer
    Timeout for periodic template flowset transmission. On FortiOS versions 6.2.0-7.0.0: 1 - 1440 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 86400 sec, default = 1800.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    activeFlowTimeout number
    Timeout to report active flows. On FortiOS versions 6.2.0-7.0.0: 1 - 60 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 3600 sec, default = 1800.
    collectorIp string
    Collector IP.
    collectorPort number
    NetFlow collector port number.
    collectors NetflowCollector[]
    Netflow collectors. 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 ].
    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.
    inactiveFlowTimeout number
    Timeout for periodic report of finished flows (10 - 600 sec, default = 15).
    interface string
    Specify outgoing interface to reach server.
    interfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    sourceIp string
    Source IP address for communication with the NetFlow agent.
    templateTxCounter number
    Counter of flowset records before resending a template flowset record.
    templateTxTimeout number
    Timeout for periodic template flowset transmission. On FortiOS versions 6.2.0-7.0.0: 1 - 1440 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 86400 sec, default = 1800.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    active_flow_timeout int
    Timeout to report active flows. On FortiOS versions 6.2.0-7.0.0: 1 - 60 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 3600 sec, default = 1800.
    collector_ip str
    Collector IP.
    collector_port int
    NetFlow collector port number.
    collectors Sequence[NetflowCollectorArgs]
    Netflow collectors. 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 ].
    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.
    inactive_flow_timeout int
    Timeout for periodic report of finished flows (10 - 600 sec, default = 15).
    interface str
    Specify outgoing interface to reach server.
    interface_select_method str
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    source_ip str
    Source IP address for communication with the NetFlow agent.
    template_tx_counter int
    Counter of flowset records before resending a template flowset record.
    template_tx_timeout int
    Timeout for periodic template flowset transmission. On FortiOS versions 6.2.0-7.0.0: 1 - 1440 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 86400 sec, default = 1800.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    activeFlowTimeout Number
    Timeout to report active flows. On FortiOS versions 6.2.0-7.0.0: 1 - 60 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 3600 sec, default = 1800.
    collectorIp String
    Collector IP.
    collectorPort Number
    NetFlow collector port number.
    collectors List<Property Map>
    Netflow collectors. 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 ].
    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.
    inactiveFlowTimeout Number
    Timeout for periodic report of finished flows (10 - 600 sec, default = 15).
    interface String
    Specify outgoing interface to reach server.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    sourceIp String
    Source IP address for communication with the NetFlow agent.
    templateTxCounter Number
    Counter of flowset records before resending a template flowset record.
    templateTxTimeout Number
    Timeout for periodic template flowset transmission. On FortiOS versions 6.2.0-7.0.0: 1 - 1440 min, default = 30. On FortiOS versions >= 7.0.1: 60 - 86400 sec, default = 1800.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Supporting Types

    NetflowCollector, NetflowCollectorArgs

    CollectorIp string
    Collector IP.
    CollectorPort int
    NetFlow collector port number.
    Id int
    ID.
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    SourceIp string
    Source IP address for communication with the NetFlow agent.
    CollectorIp string
    Collector IP.
    CollectorPort int
    NetFlow collector port number.
    Id int
    ID.
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    SourceIp string
    Source IP address for communication with the NetFlow agent.
    collectorIp String
    Collector IP.
    collectorPort Integer
    NetFlow collector port number.
    id Integer
    ID.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    interface_ String
    Specify outgoing interface to reach server.
    sourceIp String
    Source IP address for communication with the NetFlow agent.
    collectorIp string
    Collector IP.
    collectorPort number
    NetFlow collector port number.
    id number
    ID.
    interface string
    Specify outgoing interface to reach server.
    interfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    sourceIp string
    Source IP address for communication with the NetFlow agent.
    collector_ip str
    Collector IP.
    collector_port int
    NetFlow collector port number.
    id int
    ID.
    interface str
    Specify outgoing interface to reach server.
    interface_select_method str
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    source_ip str
    Source IP address for communication with the NetFlow agent.
    collectorIp String
    Collector IP.
    collectorPort Number
    NetFlow collector port number.
    id Number
    ID.
    interface String
    Specify outgoing interface to reach server.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    sourceIp String
    Source IP address for communication with the NetFlow agent.

    Import

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

    $ pulumi import fortios:system/netflow:Netflow labelname SystemNetflow

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/netflow:Netflow labelname SystemNetflow

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

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