node-ip-blacklist

Queries address group (IP blocklist) data synchronized between the Data Node and the Control Node. When the guid option is specified, queries the IP entries of that address group. When 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:

node-ip-blacklist guid=STR

Options

guid=STR: GUID of the address group to query. When omitted, lists all address groups.

Output fields

When the guid option is 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 the guid 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	You do not have permission to run node-ip-blacklist.	Executed from a session without administrator privileges.
300331	The guid option for the node-ip-blacklist command is not in a valid format.	The `guid` option value is not a valid GUID format.
300332	The IP blocklist [guid] specified in node-ip-blacklist was not found.	No address group exists for the specified `guid`.

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 the guid option is specified, it queries the individual IP addresses and descriptions registered in that address group. When the guid option is omitted, it lists the metadata of all address groups synchronized to the Data Node.

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.