fail-safe¶
Fail Safe Global Commands
fail-safe Specification¶
Parameter Value Type Configuration Resource Element Name fail-safe Element URI /axapi/v3/fail-safe Element Attributes fail-safe_attributes Partition Visibility shared Operational Data URI /axapi/v3/fail-safe/oper Schema fail-safe schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/fail-safe | ||
Get Object | GET | /axapi/v3/fail-safe | ||
Modify Object | POST | /axapi/v3/fail-safe | ||
Replace Object | PUT | /axapi/v3/fail-safe | ||
Delete Object | DELETE | /axapi/v3/fail-safe | ||
fail-safe attributes¶
config
Description: config is a JSON Block. Please see below for config
Type: Object
Reference Object: /axapi/v3/fail-safe/config
dataplane-recovery-timeout
Description dataplane hung detection timeout before ACOS is restarted (in seconds)
Type: number
Range: 1-30
Default: 5
disable-failsafe
Description: disable-failsafe is a JSON Block. Please see below for disable-failsafe
Type: Object
Reference Object: /axapi/v3/fail-safe/disable-failsafe
fpga-buff-recovery-threshold
Description FPGA buffers recovery threshold (Units of 256 buffers (default 2))
Type: number
Range: 1-10
Default: 2
fpga-monitor-enable
Description FPGA monitor feature enable
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
fpga-monitor-forced-reboot
Description FPGA monitor forced reboot in error condition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
fpga-monitor-interval
Description FPGA monitor packet interval (seconds) (Numbers of seconds between sending packets (default 1))
Type: number
Range: 1-60
Default: 1
fpga-monitor-threshold
Description FPGA monitor packet missed for error condition (Numbers of missed monitor packets before setting error condition (default 30))
Type: number
Range: 2-255
Default: 30
hw-error-monitor
Description ‘hw-error-monitor-disable’: Disable fail-safe hardware error monitor; ‘hw-error-monitor-enable’: Enable fail-safe hardware error monitor;
Type: string
Supported Values: hw-error-monitor-disable, hw-error-monitor-enable
Default: hw-error-monitor-enable
hw-error-recovery-timeout
Description Hardware error recovery timeout (minutes) (waiting time of recovery from hardware errors (default 0))
Type: number
Range: 1-1440
hw-ssl-timeout-monitor
Description ‘hw-ssl-timeout-monitor-disable’: Disable fail-safe hardware SSL timeout monitor; ‘hw-ssl-timeout-monitor-enable’: Enable fail-safe hardware SSL timeout monitor;
Type: string
Supported Values: hw-ssl-timeout-monitor-disable, hw-ssl-timeout-monitor-enable
Default: hw-ssl-timeout-monitor-enable
kill
Description Stop the traffic and log the event
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: kill and log are mutually exclusive
log
Description Log the event
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: log and kill are mutually exclusive
session-mem-recovery-threshold
Description Session memory recovery threshold (percentage) (Percentage of available session memory (default 30%))
Type: number
Range: 1-100
Default: 30
sw-error-monitor-enable
Description Enable fail-safe software error monitor
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sw-error-recovery-timeout
Description Software error recovery timeout (minutes) (waiting time of recovery from software errors (default 3))
Type: number
Range: 1-1440
Default: 3
total-memory-size-check
Description Check total memory size of current system (Size of memory (GB))
Type: number
Range: 1-256
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
disable-failsafe¶
Specification Value Type object action
Description ‘all’: Disable All; ‘io-buffer’: Disable I/O Buffer; ‘session-memory’: Disable Session Memory; ‘system-memory’: Disable System Memory;
Type: string
Supported Values: all, io-buffer, session-memory, system-memory
Default: all
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
config¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters