# protection ## protection backup groups add-resource **Usage** ```none usage: symp protection backup groups add-resource [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id resource_id resource_type ``` **Description** Add a resource to a backup group to protect. **Returns** Returns dict: A resource protected by backup group. **Mandatory** ```none positional arguments: group_id The ID of the backup group to filter by resource_id The ID of the resource resource_type The resource type that is being assigned to a backup group. ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## protection backup groups create **Usage** ```none usage: symp protection backup groups create [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--description DESCRIPTION] [--project-id PROJECT_ID] [--admin-only ADMIN_ONLY] [--endpoint-id ENDPOINT_ID] [--remote-retention REMOTE_RETENTION] [--enabled] [--local-remote-ratio LOCAL_REMOTE_RATIO] name recurrence start_time local_retention ``` **Description** Creates a new backup group **Returns** Returns dict: Backup group **Mandatory** ```none positional arguments: name The name of the protection group recurrence The schedule recurrence rule. iCalendar RRULE format [FREQ=HOURLY/DAILY/WEEKLY/MONTHLY;INTERVAL=numeric] start_time The schedule start time. local_retention Duration(in days) for retaining local snapshots ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --description DESCRIPTION The description of the protection group --project-id PROJECT_ID The project ID to which the protection group belongs --admin-only ADMIN_ONLY True if this group is restricted to admin users, False otherwise --endpoint-id ENDPOINT_ID The ID of the external endpoint (Object Store) to which the backups are stored. If provided, the snapshots will be created in the external endpoint. --remote-retention REMOTE_RETENTION Duration(in days) for retaining remote snapshots. Must be provided if endpoint ID is provided. --enabled Disabling the schedule will stop the backup process for this group But will continue to cleanup the snapshots of the existing backups according to the retention policy. --local-remote-ratio LOCAL_REMOTE_RATIO The ratio of local to remote snapshots. e.g 3 means 3 local snapshots for every remote snapshot. Can be provided only if an endpoint ID is provided. ``` ## protection backup groups delete **Usage** ```none usage: symp protection backup groups delete [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--force] [--ignore-existing-snapshots] group_id ``` **Description** Delete the backup group **Mandatory** ```none positional arguments: group_id The ID of the backup group ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --force True if the delete operation should delete group memberships as well. --ignore-existing-snapshots if set to True delete group even if there are snapshots ``` ## protection backup groups get **Usage** ```none usage: symp protection backup groups get [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id ``` **Description** Retrieves a backup group **Returns** Returns dict: Backup group **Mandatory** ```none positional arguments: group_id The ID of the backup group ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## protection backup groups get-resource **Usage** ```none usage: symp protection backup groups get-resource [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id resource_id ``` **Description** Retrieves a backup resource **Returns** Returns dict: Resource details **Mandatory** ```none positional arguments: group_id The ID of the backup group resource_id The ID of the resource ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## protection backup groups list **Usage** ```none usage: symp protection backup groups list [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [-m [NAME=VALUE [NAME=VALUE ...]]] [--sort-column SORT_COLUMN] [--limit LIMIT] [--offset OFFSET] [--order ORDER] [--sort-by SORT_BY] [--enabled ENABLED] [--admin-only ADMIN_ONLY] [--detailed] ``` **Description** Retrieves all protection groups **Returns** Returns list: groups list **Optional** ```none optional arguments: -h, --help show this help message and exit --limit LIMIT The maximum number of elements returned in the output list. --offset OFFSET The number of elements not to display from the beginning of the output list. --order ORDER The order, ascending or descending, based on the 'sort-by' parameter in which the output will be displayed. Values: asc or desc --sort-by SORT_BY The parameter by which to sort the output list. Default: id --enabled ENABLED Filter for displaying enabled or disabled groups only. Values: true or false --admin-only ADMIN_ONLY Filter for displaying admin only groups. Values: true or false --detailed Add group resources to corresponding backup groups ``` ## protection backup groups list-resources **Usage** ```none usage: symp protection backup groups list-resources [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [-m [NAME=VALUE [NAME=VALUE ...]]] [--sort-column SORT_COLUMN] [--limit LIMIT] [--offset OFFSET] [--order ORDER] [--sort-by SORT_BY] group_id ``` **Description** Retrieves all backup resources for a specific group **Returns** Returns list: List of backup resources **Mandatory** ```none positional arguments: group_id The ID of the backup group to filter by ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --limit LIMIT The maximum number of elements returned in the output list. --offset OFFSET The number of elements not to display from the beginning of the output list. --order ORDER The order, ascending or descending, based on the 'sort-by' parameter in which the output will be displayed. Values: asc or desc --sort-by SORT_BY The parameter by which to sort the output list. Default: id ``` ## protection backup groups remove-resource **Usage** ```none usage: symp protection backup groups remove-resource [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id resource_id ``` **Description** Delete a resource from a backup group **Mandatory** ```none positional arguments: group_id The ID of the backup group resource_id The ID of the resource ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## protection backup groups trigger-snapshot **Usage** ```none usage: symp protection backup groups trigger-snapshot [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [-m [NAME=VALUE [NAME=VALUE ...]]] [--sort-column SORT_COLUMN] [--with-remote] group_id ``` **Description** Triggers a snapshot for the requested backup group **Returns** Returns list: Snapshot triggered successfully for the backup group **Mandatory** ```none positional arguments: group_id The ID of the backup group ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --with-remote Whether to create a remote snapshot as well. Valid only for remote backup groups. ``` ## protection backup groups update **Usage** ```none usage: symp protection backup groups update [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--name NAME] [--description DESCRIPTION] [--admin-only ADMIN_ONLY] [--recurrence RECURRENCE] [--start-time START_TIME] [--local-retention LOCAL_RETENTION] [--endpoint-id ENDPOINT_ID] [--remote-retention REMOTE_RETENTION] [--enabled ENABLED] [--local-remote-ratio LOCAL_REMOTE_RATIO] group_id ``` **Description** Update backup groups details **Returns** Returns dict: The updated details of a backup group. **Mandatory** ```none positional arguments: group_id The ID of the backup group ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --name NAME The new name of the protection group --description DESCRIPTION The new description of the protection group --admin-only ADMIN_ONLY True if this group is restricted to admin users, False otherwise --recurrence RECURRENCE The schedule recurrence rule. iCalendar RRULE format [FREQ=HOURLY/DAILY/WEEKLY/MONTHLY;INTERVAL=numeric] --start-time START_TIME The schedule start time. --local-retention LOCAL_RETENTION Duration(in days) for retaining local snapshots --endpoint-id ENDPOINT_ID The ID of the external endpoint (Object Store) to which the backups are stored. Can be updated only if the group has no endpoint ID. If provided, the snapshots will be created in the external endpoint. --remote-retention REMOTE_RETENTION Duration(in days) for retaining remote snapshots Must be provided if endpoint ID is provided. --enabled ENABLED Disabling the schedule will stop the backup process for this group But will continue to cleanup the snapshots of the existing backups according to the retention policy. --local-remote-ratio LOCAL_REMOTE_RATIO The ratio of local to remote snapshots. e.g 3 means 3 local snapshots for every remote snapshot. Can be updated only if the group has endpoint ID or endpoint ID is passed. ``` ## protection restore groups create **Usage** ```none usage: symp protection restore groups create [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--description DESCRIPTION] [--project-id PROJECT_ID] name endpoint_id ``` **Description** Creates a new restore protection group **Returns** Returns dict: Restore protection group **Mandatory** ```none positional arguments: name The name of the protection group endpoint_id The UUID of the endpoint ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --description DESCRIPTION The description of the protection group --project-id PROJECT_ID The project ID to which the protection group belongs ``` ## protection restore groups delete **Usage** ```none usage: symp protection restore groups delete [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--force FORCE] group_id ``` **Description** Delete the restore protection group **Mandatory** ```none positional arguments: group_id The ID of the restore protection group ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --force FORCE True if the delete operation should delete group VSC endpoint as well. ``` ## protection restore groups get **Usage** ```none usage: symp protection restore groups get [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id ``` **Description** Retrieves a restore protection group **Returns** Returns dict: Restore protection group **Mandatory** ```none positional arguments: group_id The ID of the restore protection group ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## protection restore groups list **Usage** ```none usage: symp protection restore groups list [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [-m [NAME=VALUE [NAME=VALUE ...]]] [--sort-column SORT_COLUMN] [--limit LIMIT] [--offset OFFSET] [--order ORDER] [--sort-by SORT_BY] ``` **Description** Retrieves all restore protection groups **Returns** Returns list: Restore groups list **Optional** ```none optional arguments: -h, --help show this help message and exit --limit LIMIT The maximum number of elements returned in the output list. --offset OFFSET The number of elements not to display from the beginning of the output list. --order ORDER The order, ascending or descending, based on the 'sort-by' parameter in which the output will be displayed. Values: asc or desc --sort-by SORT_BY The parameter by which to sort the output list. Default: id ``` ## protection restore groups update **Usage** ```none usage: symp protection restore groups update [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--name NAME] [--description DESCRIPTION] group_id ``` **Description** Update restore groups details **Returns** Returns dict: The updated details of a restore protection group. **Mandatory** ```none positional arguments: group_id The ID of the restore protection group ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --name NAME The new name of the protection group --description DESCRIPTION The new description of the protection group ``` ## protection snapshots get **Usage** ```none usage: symp protection snapshots get [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] snapshot_id ``` **Description** Retrieves a protection group snapshot **Returns** Returns dict: Protection group snapshot **Mandatory** ```none positional arguments: snapshot_id The ID of the protection group snapshot ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## protection snapshots list **Usage** ```none usage: symp protection snapshots list [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [-m [NAME=VALUE [NAME=VALUE ...]]] [--sort-column SORT_COLUMN] [--limit LIMIT] [--offset OFFSET] [--order ORDER] [--sort-by SORT_BY] [--remote] [--local] [--group-id GROUP_ID] ``` **Description** Retrieves all protection group snapshots **Returns** Returns list: List of protection group snapshots **Optional** ```none optional arguments: -h, --help show this help message and exit --limit LIMIT The maximum number of elements returned in the output list. --offset OFFSET The number of elements not to display from the beginning of the output list. --order ORDER The order, ascending or descending, based on the 'sort-by' parameter in which the output will be displayed. Values: asc or desc --sort-by SORT_BY The parameter by which to sort the output list. Default: id --remote Filter for displaying remote snapshots only --local Filter for displaying local snapshots only --group-id GROUP_ID The ID of the group to filter by ``` ## protection snapshots remove **Usage** ```none usage: symp protection snapshots remove [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] snapshot_id ``` **Description** Delete the protection group snapshot **Mandatory** ```none positional arguments: snapshot_id The ID of the protection group snapshot ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ```