file-inspection¶
File Inspection related commands
file-inspection Specification¶
Type Intermediate Resource Element Name file-inspection Element URI /axapi/v3/file-inspection Element Attributes file-inspection_attributes Schema file-inspection schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/file-inspection | file-inspection_attributes |
file-inspection attributes¶
data-file
Description: data-file is a JSON Block. Please see below for data-file
Type: Object
Refernce Object: /axapi/v3/file-inspection/data-file
global
Description: global is a JSON Block. Please see below for global
Type: Object
Refernce Object: /axapi/v3/file-inspection/global
global-stat
Description: global-stat is a JSON Block. Please see below for global-stat
Type: Object
Refernce Object: /axapi/v3/file-inspection/global-stat
service
Description: service is a JSON Block. Please see below for service
Type: Object
Refernce Object: /axapi/v3/file-inspection/service
status
Description: status is a JSON Block. Please see below for status
Type: Object
Refernce Object: /axapi/v3/file-inspection/status
template-list
Type: List
Refernce Object: /axapi/v3/file-inspection/template/{name}
status¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
data-file¶
Specification Type object action
Description data file action
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
file-url
Description File URL
Type: string
Format: url
name
Description data file name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
source-ip-address
Description Source IP address
Type: string
Format: ipv4-address
Mutual Exclusion: source-ip-address and use-mgmt-port are mutually exclusive
type
Description data file type
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: use-mgmt-port and source-ip-address are mutually exclusive
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
service¶
Specification Type object enable
Description Enable Internal File Inspection Service
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
health-check-disable
Description Disable internal service health check
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: health-check-disable and health-monitor are mutually exclusive
service-down-action
Description ‘reset’: Reset Connection; ‘allow’: Allow File;
Type: string
Supported Values: reset, allow
Default: allow
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
global¶
Specification Type object classification
Description: classification is a JSON Block. Please see below for global_classification
Type: Object
logging
Description: logging is a JSON Block. Please see below for global_logging
Type: Object
max-buffer-size
Description Maximum size (bytes) of content that can be buffered - default 0 (disabled) (Maximum size (bytes) content that can be buffered - default 0 (disabled))
Type: number
Range: 0-268435455
Default: 0
max-concurrent-files
Description Max concurrenet inspected files per server - default 10 ( Max concurrenet inspected files per server - default 10)
Type: number
Range: 1-100
Default: 10
max-concurrent-files-action
Description ‘bypass’: Bypass File Inspection (default);
Type: string
Supported Values: bypass
Default: bypass
max-file-size
Description Maximum file size (bytes) - default 157286400
Type: number
Range: 0-1073741824
Default: 157286400
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
global_logging¶
Specification Type object bypass
Description: bypass is a JSON Block. Please see below for global_logging_bypass
Type: Object
failed-transactions
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
local-logging-disable
Description Disable local logging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
global_logging_bypass¶
Specification Type object aflex-disabled-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: no-log
Mutual Exclusion: aflex-disabled-log and all-bypass-log are mutually exclusive
all-bypass-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: no-log
Mutual Exclusion: all-bypass-logno-content-disposition-log, old-http-version-log, aflex-disabled-log, service-disabled-log, service-down-log, max-concurrent-files-log, filesize-overlimit-log and internal-buffered-overlimit-log are mutually exclusive
filesize-overlimit-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: no-log
Mutual Exclusion: filesize-overlimit-log and all-bypass-log are mutually exclusive
internal-buffered-overlimit-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: no-log
Mutual Exclusion: internal-buffered-overlimit-log and all-bypass-log are mutually exclusive
max-concurrent-files-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: no-log
Mutual Exclusion: max-concurrent-files-log and all-bypass-log are mutually exclusive
no-content-disposition-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: no-log
Mutual Exclusion: no-content-disposition-log and all-bypass-log are mutually exclusive
old-http-version-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: no-log
Mutual Exclusion: old-http-version-log and all-bypass-log are mutually exclusive
service-disabled-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: no-log
Mutual Exclusion: service-disabled-log and all-bypass-log are mutually exclusive
service-down-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: no-log
Mutual Exclusion: service-down-log and all-bypass-log are mutually exclusive
global_classification¶
Specification Type object classification-disable
Description Disable Internal File Inspection Classification
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
max-classification-len
Description maximum length to be taken for file classification - default 65536
Type: number
Range: 1-268435455
Default: 65536
min-classification-len
Description minimum length to be taken for file classification - default 4096
Type: number
Range: 1-268435455
Default: 4096
template-list¶
Specification Type list Block object keys bad-downloads-action
Description ‘reset’: Reset Connection; ‘drop’: Drop File (default); ‘allow’: Allow File;
Type: string
Supported Values: reset, drop, allow
Default: drop
bad-uploads-action
Description ‘reset’: Reset Connection; ‘drop’: Drop File; ‘allow’: Allow File;
Type: string
Supported Values: reset, drop, allow
downloads-bad-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
downloads-external-inspect
Description respmod template for external icap inspection
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: downloads-external-inspect and suspect-downloads-action are mutually exclusive
Refernce Object: /axapi/v3/slb/template/respmod-icap
downloads-external-suspect-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
downloads-good-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
downloads-suspect-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
good-downloads-action
Description ‘reset’: Reset Connection; ‘drop’: Drop File; ‘allow’: Allow File (default);
Type: string
Supported Values: reset, drop, allow
Default: allow
good-uploads-action
Description ‘reset’: Reset Connection; ‘drop’: Drop File; ‘allow’: Allow File;
Type: string
Supported Values: reset, drop, allow
inspect
Description: inspect is a JSON Block. Please see below for template-list_inspect
Type: Object
name
Description file-inspection template name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
suspect-downloads-action
Description ‘reset’: Reset Connection; ‘drop’: Drop File; ‘allow’: Allow File (default);
Type: string
Supported Values: reset, drop, allow
Default: allow
Mutual Exclusion: suspect-downloads-action and downloads-external-inspect are mutually exclusive
suspect-uploads-action
Description ‘reset’: Reset Connection; ‘drop’: Drop File; ‘allow’: Allow File;
Type: string
Supported Values: reset, drop, allow
Mutual Exclusion: suspect-uploads-action and uploads-external-inspect are mutually exclusive
uploads-bad-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
uploads-external-inspect
Description reqmod template for external icap inspection
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: uploads-external-inspect and suspect-uploads-action are mutually exclusive
Refernce Object: /axapi/v3/slb/template/reqmod-icap
uploads-external-suspect-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
uploads-good-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
uploads-suspect-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
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
template-list_inspect¶
Specification Type object download-icap
Description respmod icap template (respmod icap Config name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/slb/template/respmod-icap
inspect-downloads
Description Inspect file downloads
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
global-stat¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
global-stat_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘download_bad_blocked’: Download malware blocked; ‘download_bad_allowed’: Download malware allowed; ‘download_bad_ext_inspect’: Download malware extrnal inspect; ‘download_suspect_blocked’: Download suspect blocked; ‘download_suspect_ext_inspect’: Download suspect extrnal inspect; ‘download_suspect_allowed’: Download suspect allowed; ‘download_good_blocked’: Download safe blocked; ‘download_good_allowed’: Download safe external inspect; ‘download_good_ext_inspect’: Download safe allowed; ‘upload_bad_blocked’: Upload malware blocked; ‘upload_bad_allowed’: Upload malware allowed; ‘upload_bad_ext_inspect’: Upload malware extrnal inspect; ‘upload_suspect_blocked’: Upload suspect blocked; ‘upload_suspect_ext_inspect’: Upload suspect extrnal inspect; ‘upload_suspect_allowed’: Upload suspect allowed; ‘upload_good_blocked’: Upload safe blocked; ‘upload_good_ext_inspect’: Upload safe external inspect; ‘upload_good_allowed’: Upload safe allowed; ‘icap_200’: Receive icap status 200; ‘icap_204’: Receive icap status 204; ‘icap_500’: Receive icap status 500; ‘icap_other_status_code’: Receive icap other status code; ‘icap_connect_fail’: Icap connect fail; ‘icap_connection_created’: Icap connection created; ‘icap_connection_established’: Icap connection established; ‘icap_connection_closed’: Icap connection closed; ‘icap_connection_rst’: Icap connection rst; ‘icap_bytes_sent’: Icap bytes sent; ‘icap_bytes_received’: Icap bytes received; ‘bypass_aflex’: Bypassed by aflex; ‘bypass_large_file’: Bypassed - large file size; ‘bypass_service_disabled’: Bypassed - Internal service disabled; ‘bypass_service_down’: Bypassed - Internal service down; ‘reset_service_down’: Reset - Internal service down; ‘bypass_max_concurrent_files_reached’: Bypassed - max concurrent files on server reached; ‘bypass_non_inspection’: Bypassed non inspection data; ‘non_supported_file’: Non supported file type; ‘transactions_alloc’: Total transactions allocated; ‘transactions_free’: Total transactions freed; ‘transactions_failure’: Total transactions failure; ‘transactions_aborted’: Total transactions aborted; ‘orig_conn_bytes_received’: Original connection bytes received; ‘orig_conn_bytes_sent’: Original connection bytes sent; ‘orig_conn_bytes_bypassed’: Original connection bytes bypassed; ‘bypass_buffered_overlimit’: Total Bytes Buffered Overlimit; ‘total_bandwidth’: Total File Bytes; ‘total_suspect_bandwidth’: Total Suspected Files Bytes; ‘total_bad_bandwidth’: Total Bad Files Bytes; ‘total_good_bandwidth’: Total Good Files Bytes; ‘total_file_size_less_1m’: Total Files Less than 1Mb; ‘total_file_size_1_5m’: Total Files Between 1-5Mb; ‘total_file_size_5_8m’: Total Files Between 5-8Mb; ‘total_file_size_8_32m’: Total Files Between 8-32Mb; ‘total_file_size_over_32m’: Total Files over 32Mb; ‘suspect_file_size_less_1m’: Suspect Files Less than 1Mb; ‘suspect_file_size_1_5m’: Suspect Files Between 1-5Mb; ‘suspect_file_size_5_8m’: Suspect Files Between 5-8Mb; ‘suspect_file_size_8_32m’: Suspect Files Between 8-32Mb; ‘suspect_file_size_over_32m’: Suspect Files over 32Mb; ‘good_file_size_less_1m’: Good Files Less than 1Mb; ‘good_file_size_1_5m’: Good Files Between 1-5Mb; ‘good_file_size_5_8m’: Good Files Between 5-8Mb; ‘good_file_size_8_32m’: Good Files Between 8-32Mb; ‘good_file_size_over_32m’: Good Files over 32Mb; ‘bad_file_size_less_1m’: Bad Files Less than 1Mb; ‘bad_file_size_1_5m’: Bad Files Between 1-5Mb; ‘bad_file_size_5_8m’: Bad Files Between 5-8Mb; ‘bad_file_size_8_32m’: Bad Files Between 8-32Mb; ‘bad_file_size_over_32m’: Bad Files over 32Mb;
Type: string
Supported Values: all, download_bad_blocked, download_bad_allowed, download_bad_ext_inspect, download_suspect_blocked, download_suspect_ext_inspect, download_suspect_allowed, download_good_blocked, download_good_allowed, download_good_ext_inspect, upload_bad_blocked, upload_bad_allowed, upload_bad_ext_inspect, upload_suspect_blocked, upload_suspect_ext_inspect, upload_suspect_allowed, upload_good_blocked, upload_good_ext_inspect, upload_good_allowed, icap_200, icap_204, icap_500, icap_other_status_code, icap_connect_fail, icap_connection_created, icap_connection_established, icap_connection_closed, icap_connection_rst, icap_bytes_sent, icap_bytes_received, bypass_aflex, bypass_large_file, bypass_service_disabled, bypass_service_down, reset_service_down, bypass_max_concurrent_files_reached, bypass_non_inspection, non_supported_file, transactions_alloc, transactions_free, transactions_failure, transactions_aborted, orig_conn_bytes_received, orig_conn_bytes_sent, orig_conn_bytes_bypassed, bypass_buffered_overlimit, total_bandwidth, total_suspect_bandwidth, total_bad_bandwidth, total_good_bandwidth, total_file_size_less_1m, total_file_size_1_5m, total_file_size_5_8m, total_file_size_8_32m, total_file_size_over_32m, suspect_file_size_less_1m, suspect_file_size_1_5m, suspect_file_size_5_8m, suspect_file_size_8_32m, suspect_file_size_over_32m, good_file_size_less_1m, good_file_size_1_5m, good_file_size_5_8m, good_file_size_8_32m, good_file_size_over_32m, bad_file_size_less_1m, bad_file_size_1_5m, bad_file_size_5_8m, bad_file_size_8_32m, bad_file_size_over_32m