web-gui tps¶
Configure TPS
tps Specification¶
Type Configuration Resource Element Name tps Element URI /axapi/v3/web-gui/tps Element Attributes tps_attributes Schema tps schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/web-gui/tps | ||
Get Object | GET | /axapi/v3/web-gui/tps | ||
Modify Object | POST | /axapi/v3/web-gui/tps | ||
Replace Object | PUT | /axapi/v3/web-gui/tps | ||
Delete Object | DELETE | /axapi/v3/web-gui/tps |
tps attributes¶
wizard
Description: wizard is a JSON Block. Please see below for wizard
Type: Object
Refernce Object: /axapi/v3/web-gui/tps/wizard
wizard¶
Specification Type object learning
Description: learning is a JSON Block. Please see below for wizard_learning
Type: Object
Refernce Object: /axapi/v3/web-gui/tps/wizard/learning
protection
Description: protection is a JSON Block. Please see below for wizard_protection
Type: Object
Refernce Object: /axapi/v3/web-gui/tps/wizard/protection
wizard_protection¶
Specification Type object global-sensitivity
Description ‘5’: Low; ‘3’: Medium; ‘1.5’: High;
Type: string
Supported Values: 5, 3, 1.5
Default: 3
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
zone-list
Type: List
Refernce Object: /axapi/v3/web-gui/tps/wizard/protection/zone/{zone-name}
wizard_protection_zone-list¶
Specification Type list Block object keys ip-proto
Description: ip-proto is a JSON Block. Please see below for wizard_protection_zone-list_ip-proto
Type: Object
Refernce Object: /axapi/v3/web-gui/tps/wizard/protection/zone/{zone-name}/ip-proto
port
Description: port is a JSON Block. Please see below for wizard_protection_zone-list_port
Type: Object
Refernce Object: /axapi/v3/web-gui/tps/wizard/protection/zone/{zone-name}/port
port-range-list
sensitivity
Description ‘5’: Low; ‘3’: Medium; ‘1.5’: High;
Type: string
Supported Values: 5, 3, 1.5
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
zone-name
Description Specify name of the zone
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
wizard_protection_zone-list_ip-proto¶
Specification Type object proto-name-list
Type: List
Refernce Object: /axapi/v3/web-gui/tps/wizard/protection/zone/{zone-name}/ip-proto/proto-name/{protocol}
wizard_protection_zone-list_ip-proto_proto-name-list¶
Specification Type list Block object keys pbe
Description Peak Bandwidth Expected
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
protocol
Description ‘icmp-v4’: ip-proto icmp-v4; ‘icmp-v6’: ip-proto icmp-v6;
Type: string
Supported Values: icmp-v4, icmp-v6
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
wizard_protection_zone-list_port-range-list¶
Specification Type list Block object keys pbe
Description Peak Bandwidth Expected
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
port-range-end
Description Port-Range End Port Number
Type: number
Range: 1-65535
port-range-start
Description Port-Range Start Port Number
Type: number
Range: 1-65535
protocol
Description ‘dns-tcp’: DNS-TCP Port; ‘dns-udp’: DNS-UDP Port; ‘http’: HTTP Port; ‘tcp’: TCP Port; ‘udp’: UDP Port; ‘ssl-l4’: SSL-L4 Port;
Type: string
Supported Values: dns-tcp, dns-udp, http, tcp, udp, ssl-l4
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
wizard_protection_zone-list_port¶
Specification Type object zone-service-list
Type: List
Refernce Object: /axapi/v3/web-gui/tps/wizard/protection/zone/{zone-name}/port/zone-service/{port-num}+{protocol}
zone-service-other-list
Type: List
Refernce Object: /axapi/v3/web-gui/tps/wizard/protection/zone/{zone-name}/port/zone-service-other/{port-other}+{protocol}
wizard_protection_zone-list_port_zone-service-list¶
Specification Type list Block object keys pbe
Description Peak Bandwidth Expected
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
port-num
Description Port Number
Type: number
Range: 1-65535
protocol
Description ‘dns-tcp’: DNS-TCP Port; ‘dns-udp’: DNS-UDP Port; ‘http’: HTTP Port; ‘tcp’: TCP Port; ‘udp’: UDP Port; ‘ssl-l4’: SSL-L4 Port;
Type: string
Supported Values: dns-tcp, dns-udp, http, tcp, udp, ssl-l4
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
wizard_protection_zone-list_port_zone-service-other-list¶
Specification Type list Block object keys pbe
Description Peak Bandwidth Expected
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
port-other
Description ‘other’: other;
Type: string
Supported Values: other
protocol
Description ‘tcp’: TCP Port; ‘udp’: UDP Port;
Type: string
Supported Values: tcp, udp
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
wizard_learning¶
Specification Type object duration
Description ‘6hour’: 6 hours; ‘12hour’: 12 hours; ‘24hour’: 24 hours; ‘7day’: 7 days;
Type: string
Supported Values: 6hour, 12hour, 24hour, 7day
Default: 6hour
start-time
Description Configure start time
Type: string
Maximum Length: 13 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
zone-list
Type: List
Refernce Object: /axapi/v3/web-gui/tps/wizard/learning/zone/{name}
wizard_learning_zone-list¶
Specification Type list Block object keys learned
Description ‘yes’: Yes, learned; ‘no’: No, not learned;
Type: string
Supported Values: yes, no
name
Description Specify name of the zone
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters