backup-periodic

Configure periodic backups for the system files and the log files. Day, hour, and week are mutually exclusive so you will only configure one.

backup-periodic Specification

Type Collection
Object Key(s) system, log
Collection Name backup-periodic-list
Collection URI /axapi/v3/backup-periodic/
Element Name backup-periodic
Element URI /axapi/v3/backup-periodic/{system}+{log}
Element Attributes backup-periodic_attributes
Schema backup-periodic schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/backup-periodic/

backup-periodic Attributes

Create List

POST

/axapi/v3/backup-periodic/

backup-periodic Attributes

Get Object

GET

/axapi/v3/backup-periodic/{system}+{log}

backup-periodic Attributes

Get List

GET

/axapi/v3/backup-periodic/

backup-periodic-list

Modify Object

POST

/axapi/v3/backup-periodic/{system}+{log}

backup-periodic Attributes

Replace Object

PUT

/axapi/v3/backup-periodic/{system}+{log}

backup-periodic Attributes

Replace List

PUT

/axapi/v3/backup-periodic/

backup-periodic-list

Delete Object

DELETE

/axapi/v3/backup-periodic/{system}+{log}

backup-periodic Attributes

backup-periodic-list

backup-periodic-list is JSON List of backup-periodic Attributes

backup-periodic-list : [

backup-periodic Attributes

day

Description: Performs the backup each time the specified number of days passes. For example, specifying 5 causes the backup to occur every 5 days.

Type: number

Range: 1-199

Mutual Exclusion: day hour and week are mutually exclusive

hour

Description: Performs the backup each time the specified number of hours passes. For example, specifying 3 causes the backup to occur every 3 hours.

Type: number

Range: 1-65534

Mutual Exclusion: hour day and week are mutually exclusive

log

Description: Backup the log files.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Required: Yes

remote-file

Description: File name for the remote url.

Type: string

Format: url

store-name

Description: Assign a name to the backup store.

Type: string

system

Description: Backup the system files.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Required: Yes

use-mgmt-port

Description: Uses the management interface as the source interface for the connection to the remote device.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

week

Description: Performs the backup each time the specified number of weeks passes. For example, specifying 4 causes the backup to occur every 4 weeks.

Type: number

Range: 1-199

Mutual Exclusion: week day and hour are mutually exclusive