JSON Object Definitions
Agent
Attribute |
Type |
Description |
---|---|---|
agent_uuid |
string |
Agent UUID. |
agent_config |
object |
|
agent_config_status |
object |
|
desired_network_policy_config |
object |
|
provisioned_network_policy_config |
object |
|
provisioned_state_update_timestamp |
integer |
epoch timestamp in seconds when agent acknowledged the above provisioned policy. |
desired_policy_update_timestamp |
integer |
epoch timestamp in seconds when desired_network_policy_config is generated. |
agent_info |
object |
|
skipped |
boolean |
true, when concrete policy generation is skipped. |
message |
string |
Reason why concrete policy generation is skipped. |
Agent Config
Attribute |
Type |
Description |
---|---|---|
agent_uuid |
string |
Agent UUID. |
enforcement_enabled |
boolean |
Config stating is enforcement is enabled on Agent. |
fail_mode |
string |
Fail Mode. |
version |
number |
Agent config version number. |
control_tet_rules_only |
boolean |
Control tet rules only config. |
allow_broadcast |
boolean |
Allow Broadcast config. |
allow_multicast |
boolean |
Allow Multicast config. |
allow_link_local |
boolean |
Allow Link Local config. |
enforcement_cpu_quota_mode |
string |
Enforcement Agent CPU quota mode. |
enforcement_cpu_quota_us |
string |
Enforcement Agent CPU quota micros sec. |
enforcement_max_rss_limit |
number |
Enforcement Agent Max RSS limit. |
Network Policy Configuration
Attribute |
Type |
Description |
---|---|---|
version |
string |
Version number. |
network_policy |
array |
Array of Network Policy objects. |
address_sets |
array |
Array of Address Set objects for IP set feature. |
container_network_policy |
array |
Array of ContainerNetworkPolicy objects. |
Network Policy
Attribute |
Type |
Description |
---|---|---|
priority |
string |
Priority of concrete policy. |
enforcement_intent_id |
string |
Enforcement Intent ID. |
concrete_policy_id |
string |
Concrete Policy ID. |
match |
object |
Match criteria for policy. This field is deprecated. |
action |
object |
Action for policy match. |
workspace_id |
string |
ID for a workspace. |
adm_data_set_id |
string |
Automatic policy discovery data set id of workspace. |
adm_data_set_version |
string |
Automatic policy discovery data set version of the workspace. Set only when inject_versions=true is passed in params. |
cluster_edge_id |
string |
Cluster Edge ID. |
policy_intent_group_id |
string |
Policy intent group ID. |
match_set |
object |
Match Set object for IP set support. Exactly one of match or match_set will be present. |
src_filter_id |
string |
Source inventory filter ID. This will be set when include_filter_names=true passed as params. |
src_filter_name |
string |
Source inventory filter name. This will be set when include_filter_names=true passed as params. |
dst_filter_id |
string |
Destination inventory filter ID. This will be set when include_filter_names=true passed as params. |
dst_filter_name |
string |
Destination Inventory filter name. This will be set when include_filter_names=true passed as params. |
ContainerNetworkPolicy
Attribute |
Type |
Description |
---|---|---|
pod_id |
string |
POD ID. |
network_policy |
array |
Array of Network Policy objects. |
deployment |
string |
Deployment Name. |
service_endpoint |
array |
List of service endpoint names. |
Match
Attribute |
Type |
Description |
---|---|---|
src_addr |
object |
Subnet object for source address. |
dst_addr |
object |
Subnet object for destination address. |
src_port_range_start |
int |
Source port range start. |
src_port_range_end |
int |
Source port range end. |
dst_port_range_start |
int |
Destination port range start. |
dst_port_range_end |
int |
Destination port range end. |
ip_protocol |
string |
IP Protocol. |
address_family |
string |
IPv4 or IPv6 address family. |
direction |
string |
Direction of match, INGRESS or EGRESS. |
src_addr_range |
object |
Address Range object for source address. |
dst_add_range |
object |
Address Range object for destination address. |
Action
Attribute |
Type |
Description |
---|---|---|
type |
string |
Action type. |
Match Set
Attribute |
Type |
Description |
---|---|---|
src_set_id |
string |
Source set ID of Address Set
object in the Network Policy Configuration
array. |
dst_set_id |
string |
Destination set ID of Address Set
object in the Network Policy Configuration
|
src_ports |
ar- ray |
Array of Port Range objects for source ports. |
dst_ports |
ar- ray |
Array of Port Range objects for destination ports. |
ip_protocol |
string |
IP Protocol. |
address_family |
string |
IPv4 or IPv6 address family. |
direction |
string |
Direction of match, INGRESS or EGRESS. |
Address Set
Attribute |
Type |
Description |
---|---|---|
set_id |
string |
Address set ID. |
addr_ranges |
array |
Array of Address Range objects. |
subnets |
array |
Array of Subnet objects. |
addr_family |
string |
IPv4 or IPv6 address family. |
Subnet
Attribute |
Type |
Description |
---|---|---|
ip_addr |
string |
IP address. |
prefix_length |
int |
Prefix length for subnet. |
Address Range
Attribute |
Type |
Description |
---|---|---|
start_ip_addr |
string |
Start IP address for range. |
end_ip_addr |
string |
End IP address for range. |
Port Range
Attribute |
Type |
Description |
---|---|---|
start_port |
int |
Start port for range. |
end_port |
int |
End port for range. |
Agent Config Status
Attribute |
Type |
Description |
---|---|---|
disabled |
boolean |
Config stating is enforcement is disabled on Agent. |
current_version |
number |
Current Agent config version applied on Agent. |
highest_seen_version |
number |
Highest version of agent config received by Agent. |
Provisioned Network Policy Config
Attribute |
Type |
Description |
---|---|---|
version |
string |
Network policy config version provisioned by Agent. |
error_reason |
string |
CONFIG_SUCCESS when Agent successfully applied policies else error reason. |
disabled |
boolean |
Config stating is enforcement is disabled on Agent. |
current_version |
number |
Current NPC version applied on Agent. |
highest_seen_version |
number |
Highest version of NPC received by Agent. |
policy_status |
object |
Every network policy status. |
Agent Info
Attribute |
Type |
Description |
---|---|---|
agent_info_supported |
boolean |
Agent capability if agent_info is supported. |
ipset_supported |
boolean |
Agent capability if ipsets are supported. |
Concrete Policy Result
Attribute |
Type |
Description |
---|---|---|
byte_count |
int |
Byte count for concrete policy hits. |
pkt_count |
int |
Packet count for concrete policy hits. |
Timeseries Concrete Policy Result
Attribute |
Type |
Description |
---|---|---|
timestamp |
string |
Timestamp string for aggregation of results. |
result |
object |