@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
437 lines (436 loc) • 18.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Configure general log settings.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.log.Setting("trname", {
* briefTrafficFormat: "disable",
* daemonLog: "disable",
* expolicyImplicitLog: "disable",
* fazOverride: "disable",
* fwpolicy6ImplicitLog: "disable",
* fwpolicyImplicitLog: "disable",
* localInAllow: "disable",
* localInDenyBroadcast: "disable",
* localInDenyUnicast: "disable",
* localOut: "disable",
* logInvalidPacket: "disable",
* logPolicyComment: "disable",
* logPolicyName: "disable",
* logUserInUpper: "disable",
* neighborEvent: "disable",
* resolveIp: "disable",
* resolvePort: "enable",
* syslogOverride: "disable",
* userAnonymize: "disable",
* });
* ```
*
* ## Import
*
* Log Setting can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:log/setting:Setting labelname LogSetting
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:log/setting:Setting labelname LogSetting
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Setting extends pulumi.CustomResource {
/**
* Get an existing Setting 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?: SettingState, opts?: pulumi.CustomResourceOptions): Setting;
/**
* Returns true if the given object is an instance of Setting. 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 Setting;
/**
* User name anonymization hash salt.
*/
readonly anonymizationHash: pulumi.Output<string>;
/**
* Enable/disable brief format traffic logging. Valid values: `enable`, `disable`.
*/
readonly briefTrafficFormat: pulumi.Output<string>;
/**
* Custom fields to append to all log messages. The structure of `customLogFields` block is documented below.
*/
readonly customLogFields: pulumi.Output<outputs.log.SettingCustomLogField[] | undefined>;
/**
* Enable/disable daemon logging. Valid values: `enable`, `disable`.
*/
readonly daemonLog: pulumi.Output<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 ].
*/
readonly dynamicSortSubtable: pulumi.Output<string | undefined>;
/**
* Enable/disable explicit proxy firewall implicit policy logging. Valid values: `enable`, `disable`.
*/
readonly expolicyImplicitLog: pulumi.Output<string>;
/**
* Enable/disable extended traffic logging. Valid values: `enable`, `disable`.
*/
readonly extendedLog: pulumi.Output<string>;
/**
* Enable/disable override FortiAnalyzer settings. Valid values: `enable`, `disable`.
*/
readonly fazOverride: pulumi.Output<string>;
/**
* Enable/disable implicit firewall policy6 logging. Valid values: `enable`, `disable`.
*/
readonly fwpolicy6ImplicitLog: pulumi.Output<string>;
/**
* Enable/disable implicit firewall policy logging. Valid values: `enable`, `disable`.
*/
readonly fwpolicyImplicitLog: pulumi.Output<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.
*/
readonly getAllTables: pulumi.Output<string | undefined>;
/**
* Enable/disable local-in-allow logging. Valid values: `enable`, `disable`.
*/
readonly localInAllow: pulumi.Output<string>;
/**
* Enable/disable local-in-deny-broadcast logging. Valid values: `enable`, `disable`.
*/
readonly localInDenyBroadcast: pulumi.Output<string>;
/**
* Enable/disable local-in-deny-unicast logging. Valid values: `enable`, `disable`.
*/
readonly localInDenyUnicast: pulumi.Output<string>;
/**
* Enable/disable local-out logging. Valid values: `enable`, `disable`.
*/
readonly localOut: pulumi.Output<string>;
/**
* Enable/disable local-out traffic IoC detection. Requires local-out to be enabled. Valid values: `enable`, `disable`.
*/
readonly localOutIocDetection: pulumi.Output<string>;
/**
* Enable/disable invalid packet traffic logging. Valid values: `enable`, `disable`.
*/
readonly logInvalidPacket: pulumi.Output<string>;
/**
* Enable/disable inserting policy comments into traffic logs. Valid values: `enable`, `disable`.
*/
readonly logPolicyComment: pulumi.Output<string>;
/**
* Enable/disable inserting policy name into traffic logs. Valid values: `enable`, `disable`.
*/
readonly logPolicyName: pulumi.Output<string>;
/**
* Enable/disable logs with user-in-upper. Valid values: `enable`, `disable`.
*/
readonly logUserInUpper: pulumi.Output<string>;
/**
* Enable/disable long-live-session statistics logging. Valid values: `enable`, `disable`.
*/
readonly longLiveSessionStat: pulumi.Output<string>;
/**
* Enable/disable neighbor event logging. Valid values: `enable`, `disable`.
*/
readonly neighborEvent: pulumi.Output<string>;
/**
* Enable/disable adding resolved domain names to traffic logs if possible. Valid values: `enable`, `disable`.
*/
readonly resolveIp: pulumi.Output<string>;
/**
* Enable/disable adding resolved service names to traffic logs. Valid values: `enable`, `disable`.
*/
readonly resolvePort: pulumi.Output<string>;
/**
* Enable/disable REST API GET request logging. Valid values: `enable`, `disable`.
*/
readonly restApiGet: pulumi.Output<string>;
/**
* Enable/disable REST API POST/PUT/DELETE request logging. Valid values: `enable`, `disable`.
*/
readonly restApiSet: pulumi.Output<string>;
/**
* Enable/disable override Syslog settings. Valid values: `enable`, `disable`.
*/
readonly syslogOverride: pulumi.Output<string>;
/**
* Enable/disable anonymizing user names in log messages. Valid values: `enable`, `disable`.
*/
readonly userAnonymize: 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 Setting 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?: SettingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Setting resources.
*/
export interface SettingState {
/**
* User name anonymization hash salt.
*/
anonymizationHash?: pulumi.Input<string>;
/**
* Enable/disable brief format traffic logging. Valid values: `enable`, `disable`.
*/
briefTrafficFormat?: pulumi.Input<string>;
/**
* Custom fields to append to all log messages. The structure of `customLogFields` block is documented below.
*/
customLogFields?: pulumi.Input<pulumi.Input<inputs.log.SettingCustomLogField>[]>;
/**
* Enable/disable daemon logging. Valid values: `enable`, `disable`.
*/
daemonLog?: pulumi.Input<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 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* Enable/disable explicit proxy firewall implicit policy logging. Valid values: `enable`, `disable`.
*/
expolicyImplicitLog?: pulumi.Input<string>;
/**
* Enable/disable extended traffic logging. Valid values: `enable`, `disable`.
*/
extendedLog?: pulumi.Input<string>;
/**
* Enable/disable override FortiAnalyzer settings. Valid values: `enable`, `disable`.
*/
fazOverride?: pulumi.Input<string>;
/**
* Enable/disable implicit firewall policy6 logging. Valid values: `enable`, `disable`.
*/
fwpolicy6ImplicitLog?: pulumi.Input<string>;
/**
* Enable/disable implicit firewall policy logging. Valid values: `enable`, `disable`.
*/
fwpolicyImplicitLog?: 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>;
/**
* Enable/disable local-in-allow logging. Valid values: `enable`, `disable`.
*/
localInAllow?: pulumi.Input<string>;
/**
* Enable/disable local-in-deny-broadcast logging. Valid values: `enable`, `disable`.
*/
localInDenyBroadcast?: pulumi.Input<string>;
/**
* Enable/disable local-in-deny-unicast logging. Valid values: `enable`, `disable`.
*/
localInDenyUnicast?: pulumi.Input<string>;
/**
* Enable/disable local-out logging. Valid values: `enable`, `disable`.
*/
localOut?: pulumi.Input<string>;
/**
* Enable/disable local-out traffic IoC detection. Requires local-out to be enabled. Valid values: `enable`, `disable`.
*/
localOutIocDetection?: pulumi.Input<string>;
/**
* Enable/disable invalid packet traffic logging. Valid values: `enable`, `disable`.
*/
logInvalidPacket?: pulumi.Input<string>;
/**
* Enable/disable inserting policy comments into traffic logs. Valid values: `enable`, `disable`.
*/
logPolicyComment?: pulumi.Input<string>;
/**
* Enable/disable inserting policy name into traffic logs. Valid values: `enable`, `disable`.
*/
logPolicyName?: pulumi.Input<string>;
/**
* Enable/disable logs with user-in-upper. Valid values: `enable`, `disable`.
*/
logUserInUpper?: pulumi.Input<string>;
/**
* Enable/disable long-live-session statistics logging. Valid values: `enable`, `disable`.
*/
longLiveSessionStat?: pulumi.Input<string>;
/**
* Enable/disable neighbor event logging. Valid values: `enable`, `disable`.
*/
neighborEvent?: pulumi.Input<string>;
/**
* Enable/disable adding resolved domain names to traffic logs if possible. Valid values: `enable`, `disable`.
*/
resolveIp?: pulumi.Input<string>;
/**
* Enable/disable adding resolved service names to traffic logs. Valid values: `enable`, `disable`.
*/
resolvePort?: pulumi.Input<string>;
/**
* Enable/disable REST API GET request logging. Valid values: `enable`, `disable`.
*/
restApiGet?: pulumi.Input<string>;
/**
* Enable/disable REST API POST/PUT/DELETE request logging. Valid values: `enable`, `disable`.
*/
restApiSet?: pulumi.Input<string>;
/**
* Enable/disable override Syslog settings. Valid values: `enable`, `disable`.
*/
syslogOverride?: pulumi.Input<string>;
/**
* Enable/disable anonymizing user names in log messages. Valid values: `enable`, `disable`.
*/
userAnonymize?: 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 Setting resource.
*/
export interface SettingArgs {
/**
* User name anonymization hash salt.
*/
anonymizationHash?: pulumi.Input<string>;
/**
* Enable/disable brief format traffic logging. Valid values: `enable`, `disable`.
*/
briefTrafficFormat?: pulumi.Input<string>;
/**
* Custom fields to append to all log messages. The structure of `customLogFields` block is documented below.
*/
customLogFields?: pulumi.Input<pulumi.Input<inputs.log.SettingCustomLogField>[]>;
/**
* Enable/disable daemon logging. Valid values: `enable`, `disable`.
*/
daemonLog?: pulumi.Input<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 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* Enable/disable explicit proxy firewall implicit policy logging. Valid values: `enable`, `disable`.
*/
expolicyImplicitLog?: pulumi.Input<string>;
/**
* Enable/disable extended traffic logging. Valid values: `enable`, `disable`.
*/
extendedLog?: pulumi.Input<string>;
/**
* Enable/disable override FortiAnalyzer settings. Valid values: `enable`, `disable`.
*/
fazOverride?: pulumi.Input<string>;
/**
* Enable/disable implicit firewall policy6 logging. Valid values: `enable`, `disable`.
*/
fwpolicy6ImplicitLog?: pulumi.Input<string>;
/**
* Enable/disable implicit firewall policy logging. Valid values: `enable`, `disable`.
*/
fwpolicyImplicitLog?: 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>;
/**
* Enable/disable local-in-allow logging. Valid values: `enable`, `disable`.
*/
localInAllow?: pulumi.Input<string>;
/**
* Enable/disable local-in-deny-broadcast logging. Valid values: `enable`, `disable`.
*/
localInDenyBroadcast?: pulumi.Input<string>;
/**
* Enable/disable local-in-deny-unicast logging. Valid values: `enable`, `disable`.
*/
localInDenyUnicast?: pulumi.Input<string>;
/**
* Enable/disable local-out logging. Valid values: `enable`, `disable`.
*/
localOut?: pulumi.Input<string>;
/**
* Enable/disable local-out traffic IoC detection. Requires local-out to be enabled. Valid values: `enable`, `disable`.
*/
localOutIocDetection?: pulumi.Input<string>;
/**
* Enable/disable invalid packet traffic logging. Valid values: `enable`, `disable`.
*/
logInvalidPacket?: pulumi.Input<string>;
/**
* Enable/disable inserting policy comments into traffic logs. Valid values: `enable`, `disable`.
*/
logPolicyComment?: pulumi.Input<string>;
/**
* Enable/disable inserting policy name into traffic logs. Valid values: `enable`, `disable`.
*/
logPolicyName?: pulumi.Input<string>;
/**
* Enable/disable logs with user-in-upper. Valid values: `enable`, `disable`.
*/
logUserInUpper?: pulumi.Input<string>;
/**
* Enable/disable long-live-session statistics logging. Valid values: `enable`, `disable`.
*/
longLiveSessionStat?: pulumi.Input<string>;
/**
* Enable/disable neighbor event logging. Valid values: `enable`, `disable`.
*/
neighborEvent?: pulumi.Input<string>;
/**
* Enable/disable adding resolved domain names to traffic logs if possible. Valid values: `enable`, `disable`.
*/
resolveIp?: pulumi.Input<string>;
/**
* Enable/disable adding resolved service names to traffic logs. Valid values: `enable`, `disable`.
*/
resolvePort?: pulumi.Input<string>;
/**
* Enable/disable REST API GET request logging. Valid values: `enable`, `disable`.
*/
restApiGet?: pulumi.Input<string>;
/**
* Enable/disable REST API POST/PUT/DELETE request logging. Valid values: `enable`, `disable`.
*/
restApiSet?: pulumi.Input<string>;
/**
* Enable/disable override Syslog settings. Valid values: `enable`, `disable`.
*/
syslogOverride?: pulumi.Input<string>;
/**
* Enable/disable anonymizing user names in log messages. Valid values: `enable`, `disable`.
*/
userAnonymize?: 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>;
}