node-ip-blacklist

Queries address group (IP blocklist) data synchronized between the Data Node and the Control Node. When the guid option is specified (in the 4.0 series, 4.0.2609.0 and later, the name option as well), queries the IP entries of that address group. When both are omitted, lists all address groups.

Command properties

Property	Description
Command type	Driver
Required permission	Administrator
License usage	Not counted
Parallel execution	Not supported
Distributed execution	Not supported

Syntax

To list address groups:

node-ip-blacklist

To query IP entries of a specific address group by GUID:

node-ip-blacklist guid=STR

To query IP entries of a specific address group by name (4.0 series, 4.0.2609.0 and later):

node-ip-blacklist name=STR

Options

guid=STR: GUID of the address group to query. In the 5.0 series (through 5.0.2605.2), this is the only way to specify an address group. In the 4.0 series (4.0.2609.0 and later), it cannot be used together with name. When omitted, lists all address groups.
name=STR: Name of the address group to query (cannot be used together with guid). When omitted, lists all address groups. This option is available starting with 4.0.2609.0.

Output fields

When both the guid and name options are omitted (address group list):

Field	Type	Description
`id`	integer	Address group ID
`guid`	string	Address group GUID
`name`	string	Address group name
`description`	string	Address group description
`count`	long	Number of IP address entries
`version`	long	Address group version
`user_name`	string	Name of the user who created it
`user_guid`	string	GUID of the user who created it

When either the guid or name option is specified (IP entry list):

Field	Type	Description
`ip`	ipaddr	IP address
`description`	string	IP address description

Error codes

Parse errors

Error code	Message	Description
300330	no permission for node-ip-blacklist	Executed from a session without administrator privileges.
300331	invalid guid format for node-ip-blacklist	The `guid` option value is not a valid GUID format.
300332	IP blacklist [guid] not found for node-ip-blacklist	No address group exists for the specified `guid`.
300333	Address group not found by name for node-ip-blacklist.	No address group exists with the name specified in the `name` option. Available starting with 4.0.2609.0, which has the `name` option.
300334	Duplicate address group name for node-ip-blacklist.	More than one address group exists with the name specified in the `name` option. Available starting with 4.0.2609.0, which has the `name` option.
300335	Specify only one of 'guid' or 'name' option in the node-ip-blacklist command.	Both the `guid` and `name` options are specified. Available starting with 4.0.2609.0, which has the `name` option.

Runtime errors

None

Description

The node-ip-blacklist command queries address group data synchronized to the Data Node. This command is only available on the Data Node and requires administrator privileges.

When either the guid or name option is specified, it queries the individual IP addresses and descriptions registered in that address group. When both options are omitted, it lists the metadata of all address groups synchronized to the Data Node.

In the 4.0 series (4.0.2609.0 and later), you can use the name option to specify an address group by name instead of GUID. Specifying both options at the same time causes an error, as does specifying a name that does not exist or that matches more than one group.

Examples

List all address groups
```
node-ip-blacklist
```
Lists all address groups synchronized to the Data Node.
Query IP entries of a specific address group
```
node-ip-blacklist guid=550e8400-e29b-41d4-a716-446655440000
```
Queries the IP address entries of the address group corresponding to the specified GUID.
Query IP entries of an address group by name (4.0 series, 4.0.2609.0 and later)
```
node-ip-blacklist name=known_attackers
```
Queries the IP address entries of the address group with the specified name.

Change history

Target	Introduced in
The `node-ip-blacklist` command	Before Sonar 4.0
The `name` option	4.0.2609.0