backup-periodic¶

Configure backup periodically

backup-periodic Specification¶

Parameter Value

Type Configuration Resource

Element Name backup-periodic

Element URI /axapi/v3/backup-periodic

Element Attributes backup-periodic_attributes

Partition Visibility shared

Schema backup-periodic schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/backup-periodic	backup-periodic attributes
POST /axapi/v3/backup-periodic Payload: { "backup-periodic": { "system": 1, "day": 1, "remote-file": "http://example.com/axapi/v3health/postfile_url/stats4", "encrypt": 1 } }
Get Object	GET	/axapi/v3/backup-periodic	backup-periodic attributes
GET /axapi/v3/backup-periodic Reponse: { "backup-periodic": { "system": 1, "log": 0, "fixed-nat": 0, "day": 1, "encrypt": 1, "use-mgmt-port": 0, "remote-file": "http://example.com/axapi/v3health/postfile_url/stats4", "uuid": "4a981ad0-4fcf-11ee-bd2f-85f7e5aa92f8", "a10-url": "/axapi/v3/backup-periodic" } }
Modify Object	POST	/axapi/v3/backup-periodic	backup-periodic attributes
Replace Object	PUT	/axapi/v3/backup-periodic	backup-periodic attributes
Delete Object	DELETE	/axapi/v3/backup-periodic	backup-periodic attributes
DELETE /axapi/v3/backup-periodic Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

backup-periodic attributes¶

day

Description Specify interval days

Type: number

Range: 1-199

Mutual Exclusion: day, hour, and week are mutually exclusive

encrypt

Description Encrypt the backup file

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fixed-nat

Description Backup fixed-nat port mapping files

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

hour

Description Specify interval hours

Type: number

Range: 1-65534

Mutual Exclusion: hour, day, and week are mutually exclusive

log

Description Backup log files

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

remote-file

Description profile name for remote url

Type: string

Format: url

store-name

Description profile name to store remote url

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

system

Description Backup system files

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

use-mgmt-port

Description Use management port as source port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

week

Description Specify interval weeks

Type: number

Range: 1-199

Mutual Exclusion: week, day, and hour are mutually exclusive