node-subnet-group
Queries subnet group 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 subnet entries of that subnet group. When both are 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:
To query subnet entries of a specific subnet group by GUID:
To query subnet entries of a specific subnet group by name (4.0 series, 4.0.2609.0 and later):
Options
guid=STR- GUID of the subnet group to query. In the 5.0 series (through 5.0.2605.2), this is the only way to specify a subnet group. In the 4.0 series (4.0.2609.0 and later), it cannot be used together with
name. When omitted, lists all subnet groups. name=STR- Name of the subnet group to query (cannot be used together with
guid). When omitted, lists all subnet groups. This option is available starting with 4.0.2609.0.
Output fields
When both the guid and name options are 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 either the guid or name 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 | no permission for node-subnet-group | Executed from a session without administrator privileges. |
| 300301 | invalid guid format for node-subnet-group | The guid option value is not a valid GUID format. |
| 300302 | subnet group [guid] not found for node-subnet-group | No subnet group exists for the specified guid. |
| 300303 | Subnet group not found by name for node-subnet-group. | No subnet group exists with the name specified in the name option. Available starting with 4.0.2609.0, which has the name option. |
| 300304 | Duplicate subnet group name for node-subnet-group. | More than one subnet group exists with the name specified in the name option. Available starting with 4.0.2609.0, which has the name option. |
| 300305 | Specify only one of 'guid' or 'name' option in the node-subnet-group command. | Both the guid and name options are specified. Available starting with 4.0.2609.0, which has the name option. |
| 300306 | Cannot load subnet group for node-subnet-group. | An error occurred while reading data while querying by the name option. Available starting with 4.0.2609.0, which has the name option. |
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 either the guid or name option is specified, it queries the start IP, end IP, CIDR, and description of each subnet defined in that subnet group. When both options are omitted, it lists the metadata of all subnet 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 a subnet 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 subnet groups
node-subnet-groupLists all subnet groups synchronized to the Data Node.
-
Query subnet entries of a specific subnet group
node-subnet-group guid=550e8400-e29b-41d4-a716-446655440000Queries the subnet entries of the subnet group corresponding to the specified GUID.
-
Query subnet entries of a subnet group by name (4.0 series, 4.0.2609.0 and later)
node-subnet-group name=internal_subnetsQueries the subnet entries of the subnet group with the specified name.
Change history
| Target | Introduced in |
|---|---|
The node-subnet-group command | Before Sonar 4.0 |
The name option | 4.0.2609.0 |