Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectSystemNpuIcmpratectrl
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectSystemNpuIcmpratectrl

Explore with Pulumi AI

fortimanager logo
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

    Configure the rate of ICMP messages generated by this FortiGate.

    This resource is a sub resource for variable icmp_rate_ctrl of resource fortimanager.ObjectSystemNpu. Conflict and overwrite may occur if use both of them.

    Create ObjectSystemNpuIcmpratectrl Resource

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

    Constructor syntax

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

@overload
def ObjectSystemNpuIcmpratectrl(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                adom: Optional[str] = None,
                                icmp_v4_bucket_size: Optional[float] = None,
                                icmp_v4_rate: Optional[float] = None,
                                icmp_v6_bucket_size: Optional[float] = None,
                                icmp_v6_rate: Optional[float] = None,
                                object_system_npu_icmpratectrl_id: Optional[str] = None,
                                scopetype: Optional[str] = None)
    func NewObjectSystemNpuIcmpratectrl(ctx *Context, name string, args *ObjectSystemNpuIcmpratectrlArgs, opts ...ResourceOption) (*ObjectSystemNpuIcmpratectrl, error)
    public ObjectSystemNpuIcmpratectrl(string name, ObjectSystemNpuIcmpratectrlArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectSystemNpuIcmpratectrl(String name, ObjectSystemNpuIcmpratectrlArgs args)
public ObjectSystemNpuIcmpratectrl(String name, ObjectSystemNpuIcmpratectrlArgs args, CustomResourceOptions options)

    type: fortimanager:ObjectSystemNpuIcmpratectrl
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 ObjectSystemNpuIcmpratectrlArgs
    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 ObjectSystemNpuIcmpratectrlArgs
    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 ObjectSystemNpuIcmpratectrlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectSystemNpuIcmpratectrlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectSystemNpuIcmpratectrlArgs
    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 objectSystemNpuIcmpratectrlResource = new Fortimanager.ObjectSystemNpuIcmpratectrl("objectSystemNpuIcmpratectrlResource", new()
{
    Adom = "string",
    IcmpV4BucketSize = 0,
    IcmpV4Rate = 0,
    IcmpV6BucketSize = 0,
    IcmpV6Rate = 0,
    ObjectSystemNpuIcmpratectrlId = "string",
    Scopetype = "string",
});

    example, err := fortimanager.NewObjectSystemNpuIcmpratectrl(ctx, "objectSystemNpuIcmpratectrlResource", &fortimanager.ObjectSystemNpuIcmpratectrlArgs{
Adom: pulumi.String("string"),
IcmpV4BucketSize: pulumi.Float64(0),
IcmpV4Rate: pulumi.Float64(0),
IcmpV6BucketSize: pulumi.Float64(0),
IcmpV6Rate: pulumi.Float64(0),
ObjectSystemNpuIcmpratectrlId: pulumi.String("string"),
Scopetype: pulumi.String("string"),
})

    var objectSystemNpuIcmpratectrlResource = new ObjectSystemNpuIcmpratectrl("objectSystemNpuIcmpratectrlResource", ObjectSystemNpuIcmpratectrlArgs.builder()
    .adom("string")
    .icmpV4BucketSize(0)
    .icmpV4Rate(0)
    .icmpV6BucketSize(0)
    .icmpV6Rate(0)
    .objectSystemNpuIcmpratectrlId("string")
    .scopetype("string")
    .build());

    object_system_npu_icmpratectrl_resource = fortimanager.ObjectSystemNpuIcmpratectrl("objectSystemNpuIcmpratectrlResource",
    adom="string",
    icmp_v4_bucket_size=0,
    icmp_v4_rate=0,
    icmp_v6_bucket_size=0,
    icmp_v6_rate=0,
    object_system_npu_icmpratectrl_id="string",
    scopetype="string")

    const objectSystemNpuIcmpratectrlResource = new fortimanager.ObjectSystemNpuIcmpratectrl("objectSystemNpuIcmpratectrlResource", {
    adom: "string",
    icmpV4BucketSize: 0,
    icmpV4Rate: 0,
    icmpV6BucketSize: 0,
    icmpV6Rate: 0,
    objectSystemNpuIcmpratectrlId: "string",
    scopetype: "string",
});

    type: fortimanager:ObjectSystemNpuIcmpratectrl
properties:
    adom: string
    icmpV4BucketSize: 0
    icmpV4Rate: 0
    icmpV6BucketSize: 0
    icmpV6Rate: 0
    objectSystemNpuIcmpratectrlId: string
    scopetype: string

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

    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    IcmpV4BucketSize double
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv4 packets (1 - 100, default = 10).
    IcmpV4Rate double
    Average rate of ICMPv4 packets that allowed to be generated per second (1 - 100, default = 1).
    IcmpV6BucketSize double
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv6 packets (1 - 100, default = 10).
    IcmpV6Rate double
    Average rate of ICMPv6 packets that allowed to be generated per second (1 - 100, default = 1).
    ObjectSystemNpuIcmpratectrlId string
    an identifier for the resource.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    IcmpV4BucketSize float64
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv4 packets (1 - 100, default = 10).
    IcmpV4Rate float64
    Average rate of ICMPv4 packets that allowed to be generated per second (1 - 100, default = 1).
    IcmpV6BucketSize float64
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv6 packets (1 - 100, default = 10).
    IcmpV6Rate float64
    Average rate of ICMPv6 packets that allowed to be generated per second (1 - 100, default = 1).
    ObjectSystemNpuIcmpratectrlId string
    an identifier for the resource.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    icmpV4BucketSize Double
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv4 packets (1 - 100, default = 10).
    icmpV4Rate Double
    Average rate of ICMPv4 packets that allowed to be generated per second (1 - 100, default = 1).
    icmpV6BucketSize Double
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv6 packets (1 - 100, default = 10).
    icmpV6Rate Double
    Average rate of ICMPv6 packets that allowed to be generated per second (1 - 100, default = 1).
    objectSystemNpuIcmpratectrlId String
    an identifier for the resource.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    icmpV4BucketSize number
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv4 packets (1 - 100, default = 10).
    icmpV4Rate number
    Average rate of ICMPv4 packets that allowed to be generated per second (1 - 100, default = 1).
    icmpV6BucketSize number
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv6 packets (1 - 100, default = 10).
    icmpV6Rate number
    Average rate of ICMPv6 packets that allowed to be generated per second (1 - 100, default = 1).
    objectSystemNpuIcmpratectrlId string
    an identifier for the resource.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    icmp_v4_bucket_size float
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv4 packets (1 - 100, default = 10).
    icmp_v4_rate float
    Average rate of ICMPv4 packets that allowed to be generated per second (1 - 100, default = 1).
    icmp_v6_bucket_size float
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv6 packets (1 - 100, default = 10).
    icmp_v6_rate float
    Average rate of ICMPv6 packets that allowed to be generated per second (1 - 100, default = 1).
    object_system_npu_icmpratectrl_id str
    an identifier for the resource.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    icmpV4BucketSize Number
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv4 packets (1 - 100, default = 10).
    icmpV4Rate Number
    Average rate of ICMPv4 packets that allowed to be generated per second (1 - 100, default = 1).
    icmpV6BucketSize Number
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv6 packets (1 - 100, default = 10).
    icmpV6Rate Number
    Average rate of ICMPv6 packets that allowed to be generated per second (1 - 100, default = 1).
    objectSystemNpuIcmpratectrlId String
    an identifier for the resource.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ObjectSystemNpuIcmpratectrl 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 ObjectSystemNpuIcmpratectrl Resource

    Get an existing ObjectSystemNpuIcmpratectrl 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?: ObjectSystemNpuIcmpratectrlState, opts?: CustomResourceOptions): ObjectSystemNpuIcmpratectrl
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        icmp_v4_bucket_size: Optional[float] = None,
        icmp_v4_rate: Optional[float] = None,
        icmp_v6_bucket_size: Optional[float] = None,
        icmp_v6_rate: Optional[float] = None,
        object_system_npu_icmpratectrl_id: Optional[str] = None,
        scopetype: Optional[str] = None) -> ObjectSystemNpuIcmpratectrl
    func GetObjectSystemNpuIcmpratectrl(ctx *Context, name string, id IDInput, state *ObjectSystemNpuIcmpratectrlState, opts ...ResourceOption) (*ObjectSystemNpuIcmpratectrl, error)
    public static ObjectSystemNpuIcmpratectrl Get(string name, Input<string> id, ObjectSystemNpuIcmpratectrlState? state, CustomResourceOptions? opts = null)
    public static ObjectSystemNpuIcmpratectrl get(String name, Output<String> id, ObjectSystemNpuIcmpratectrlState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectSystemNpuIcmpratectrl    get:      id: ${id}
    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.
    The following state arguments are supported:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    IcmpV4BucketSize double
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv4 packets (1 - 100, default = 10).
    IcmpV4Rate double
    Average rate of ICMPv4 packets that allowed to be generated per second (1 - 100, default = 1).
    IcmpV6BucketSize double
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv6 packets (1 - 100, default = 10).
    IcmpV6Rate double
    Average rate of ICMPv6 packets that allowed to be generated per second (1 - 100, default = 1).
    ObjectSystemNpuIcmpratectrlId string
    an identifier for the resource.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    IcmpV4BucketSize float64
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv4 packets (1 - 100, default = 10).
    IcmpV4Rate float64
    Average rate of ICMPv4 packets that allowed to be generated per second (1 - 100, default = 1).
    IcmpV6BucketSize float64
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv6 packets (1 - 100, default = 10).
    IcmpV6Rate float64
    Average rate of ICMPv6 packets that allowed to be generated per second (1 - 100, default = 1).
    ObjectSystemNpuIcmpratectrlId string
    an identifier for the resource.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    icmpV4BucketSize Double
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv4 packets (1 - 100, default = 10).
    icmpV4Rate Double
    Average rate of ICMPv4 packets that allowed to be generated per second (1 - 100, default = 1).
    icmpV6BucketSize Double
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv6 packets (1 - 100, default = 10).
    icmpV6Rate Double
    Average rate of ICMPv6 packets that allowed to be generated per second (1 - 100, default = 1).
    objectSystemNpuIcmpratectrlId String
    an identifier for the resource.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    icmpV4BucketSize number
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv4 packets (1 - 100, default = 10).
    icmpV4Rate number
    Average rate of ICMPv4 packets that allowed to be generated per second (1 - 100, default = 1).
    icmpV6BucketSize number
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv6 packets (1 - 100, default = 10).
    icmpV6Rate number
    Average rate of ICMPv6 packets that allowed to be generated per second (1 - 100, default = 1).
    objectSystemNpuIcmpratectrlId string
    an identifier for the resource.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    icmp_v4_bucket_size float
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv4 packets (1 - 100, default = 10).
    icmp_v4_rate float
    Average rate of ICMPv4 packets that allowed to be generated per second (1 - 100, default = 1).
    icmp_v6_bucket_size float
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv6 packets (1 - 100, default = 10).
    icmp_v6_rate float
    Average rate of ICMPv6 packets that allowed to be generated per second (1 - 100, default = 1).
    object_system_npu_icmpratectrl_id str
    an identifier for the resource.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    icmpV4BucketSize Number
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv4 packets (1 - 100, default = 10).
    icmpV4Rate Number
    Average rate of ICMPv4 packets that allowed to be generated per second (1 - 100, default = 1).
    icmpV6BucketSize Number
    Bucket size used in the token bucket algorithm for controlling the flow of ICMPv6 packets (1 - 100, default = 10).
    icmpV6Rate Number
    Average rate of ICMPv6 packets that allowed to be generated per second (1 - 100, default = 1).
    objectSystemNpuIcmpratectrlId String
    an identifier for the resource.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.

    Import

    ObjectSystem NpuIcmpRateCtrl can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectSystemNpuIcmpratectrl:ObjectSystemNpuIcmpratectrl labelname ObjectSystemNpuIcmpRateCtrl

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
    fortinetdev/terraform-provider-fortimanager