node-port-group
Queries port group data downloaded to the Data Node through the policy synchronization module.
Command properties
| Property | Description |
|---|---|
| Command type | Driver |
| Required permission | Administrator |
| License usage | Not counted |
| Parallel execution | Not supported |
| Distributed execution | Not supported |
Syntax
Options
guid=STR- Port group GUID. When specified, queries the port entries included in that port group. When omitted, lists a summary of all port groups.
Output fields
When the guid option is specified:
| Field | Type | Description |
|---|---|---|
protocol | string | Protocol (tcp, udp, etc.) |
start | integer | Start of port range |
end | integer | End of port range |
description | string | Port entry description |
app_code | string | App code |
app_built_in | boolean | Whether this is a built-in app |
When the guid option is omitted:
| Field | Type | Description |
|---|---|---|
id | integer | Port group ID |
guid | string | Port group GUID |
name | string | Port group name |
description | string | Port group description |
port_count | integer | Number of port entries |
user_name | string | Creator name |
user_guid | string | Creator GUID |
Error codes
Parse errors
| Error code | Message | Description |
|---|---|---|
| 300310 | no permission for node-port-group | Administrator privileges are required. |
| 300311 | invalid guid format for node-port-group | The guid option value is not a valid GUID format. |
| 300312 | port group [guid] not found for node-port-group | No port group exists for the specified GUID. |
Runtime errors
None
Description
The node-port-group command queries port group data downloaded from the Control Node to the Data Node through the policy synchronization module.
When the guid option is specified, it returns the individual port entries (protocol, start port, end port, description) included in that port group. When the guid option is omitted, it returns a summary list of all synchronized port groups (name, GUID, port count, etc.).
Examples
-
List all port groups
node-port-groupQueries the summary information of all port groups synchronized to the Data Node.
-
Query port entries of a specific port group
node-port-group guid=550e8400-e29b-41d4-a716-446655440000Queries the port entries included in the port group with the specified GUID.