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

fortios.system.Ips

Explore with Pulumi AI

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

Configure IPS system settings. Applies to FortiOS Version >= 6.4.2.

Create Ips Resource

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

Constructor syntax

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

@overload
def Ips(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        override_signature_hold_by_id: Optional[str] = None,
        signature_hold_time: Optional[str] = None,
        vdomparam: Optional[str] = None)
func NewIps(ctx *Context, name string, args *IpsArgs, opts ...ResourceOption) (*Ips, error)
public Ips(string name, IpsArgs? args = null, CustomResourceOptions? opts = null)
public Ips(String name, IpsArgs args)
public Ips(String name, IpsArgs args, CustomResourceOptions options)

type: fortios:system:Ips
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 IpsArgs
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 IpsArgs
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 IpsArgs
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 IpsArgs
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. IpsArgs
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 ipsResource = new Fortios.System.Ips("ipsResource", new()
{
    OverrideSignatureHoldById = "string",
    SignatureHoldTime = "string",
    Vdomparam = "string",
});
Copy
example, err := system.NewIps(ctx, "ipsResource", &system.IpsArgs{
	OverrideSignatureHoldById: pulumi.String("string"),
	SignatureHoldTime:         pulumi.String("string"),
	Vdomparam:                 pulumi.String("string"),
})
Copy
var ipsResource = new Ips("ipsResource", IpsArgs.builder()
    .overrideSignatureHoldById("string")
    .signatureHoldTime("string")
    .vdomparam("string")
    .build());
Copy
ips_resource = fortios.system.Ips("ipsResource",
    override_signature_hold_by_id="string",
    signature_hold_time="string",
    vdomparam="string")
Copy
const ipsResource = new fortios.system.Ips("ipsResource", {
    overrideSignatureHoldById: "string",
    signatureHoldTime: "string",
    vdomparam: "string",
});
Copy
type: fortios:system:Ips
properties:
    overrideSignatureHoldById: string
    signatureHoldTime: string
    vdomparam: string
Copy

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

OverrideSignatureHoldById string
Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. Valid values: enable, disable.
SignatureHoldTime string
Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h, default hold time: 0d0h).
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.
OverrideSignatureHoldById string
Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. Valid values: enable, disable.
SignatureHoldTime string
Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h, default hold time: 0d0h).
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.
overrideSignatureHoldById String
Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. Valid values: enable, disable.
signatureHoldTime String
Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h, default hold time: 0d0h).
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.
overrideSignatureHoldById string
Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. Valid values: enable, disable.
signatureHoldTime string
Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h, default hold time: 0d0h).
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.
override_signature_hold_by_id str
Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. Valid values: enable, disable.
signature_hold_time str
Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h, default hold time: 0d0h).
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.
overrideSignatureHoldById String
Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. Valid values: enable, disable.
signatureHoldTime String
Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h, default hold time: 0d0h).
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 Ips 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 Ips Resource

Get an existing Ips 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?: IpsState, opts?: CustomResourceOptions): Ips
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        override_signature_hold_by_id: Optional[str] = None,
        signature_hold_time: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Ips
func GetIps(ctx *Context, name string, id IDInput, state *IpsState, opts ...ResourceOption) (*Ips, error)
public static Ips Get(string name, Input<string> id, IpsState? state, CustomResourceOptions? opts = null)
public static Ips get(String name, Output<String> id, IpsState state, CustomResourceOptions options)
resources:  _:    type: fortios:system:Ips    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:
OverrideSignatureHoldById string
Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. Valid values: enable, disable.
SignatureHoldTime string
Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h, default hold time: 0d0h).
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.
OverrideSignatureHoldById string
Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. Valid values: enable, disable.
SignatureHoldTime string
Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h, default hold time: 0d0h).
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.
overrideSignatureHoldById String
Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. Valid values: enable, disable.
signatureHoldTime String
Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h, default hold time: 0d0h).
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.
overrideSignatureHoldById string
Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. Valid values: enable, disable.
signatureHoldTime string
Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h, default hold time: 0d0h).
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.
override_signature_hold_by_id str
Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. Valid values: enable, disable.
signature_hold_time str
Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h, default hold time: 0d0h).
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.
overrideSignatureHoldById String
Enable/disable override of hold of triggering signatures that are specified by IDs regardless of hold. Valid values: enable, disable.
signatureHoldTime String
Time to hold and monitor IPS signatures. Format <#d##h> (day range: 0 - 7, hour range: 0 - 23, max hold time: 7d0h, default hold time: 0d0h).
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.

Import

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

$ pulumi import fortios:system/ips:Ips labelname SystemIps
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:system/ips:Ips labelname SystemIps
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