Filters events using CIDR subnets. Used for both IPv4 and IPv6 addresses.

ParameterTypeRequiredDefaultDescription
columnstringoptional[a]  When file and column parameters are used together, it loads the subnet list from the given .csv.
field[b]stringrequired  Specifies the field that the CIDR expression runs against.
filestringoptional[a]  When file and column parameters are used together, it loads the subnet list from the given .csv.
negate (deprecated)booleanoptional[a]false This parameter is deprecated. Use the !cidr(...) negation instead to allow only addresses that are not in the given subnet to pass through (see cidr() Examples) or to allow events without the assigned field to pass through. (deprecated in 1.100.0)
subnetArray of stringsoptional[a]  Specifies the list of IP ranges the CIDR expression matches with.

[a] Optional parameters use their default value unless explicitly set

[b] The argument name field can be omitted.

Omitted Argument Names

The argument name for field can be omitted; the following forms of this function are equivalent:

logscale
cidr("value")

and:

logscale
cidr(field="value")

cidr() Examples

Matches events for which the ipAddress attributes is in the IP range 192.0.2.0/24

logscale
cidr(ipAddress, subnet="192.0.2.0/24")

Matches events for which the ipAddress attributes is not in the IP range 192.0.2.0/24

logscale
!cidr(ipAddress, subnet="192.0.2.0/24")

Matches events for which the ipAddress attributes is in the ip range 192.0.2.0/24 or 203.0.113.0/24

logscale
cidr(ipAddress, subnet=["192.0.2.0/24", "203.0.113.0/24"])

Matches events for which the SRC attributes is one of those listed in the uploaded file cidrfile.csv with the subnets in the column cidr-block

logscale
cidr(field=SRC, file="cidrfile.csv", column="cidr-block")