protection

protection groups create

Usage

  usage: symp protection groups create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                       [--description DESCRIPTION]
                                       [--project-id PROJECT_ID]
                                       [--admin-only ADMIN_ONLY]
                                       [--remote REMOTE]
                                       name schedule

Description

Creates a new protection group

Returns

Returns dict: Protection group

Mandatory

positional arguments:
  name                  The name of the protection group
  schedule              The schedule is defined by the following parameters and their values:

                        - enabled (true/false): True if this schedule is enabled.

                        - recurrence (string):  The schedule recurrence rule.
                        iCalendar RRULE format
                        [FREQ=HOURLY/DAILY/WEEKLY/MONTHLY;INTERVAL=numeric]

                        - start_time (string):  The schedule start time.
                        iCalendar DTSTART format
                        [yyyymmddThhmmss]

                        - window (string):      The time allotted for backups initializations.
                        iCalendar DURATION format, [PTnHnMnS] where n is the number of Hours, Minutes and Seconds

                        After the allotted time for the backup, those entities in the protection
                        group for which the backup process has not yet started, will not be backed up.
                        The backup of entities for which the backup process has already started,
                        will be completed even after the allotted time.

                        - days_to_retain (integer): The number of days in which to keep the backups.

                        Example:

                        {"enabled":true,"recurrence":"FREQ=HOURLY;INTERVAL=4","start_time":"20180303T220000","window":"P1DT2H10M20S","days_to_retain":10}

Optional

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
  --remote REMOTE       The remote backup is defined by the following parameters and their values:

                        - endpoint_id (string): The UUID of the external-endpoint
                        - full_backup_rate (integer): The recurrence rate of a full backup vs. incremental backups
                        For example: 6 would mean every 6th backup is a full backup with the other five being incremental

                        Example:

                        {"endpoint_id":"d03f4e64-30d8-405e-b49f-ee4cfd109986","full_backup_rate":5}

protection groups delete

Usage

  usage: symp protection groups delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                       [--force FORCE]
                                       [--ignore-existing-snapshots IGNORE_EXISTING_SNAPSHOTS]
                                       group_id

Description

Delete the protection group

Mandatory

positional arguments:
  group_id              The ID of the protection group

Optional

optional arguments:
  -h, --help            show this help message and exit
  --force FORCE         True if the delete operation should delete group memberships as well.
  --ignore-existing-snapshots IGNORE_EXISTING_SNAPSHOTS
                        if set to True delete group even if there are snapshots

protection groups get

Usage

  usage: symp protection groups get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    [-m [NAME=VALUE [NAME=VALUE ...]]]
                                    group_id

Description

Retrieves a protection group

Returns

Returns dict: Protection group

Mandatory

positional arguments:
  group_id              The ID of the protection group

Optional

optional arguments:
  -h, --help            show this help message and exit

protection groups list

Usage

  usage: symp protection groups list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     [--admin-only ADMIN_ONLY]
                                     [--enabled ENABLED] [--sort-by SORT_BY]
                                     [--limit LIMIT] [--offset OFFSET]
                                     [--order ORDER]

Description

Retrieves all protection groups

Returns

Returns list: groups list

Optional

optional arguments:
  -h, --help            show this help message and exit
  --admin-only ADMIN_ONLY
                        Filter for displaying admin only groups. Values: true or false
  --enabled ENABLED     Filter for displaying enabled or disabled groups only. Values: true or false
  --sort-by SORT_BY     The parameter by which to sort the output list. Default: id
  --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

protection groups update

Usage

  usage: symp protection groups update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                       [--name NAME] [--description DESCRIPTION]
                                       [--admin-only ADMIN_ONLY]
                                       [--schedule SCHEDULE] [--remote REMOTE]
                                       group_id

Description

Update groups details

Returns

Returns dict: The updated details of a protection group.

Mandatory

positional arguments:
  group_id              The ID of the protection group

Optional

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
  --schedule SCHEDULE   The schedule is defined by the following parameters and their values:

                        - enabled (true/false): True if this schedule is enabled.

                        - recurrence (string):  The schedule recurrence rule.
                        iCalendar RRULE format
                        [FREQ=HOURLY/DAILY/WEEKLY/MONTHLY;INTERVAL=numeric]

                        - start_time (string):  The schedule start time.
                        iCalendar DTSTART format
                        [yyyymmddThhmmss]

                        - window (string):      The time allotted for backups initialization.
                        iCalendar DURATION format, [PTnHnMnS] where n is the number of Hours, Minutes and Seconds

                        After the allotted time for the backup, those entities in the protection
                        group for which the backup process has not yet started, will not be backed up.
                        The backup of entities for which the backup process has already started,
                        will be completed even after the allotted time.

                        - days_to_retain (integer): The number of days in which to keep the backups.

                        Example:

                        {"enabled":true,"recurrence":"FREQ=HOURLY;INTERVAL=4","start_time":"20180303T220000","window":"P1DT2H10M20S","days_to_retain":10}
  --remote REMOTE       The remote backup is defined by the following parameters and their values:

                        - endpoint_id (string): The UUID of the external-endpoint
                        - full_backup_rate (integer): The recurrence rate of a full backup vs. incremental backups
                        For example: 6 would mean every 6th backup is a full backup with the other five being incremental

                        Example:

                        {"endpoint_id":"d03f4e64-30d8-405e-b49f-ee4cfd109986","full_backup_rate":5}

protection memberships create

Usage

  usage: symp protection memberships create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                            [-c COLUMN] [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [-m [NAME=VALUE [NAME=VALUE ...]]]
                                            resource_id resource_type group_id

Description

Assigns a resource to a protection group.

Returns

Returns dict: A resource assigned to a protection group.

Mandatory

positional arguments:
  resource_id           The UUID of the resource
  resource_type         The type of resource which is being assigned a Protection group. Values: volume, instance or dbs-instance
  group_id              The UUID of the protection group

Optional

optional arguments:
  -h, --help            show this help message and exit

protection memberships delete

Usage

  usage: symp protection memberships delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                            [-c COLUMN] [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [-m [NAME=VALUE [NAME=VALUE ...]]]
                                            membership_id

Description

Deletes a protection membership

Mandatory

positional arguments:
  membership_id         The ID of the protection membership

Optional

optional arguments:
  -h, --help            show this help message and exit

protection memberships get

Usage

  usage: symp protection memberships get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         membership_id

Description

Retrieves a protection membership

Returns

Returns dict: Protection membership

Mandatory

positional arguments:
  membership_id         The ID of the protection membership

Optional

optional arguments:
  -h, --help            show this help message and exit

protection memberships list

Usage

  usage: symp protection memberships list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--sort-by SORT_BY] [--limit LIMIT]
                                          [--offset OFFSET]
                                          [--group-id GROUP_ID] [--order ORDER]

Description

Retrieves all protection memberships

Returns

Returns list: List of protection memberships

Optional

optional arguments:
  -h, --help            show this help message and exit
  --sort-by SORT_BY     The parameter by which to sort the output list. Default: id
  --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.
  --group-id GROUP_ID   The ID of the protection group to filter by
  --order ORDER         The order, ascending or descending, based on the 'sort-by' parameter in which the output will be displayed. Values: asc or desc