@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
194 lines (193 loc) • 8.59 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Configure NetFlow per VDOM.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.system.Vdomnetflow("trname", {
* collectorIp: "0.0.0.0",
* collectorPort: 2055,
* sourceIp: "0.0.0.0",
* vdomNetflow: "disable",
* });
* ```
*
* ## Import
*
* System VdomNetflow can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:system/vdomnetflow:Vdomnetflow labelname SystemVdomNetflow
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:system/vdomnetflow:Vdomnetflow labelname SystemVdomNetflow
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Vdomnetflow extends pulumi.CustomResource {
/**
* Get an existing Vdomnetflow resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VdomnetflowState, opts?: pulumi.CustomResourceOptions): Vdomnetflow;
/**
* Returns true if the given object is an instance of Vdomnetflow. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Vdomnetflow;
/**
* NetFlow collector IP address.
*/
readonly collectorIp: pulumi.Output<string>;
/**
* NetFlow collector port number.
*/
readonly collectorPort: pulumi.Output<number>;
/**
* Netflow collectors. The structure of `collectors` block is documented below.
*/
readonly collectors: pulumi.Output<outputs.system.VdomnetflowCollector[] | undefined>;
/**
* 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 ].
*/
readonly dynamicSortSubtable: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly getAllTables: pulumi.Output<string | undefined>;
/**
* Specify outgoing interface to reach server.
*/
readonly interface: pulumi.Output<string>;
/**
* Specify how to select outgoing interface to reach server. Valid values: `auto`, `sdwan`, `specify`.
*/
readonly interfaceSelectMethod: pulumi.Output<string>;
/**
* Source IP address for communication with the NetFlow agent.
*/
readonly sourceIp: pulumi.Output<string>;
/**
* Enable/disable NetFlow per VDOM. Valid values: `enable`, `disable`.
*/
readonly vdomNetflow: pulumi.Output<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.
*/
readonly vdomparam: pulumi.Output<string>;
/**
* Create a Vdomnetflow resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: VdomnetflowArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Vdomnetflow resources.
*/
export interface VdomnetflowState {
/**
* NetFlow collector IP address.
*/
collectorIp?: pulumi.Input<string>;
/**
* NetFlow collector port number.
*/
collectorPort?: pulumi.Input<number>;
/**
* Netflow collectors. The structure of `collectors` block is documented below.
*/
collectors?: pulumi.Input<pulumi.Input<inputs.system.VdomnetflowCollector>[]>;
/**
* 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 ].
*/
dynamicSortSubtable?: pulumi.Input<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.
*/
getAllTables?: pulumi.Input<string>;
/**
* Specify outgoing interface to reach server.
*/
interface?: pulumi.Input<string>;
/**
* Specify how to select outgoing interface to reach server. Valid values: `auto`, `sdwan`, `specify`.
*/
interfaceSelectMethod?: pulumi.Input<string>;
/**
* Source IP address for communication with the NetFlow agent.
*/
sourceIp?: pulumi.Input<string>;
/**
* Enable/disable NetFlow per VDOM. Valid values: `enable`, `disable`.
*/
vdomNetflow?: pulumi.Input<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.
*/
vdomparam?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Vdomnetflow resource.
*/
export interface VdomnetflowArgs {
/**
* NetFlow collector IP address.
*/
collectorIp?: pulumi.Input<string>;
/**
* NetFlow collector port number.
*/
collectorPort?: pulumi.Input<number>;
/**
* Netflow collectors. The structure of `collectors` block is documented below.
*/
collectors?: pulumi.Input<pulumi.Input<inputs.system.VdomnetflowCollector>[]>;
/**
* 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 ].
*/
dynamicSortSubtable?: pulumi.Input<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.
*/
getAllTables?: pulumi.Input<string>;
/**
* Specify outgoing interface to reach server.
*/
interface?: pulumi.Input<string>;
/**
* Specify how to select outgoing interface to reach server. Valid values: `auto`, `sdwan`, `specify`.
*/
interfaceSelectMethod?: pulumi.Input<string>;
/**
* Source IP address for communication with the NetFlow agent.
*/
sourceIp?: pulumi.Input<string>;
/**
* Enable/disable NetFlow per VDOM. Valid values: `enable`, `disable`.
*/
vdomNetflow?: pulumi.Input<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.
*/
vdomparam?: pulumi.Input<string>;
}