health external¶
Address the External Script Program
external Specification¶
Type Intermediate Resource Element Name external Element URI /axapi/v3/health/external Element Attributes external_attributes Schema external schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Get Object | GET | /axapi/v3/health/external | external_attributes |
external attributes¶
copy
Description: copy is a JSON Block. Please see below for copy
Type: Object
Refernce Object: /axapi/v3/health/external/copy
create
Description: create is a JSON Block. Please see below for create
Type: Object
Refernce Object: /axapi/v3/health/external/create
delete
Description: delete is a JSON Block. Please see below for delete
Type: Object
Refernce Object: /axapi/v3/health/external/delete
edit
Description: edit is a JSON Block. Please see below for edit
Type: Object
Refernce Object: /axapi/v3/health/external/edit
privileged
Description: privileged is a JSON Block. Please see below for privileged
Type: Object
Refernce Object: /axapi/v3/health/external/privileged
rename
Description: rename is a JSON Block. Please see below for rename
Type: Object
Refernce Object: /axapi/v3/health/external/rename
rename¶
Specification Type object dst-file
Description Destination external health monitor script file name
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
src-file
Description Source external health monitor script file name
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
edit¶
Specification Type object description
Description Describe health external monitor script briefly
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
file-name
Description External health monitor script file name
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
create¶
Specification Type object description
Description Describe health external monitor script briefly
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
file-name
Description External health monitor script file name
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
copy¶
Specification Type object dst-file
Description Destination external health monitor script file name
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
src-file
Description Source external health monitor script file name
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
privileged¶
Specification Type object action
Description ‘enable’: To run external health monitor script as root; ‘disable’: To run external health monitor script as non-root;
Type: string
Supported Values: enable, disable
Default: enable
delete¶
Specification Type object file-name
Description External health monitor script file name
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters