node-subnet-group

Queries subnet group data synchronized between the Data Node and the Control Node. When the guid option is specified, queries the subnet entries of that subnet group. When omitted, lists all subnet 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 subnet groups:

node-subnet-group

To query subnet entries of a specific subnet group:

node-subnet-group guid=STR

Options

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

Output fields

When the guid option is omitted (subnet group list):

Field	Type	Description
`id`	integer	Subnet group ID
`guid`	string	Subnet group GUID
`name`	string	Subnet group name
`description`	string	Subnet group description
`subnet_count`	integer	Number of subnet entries
`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 (subnet entry list):

Field	Type	Description
`start_ip`	ipaddr	Start IP address of the subnet
`end_ip`	ipaddr	End IP address of the subnet
`cidr`	integer	CIDR prefix length
`description`	string	Subnet description

Error codes

Parse errors

Error code	Message	Description
300300	You do not have permission to run node-subnet-group.	Executed from a session without administrator privileges.
300301	The guid option for the node-subnet-group command is not in a valid format.	The `guid` option value is not a valid GUID format.
300302	The subnet group [guid] specified in node-subnet-group was not found.	No subnet group exists for the specified `guid`.

Runtime errors

None

Description

The node-subnet-group command queries subnet 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 start IP, end IP, CIDR, and description of each subnet defined in that subnet group. When the guid option is omitted, it lists the metadata of all subnet groups synchronized to the Data Node.

Examples

List all subnet groups
```
node-subnet-group
```
Lists all subnet groups synchronized to the Data Node.
Query subnet entries of a specific subnet group
```
node-subnet-group guid=550e8400-e29b-41d4-a716-446655440000
```
Queries the subnet entries of the subnet group corresponding to the specified GUID.