1. Packages
  2. Fortios
  3. API Docs
  4. switchcontroller
  5. Stormcontrol
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.switchcontroller.Stormcontrol

Explore with Pulumi AI

Configure FortiSwitch storm control.

Create Stormcontrol Resource

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

Constructor syntax

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

@overload
def Stormcontrol(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 broadcast: Optional[str] = None,
                 rate: Optional[int] = None,
                 unknown_multicast: Optional[str] = None,
                 unknown_unicast: Optional[str] = None,
                 vdomparam: Optional[str] = None)
func NewStormcontrol(ctx *Context, name string, args *StormcontrolArgs, opts ...ResourceOption) (*Stormcontrol, error)
public Stormcontrol(string name, StormcontrolArgs? args = null, CustomResourceOptions? opts = null)
public Stormcontrol(String name, StormcontrolArgs args)
public Stormcontrol(String name, StormcontrolArgs args, CustomResourceOptions options)
type: fortios:switchcontroller:Stormcontrol
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 StormcontrolArgs
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 StormcontrolArgs
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 StormcontrolArgs
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 StormcontrolArgs
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. StormcontrolArgs
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 stormcontrolResource = new Fortios.Switchcontroller.Stormcontrol("stormcontrolResource", new()
{
    Broadcast = "string",
    Rate = 0,
    UnknownMulticast = "string",
    UnknownUnicast = "string",
    Vdomparam = "string",
});
Copy
example, err := switchcontroller.NewStormcontrol(ctx, "stormcontrolResource", &switchcontroller.StormcontrolArgs{
	Broadcast:        pulumi.String("string"),
	Rate:             pulumi.Int(0),
	UnknownMulticast: pulumi.String("string"),
	UnknownUnicast:   pulumi.String("string"),
	Vdomparam:        pulumi.String("string"),
})
Copy
var stormcontrolResource = new Stormcontrol("stormcontrolResource", StormcontrolArgs.builder()
    .broadcast("string")
    .rate(0)
    .unknownMulticast("string")
    .unknownUnicast("string")
    .vdomparam("string")
    .build());
Copy
stormcontrol_resource = fortios.switchcontroller.Stormcontrol("stormcontrolResource",
    broadcast="string",
    rate=0,
    unknown_multicast="string",
    unknown_unicast="string",
    vdomparam="string")
Copy
const stormcontrolResource = new fortios.switchcontroller.Stormcontrol("stormcontrolResource", {
    broadcast: "string",
    rate: 0,
    unknownMulticast: "string",
    unknownUnicast: "string",
    vdomparam: "string",
});
Copy
type: fortios:switchcontroller:Stormcontrol
properties:
    broadcast: string
    rate: 0
    unknownMulticast: string
    unknownUnicast: string
    vdomparam: string
Copy

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

Broadcast string
Enable/disable storm control to drop broadcast traffic. Valid values: enable, disable.
Rate int
Rate in packets per second at which storm control drops excess traffic, default=500. On FortiOS versions 6.2.0-7.2.8: 1 - 10000000. On FortiOS versions >= 7.4.0: 0-10000000, drop-all=0.
UnknownMulticast string
Enable/disable storm control to drop unknown multicast traffic. Valid values: enable, disable.
UnknownUnicast string
Enable/disable storm control to drop unknown unicast traffic. Valid values: enable, disable.
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.
Broadcast string
Enable/disable storm control to drop broadcast traffic. Valid values: enable, disable.
Rate int
Rate in packets per second at which storm control drops excess traffic, default=500. On FortiOS versions 6.2.0-7.2.8: 1 - 10000000. On FortiOS versions >= 7.4.0: 0-10000000, drop-all=0.
UnknownMulticast string
Enable/disable storm control to drop unknown multicast traffic. Valid values: enable, disable.
UnknownUnicast string
Enable/disable storm control to drop unknown unicast traffic. Valid values: enable, disable.
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.
broadcast String
Enable/disable storm control to drop broadcast traffic. Valid values: enable, disable.
rate Integer
Rate in packets per second at which storm control drops excess traffic, default=500. On FortiOS versions 6.2.0-7.2.8: 1 - 10000000. On FortiOS versions >= 7.4.0: 0-10000000, drop-all=0.
unknownMulticast String
Enable/disable storm control to drop unknown multicast traffic. Valid values: enable, disable.
unknownUnicast String
Enable/disable storm control to drop unknown unicast traffic. Valid values: enable, disable.
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.
broadcast string
Enable/disable storm control to drop broadcast traffic. Valid values: enable, disable.
rate number
Rate in packets per second at which storm control drops excess traffic, default=500. On FortiOS versions 6.2.0-7.2.8: 1 - 10000000. On FortiOS versions >= 7.4.0: 0-10000000, drop-all=0.
unknownMulticast string
Enable/disable storm control to drop unknown multicast traffic. Valid values: enable, disable.
unknownUnicast string
Enable/disable storm control to drop unknown unicast traffic. Valid values: enable, disable.
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.
broadcast str
Enable/disable storm control to drop broadcast traffic. Valid values: enable, disable.
rate int
Rate in packets per second at which storm control drops excess traffic, default=500. On FortiOS versions 6.2.0-7.2.8: 1 - 10000000. On FortiOS versions >= 7.4.0: 0-10000000, drop-all=0.
unknown_multicast str
Enable/disable storm control to drop unknown multicast traffic. Valid values: enable, disable.
unknown_unicast str
Enable/disable storm control to drop unknown unicast traffic. Valid values: enable, disable.
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.
broadcast String
Enable/disable storm control to drop broadcast traffic. Valid values: enable, disable.
rate Number
Rate in packets per second at which storm control drops excess traffic, default=500. On FortiOS versions 6.2.0-7.2.8: 1 - 10000000. On FortiOS versions >= 7.4.0: 0-10000000, drop-all=0.
unknownMulticast String
Enable/disable storm control to drop unknown multicast traffic. Valid values: enable, disable.
unknownUnicast String
Enable/disable storm control to drop unknown unicast traffic. Valid values: enable, disable.
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 Stormcontrol 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 Stormcontrol Resource

Get an existing Stormcontrol 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?: StormcontrolState, opts?: CustomResourceOptions): Stormcontrol
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        broadcast: Optional[str] = None,
        rate: Optional[int] = None,
        unknown_multicast: Optional[str] = None,
        unknown_unicast: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Stormcontrol
func GetStormcontrol(ctx *Context, name string, id IDInput, state *StormcontrolState, opts ...ResourceOption) (*Stormcontrol, error)
public static Stormcontrol Get(string name, Input<string> id, StormcontrolState? state, CustomResourceOptions? opts = null)
public static Stormcontrol get(String name, Output<String> id, StormcontrolState state, CustomResourceOptions options)
resources:  _:    type: fortios:switchcontroller:Stormcontrol    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:
Broadcast string
Enable/disable storm control to drop broadcast traffic. Valid values: enable, disable.
Rate int
Rate in packets per second at which storm control drops excess traffic, default=500. On FortiOS versions 6.2.0-7.2.8: 1 - 10000000. On FortiOS versions >= 7.4.0: 0-10000000, drop-all=0.
UnknownMulticast string
Enable/disable storm control to drop unknown multicast traffic. Valid values: enable, disable.
UnknownUnicast string
Enable/disable storm control to drop unknown unicast traffic. Valid values: enable, disable.
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.
Broadcast string
Enable/disable storm control to drop broadcast traffic. Valid values: enable, disable.
Rate int
Rate in packets per second at which storm control drops excess traffic, default=500. On FortiOS versions 6.2.0-7.2.8: 1 - 10000000. On FortiOS versions >= 7.4.0: 0-10000000, drop-all=0.
UnknownMulticast string
Enable/disable storm control to drop unknown multicast traffic. Valid values: enable, disable.
UnknownUnicast string
Enable/disable storm control to drop unknown unicast traffic. Valid values: enable, disable.
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.
broadcast String
Enable/disable storm control to drop broadcast traffic. Valid values: enable, disable.
rate Integer
Rate in packets per second at which storm control drops excess traffic, default=500. On FortiOS versions 6.2.0-7.2.8: 1 - 10000000. On FortiOS versions >= 7.4.0: 0-10000000, drop-all=0.
unknownMulticast String
Enable/disable storm control to drop unknown multicast traffic. Valid values: enable, disable.
unknownUnicast String
Enable/disable storm control to drop unknown unicast traffic. Valid values: enable, disable.
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.
broadcast string
Enable/disable storm control to drop broadcast traffic. Valid values: enable, disable.
rate number
Rate in packets per second at which storm control drops excess traffic, default=500. On FortiOS versions 6.2.0-7.2.8: 1 - 10000000. On FortiOS versions >= 7.4.0: 0-10000000, drop-all=0.
unknownMulticast string
Enable/disable storm control to drop unknown multicast traffic. Valid values: enable, disable.
unknownUnicast string
Enable/disable storm control to drop unknown unicast traffic. Valid values: enable, disable.
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.
broadcast str
Enable/disable storm control to drop broadcast traffic. Valid values: enable, disable.
rate int
Rate in packets per second at which storm control drops excess traffic, default=500. On FortiOS versions 6.2.0-7.2.8: 1 - 10000000. On FortiOS versions >= 7.4.0: 0-10000000, drop-all=0.
unknown_multicast str
Enable/disable storm control to drop unknown multicast traffic. Valid values: enable, disable.
unknown_unicast str
Enable/disable storm control to drop unknown unicast traffic. Valid values: enable, disable.
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.
broadcast String
Enable/disable storm control to drop broadcast traffic. Valid values: enable, disable.
rate Number
Rate in packets per second at which storm control drops excess traffic, default=500. On FortiOS versions 6.2.0-7.2.8: 1 - 10000000. On FortiOS versions >= 7.4.0: 0-10000000, drop-all=0.
unknownMulticast String
Enable/disable storm control to drop unknown multicast traffic. Valid values: enable, disable.
unknownUnicast String
Enable/disable storm control to drop unknown unicast traffic. Valid values: enable, disable.
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

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

$ pulumi import fortios:switchcontroller/stormcontrol:Stormcontrol labelname SwitchControllerStormControl
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:switchcontroller/stormcontrol:Stormcontrol labelname SwitchControllerStormControl
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.