msys.audit_series.remove_item

March 26, 2020

Name

msys.audit_series.remove_item — Remove a counter from a named series

Synopsis

msys.audit_series.remove_item(name, key);

name: string
key: string, optional

Description

Removes a counter from a named series. The interpretation of key depends on the key type. For a CIDR series, the key is interpreted as an IP specifying the address of interest. If accept_construct is used as key, the remote IP of the accept construct is used. If not specified, the current connected IP is assumed. For string series, the key is the string key to associate the count with. If it is not specified, an error is thrown.

As of version 3.4, this feature supports IPv6.

IPv6 addresses are much more flexible than IPv4 addresses in terms of their formatting options. They also use a different delimiter character than IPv4 addresses (a colon instead of a period). This means that in certain contexts, an IPv6 address can create parsing ambiguities.

The accepted convention is to require that, in circumstances where a configuration parameter can also contain something other than an IP address, that an IPv6 address must be enclosed in square brackets. In practical terms, this means that things like the gateway, routes and listen options must have IPv6 addresses enclosed in brackets. Others, such as peer, relay_hosts and prohibited_hosts do not require the IPv6 address in brackets.

Enable this function with the statement require('msys.audit_series');.

See Also

msys.audit_series.define msys.audit_series.count, msys.audit_series.add, Use_IPv6, “inbound_audit – Inbound traffic analytics”