ddos network-object¶
Configure DDoS a static Monitor Network Object
network-object Specification¶
Parameter Value Type Collection Object Key(s) object-name Collection Name network-object-list Collection URI /axapi/v3/ddos/network-object Element Name network-object Element URI /axapi/v3/ddos/network-object/{object-name} Element Attributes network-object_attributes Partition Visibility shared Statistics Data URI /axapi/v3/ddos/network-object/{object-name}/stats Operational Data URI /axapi/v3/ddos/network-object/{object-name}/oper Schema network-object schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/ddos/network-object | ||
Create List | POST | /axapi/v3/ddos/network-object | ||
Get Object | GET | /axapi/v3/ddos/network-object/{object-name} | ||
Get List | GET | /axapi/v3/ddos/network-object | ||
Modify Object | POST | /axapi/v3/ddos/network-object/{object-name} | ||
Replace Object | PUT | /axapi/v3/ddos/network-object/{object-name} | ||
Replace List | PUT | /axapi/v3/ddos/network-object | ||
Delete Object | DELETE | /axapi/v3/ddos/network-object/{object-name} |
network-object-list¶
network-object-list is JSON List of network-object attributes
network-object-list : [
]
network-object attributes¶
anomaly-detection-trigger
Description ‘all’: Use both learned and static thresholds (static thresholds take precedence); ‘static-threshold-only’: Use static thresholds only;
Type: string
Supported Values: all, static-threshold-only
Default: all
enable-top-k
Type: Listflooding-multiplier
Description multiplier for flooding detection threshold in network objects (default 2x threshold)
Type: number
Range: 2-10
Default: 2
histogram-mode
Description ‘off’: histogram feature disabled; ‘monitor’: histogram feature enabled with anomaly escalation; ‘observe’: histogram feature enabled and observe only;
Type: string
Supported Values: off, monitor, observe
Default: observe
host-anomaly-threshold
Description: host-anomaly-threshold is a JSON Block. Please see below for host-anomaly-threshold
Type: Object
host-sport-discovery
Description ‘enable’: Enable source port discovery.; ‘disable’: Disable source port discovery.;
Type: string
Supported Values: enable, disable
indicators-to-monitor
Description: indicators-to-monitor is a JSON Block. Please see below for indicators-to-monitor
Type: Object
Reference Object: /axapi/v3/ddos/network-object/{object-name}/indicators-to-monitor
ip-list
Type: List
Reference Object: /axapi/v3/ddos/network-object/{object-name}/ip/{subnet-ip-addr}
ipv6-list
Type: List
Reference Object: /axapi/v3/ddos/network-object/{object-name}/ipv6/{subnet-ipv6-addr}
network-object-anomaly-threshold
Description: network-object-anomaly-threshold is a JSON Block. Please see below for network-object-anomaly-threshold
Type: Object
notification
Description: notification is a JSON Block. Please see below for notification
Type: Object
Reference Object: /axapi/v3/ddos/network-object/{object-name}/notification
object-name
Description
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
operational-mode
Description ‘monitor’: Monitor mode; ‘learning’: Learning mode;
Type: string
Supported Values: monitor, learning
Default: learning
relative-auto-break-down-threshold
Description: relative-auto-break-down-threshold is a JSON Block. Please see below for relative-auto-break-down-threshold
Type: Object
sampling-enable
Type: Listservice-break-down-threshold-local
Description: service-break-down-threshold-local is a JSON Block. Please see below for service-break-down-threshold-local
Type: Object
service-discovery
Description ‘disable’: Disable service discovery for hosts (default: enabled);
Type: string
Supported Values: disable
sport-anomaly-detection
Description ‘disable’: Disable source port anomaly detection (default: enabled);
Type: string
Supported Values: disable
sport-anomaly-threshold
Description: sport-anomaly-threshold is a JSON Block. Please see below for sport-anomaly-threshold
Type: Object
Reference Object: /axapi/v3/ddos/network-object/{object-name}/sport-anomaly-threshold
sport-discovery-threshold
Description: sport-discovery-threshold is a JSON Block. Please see below for sport-discovery-threshold
Type: Object
sport-list
Type: List
Reference Object: /axapi/v3/ddos/network-object/{object-name}/sport/{port-num}+{protocol}
static-auto-break-down-threshold
Description: static-auto-break-down-threshold is a JSON Block. Please see below for static-auto-break-down-threshold
Type: Object
sub-network
Description: sub-network is a JSON Block. Please see below for sub-network
Type: Object
Reference Object: /axapi/v3/ddos/network-object/{object-name}/sub-network
threshold-sensitivity
Description ‘LOW’: LOW; ‘MEDIUM’: MEDIUM; ‘HIGH’: HIGH; ‘OFF’: OFF;
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Default: OFF
topk-destinations
Description: topk-destinations is a JSON Block. Please see below for topk-destinations
Type: Object
Reference Object: /axapi/v3/ddos/network-object/{object-name}/topk-destinations
trustlist
Description: trustlist is a JSON Block. Please see below for trustlist
Type: Object
Reference Object: /axapi/v3/ddos/network-object/{object-name}/trustlist
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
service-break-down-threshold-local¶
Specification Value Type object svc-percentage
Description percentage of parent ip node
Type: number
Range: 5-99
network-object-anomaly-threshold¶
Specification Value Type object network-object-bit-rate
Description Bit rate of the network-object
Type: number
Range: 800-87960930222080
network-object-pkt-rate
Description Packet rate of the network-object
Type: number
Range: 1-10995116277760
indicators-to-monitor¶
Specification Value Type object enable
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-bit-rate
Description Forward bit rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-fin-rate
Description FIN packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-flow-count
Description Flow count
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-icmp-pkt-rate
Description ICMP packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-pkt-rate
Description Forward packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-rev-bit-rate
Description Reverse bit rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-rev-pkt-rate
Description Reverse packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-rst-rate
Description RST packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-syn-rate
Description SYN packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-tcp-pkt-rate
Description TCP packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-udp-pkt-rate
Description UDP packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-undiscovered-pkt-rate
Description Undiscovered forward packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trustlist¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
v4-class-list
Description IPv4 Class-list name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
v6-class-list
Description IPv6 Class-list name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
relative-auto-break-down-threshold¶
Specification Value Type object network-percentage
Description percentage of parent node
Type: number
Range: 1-99
permil
Description permil of root node
Type: number
Range: 1-999
host-anomaly-threshold¶
Specification Value Type object host-bit-rate
Description Forward bit rate of per host
Type: number
Range: 800-34359738360
host-fin-rate
Description FIN packet rate of per host
Type: number
Range: 1-2147483647
host-flow-count
Description Flow count of per host
Type: number
Range: 1-2147483647
host-icmp-pkt-rate
Description ICMP packet rate of per host
Type: number
Range: 1-2147483647
host-pkt-rate
Description Forward packet rate of per host
Type: number
Range: 1-2147483647
host-rev-bit-rate
Description Reverse bit rate of per host
Type: number
Range: 800-34359738360
host-rev-pkt-rate
Description Reverse packet rate of per host
Type: number
Range: 1-2147483647
host-rst-rate
Description RST packet rate of per host
Type: number
Range: 1-2147483647
host-syn-rate
Description SYN packet rate of per host
Type: number
Range: 1-2147483647
host-tcp-pkt-rate
Description Tcp packet rate of per host
Type: number
Range: 1-2147483647
host-udp-pkt-rate
Description Udp packet rate of per host
Type: number
Range: 1-2147483647
host-undiscovered-host-bit-rate
Description Forward bit rate of per undiscovered host
Type: number
Range: 800-34359738360
host-undiscovered-host-pkt-rate
Description forward packet rate of per undiscovered host
Type: number
Range: 1-2147483647
host-undiscovered-pkt-rate
Description Undiscovered forward packet rate of per host
Type: number
Range: 1-2147483647
sub-network¶
Specification Value Type object sub-network-v4-list
Type: List
Reference Object: /axapi/v3/ddos/network-object/{object-name}/sub-network/sub-network-v4/{subnet-ip-addr}
sub-network-v6-list
Type: List
Reference Object: /axapi/v3/ddos/network-object/{object-name}/sub-network/sub-network-v6/{subnet-ipv6-addr}
sub-network_sub-network-v4-list¶
Specification Value Type list Block object keys breakdown-subnet-threshold
Description: breakdown-subnet-threshold is a JSON Block. Please see below for sub-network_sub-network-v4-list_breakdown-subnet-threshold
Type: Object
host-anomaly-threshold
Description: host-anomaly-threshold is a JSON Block. Please see below for sub-network_sub-network-v4-list_host-anomaly-threshold
Type: Object
sampling-enable
Type: Listsub-network-anomaly-threshold
Description: sub-network-anomaly-threshold is a JSON Block. Please see below for sub-network_sub-network-v4-list_sub-network-anomaly-threshold
Type: Object
subnet-breakdown
Description additional layer of breakdown subnet
Type: number
Range: 25-31
subnet-ip-addr
Description IPv4 Subnet/host, supported prefix range is from 24 to 32
Type: string
Format: ipv4-cidr
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sub-network_sub-network-v4-list_sub-network-anomaly-threshold¶
Specification Value Type object static-sub-network-bit-rate
Description Bit rate of the sub-network
Type: number
Range: 800-34359738360
static-sub-network-pkt-rate
Description Packet rate of the sub-network
Type: number
Range: 1-2147483647
sub-network_sub-network-v4-list_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘packet_rate’: PPS; ‘bit_rate’: B(bits)PS;
Type: string
Supported Values: all, packet_rate, bit_rate
sub-network_sub-network-v4-list_breakdown-subnet-threshold¶
Specification Value Type object breakdown-subnet-bit-rate
Description Bit rate of per host
Type: number
Range: 800-34359738360
breakdown-subnet-pkt-rate
Description Packet rate of per host
Type: number
Range: 1-2147483647
sub-network_sub-network-v4-list_host-anomaly-threshold¶
Specification Value Type object static-bit-rate-threshold
Description Bit rate of per host
Type: number
Range: 800-34359738360
static-fin-rate-threshold
Description FIN packet rate of per host
Type: number
Range: 1-2147483647
static-flow-count-threshold
Description Flow count of per host
Type: number
Range: 1-2147483647
static-icmp-pkt-rate-threshold
Description ICMP packet rate of per host
Type: number
Range: 1-2147483647
static-pkt-rate-threshold
Description Packet rate of per host
Type: number
Range: 1-2147483647
static-rev-bit-rate-threshold
Description Bit rate of per host
Type: number
Range: 800-34359738360
static-rev-pkt-rate-threshold
Description Packet rate of per host
Type: number
Range: 1-2147483647
static-rst-rate-threshold
Description RST packet rate of per host
Type: number
Range: 1-2147483647
static-syn-rate-threshold
Description SYN packet rate of per host
Type: number
Range: 1-2147483647
static-tcp-pkt-rate-threshold
Description TCP packet rate of per host
Type: number
Range: 1-2147483647
static-udp-pkt-rate-threshold
Description UDP packet rate of per host
Type: number
Range: 1-2147483647
static-undiscovered-host-bit-rate-threshold
Description Bit rate of per undiscovered host
Type: number
Range: 800-34359738360
static-undiscovered-host-pkt-rate-threshold
Description packet rate of per undiscovered host
Type: number
Range: 1-2147483647
static-undiscovered-pkt-rate-threshold
Description Undiscovered packet rate of per host
Type: number
Range: 1-2147483647
sub-network_sub-network-v6-list¶
Specification Value Type list Block object keys host-anomaly-threshold
Description: host-anomaly-threshold is a JSON Block. Please see below for sub-network_sub-network-v6-list_host-anomaly-threshold
Type: Object
sampling-enable
Type: Listsub-network-anomaly-threshold
Description: sub-network-anomaly-threshold is a JSON Block. Please see below for sub-network_sub-network-v6-list_sub-network-anomaly-threshold
Type: Object
subnet-breakdown
Description additional layer of breakdown subnet
Type: number
Range: 57-63
subnet-ipv6-addr
Description IPv6 Subnet/host, supported prefix range is from 56 to 64
Type: string
Format: ipv6-address-plen
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sub-network_sub-network-v6-list_sub-network-anomaly-threshold¶
Specification Value Type object static-sub-network-bit-rate
Description Bit rate of the sub-network
Type: number
Range: 800-34359738360
static-sub-network-pkt-rate
Description Packet rate of the sub-network
Type: number
Range: 1-2147483647
sub-network_sub-network-v6-list_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘packet_rate’: PPS; ‘bit_rate’: B(bits)PS;
Type: string
Supported Values: all, packet_rate, bit_rate
sub-network_sub-network-v6-list_host-anomaly-threshold¶
Specification Value Type object static-bit-rate-threshold
Description Bit rate of per host
Type: number
Range: 800-34359738360
static-fin-rate-threshold
Description FIN packet rate of per host
Type: number
Range: 1-2147483647
static-flow-count-threshold
Description Flow count of per host
Type: number
Range: 1-2147483647
static-icmp-pkt-rate-threshold
Description ICMP packet rate of per host
Type: number
Range: 1-2147483647
static-pkt-rate-threshold
Description Packet rate of per host
Type: number
Range: 1-2147483647
static-rev-bit-rate-threshold
Description Bit rate of per host
Type: number
Range: 800-34359738360
static-rev-pkt-rate-threshold
Description Packet rate of per host
Type: number
Range: 1-2147483647
static-rst-rate-threshold
Description RST packet rate of per host
Type: number
Range: 1-2147483647
static-syn-rate-threshold
Description SYN packet rate of per host
Type: number
Range: 1-2147483647
static-tcp-pkt-rate-threshold
Description TCP packet rate of per host
Type: number
Range: 1-2147483647
static-udp-pkt-rate-threshold
Description UDP packet rate of per host
Type: number
Range: 1-2147483647
static-undiscovered-host-bit-rate-threshold
Description Bit rate of per undiscovered host
Type: number
Range: 800-34359738360
static-undiscovered-host-pkt-rate-threshold
Description packet rate of per undiscovered host
Type: number
Range: 1-2147483647
static-undiscovered-pkt-rate-threshold
Description Undiscovered packet rate of per host
Type: number
Range: 1-2147483647
notification¶
Specification Value Type object configuration
Description ‘configuration’: configuration;
Type: string
Supported Values: configuration
notification
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
notification_notification¶
Specification Value Type list Block object keys notification-template-name
Description Specify the notification template name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ddos/notification-template
topk-destinations¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sport-discovery-threshold¶
Specification Value Type object sport-discovery-bit-rate-percentage
Description Percentage of the bit rate of source port’s parent entry (default: 5)
Type: number
Range: 0-99
sport-heavy-hitter-percentage
Description Percentage of the bit rate of undiscovered source ports (default: 50)
Type: number
Range: 0-99
Default: 10
sport-list¶
Specification Value Type list Block object keys port-num
Description Port Number
Type: number
Range: 1-65535
protocol
Description ‘udp’: UDP port; ‘tcp’: TCP Port;
Type: string
Supported Values: udp, tcp
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-list¶
Specification Value Type list Block object keys prefix-anomaly-threshold
Description: prefix-anomaly-threshold is a JSON Block. Please see below for ip-list_prefix-anomaly-threshold
Type: Object
sampling-enable
Type: Listsubnet-ip-addr
Description IP Subnet, supported prefix range is from 8 to 31
Type: string
Format: ipv4-cidr
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-list_prefix-anomaly-threshold¶
Specification Value Type object prefix-bit-rate
Description Bit rate of the prefix subnet
Type: number
Range: 800-34359738360
prefix-pkt-rate
Description Packet rate of the prefix subnet
Type: number
Range: 1-2147483647
ip-list_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘packet_rate’: PPS; ‘bit_rate’: B(bits)PS;
Type: string
Supported Values: all, packet_rate, bit_rate
sport-anomaly-threshold¶
Specification Value Type object bit-rate
Description: bit-rate is a JSON Block. Please see below for sport-anomaly-threshold_bit-rate
Type: Object
Reference Object: /axapi/v3/ddos/network-object/{object-name}/sport-anomaly-threshold/bit-rate
bit-rate-percentage
Description: bit-rate-percentage is a JSON Block. Please see below for sport-anomaly-threshold_bit-rate-percentage
Type: Object
Reference Object: /axapi/v3/ddos/network-object/{object-name}/sport-anomaly-threshold/bit-rate-percentage
ip-list
ipv6-list
packet-rate
Description: packet-rate is a JSON Block. Please see below for sport-anomaly-threshold_packet-rate
Type: Object
Reference Object: /axapi/v3/ddos/network-object/{object-name}/sport-anomaly-threshold/packet-rate
packet-rate-percentage
Description: packet-rate-percentage is a JSON Block. Please see below for sport-anomaly-threshold_packet-rate-percentage
Type: Object
Reference Object: /axapi/v3/ddos/network-object/{object-name}/sport-anomaly-threshold/packet-rate-percentage
sport-list
sport-anomaly-threshold_bit-rate-percentage¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
value
Description Percentage of source port entry’s parent entry
Type: number
Range: 1-99
sport-anomaly-threshold_bit-rate¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
value
Description Bit rate of a source port entry
Type: number
Range: 800-34359738360
sport-anomaly-threshold_sport-list¶
Specification Value Type list Block object keys bit-rate
Description Bit rate of a source port entry
Type: number
Range: 800-34359738360
bit-rate-percentage
Description Percentage of source port entry’s parent entry
Type: number
Range: 1-99
bit-rate-percentage-str
Description ‘bit-rate-percentage’: Percentage of source port entry’s parent entry;
Type: string
Supported Values: bit-rate-percentage
bit-rate-str
Description ‘bit-rate’: Bit rate of a source port entry;
Type: string
Supported Values: bit-rate
packet-rate
Description Packet rate of a source port entry
Type: number
Range: 1-2147483647
packet-rate-percentage
Description Percentage of source port entry’s parent entry
Type: number
Range: 1-99
packet-rate-percentage-str
Description ‘packet-rate-percentage’: Percentage of source port entry’s parent entry;
Type: string
Supported Values: packet-rate-percentage
packet-rate-str
Description ‘packet-rate’: Packet rate of a source port entry;
Type: string
Supported Values: packet-rate
protocol
Description ‘udp’: UDP port; ‘tcp’: TCP Port;
Type: string
Supported Values: udp, tcp
sport-num
Description Source port number
Type: number
Range: 1-65535
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sport-anomaly-threshold_ip-list¶
Specification Value Type list Block object keys bit-rate
Description Bit rate of a source port entry
Type: number
Range: 800-34359738360
bit-rate-percentage
Description Percentage of source port entry’s parent entry
Type: number
Range: 1-99
bit-rate-percentage-str
Description ‘bit-rate-percentage’: Percentage of source port entry’s parent entry;
Type: string
Supported Values: bit-rate-percentage
bit-rate-str
Description ‘bit-rate’: Bit rate of a source port entry;
Type: string
Supported Values: bit-rate
ip-addr
Description Override threshold
Type: string
Format: ipv4-address
ip-sport-bit-rate
Description Bit rate of a source port entry
Type: number
Range: 800-34359738360
ip-sport-bit-rate-percentage
Description Percentage of source port entry’s parent entry
Type: number
Range: 1-99
ip-sport-bit-rate-percentage-str
Description ‘bit-rate-percentage’: Percentage of source port entry’s parent entry;
Type: string
Supported Values: bit-rate-percentage
ip-sport-bit-rate-str
Description ‘bit-rate’: Bit rate of a source port entry;
Type: string
Supported Values: bit-rate
ip-sport-packet-rate
Description Packet rate of a source port entry
Type: number
Range: 1-2147483647
ip-sport-packet-rate-percentage
Description Percentage of source port entry’s parent entry
Type: number
Range: 1-99
ip-sport-packet-rate-percentage-str
Description ‘packet-rate-percentage’: Percentage of source port entry’s parent entry;
Type: string
Supported Values: packet-rate-percentage
ip-sport-packet-rate-str
Description ‘packet-rate’: Packet rate of a source port entry;
Type: string
Supported Values: packet-rate
packet-rate
Description Packet rate of a source port entry
Type: number
Range: 1-2147483647
packet-rate-percentage
Description Percentage of source port entry’s parent entry
Type: number
Range: 1-99
packet-rate-percentage-str
Description ‘packet-rate-percentage’: Percentage of source port entry’s parent entry;
Type: string
Supported Values: packet-rate-percentage
packet-rate-str
Description ‘packet-rate’: Packet rate of a source port entry;
Type: string
Supported Values: packet-rate
protocol
Description ‘udp’: UDP port; ‘tcp’: TCP Port;
Type: string
Supported Values: udp, tcp
sport-num
Description Source port number
Type: number
Range: 1-65535
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sport-anomaly-threshold_ipv6-list¶
Specification Value Type list Block object keys bit-rate
Description Bit rate of a source port entry
Type: number
Range: 800-34359738360
bit-rate-percentage
Description Percentage of source port entry’s parent entry
Type: number
Range: 1-99
bit-rate-percentage-str
Description ‘bit-rate-percentage’: Percentage of source port entry’s parent entry;
Type: string
Supported Values: bit-rate-percentage
bit-rate-str
Description ‘bit-rate’: Bit rate of a source port entry;
Type: string
Supported Values: bit-rate
ip-addr
Description Override threshold
Type: string
Format: ipv6-address-plen
ip-sport-bit-rate
Description Bit rate of a source port entry
Type: number
Range: 800-34359738360
ip-sport-bit-rate-percentage
Description Percentage of source port entry’s parent entry
Type: number
Range: 1-99
ip-sport-bit-rate-percentage-str
Description ‘bit-rate-percentage’: Percentage of source port entry’s parent entry;
Type: string
Supported Values: bit-rate-percentage
ip-sport-bit-rate-str
Description ‘bit-rate’: Bit rate of a source port entry;
Type: string
Supported Values: bit-rate
ip-sport-packet-rate
Description Packet rate of a source port entry
Type: number
Range: 1-2147483647
ip-sport-packet-rate-percentage
Description Percentage of source port entry’s parent entry
Type: number
Range: 1-99
ip-sport-packet-rate-percentage-str
Description ‘packet-rate-percentage’: Percentage of source port entry’s parent entry;
Type: string
Supported Values: packet-rate-percentage
ip-sport-packet-rate-str
Description ‘packet-rate’: Packet rate of a source port entry;
Type: string
Supported Values: packet-rate
packet-rate
Description Packet rate of a source port entry
Type: number
Range: 1-2147483647
packet-rate-percentage
Description Percentage of source port entry’s parent entry
Type: number
Range: 1-99
packet-rate-percentage-str
Description ‘packet-rate-percentage’: Percentage of source port entry’s parent entry;
Type: string
Supported Values: packet-rate-percentage
packet-rate-str
Description ‘packet-rate’: Packet rate of a source port entry;
Type: string
Supported Values: packet-rate
protocol
Description ‘udp’: UDP port; ‘tcp’: TCP Port;
Type: string
Supported Values: udp, tcp
sport-num
Description Source port number
Type: number
Range: 1-65535
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sport-anomaly-threshold_packet-rate¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
value
Description Packet rate of a source port entry
Type: number
Range: 1-2147483647
sport-anomaly-threshold_packet-rate-percentage¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
value
Description Percentage of source port entry’s parent entry
Type: number
Range: 1-99
static-auto-break-down-threshold¶
Specification Value Type object network-pkt-rate
Description packet rate of current node
Type: number
Range: 100-2000000
sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘subnet_learned’: Subnet Entry Learned; ‘subnet_aged’: Subnet Entry Aged; ‘subnet_create_fail’: Subnet Entry Create Failures; ‘ip_learned’: IP Entry Learned; ‘ip_aged’: IP Entry Aged; ‘ip_create_fail’: IP Entry Create Failures; ‘service_learned’: Service Entry Learned; ‘service_aged’: Service Entry Aged; ‘service_create_fail’: Service Entry Create Failures; ‘packet_rate’: PPS; ‘bit_rate’: B(bits)PS; ‘topk_allocate_fail’: Topk Allocate Failures; ‘sport_learned’: Source Port Entry Learned; ‘sport_aged’: Source Port Entry Aged; ‘sport_create_fail’: Source Port Entry Create Failures;
Type: string
Supported Values: all, subnet_learned, subnet_aged, subnet_create_fail, ip_learned, ip_aged, ip_create_fail, service_learned, service_aged, service_create_fail, packet_rate, bit_rate, topk_allocate_fail, sport_learned, sport_aged, sport_create_fail, agent_group_learned, agent_group_aged, agent_group_create_fail, duplicate_sample_pkt_rcv
enable-top-k¶
Specification Value Type list Block object keys topk-dst-num-records
Description Maximum number of records to show in topk
Type: number
Range: 1-100
Default: 20
topk-sort-key
Description ‘average’: window average; ‘max-peak’: max peak;
Type: string
Supported Values: average, max-peak
Default: average
topk-type
Description ‘destination’: Topk destination IP;
Type: string
Supported Values: destination
ipv6-list¶
Specification Value Type list Block object keys prefix-anomaly-threshold
Description: prefix-anomaly-threshold is a JSON Block. Please see below for ipv6-list_prefix-anomaly-threshold
Type: Object
sampling-enable
Type: Listsubnet-ipv6-addr
Description IPV6 Subnet, supported prefix range is from 40 to 63
Type: string
Format: ipv6-address-plen
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ipv6-list_prefix-anomaly-threshold¶
Specification Value Type object prefix-bit-rate
Description Bit rate of the prefix subnet
Type: number
Range: 800-34359738360
prefix-pkt-rate
Description Packet rate of the prefix subnet
Type: number
Range: 1-2147483647
ipv6-list_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘packet_rate’: PPS; ‘bit_rate’: B(bits)PS;
Type: string
Supported Values: all, packet_rate, bit_rate