ddos network-object-template¶
Network-object Template Configuration
network-object-template Specification¶
Parameter Value Type Collection Object Key(s) name Collection Name network-object-template-list Collection URI /axapi/v3/ddos/network-object-template Element Name network-object-template Element URI /axapi/v3/ddos/network-object-template/{name} Element Attributes network-object-template_attributes Partition Visibility shared Schema network-object-template schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/ddos/network-object-template | ||
Create List | POST | /axapi/v3/ddos/network-object-template | ||
Get Object | GET | /axapi/v3/ddos/network-object-template/{name} | ||
Get List | GET | /axapi/v3/ddos/network-object-template | ||
Modify Object | POST | /axapi/v3/ddos/network-object-template/{name} | ||
Replace Object | PUT | /axapi/v3/ddos/network-object-template/{name} | ||
Replace List | PUT | /axapi/v3/ddos/network-object-template | ||
Delete Object | DELETE | /axapi/v3/ddos/network-object-template/{name} | ||
network-object-template-list¶
network-object-template-list is JSON List of network-object-template attributes
network-object-template-list : [
network-object-template 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
flooding-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
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-template/{name}/indicators-to-monitor
name
Description DDOS network-object-template name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
network-object-anomaly-threshold
Description: network-object-anomaly-threshold is a JSON Block. Please see below for network-object-anomaly-threshold
Type: Object
operational-mode
Description ‘monitor’: Monitor mode; ‘learning’: Learning mode;
Type: string
Supported Values: monitor, learning
Default: learning
service-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-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-template/{name}/sport-anomaly-threshold
threshold-sensitivity
Description tune threshold ranges with levels LOW/MEDIUM/HIGH/OFF (default) or multiplier of threshold value (available options are LOW=5x/MEDIUM=3x/HIGH=1.5x/OFF=1x, or float value between 1.0-10.0)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Default: OFF
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
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-template/{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-template/{name}/sport-anomaly-threshold/bit-rate-percentage
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-template/{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-template/{name}/sport-anomaly-threshold/packet-rate-percentage
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_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_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_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
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