shutdown¶
Shutdown the System
shutdown Specification¶
Parameter Value Type operational Element Name shutdown Element URI /axapi/v3/shutdown Element Attributes shutdown_attributes Partition Visibility shared Schema shutdown schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
EXECUTE Object | POST | /axapi/v3/shutdown |
shutdown attributes¶
at
Description Shutdown at a specific time/date
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
cancel
Description Cancel Pending Shutdown
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
day-of-month
Description Day of the Month
Type: number
Range: 1-31
day-of-month-2
Description Day of the Month
Type: number
Range: 1-31
in
Description Delay before Shutdown (Time in hours and minutes)
Type: string
Format: time-hhmm
month
Description ‘January’: Month of the year; ‘February’: Month of the year; ‘March’: Month of the year; ‘April’: Month of the year; ‘May’: Month of the year; ‘June’: Month of the year; ‘July’: Month of the year; ‘August’: Month of the year; ‘September’: Month of the year; ‘October’: Month of the year; ‘November’: Month of the year; ‘December’: Month of the year;
Type: string
Supported Values: January, February, March, April, May, June, July, August, September, October, November, December
month-2
Description ‘January’: Month of the year; ‘February’: Month of the year; ‘March’: Month of the year; ‘April’: Month of the year; ‘May’: Month of the year; ‘June’: Month of the year; ‘July’: Month of the year; ‘August’: Month of the year; ‘September’: Month of the year; ‘October’: Month of the year; ‘November’: Month of the year; ‘December’: Month of the year;
Type: string
Supported Values: January, February, March, April, May, June, July, August, September, October, November, December
reason
Description Reason for Shutdown
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
reason-2
Description Reason for Shutdown
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
reason-3
Description Reason for Shutdown
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
time
Description Time to Shutdown (hh:mm)
Type: string
Format: time-hhmm