Docs Home
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
fortios.switchcontroller.Stormcontrolpolicy
Explore with Pulumi AI
Configure FortiSwitch storm control policy to be applied on managed-switch ports. Applies to FortiOS Version >= 6.2.4.
Create Stormcontrolpolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Stormcontrolpolicy(name: string, args?: StormcontrolpolicyArgs, opts?: CustomResourceOptions);@overload
def Stormcontrolpolicy(resource_name: str,
args: Optional[StormcontrolpolicyArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Stormcontrolpolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
broadcast: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
rate: Optional[int] = None,
storm_control_mode: Optional[str] = None,
unknown_multicast: Optional[str] = None,
unknown_unicast: Optional[str] = None,
vdomparam: Optional[str] = None)func NewStormcontrolpolicy(ctx *Context, name string, args *StormcontrolpolicyArgs, opts ...ResourceOption) (*Stormcontrolpolicy, error)public Stormcontrolpolicy(string name, StormcontrolpolicyArgs? args = null, CustomResourceOptions? opts = null)
public Stormcontrolpolicy(String name, StormcontrolpolicyArgs args)
public Stormcontrolpolicy(String name, StormcontrolpolicyArgs args, CustomResourceOptions options)
type: fortios:switchcontroller:Stormcontrolpolicy
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 StormcontrolpolicyArgs
- 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 StormcontrolpolicyArgs
- 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 StormcontrolpolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StormcontrolpolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StormcontrolpolicyArgs
- 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 stormcontrolpolicyResource = new Fortios.Switchcontroller.Stormcontrolpolicy("stormcontrolpolicyResource", new()
{
Broadcast = "string",
Description = "string",
Name = "string",
Rate = 0,
StormControlMode = "string",
UnknownMulticast = "string",
UnknownUnicast = "string",
Vdomparam = "string",
});
example, err := switchcontroller.NewStormcontrolpolicy(ctx, "stormcontrolpolicyResource", &switchcontroller.StormcontrolpolicyArgs{
Broadcast: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Rate: pulumi.Int(0),
StormControlMode: pulumi.String("string"),
UnknownMulticast: pulumi.String("string"),
UnknownUnicast: pulumi.String("string"),
Vdomparam: pulumi.String("string"),
})
var stormcontrolpolicyResource = new Stormcontrolpolicy("stormcontrolpolicyResource", StormcontrolpolicyArgs.builder()
.broadcast("string")
.description("string")
.name("string")
.rate(0)
.stormControlMode("string")
.unknownMulticast("string")
.unknownUnicast("string")
.vdomparam("string")
.build());
stormcontrolpolicy_resource = fortios.switchcontroller.Stormcontrolpolicy("stormcontrolpolicyResource",
broadcast="string",
description="string",
name="string",
rate=0,
storm_control_mode="string",
unknown_multicast="string",
unknown_unicast="string",
vdomparam="string")
const stormcontrolpolicyResource = new fortios.switchcontroller.Stormcontrolpolicy("stormcontrolpolicyResource", {
broadcast: "string",
description: "string",
name: "string",
rate: 0,
stormControlMode: "string",
unknownMulticast: "string",
unknownUnicast: "string",
vdomparam: "string",
});
type: fortios:switchcontroller:Stormcontrolpolicy
properties:
broadcast: string
description: string
name: string
rate: 0
stormControlMode: string
unknownMulticast: string
unknownUnicast: string
vdomparam: string
Stormcontrolpolicy 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 Stormcontrolpolicy resource accepts the following input properties:
- Broadcast string
- Enable/disable storm control to drop/allow broadcast traffic in override mode. Valid values:
enable,disable. - Description string
- Description of the storm control policy.
- Name string
- Storm control policy name.
- Rate int
- Threshold rate in packets per second at which storm traffic is controlled in override mode (default=500, 0 to drop all).
- Storm
Control stringMode - Set Storm control mode. Valid values:
global,override,disabled. - Unknown
Multicast string - Enable/disable storm control to drop/allow unknown multicast traffic in override mode. Valid values:
enable,disable. - Unknown
Unicast string - Enable/disable storm control to drop/allow unknown unicast traffic in override mode. Valid values:
enable,disable. - 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.
- Broadcast string
- Enable/disable storm control to drop/allow broadcast traffic in override mode. Valid values:
enable,disable. - Description string
- Description of the storm control policy.
- Name string
- Storm control policy name.
- Rate int
- Threshold rate in packets per second at which storm traffic is controlled in override mode (default=500, 0 to drop all).
- Storm
Control stringMode - Set Storm control mode. Valid values:
global,override,disabled. - Unknown
Multicast string - Enable/disable storm control to drop/allow unknown multicast traffic in override mode. Valid values:
enable,disable. - Unknown
Unicast string - Enable/disable storm control to drop/allow unknown unicast traffic in override mode. Valid values:
enable,disable. - 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.
- broadcast String
- Enable/disable storm control to drop/allow broadcast traffic in override mode. Valid values:
enable,disable. - description String
- Description of the storm control policy.
- name String
- Storm control policy name.
- rate Integer
- Threshold rate in packets per second at which storm traffic is controlled in override mode (default=500, 0 to drop all).
- storm
Control StringMode - Set Storm control mode. Valid values:
global,override,disabled. - unknown
Multicast String - Enable/disable storm control to drop/allow unknown multicast traffic in override mode. Valid values:
enable,disable. - unknown
Unicast String - Enable/disable storm control to drop/allow unknown unicast traffic in override mode. Valid values:
enable,disable. - 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.
- broadcast string
- Enable/disable storm control to drop/allow broadcast traffic in override mode. Valid values:
enable,disable. - description string
- Description of the storm control policy.
- name string
- Storm control policy name.
- rate number
- Threshold rate in packets per second at which storm traffic is controlled in override mode (default=500, 0 to drop all).
- storm
Control stringMode - Set Storm control mode. Valid values:
global,override,disabled. - unknown
Multicast string - Enable/disable storm control to drop/allow unknown multicast traffic in override mode. Valid values:
enable,disable. - unknown
Unicast string - Enable/disable storm control to drop/allow unknown unicast traffic in override mode. Valid values:
enable,disable. - 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.
- broadcast str
- Enable/disable storm control to drop/allow broadcast traffic in override mode. Valid values:
enable,disable. - description str
- Description of the storm control policy.
- name str
- Storm control policy name.
- rate int
- Threshold rate in packets per second at which storm traffic is controlled in override mode (default=500, 0 to drop all).
- storm_
control_ strmode - Set Storm control mode. Valid values:
global,override,disabled. - unknown_
multicast str - Enable/disable storm control to drop/allow unknown multicast traffic in override mode. Valid values:
enable,disable. - unknown_
unicast str - Enable/disable storm control to drop/allow unknown unicast traffic in override mode. Valid values:
enable,disable. - 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.
- broadcast String
- Enable/disable storm control to drop/allow broadcast traffic in override mode. Valid values:
enable,disable. - description String
- Description of the storm control policy.
- name String
- Storm control policy name.
- rate Number
- Threshold rate in packets per second at which storm traffic is controlled in override mode (default=500, 0 to drop all).
- storm
Control StringMode - Set Storm control mode. Valid values:
global,override,disabled. - unknown
Multicast String - Enable/disable storm control to drop/allow unknown multicast traffic in override mode. Valid values:
enable,disable. - unknown
Unicast String - Enable/disable storm control to drop/allow unknown unicast traffic in override mode. Valid values:
enable,disable. - 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 Stormcontrolpolicy 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 Stormcontrolpolicy Resource
Get an existing Stormcontrolpolicy 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?: StormcontrolpolicyState, opts?: CustomResourceOptions): Stormcontrolpolicy@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
broadcast: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
rate: Optional[int] = None,
storm_control_mode: Optional[str] = None,
unknown_multicast: Optional[str] = None,
unknown_unicast: Optional[str] = None,
vdomparam: Optional[str] = None) -> Stormcontrolpolicyfunc GetStormcontrolpolicy(ctx *Context, name string, id IDInput, state *StormcontrolpolicyState, opts ...ResourceOption) (*Stormcontrolpolicy, error)public static Stormcontrolpolicy Get(string name, Input<string> id, StormcontrolpolicyState? state, CustomResourceOptions? opts = null)public static Stormcontrolpolicy get(String name, Output<String> id, StormcontrolpolicyState 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.
- Broadcast string
- Enable/disable storm control to drop/allow broadcast traffic in override mode. Valid values:
enable,disable. - Description string
- Description of the storm control policy.
- Name string
- Storm control policy name.
- Rate int
- Threshold rate in packets per second at which storm traffic is controlled in override mode (default=500, 0 to drop all).
- Storm
Control stringMode - Set Storm control mode. Valid values:
global,override,disabled. - Unknown
Multicast string - Enable/disable storm control to drop/allow unknown multicast traffic in override mode. Valid values:
enable,disable. - Unknown
Unicast string - Enable/disable storm control to drop/allow unknown unicast traffic in override mode. Valid values:
enable,disable. - 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.
- Broadcast string
- Enable/disable storm control to drop/allow broadcast traffic in override mode. Valid values:
enable,disable. - Description string
- Description of the storm control policy.
- Name string
- Storm control policy name.
- Rate int
- Threshold rate in packets per second at which storm traffic is controlled in override mode (default=500, 0 to drop all).
- Storm
Control stringMode - Set Storm control mode. Valid values:
global,override,disabled. - Unknown
Multicast string - Enable/disable storm control to drop/allow unknown multicast traffic in override mode. Valid values:
enable,disable. - Unknown
Unicast string - Enable/disable storm control to drop/allow unknown unicast traffic in override mode. Valid values:
enable,disable. - 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.
- broadcast String
- Enable/disable storm control to drop/allow broadcast traffic in override mode. Valid values:
enable,disable. - description String
- Description of the storm control policy.
- name String
- Storm control policy name.
- rate Integer
- Threshold rate in packets per second at which storm traffic is controlled in override mode (default=500, 0 to drop all).
- storm
Control StringMode - Set Storm control mode. Valid values:
global,override,disabled. - unknown
Multicast String - Enable/disable storm control to drop/allow unknown multicast traffic in override mode. Valid values:
enable,disable. - unknown
Unicast String - Enable/disable storm control to drop/allow unknown unicast traffic in override mode. Valid values:
enable,disable. - 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.
- broadcast string
- Enable/disable storm control to drop/allow broadcast traffic in override mode. Valid values:
enable,disable. - description string
- Description of the storm control policy.
- name string
- Storm control policy name.
- rate number
- Threshold rate in packets per second at which storm traffic is controlled in override mode (default=500, 0 to drop all).
- storm
Control stringMode - Set Storm control mode. Valid values:
global,override,disabled. - unknown
Multicast string - Enable/disable storm control to drop/allow unknown multicast traffic in override mode. Valid values:
enable,disable. - unknown
Unicast string - Enable/disable storm control to drop/allow unknown unicast traffic in override mode. Valid values:
enable,disable. - 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.
- broadcast str
- Enable/disable storm control to drop/allow broadcast traffic in override mode. Valid values:
enable,disable. - description str
- Description of the storm control policy.
- name str
- Storm control policy name.
- rate int
- Threshold rate in packets per second at which storm traffic is controlled in override mode (default=500, 0 to drop all).
- storm_
control_ strmode - Set Storm control mode. Valid values:
global,override,disabled. - unknown_
multicast str - Enable/disable storm control to drop/allow unknown multicast traffic in override mode. Valid values:
enable,disable. - unknown_
unicast str - Enable/disable storm control to drop/allow unknown unicast traffic in override mode. Valid values:
enable,disable. - 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.
- broadcast String
- Enable/disable storm control to drop/allow broadcast traffic in override mode. Valid values:
enable,disable. - description String
- Description of the storm control policy.
- name String
- Storm control policy name.
- rate Number
- Threshold rate in packets per second at which storm traffic is controlled in override mode (default=500, 0 to drop all).
- storm
Control StringMode - Set Storm control mode. Valid values:
global,override,disabled. - unknown
Multicast String - Enable/disable storm control to drop/allow unknown multicast traffic in override mode. Valid values:
enable,disable. - unknown
Unicast String - Enable/disable storm control to drop/allow unknown unicast traffic in override mode. Valid values:
enable,disable. - 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.
Import
SwitchController StormControlPolicy can be imported using any of these accepted formats:
$ pulumi import fortios:switchcontroller/stormcontrolpolicy:Stormcontrolpolicy labelname {{name}}
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:switchcontroller/stormcontrolpolicy:Stormcontrolpolicy labelname {{name}}
$ 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
fortiosTerraform Provider.