|
APIs in Category: config-backup |
Cluster-Mode API version 1.15 |
config-backup-copy |
This set of ZAPIs allow managing configuration backups. Configuration backups are automatically created based on three job schedules. These job schedules are '8hour', 'daily' and 'weekly'. These job schedules are pre-programmed to create 'scheduled backups'. Configuring different job schedules other than the programmed ones is not supported. Scheduled backups are uploaded to remote URL destination if it is configured. This set of ZAPIs support configuring the remote destination by specifying URL, username and password. Scheduled backups will be distributed to some nodes within the cluster and latest backups will be kept in the cluster. This set of ZAPIs allow configuring the number of latest backups to keep in the cluster per job schedule. Scheduled backups are of type 'cluster backup'. A cluster backup contains cluster-wide replicas in addition to 'node backup' of each node in the cluster. A 'node backup' contains only node-specific configuration such as configuration files on the root volume and the boot variables. Configuration backups can also be created 'on demand' by using this set of ZAPIs. These ZAPIs support creating node backups and cluster backups on demand. Backup management operations such as delete backup, copy backup to another node in cluster, rename backup, download backup from URL and upload backup to URL are supported by this set of ZAPIs. ZAPIs for delete, copy, rename, download and upload operations are applicable for any type of backups, i.e. scheduled backups and on demand backups, node backups and cluster backups. |
| config-backup-copy | [top] |
Copy a configuration backup. A job will be queued to copy the configuration backup. A job will be spawned to operate on the config-backup and the job id will be returned. The progress of the job can be tracked using the job APIs.
Input Name Range Type Description backup-name string
The name of the configuration backup. from-node string
The source node to copy the configuration backup from. This is the node that has the backup file on its root volume. to-node string
The destination node to copy the configuration backup to. Output Name Range Type Description result-error-code [0..2^32-1] integer
optional
Error code, if the operation caused an error. result-error-message string
optional
Error description, if the operation caused an error. result-jobid [0..2^64-1] integer
optional
Job Id, if this operation was performed via a job. result-status string
The operation status. Possible values: "succeeded", "in_progress", "failed".
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| config-backup-create | [top] |
Create a configuration backup. A job will be queued to create the configuration backup in the background. Creation of configuration backup may take several minutes. This ZAPI creates an on demand backup. A job will be spawned to operate on the config-backup and the job id will be returned. The progress of the job can be tracked using the job APIs.
Input Name Range Type Description backup-name string
optional
The name of the configuration backup. It must be a valid file name. An extension of .tgz will be added if the given backup-name doesn't have that extension. If backup-name is not provided, software will generate the name for configuration backup. backup-type backup-type
optional
Indicates if the backup is a node or a cluster backup. A node backup contains only node-specific configuration of a particular node in the cluster. A cluster backup contains cluster-wide replicas in addition to node backup of each node in the cluster. Possible values:
- "node" - Node Backup,
- "cluster" - Cluster Backup
node string
The node to own the configuration backup. This is the node that will have the backup file on its root volume. Output Name Range Type Description result-error-code [0..2^32-1] integer
optional
Error code, if the operation caused an error. result-error-message string
optional
Error description, if the operation caused an error. result-jobid [0..2^64-1] integer
optional
Job Id, if this operation was performed via a job. result-status string
The operation status. Possible values: "succeeded", "in_progress", "failed".
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| config-backup-delete | [top] |
Delete a configuration backup.
Input Name Range Type Description backup-name string
The name of the configuration backup. node string
The node that owns the configuration backup. This is the node that has the backup file on its root volume.
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| config-backup-download | [top] |
Download a configuration backup from a URL.
Input Name Range Type Description backup-name string
optional
The name of the configuration backup. It must be a valid file name. An extension of .tgz will be added if the given backup-name doesn't have that extension. If backup-name is not provided, software will generate a name for configuration backup. node string
The node to own the configuration backup. The backup file will be downloaded to the root volume of this node. source-url string
The source URL. URL is specified following the syntax described in RFC 3986. Only 'ftp', 'http' and 'https' protocols are supported.
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| config-backup-info-get | [top] |
Return information about a specified configuration backup.
Input Name Range Type Description backup-name string
The name of the configuration backup. desired-attributes config-backup-info-type
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. node string
The node that owns the configuration backup. This is the node that has the backup file on its root volume. Output Name Range Type Description attributes config-backup-info-type
The attributes of the config-backup-info.
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| config-backup-info-get-iter | [top] |
Return a list of configuration backups in the cluster.
Input Name Range Type Description desired-attributes config-backup-info-type
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. max-records [1..100] integer
optional
The maximum number of records to return in this call. Default: 20 query config-backup-info-type
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the config-backup-info object. All config-backup-info objects matching this query up to 'max-records' will be returned. tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Output Name Range Type Description attributes-list config-backup-info-type[]
optional
The list of attributes of config-backup-info objects. next-tag string
optional
Tag for the next call. Not present when there are no more config-backup-info objects to return. num-records [0..100] integer
The number of records returned in this call.
Errno Description EINTERNALERROR
| config-backup-rename | [top] |
Rename a configuration backup. Renamed backup stays on the same node.
Input Name Range Type Description backup-name string
The name of the configuration backup. new-backup-name string
The new name for the configuration backup. It must be a valid file name. An extension of .tgz will be added if the given new-name doesn't have that extension. node string
The node that owns the configuration backup. This is the node that has the backup file on its root volume.
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| config-backup-settings-get | [top] |
Return information about the configuration backup settings.
Input Name Range Type Description desired-attributes config-backup-settings-type
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. Output Name Range Type Description attributes config-backup-settings-type
The attributes of the config-backup-settings.
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| config-backup-settings-modify | [top] |
Modify the settings for configuration backup operations.
Input Name Range Type Description backup-count1 [1..4] integer
optional
The number of configuration backups to keep in the cluster for schedule 1. backup-count2 [1..4] integer
optional
The number of configuration backups to keep in the cluster for schedule 2. backup-count3 [1..4] integer
optional
The number of configuration backups to keep in the cluster for schedule 3. destination-url string
optional
The destination URL for uploading the configuration backups. URL is specified following the syntax described in RFC 3986. Only 'ftp', 'http' and 'https' protocols are supported. username-for-destination-url string
optional
The username for the destination URL.
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| config-backup-settings-password-set | [top] |
Modify the password for destination URL.
Input Name Range Type Description password-for-destination-url string
optional
Password for the destination URL.
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| config-backup-upload | [top] |
Upload a configuration backup to a URL.
Input Name Range Type Description backup-name string
The name of the configuration backup. destination-url string
The destination URL. URL is specified following the syntax described in RFC 3986. Only 'ftp', 'http' and 'https' protocols are supported. node string
The node that owns the configuration backup. This is the node that has the backup file on its root volume.
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| Element definition: backup-type | [top] |
The type of a configuration backup. Possible values:
- "node" - Node Backup,
- "cluster" - Cluster Backup
[none]
| Element definition: config-backup-info-type | [top] |
Configuration Backup Information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Name Range Type Description backup-creation-time [0..2^31-1] integer
optional
The time of the configuration backup creation. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable backup-name string
optional
The name of the configuration backup. Attributes: key, non-creatable, non-modifiable backup-size [0..2^63-1] integer
optional
The size of configuration backup file in number of bytes. Attributes: non-creatable, non-modifiable backup-type backup-type
optional
Indicates if the backup is a node or a cluster backup. A node backup contains only node-specific configuration of a particular node in the cluster. A cluster backup contains cluster-wide replicas in addition to node backup of each node in the cluster. If backup-type is not provided, cluster backup is assumed by default. Attributes: non-creatable, non-modifiable Possible values:
- "node" - Node Backup,
- "cluster" - Cluster Backup
cluster-name string
optional
The name of the cluster which the configuration backup was created for. This field is set only for cluster backups. For node backups, the nodes-in-backup field indicates the name of the node. Attributes: non-creatable, non-modifiable cluster-uuid string
optional
The UUID of the cluster which the configuration backup was created for. This field is set only for cluster backups. Attributes: non-creatable, non-modifiable is-auto boolean
optional
True indicates that configuration backup is a scheduled backup that was created automatically by a schedule. False indicates that configuration backup was created on demand. Attributes: non-creatable, non-modifiable node string
optional
The node that owns the configuration backup. This is the node that has the backup file on its root volume. Attributes: key, non-creatable, non-modifiable nodes-in-backup string[]
optional
The names of the nodes included in the configuration backup. Attributes: non-creatable, non-modifiable schedule string
optional
The name of the job schedule for scheduled backups. Possible values are: '8hour', 'daily', and 'weekly'. This field is not set for on demand backups created via management CLI or ZAPI. Attributes: non-creatable, non-modifiable version string
optional
The software version which the configuration backup was created with. Attributes: non-creatable, non-modifiable
| Element definition: config-backup-settings-type | [top] |
Configuration Backup Settings When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Name Range Type Description backup-count1 [1..4] integer
optional
The number of configuration backups to keep in the cluster for schedule 1. Attributes: non-creatable, modifiable backup-count2 [1..4] integer
optional
The number of configuration backups to keep in the cluster for schedule 2. Attributes: non-creatable, modifiable backup-count3 [1..4] integer
optional
The number of configuration backups to keep in the cluster for schedule 3. Attributes: non-creatable, modifiable destination-url string
optional
The destination URL for uploading the configuration backups. URL is specified following the syntax described in RFC 3986. Only 'ftp', 'http' and 'https' protocols are supported. Attributes: non-creatable, modifiable job-schedule1 string
optional
The name of the first job schedule for generating configuration backups. It is pre-programmed to be '8hour'. Attributes: non-creatable, non-modifiable job-schedule2 string
optional
The name of the second job schedule for generating configuration backups. It is pre-programmed to be 'daily'. Attributes: non-creatable, non-modifiable job-schedule3 string
optional
The name of the third job schedule for generating configuration backups. It is pre-programmed to be 'weekly'. Attributes: non-creatable, non-modifiable username-for-destination-url string
optional
The username for the destination URL. Attributes: non-creatable, modifiable
| Element definition: backup-type | [top] |
The type of a configuration backup. Possible values:
- "node" - Node Backup,
- "cluster" - Cluster Backup
[none]