This is the multi-page printable view of this section. Click here to print.
Backup
- 1: Overview
- 2: How-to guides
- 2.1: Instant Backup
- 2.2: Recovery
- 2.3: Use Backup Agent
- 2.4: Install Backup Agent
- 2.5: Use Replication
- 3: API Reference
- 4: CLI Reference
- 5: Release Note
1 - Overview
Service Overview
Backup is a service that backs up and recovers in case of an emergency the user’s data in a safe manner.
Since a backup policy includes the backup target, frequency, retention period, etc., users set a backup plan according to their business environment and requirements.
Features
- Backup Scope: Providing optimal backup and recovery services tailored to various business purposes, ensuring customers’ important data is safely preserved.
- Flexible Policy Configuration: You can set backup policies based on the usage environment and data importance. Users select backup targets and types, and specify retention periods and schedules.
- Backup Network: We minimized potential service impact during backup by using a backup network connection. The backup system and network block unauthorized access through permission management.
- Remote backup: Agentless backup can store backup copies at a different location. If a failure or disaster occurs at the backup site, you can recover using the backup copies stored at the other location.
- Replication: Agent backup can replicate the same backup to another location for storage. The schedule and retention period are set the same as the original, and in case of a failure or disaster at the backup location, recovery can be performed using the backup copy stored at the other location.
Configuration diagram
Provided features
Backup provides the following features.
- Backup target: The user can select the target server for which they want to obtain a backup.
- Backup Save: You can select the storage location for the backup.
- Encryption: AES-256 algorithm encryption is applied.
- Retention Period: You can set the retention period for backups. Backups whose retention period has elapsed are automatically deleted.
- Schedule: This is the automatic backup generation interval.
- Recovery: You can select a backup created at the desired point in time to restore resources.
Component
Backup provides a scheduling feature that automatically creates backup copies at predefined intervals and times. Users set retention periods and other parameters to ensure they can obtain backups from the desired point in time, and depending on the backup target and type, agent configuration may be required.
Backup type
Provides Agentless Backup and Agent Backup, and you can select based on the backup target.
- Agentless Backup: You can back up by creating a Backup service without configuring a separate agent. VM image backups of Virtual Server and GPU Server are considered Agentless Backup.
- Agent Backup: Before creating a Backup service, you need to create a Backup Agent and configure the Agent on the server you want to back up. This applies to filesystem backups.
Backup Category
- Full Backup: Backs up all data.
- Incremental Backup: Backs up data that has changed since the previous backup.
Schedule
Backups are automatically created according to the generation interval set by the user. You can schedule up to 1 Full Backup and up to 6 Incremental Backups.
When using the Immediate Backup feature, you can create a backup at a specific point in time desired by the user, in addition to the scheduled backups.
The backup intervals that can be configured in the schedule are as follows.
Daily: Start Time Select
Every week: day, start time select
Monthly: Week, Day of week, Start time selection
- Start Time: hour (1~23), minute (00, 30) select
- Day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday Select
- Week: 1, 2, 3, 4, select the final week
Retention period
You can set the retention period for backups created through the Backup service.
The retention period can be selected and applied from 2 weeks (14 days), 1 month (31 days), 3 months (93 days), 6 months (186 days), or 1 year (365 days).
Preceding Service
This is a list of services that must be pre‑configured before creating the service. Please refer to the guide provided for each service for details and prepare in advance.
| Service Category | Service | Detailed description |
|---|---|---|
| Compute | Virtual Server | Virtual server optimized for cloud computing |
| Compute | Bare Metal Server | High-performance physical server used without virtualization |
2 - How-to guides
Users can create a service by entering the required backup information and selecting detailed options through the Samsung Cloud Platform Console.
Create Backup
You can create and use a Backup service in the Samsung Cloud Platform Console.
- If you back up the OS of a Virtual Server or GPU Server using Agent Backup, you can utilize the necessary data after restoring additional storage.
- You can obtain an OS backup by using the image creation feature of Virtual Server and GPU Server.
To create a backup, follow the steps below.
Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
On the Service Home page, click the Create Backup button. You will be taken to the Create Backup page.
On the Backup Creation page, enter the information required to create the service and select detailed options.
Category RequiredDetailed description Backup name Required Backup name - Enter 3 to 30 characters using letters and numbers
- Cannot be edited after service creation
Backup type Required Select Backup Type - (Agentless) VM Image: Perform backup by creating a Backup service without configuring an Agent
- (Agent) Filesystem: Create a Backup Agent service, configure the Agent on the target server, then perform backup by creating a Backup service
- Cannot modify after service creation
Backup Save Required Select storage location for Agentless Backup - One Backup service can be created per storage location
- Servers in the Korea South (kr-south) region can only select the same location
- Cannot modify after service creation
Backup replication Select Select replication option and location for Agent Backup - Replication can only be set when creating the Backup service
- A Backup identical to the original (Backup name, schedule, retention period) is created at the replication location
- The South Korea (kr-south) region is unavailable
- Cannot be modified after service creation
Backup target Required Backup target server - Agentless: Select one pre‑created server from the Virtual Server or GPU Server service
- For GPU Server, the target server location and the backup storage location must be the same
- Agent: Select one pre‑created server from the Virtual Server, GPU Server, or Bare Metal Server service
- Cannot be modified after service creation
Filesystem Required Backup target Filesystem - Enter all or specific Filesystem
- Backup not possible in the following situations
- When the Filesystem used by the operating system is not entered correctly
- When the Filesystem is already registered in another Backup policy
- When it is a File Storage volume
/dev/zero,/dev/null
- When it contains the following special characters per operating system
- Linux:
*<>\
- Linux:
Encryption Required/Optional Encryption status - Agentless: Apply default encryption
- Agent: Choose encryption
- Cannot modify after service creation
Retention period Select Retention period of the recovery target (backup) - Select from 2 weeks (14 days), 1 month (31 days), 3 months (93 days), 6 months (186 days), or 1 year (365 days)
Schedule Select Backup auto-creation schedule - Set 1 Full Backup and up to 6 Incremental Backups
- Select Daily, Weekly, or Monthly
- Daily: Set the start time
- Weekly: Set the day of week and start time
- Monthly: Set the week number, day of week, and start time
- Week number: Choose from 1, 2, 3, 4, or the last week
- Day of week: Choose from Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
- Start time: Select in 30‑minute increments (00–23 hours, 00/30 minutes)
Table. Backup service information input fieldsIn the Summary panel, review the detailed information and estimated billing amount, then click the Create button.
- After creation is complete, check the created resources on the Backup List page.
- When creating or terminating a Virtual or GPU Server, it may take about 180 minutes for the backup target list to be updated.
- Virtual Server’s (Agentless) VM Image backup can be performed to a remote location by selecting a storage location (excluding GPU Server).
- To create a remote backup, create a Backup service at the location where the target server for the backup was created. Select the remote location in the Backup Save item.
- Backup target can have one Backup service per region. Creating Backup services in two or more regions ensures reliability against failures and disasters.
- To optimize backup and recovery speed, set the backup storage location to be the same as the target server’s location.
- File Storage volumes cannot be backed up. Therefore, added File Storage is excluded from backup.
- Agentless Backup is encrypted by default and cannot be modified.
- Agent Backup applies server‑side encryption based on the AES‑256 algorithm when encryption is selected, which may cause a performance degradation of approximately 20 ~ 30%.
- The initial backup is created as a Full Backup regardless of the request details.
- If you select a different region for Backup storage or Backup replication, data transfer fees will be added.
View backup details
The Backup service allows you to view and edit the full resource list and detailed information. Backup Details page consists of Details, Schedule, Backup History, Recovery Targets, Recovery History, Replication, Tags, Operation History tabs.
To view detailed information about the Backup service, follow these steps.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- On the Service Home page, click the Backup menu. You will be taken to the Backup List page.
- On the Backup List page, click the resource for which you want to view detailed information. You will be taken to the Backup Details page.
- Backup Details page displays status information and additional feature information, and consists of the Details, Schedule, Backup History, Recovery Target, Recovery History, Replication, Tags, Job History tabs.
Category Detailed description Backup status Backup status information - Creating: In progress
- Available: Creation completed
- Deleting: Service termination in progress
- Editing: Changing settings
- Error: Abnormal state
- Error Deleting: Abnormal state while deleting
- Restoring: In progress
Immediate Backup Create a backup of the current state immediately - For details about immediate backup, see Instant Backup
Service termination Cancel service button Table. Status information and additional features
- Backup Details page displays status information and additional feature information, and consists of the Details, Schedule, Backup History, Recovery Target, Recovery History, Replication, Tags, Job History tabs.
Detailed information
On the Backup List page, you can view detailed information of the selected resource and, if necessary, edit the information.
| Category | Detailed description |
|---|---|
| Service | Service group |
| Resource Type | Resource Type |
| SRN | Unique resource ID in Samsung Cloud Platform |
| Resource Name | Resource name
|
| Resource ID | Service’s unique resource ID |
| constructor | User who created the service |
| Creation Date/Time | Service creation timestamp |
| Editor | User who modified the service |
| Modification date | Date and time the service was modified |
| Backup name | Backup name
|
| Category | Distinguish original status regarding duplication |
| Backup type | Backup types related to Agent configuration |
| Encryption | Encryption status |
| Backup target | Backup target server |
| Filesystem | Backup target FileSystem
|
| Retention period | Retention period of the recovery target (backup)
|
Schedule
On the Backup list page, you can view the automatic backup schedule of the selected resources.
| Category | Detailed description |
|---|---|
| Edit schedule | Schedule edit button
|
| Schedule name | Schedule Name
|
| Backup Type | Full, Incremental Backup distinction |
| Backup frequency | User-configured automatic backup generation interval |
- The schedule is based on Asia/Seoul (GMT +09:00).
- The schedule can be set to one Full Backup and up to six Incremental Backups.
- If the status is Available, the schedule can be modified.
- The replica’s schedule is identical to the original and can be viewed in the original.
- If the original is deleted, the replica’s schedule will be removed.
Backup History
On the Backup List page, you can view the immediate Backup and scheduled backup execution history for the selected resources.
| Category | Detailed description |
|---|---|
| Schedule name | Schedule Name
|
| Backup Timestamp | Backup start time |
| Completion date/time | Backup completion time |
| status | Backup status information (success/failure/in progress) |
| Cancel backup | Cancel button during backup
|
- The backup and completion times are based on Asia/Seoul (GMT +09:00).
- Queries can be performed based on the backup timestamp within a maximum of 30 days.
- You can receive a notification when a backup fails and view it in Management > Logging&Audit.
- In clones, the Cancel Backup button is not displayed.
- The backup history for both the primary and replica is provided by the primary.
- Click the Excel Download button at the top of the list to download the retrieved backup history list as an Excel file.
Recovery target
On the Backup list page, you can view the recovery target (backup) of the selected resource.
| Category | Detailed description |
|---|---|
| Schedule | Schedule Name
|
| Backup Timestamp | Backup start time |
| Retention period | Retention period of the recovery target
|
| capacity | Recovery target size |
| Additional features > More | Management buttons for recovery target
|
- Backup time is based on Asia/Seoul (GMT +09:00).
- Queries can be performed based on the backup timestamp within a maximum of 30 days.
- Click the Excel Download button at the top of the list to download the retrieved recovery target list as an Excel file.
Recovery History
On the Backup List page, you can view the recovery execution history of the selected resources.
| Category | Detailed description |
|---|---|
| Schedule | Schedule Name
|
| Recovery server name | Name of the server created through recovery |
| Backup Timestamp | Backup start time of the recovery target used for recovery |
| Recovery date and time | Recovery start time |
| Recovery completion time | Recovery completion time |
| status | Recovery status information (success/failure/in progress) |
- Backup and recovery times are based on Asia/Seoul (GMT +09:00).
- You can query based on the recovery timestamp within a maximum of 30 days.
- You can click the Excel Download button at the top of the list to download the retrieved recovery history list as an Excel file.
Clone
You can view the replication information of the selected resources on the Backup list page.
- Replication tab information is provided only when you set Agent Backup and Backup replication to enabled when applying for the Backup service.
- In the case of Agentless Backup, the replication feature (Replication tab) is not provided, and when applying for the service, you can select a backup storage location to store the backup copy in a different location.
| Category | Detailed description |
|---|---|
| Replication Policy | User-configured replication policy
|
| Replication information | Volume information for original and replica
|
Tag
On the Backup List page, you can view the tag information of the selected resources, and you can add, modify, or delete them.
| Category | Detailed description |
|---|---|
| Tag list | Tag list
|
Work History
On the Backup List page, you can view the operation history of the selected resource.
| Category | Detailed description |
|---|---|
| Task History List | Resource Change History
|
Managing Backup Resources
If you need to modify the schedule or retention period of a created backup, cancel the backup, or delete a recovery target, you can perform these actions on the Backup Details, Schedule, and Recovery Target pages.
Edit Retention Period
You can modify the retention period of a backup. To modify the retention period, follow these steps.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- On the Service Home page, click the Backup menu. You will be taken to the Backup list page.
- On the Backup List page, click the resource whose retention period you want to modify. You will be taken to the Backup Details page.
- Click the Edit button of Retention Period. The Edit Retention Period popup opens.
- Select the retention period and click the Confirm button.
- Please select from 2 weeks (14 days), 1 month (31 days), 3 months (93 days), 6 months (186 days), or 1 year (365 days).
- On the Backup Details page, check the modified retention period.
- Click the Recovery Target page. Check the modified retention period of the recovery targets.
- Agentless Backup: When the retention period is modified, the retention period of all already created backup copies will be changed uniformly.
- Agent Backup: After modifying the retention period, the changed retention period is applied to the generated backup.
Modify Filesystem
You can modify a registered Filesystem. To modify the Filesystem, follow these steps.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- On the Service Home page, click the Backup menu. You will be taken to the Backup List page.
- Click the resource whose retention period you want to modify on the Backup List page. You will be taken to the Backup Details page.
- Click the Filesystem Edit button. The Filesystem Edit popup window opens.
- Modify the Filesystem and click the Confirm button.
- After entering the Filesystem to add, click the Add Target button. The Filesystem will be added to the list.
- Click the X button of the Filesystem you want to delete from the Filesystem list. The Filesystem will be removed from the list.
- A filesystem with the same name or a filesystem registered in another backup cannot be added.
- /dev/zero, /dev/null cannot be added to the filesystem.
- If the following special characters are included, recovery is impossible on each operating system.
- Linux:
:*<>|not allowed - Windows:
/?*<>|not allowed
- Linux:
Edit Schedule
You can modify the backup schedule.
To modify the schedule, follow these steps.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- On the Service Home page, click the Backup menu. You will be taken to the Backup List page.
- On the Backup List page, click the resource whose schedule you want to edit. You will be taken to the Backup Details page.
- Click the Schedule page. Go to the Backup Schedule page.
- Click the Edit Schedule button. The Edit Schedule popup opens.
- Select a schedule and click the Confirm button.
- Daily, Weekly, Monthly please select one.
- Daily: Set the Start time.
- Every week: Set the day of the week and start time.
- Monthly: Week, Day of the week, Start time. Please set them.
- Week: 1, 2, 3, 4, or the final week.
- Day: You can select from Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
- Start Time: can be selected in 30‑minute intervals (00–23 hours, 00/30 minutes).
- The schedule is based on Asia/Seoul (GMT +09:00).
- The schedule can be set to 1 Full Backup and up to 6 Incremental Backups, and at least one Full Backup schedule must be registered.
- If the status is Available, the schedule can be modified.
- After modifying the schedule, the initial backup is created as a Full Backup regardless of the request details.
- When the original is modified, the same changes are applied to the copy.
Cancel backup
You can cancel an ongoing backup. To cancel the backup, follow these steps.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- On the Service Home page, click the Backup menu. You will be taken to the Backup List page.
- On the Backup List page, click the resource to cancel the backup. You will be taken to the Backup Details page.
- Click the Backup History page. You will be taken to the Backup History page.
- Check the backup you want to cancel. If the backup’s status is in progress, you can cancel the backup.
- Click the Backup Cancel button. The Backup Cancel popup window opens.
- Backup name, Backup date and time and other information, then click the Confirm button. The backup will be canceled.
Delete recovery target
You can delete the generated recovery target (backup). To delete a recovery target, follow the steps below.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- On the Service Home page, click the Backup menu. You will be taken to the Backup List page.
- On the Backup List page, click the resource to delete the recovery target. Navigate to the Backup Details page.
- Click the Recovery target page. Go to the Backup recovery target page.
- After selecting all items you want to delete, click the Delete button. The Delete popup window opens.
- After confirming Backup schedule name and Backup date/time, authenticate via the logged-in user’s mobile phone.
- When deleting two or more items, only the count of items to be deleted can be viewed in the popup window.
- When authentication is complete, click the Confirm button. The recovery target will be deleted.
- When deletion is complete, check on the Backup recovery target page whether the target has been deleted.
- You can delete two or more recovery targets using multiple selection.
- Even if you delete the original’s recovery target, the replica will not be deleted.
Cancel backup
You can cancel unused backups to reduce operating costs. However, if you cancel the service, the running service may be stopped immediately, so you should thoroughly consider the impact of service interruption before proceeding with the cancellation.
- All saved backup data and history will be deleted. Please note that data cannot be recovered after termination.
- If the status is Available, Error, or Error Deleting, cancellation is possible.
- If you cancel the original Backup service, the replica’s schedule will be deleted, but the stored backup data will not be deleted.
- Agent Backup that uses replication cannot be terminated. Change the replication policy to unused in the source, then terminate.
To cancel the backup, follow these steps.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- On the Service Home page, click the Backup menu. You will be taken to the Backup List page.
- On the Backup List page, select the resource to cancel and click the Cancel Service button.
- Authenticate using the logged-in user’s mobile phone. Once authentication is complete, the service will be terminated.
- When termination is complete, check on the Backup list page whether the resource has been terminated.
2.1 - Instant Backup
You can perform an immediate backup at the current time on a generated backup regardless of any schedule settings. You can perform the operation on the Backup Details page.
Instant Backup
You can create a backup of the current point in time immediately. To perform an immediate backup, follow these steps.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- On the Service Home page, click the Backup menu. You will be taken to the Backup List page.
- Backup List page, click the resource to perform the backup. You will be taken to the Backup Details page.
- Click the Instant Backup button. The Instant Backup popup opens.
- Click the Confirm button. It will perform a backup immediately.
- Click the Backup History page. Navigate to the Backup History page.
- Check the ongoing backup.
- If the status is Available, backup can be performed immediately.
- Immediate backup is performed as a full backup.
2.2 - Recovery
You can perform a restore using the generated backup’s restore target (backup copy). You can perform the operation on the Backup Restore Target page.
Recover VM Image
You can restore using the backup copy designated for recovery.
To recover, follow the steps below.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- On the Service Home page, click the Backup menu. You will be taken to the Backup List page.
- On the Backup List page, click the resource to restore. You will be taken to the Backup Details page.
- Click the Recovery Target page. Go to the Backup Recovery Target page.
- After checking the Schedule and Backup date and time, click the More button of the target you want to restore.
- Click the Restore button. The Backup Restore popup window opens.
- After confirming Backup target and Backup time, enter the recovery location, recovery server name, etc.
- Recovery Location: For remote backups, select the recovery location (target server or backup location).
- Recovery Server Name: Enter using English letters, numbers, spaces, and special characters (
-_) within 63 characters. - Server Type: Set the server type.
- Network Settings: If you are restoring to a location different from the backup target server, configure the network on the recovery server.
- Security Group: Configure the Security Group for the recovery server.
- After reviewing the entered information, click Confirm.
- Click the Recovery History page. Go to the Backup Recovery History page.
- Check the ongoing recovery tasks.
- Recovery is possible when the status is Available.
- The original Security Group, NAT IP, and Delete on termination settings are not restored, so configure them after recovery.
- The original server’s Server Group is not applied to the recovery server.
- The restored server cannot use the Rebuild feature.
- During recovery, a new server is created, and the Block Storage type and Keypair are set the same as the original.
Filesystem Recovery
You can restore using the backup copy designated for recovery. To restore, follow the steps below.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- On the Service Home page, click the Backup menu. You will be taken to the Backup List page.
- On the Backup List page, click the resource to restore. You will be taken to the Backup Details page.
- Click the Recovery Target page. Go to the Backup Recovery Target page.
- After checking the Schedule and Backup date and time, click the More button of the target you want to restore.
- Click the Restore button. The Backup Restore popup window opens.
- Please check Backup target, Backup time, etc.
- Click the Server Selection button for the recovery target item. The Server Selection popup window will open.
- After selecting a server, click Confirm.
- Only servers with a configured Backup Agent can be selected among the servers created in the backup storage location.
- Only servers that use the same Backup Master and OS as the backup target server can be selected.
- From the list below the Filesystem item, select the Filesystem to recover, then enter the Recovery location.
- If you enter the same ‘Backup target server name’ in the top-level restore location, the entire Filesystem will be restored (e.g., source location: servername, restore location: servername)
- Enter the exact name of the filesystem in use on the OS.
- /dev/zero, /dev/null cannot be recovered when entered.
- Recovery is impossible on any operating system if the following special characters are included.
- Linux:
:*<>| - Windows:
/?*<>|
- Linux:
- Overwrite when selected, files with the same type and name are overwritten. If not selected, those files are excluded from recovery.
- After reviewing the entered information, click Confirm.
- Recovery History click the page. Backup Recovery History navigate to the page.
- Check the ongoing recovery tasks.
2.3 - Use Backup Agent
Users can create and manage the Agent required to use Filesystem backup in the Backup service.
Create Backup Agent
You can create and use the Backup Agent service in the Samsung Cloud Platform Console.
To create a Backup Agent, follow the steps below.
Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
From the Service Home page, click the Backup Agent menu. You will be taken to the Backup Agent list page.
On the Backup Agent List page, click the Create Service button. You will be taken to the Create Backup Agent page.
On the Backup Agent Creation page, enter the information required to create the service.
Category RequiredDetailed description target server Required Select the target server to create a Backup Agent - Click the Select button to choose the server for creating the Backup Agent
- Virtual Server: 1 unit, GPU Server: 1 unit, Bare Metal Server: up to 100 units
Subnet Required Backup network (backup IP and port) Subnet - Select one of the General Subnets created in the VPC connected to the target server
- Select when the target server is a Virtual Server or GPU Server
Table. Backup Agent Service Information Input ItemsSummary Check the detailed information generated in the panel, and click the Done button.
- Once creation is complete, check the created resources on the Backup Agent List page.
- After creating the Backup Agent, connect to the target server and install the Agent.
- If the connection status on the Agent installation and Backup Agent details screen is confirmed as successful, you can create a Backup service to back up the filesystem.
- For performance optimization, use the Subnet and Port selected in the Backup Agent exclusively for backup.
- After creating the Backup Agent service, connect to the target server and install the Backup Agent.
- For detailed information about the Backup Agent installation, please refer to Backup Agent Installation.
- After installation is complete, check the connection status on the Backup Agent Details page.
Check detailed information of Backup Agent
Backup Agent service allows you to view and edit the full resource list and detailed information. Backup Agent Details page consists of Detailed Information, Tags, Job History tabs.
To view detailed information about the Backup Agent service, follow these steps.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- From the Service Home page, click the Backup Agent menu. You will be taken to the Backup Agent list page.
- On the Backup Agent List page, click the resource to view detailed information. You will be taken to the Backup Agent Details page.
- Backup Agent Details page displays status information and additional feature information, and consists of the Detailed Information, Tags, Job History tabs.
Category Detailed description Backup Agent status Backup Agent status information - Creating: In progress
- Available: Creation completed
- Deleting: Service termination in progress
- Error: Abnormal state
Service termination Cancel service button Table. Status information and additional functions
- Backup Agent Details page displays status information and additional feature information, and consists of the Detailed Information, Tags, Job History tabs.
Detailed Information
On the Backup Agent List page, you can view detailed information of the selected resource and edit the information if needed.
| Category | Detailed description |
|---|---|
| Service | Service name |
| Resource Type | Resource Type |
| SRN | Unique resource ID in Samsung Cloud Platform |
| Resource name | Resource Name
|
| Resource ID | Service’s unique resource ID |
| constructor | User who created the service |
| Creation date and time | Service creation date and time |
| Editor | User who modified the service |
| Modification date | Date and time the service was modified |
| Backup Agent name | Backup Agent name |
| Installation file URL | Agent installation file download location |
| Number of backup policies | Number of Backup services connected to the backup target server |
| Backup Master | Management server (Backup Master) name and connection IP |
| Backup Media | Management server (Backup Media) name and connection IP |
| target server | Backup Agent Target Server Information
|
- After creating the Bacup Agent service, connect to the backup target server and install the Backup Agent.
- For detailed information about the Backup Agent installation, please refer to Backup Agent Installation.
- After installation is complete, check the connection status on the Backup Agent Details page.
tag
On the Backup Agent List page, you can view the tag information of the selected resource and add, modify, or delete it.
| Category | Detailed description |
|---|---|
| Tag list | Tag list
|
Job History
On the Backup Agent list page, you can view the operation history of the selected resource.
| Category | Detailed description |
|---|---|
| Task History List | Resource Change History
|
Terminate Backup Agent
You can cancel a Backup Agent you are not using.
- Available, can only be terminated when in an Error state.
- If a Backup service is connected to the Backup Agent, it cannot be terminated.
- Backup policy count is the number of Backup services connected to the Backup Agent. After terminating all connected Backups, terminate the Backup Agent.
To cancel the Backup Agent, follow the steps below.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- From the Service Home page, click the Backup Agent menu. You will be taken to the Backup Agent list page.
- On the Backup Agent List page, select the resource to cancel and click the Cancel Service button.
- After termination is complete, check on the Backup Agent List page whether the resource has been terminated.
2.4 - Install Backup Agent
To install the Backup Agent, you must first request the Backup Agent service. Refer to Create Backup Agent.
- Backup Agent Apply
- Install Backup Agent
- Register backup in the Backup service
To use an Agent-based backup, you must connect to the target server and install the Backup Agent. After installing the Backup Agent, register the backup through the Backup service.
Pre‑setup work
To install the Backup Agent, verify the installation space, download the Backup Agent files, check the Backup Master/Agent information, and perform other preparatory tasks.
Check backup agent installation space
The required storage for installing the Backup Agent is as follows.
| OS type | Path | Required capacity | Remarks |
|---|---|---|---|
| Linux | /tmp (temporarily used during installation) | 3 GB | When /usr space is insufficient, a separate space can be linked #ln -s separate space /usr/openv |
| Linux | /opt | 3 GB | /usr space is insufficient, a separate space can be linked #ln -s separate space /usr/openv |
| Linux | openv installation path (usually /usr) | 3~5 GB | /usr When /usr space is insufficient, you can link a separate space #ln -s separate space /usr/openv |
| Windows | Veritas installation path (usually C:\) | 3~5 GB | If space on C:\ is insufficient, you can install on another drive. |
| - | installation file | 10 GB |
Download Backup Agent installation file
To download the Backup Agent installation file, follow these steps.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- From the Service Home page, click the Backup Agent menu. You will be taken to the Backup Agent list page.
- On the Backup Agent List page, click the resource for which you want to view detailed information. You will be taken to the Backup Agent Details page.
- After checking the installation file URL, navigate to that URL. You can download the Backup Agent installation file.
Linux OS
If you are using Linux OS, refer to the following example and enter the command.
# cd [다운로드할 위치]
# curl -O 설치파일 → 설치 파일에 복사한 설치 파일 다운로드 URL을 넣어주세요.
Windows OS
If you are using Windows OS, you can download using a web browser or Windows PowerShell.
When using an internet browser
After launching an internet browser, enter the copied installation file download URL into the address bar. Once you navigate to the download page, the download will begin.
- It may take some time to navigate to the download screen.
- If you do not navigate to the download page, use Windows PowerShell to download.
When using Windows PowerShell
- Right-click the Windows Start icon, then run Command Prompt (Admin).
- Run Windows PowerShell in administrator mode.
- Enter the command by referring to the following example.
# wget "다운로드 URL" -OutFile "저장할 파일명"
Check Backup Master and Agent Information
To install the Backup Agent, you need routing settings and Backup Master and Agent information for host file registration. On the Backup Agent Details page, check the Backup Master IP, Backup IP, and Gateway information. Please refer to Check detailed information of Backup Agent.
Configure routing for communication with Backup Master
To communicate with the Backup Master, you must configure routing in the operating system.
Linux OS - CentOS/RHEL
Linux OS - To configure routing on CentOS/RHEL, follow these steps.
- The IP, Gateway, and Vlan ID information for the Backup Master and Agent used in the routing configuration example are as follows.
- Backup Master IP: 10.242.8.4
- Backup IP (Agent IP): 10.252.25.4
- Gateway (Agent Gateway): 10.252.25.1
- vlan: 100
- vlan can be configured in the Config file of a Bare Metal Server. For more details, refer to Configure Local Subnet.
- Use the following command to check the backup network Interface information.
- ip a
- bash /usr/local/bin/ip.sh
- Configure routing using the nmcli command.
# nmcli con mod "Vlan bond-srv.100" +ipv4.routes "10.252.8.0/24 10.252.25.1" # nmcli device reapply bond-srv.100 - Check that the routing configuration has been applied correctly.
# telnet [Backup Master명] 1556
Linux OS - ubuntu
Linux OS - To set up routing on Ubuntu, follow the steps below.
- The IP, Gateway, and Vlan ID information for the Backup Master and Agent used in the routing configuration example are as follows.
- Backup Master IP: 10.242.8.4
- Backup IP (Agent IP): 10.252.25.4
- Gateway (Agent Gateway): 10.252.25.1
- vlan: 100
- vlan can be configured in the Config file of a Bare Metal Server. For more details, see Local Subnet Configuration.
- Use the following command to check the backup network Interface information.
- ip a
- bash /usr/local/bin/ip.sh
Open the 50-cloud-init.yaml file and configure routing.
# vi /etc/netplan/50-cloud-init.yaml (기존 내용에 routes 내용 추가) network: bonds: ...................... 생략 ethernets: ...................... 생략 vlans: bond.srv.100: addresses: ...................... 생략 routes: - to:10.252.8.0/24 via:10.252.25.1 # netplan applyCheck that the routing configuration has been applied correctly.
# telnet [Backup Master명] 1556
Windows OS
To set up routing on Windows OS, follow these steps.
- The IP, Gateway, and Vlan ID information for the Backup Master and Agent used in the routing configuration example are as follows.
- Backup Master IP: 10.242.8.4
- Backup IP (Agent IP): 10.252.25.4
- Gateway (Agent Gateway): 10.252.25.1
- ifindex: 100
- ifindex can be set in the Config file of a Bare Metal Server. For more details, refer to Setting Local Subnet.
- Right-click the Windows Start icon and then launch Command Prompt (Admin).
- Run Windows PowerShell in administrator mode.
- Use the ipconfig and Get‑NetAdapter commands to check the backup network interface index (ifindex) settings.
# ipconfig /all → Agent IP에 할당된 interface name을 확인하세요. # Get-NetAdapter → 위에서 확인한 interface name 참고해 interface index를 확인하세요.
Set up routing using the NetRoute command.
# Get-NetRoute -ifindex 100 # New-NetRoute -ifIndex 100 -DestinationPrefix 10.252.8.0/24 -NextHop 10.252.25.1Check that the routing configuration has been applied correctly.
# telnet [Backup Master명] 1556
Register Backup Master information in the hosts file
To register Backup Master information in the hosts file, follow these steps.
- Open the host file using a file editing tool.
- Linux operating system: /etc/hosts
- Windows operating system: C:\Windows\System32\drivers\etc\hosts
- Open the hosts file and register the Backup Master and Backup Agent information (IP, name).
- You must add .scpbackup after the Backup Agent name as shown in the following example.
10.252.8.4 takre1p1bkm1 10.252.25.4 agent_tgdrhw.scpbackup
Adding ports for Backup Agent (when using Windows Firewall)
If you are using the Windows firewall, you must add the Backup Agent port for communicating with the Backup Master to the Windows firewall.
The ports and settings to add to the Windows firewall are as follows.
- Inbound Rule: (TCP) 1556, 13724 port
- Action: allow the connection
- Profile: select domain, private, and public
Check if the package is installed (when using RHEL 8)
If you are using RHEL 8, the libnsl package must be installed to install the Backup Agent.
- Use the following command to verify that the libnsl package is installed.
# rpm -qa | grep libnsl - If the libnsl package is not installed, use the following command to install the package.
# yum install libnsl
Installing Backup Agent
Install the Backup Agent appropriate for the operating system.
Linux OS
To install the Backup Agent on Linux OS, follow these steps.
- Backup Agent 10.1.1 After moving to the path where the installation file was extracted, change the permissions of the installation-related files.
# chmod 755 installs # chmod –R 755 NBClients - Run ./install.
- [root@bkclientlin ~]# ./install
- After the install description, when confirming whether to proceed with the installation, enter y and press the Enter key.
Do you wish to continue? [y,n] (y) y - When checking the installation status of Software on the client, enter y and press the Enter key.
Do you want to install the ~~~~~~~~~~~~ software for this client? [y,n] (y) y - When checking the Backup master server name, enter Backup Master name and press the Enter key.
Enter the name of the ~~~~~~ master server : bkmaster - When checking the client server configuration name, enter n and then input the Agent information.
- Agent information required: Backup Agent name.scpbackup (e.g., agent_tgdrhw.scpbackup)
Would you like to use "bkclientlin" as the configured name of the ~~~~~~~ client? [y,n] (y) n agent_tgdrhw.scpbackup - Check the Master Server information, and if there are no issues, enter y.
Master server [bkmaster] reports the following CA Certificate fingerprints: SHA-256 Fingerprint: [BB:38:~~~~~~~~] SHA-1 Fingerpritn: [0D:E6:~~~~~~~] Is this correct [y,n] y - When selecting the Java GUI and JRE option, enter 2. The installation of the Java GUI and JRE packages will be omitted.
Choose an option from the list below. 1) Include the Java GUI and JRE 2) Exclude the Java GUI and JRE Java GUI and JRE option: [1,2] (2) :2 Excluding the installation of Java GUI and JRE packages - Check that the installation completed successfully.
Windows OS
To install the Backup Agent on Windows OS, follow these steps.
- After moving to the folder where the Backup Agent 10.1.1 installation file has been extracted, run the Setup.exe file with administrator privileges.
- If the installation archive contains an EEB directory in the format
NB_10.4.0.1_ETXXXXXX_1, you must perform the patch procedure after installing the Backup Agent, following the steps below.- When the Backup Agent installation is complete, go to the
NB_10.4.0.1_ETXXXXXX_1folder. eebinstaller_XXXXXXX_1_AMD64.exeRun the file with administrator privileges.- If there are multiple files, install all of them.
- When the Backup Agent installation is complete, go to the
- In the popup window for selecting the Client to install, select the Client to install, then click the OK button.
- In the Vertias NetBackup popup, select Yes. The installation popup opens, and the installation steps are displayed on the left side of the popup.
- Welcome When the step description is displayed, click the Next button.
- License Agreement When the step description is displayed, select the Agree with the veritas Software License Agreement item, then click the Next button.
- When the Install Type step description is displayed, make sure the Install to the computer only option is checked, then select the Custom installation option. After completing the selection, click the Next button.
- When the Option step description is displayed, verify the installation path and click the Next button. Client option information is displayed.
- Click the Change… button to change the installation path.
- After checking the Client Options information, click the Next button. The Log on information will be displayed.
- After checking the Log on information, click the Next button.
- Safe Abort Option: This option aborts the installation when a system restart is required (optional).
- When the System Name step description is displayed, enter the server environment information and click the Next button. The Master Server information will be displayed.
- Client Name: Enter the Agent information. Backup Agent Name.scpbackup (e.g.: agent_tgdrhw.scpbackup)
- Master Server Name: Enter the Backup Master name.
- After checking the Master Server information, select the I recognize the fingerprint for this host. Proceed with the certificate deployment. item. When you have finished selecting, click the Next button.
- When the Security step description is displayed, verify that the certificate deployment succeeded, then click the Next button.
- When the Install step description is displayed, review the Installation Summary and then click the Install button.
- When the installation is complete, click the Finish button.
Configure Security Group (Linux/Window)
If backing up a Virtual Server or GPU Server, you must configure a Security Group to communicate with the Backup Master. To configure the Security Group, check the backup information on the Backup Agent Details page and register it with the Security Group attached to the Server.
- IP: Backup Master IP
- Inbound / Outboud / (TCP) 1556, 13724 port
- Action: allow the connection
Check Backup Agent status
After the Backup Agent installation is complete, perform a communication test with the Backup Master and check the status.
Linux OS
Follow these steps to perform a communication test with the Backup Master on Linux OS.
- After entering the following command, perform a communication test with Backup Master and check the results.
- Command: # /usr/openv/netbackup/bin/bpclntcmd -pn
- An example of the communication test inspection results is as follows.
# /usr/openv/netbackup/bin/bpclntcmd -pn expecting response from server takre1p1bkm1 agent_tgdrhw.scpbackup agent_tgdrhw.scpbackup 10.252.25.4 52096
- Click the All Services > Storage > Backup menu in the Samsung Cloud Platform Console. Go to the Service Home page of Backup.
- On the Service Home page, click the Backup Agent menu. You will be taken to the Backup Agent List page.
- On the Backup Agent List page, click the resource to verify the communication test. You will be taken to the Backup Agent Details page.
- In the Connection Status item, click the Check Connection Status button. If communication with Backup Master is successful, Success will be displayed.
- Verify that the result values of the Backup Master communication test performed on the OS and the Samsumg Cloud Platform Console are identical.
Windows OS
Follow these steps to perform a communication test with Backup Master on Windows OS.
- After entering the following command, perform a communication test with Backup Master and check the results.
- Command: # [installation path]\Vertitas\NetBackup\bin\bpclntcmd.exe -pn
- An example of the communication test inspection results is as follows.
# C:\Vertitas\NetBackup\bin\bpclntcmd.exe -pn expecting response from server takre1p1bkm1 agent_tgdrhw.scpbackup agent_tgdrhw.scpbackup 10.252.25.4 52096
- In the Samsung Cloud Platform Console, click the All Services > Storage > Backup menu. Navigate to the Service Home page of Backup.
- From the Service Home page, click the Backup Agent menu. You will be taken to the Backup Agent list page.
- On the Backup Agent List page, click the resource to verify the communication test. You will be taken to the Backup Agent Details page.
- In the Connection Status item, click the Check Connection Status button. If communication with Backup Master is successful, Success will be displayed.
- Verify that the result values of the Backup Master communication test performed on the OS and Samsumg Cloud Platform Console are identical.
Delete Backup Agent
If you are not using the Backup Agent, you must remove the Backup Agent installed on each operating system.
Linux OS
To uninstall the Backup Agent on Linux OS, follow the steps below.
- Stop the Backup Agent service.
# /usr/openv/netbackup/bp.kill_all # /opt/VRTSpbx/bin/vxpbx_exchanged stop # /usr/openv/netbackup/bin/vxlogcfg -r -p 51216 - Delete the Backup Agent installation file.
# rpm –qa | grep –i VRTS → Backup Agent package 확인 # rpm –e VRTSnbcfg # /opt/pdde/pddeuninstall.sh –forceclean # rpm -e VRTSnbjava # rpm -e VRTSnbjre # rpm -e VRTSnbclt # rpm -e VRTSpbx # rpm -e VRTSnbpck # rpm -qa | grep -i VRTS → Backup Agent package 확인 후 남은 package 삭제 # rm -rf /usr/openv
Windows OS
To uninstall the Backup Agent on Windows OS, follow these steps.
- Stop the Backup Agent service.
# [설치경로]\Vertitas\NetBackup\bin\bpdown.exe -f -v # [설치경로]\Vertitas\NetBackup\bin\bpps.exe → 남은 Process 확인 후 kill 수행 - From Control Panel > Programs and Features, uninstall the Backup Agent program.
- Delete the Backup Agent installation folder.
2.5 - Use Replication
You can create a replica of the Agent Backup in a different location.
- The kr-south region does not provide replication functionality.
- Agentless Backup does not provide a replication feature.
- With Agentless Backup, you can select a backup storage location when applying for the service and store the backup copy in a different location.
Create a clone
When creating a Backup service, you can set up replication for use.
To create a backup, follow the steps below.
- Click the All Services > Storage > Backup menu. Go to the Service Home page of Backup.
- On the Service Home page, click the Create Backup button. You will be taken to the Create Backup page.
- On the Backup Creation page, enter the information required to create the service and select detailed options.
Category RequiredDetailed description Backup name Required Backup name - Enter 3 to 30 characters using letters and numbers
- Cannot be edited after service creation
Backup type Required Agent > Filesystem selection Backup replication Select Use after checking, select the clone location (region) - South Korea (kr-south) region is unavailable
Backup target Required After clicking the Select Server button, select one pre‑created server from the Bare Metal Server service. Filesystem Required Enter the target FileSystem for backup - The exact Filesystem used by the operating system must be entered. Incorrect input will prevent backup
- Backup is not possible when /dev/zero, /dev/null is entered
- Backup is not possible if the following special characters are included, depending on the operating system
- Linux:
:*<>\
- Linux:
Encryption Select Select whether to apply encryption Retention period Selection Retention period of the recovery target (backup) - Select from 2 weeks (14 days), 1 month (31 days), 3 months (93 days), 6 months (186 days), 1 year (365 days)
Schedule Select Backup auto-creation schedule - Set 1 Full Backup and up to 6 Incremental Backups
- Select Daily, Weekly, or Monthly
- Daily: Set the start time
- Weekly: Set the day of week and start time
- Monthly: Set the week number, day of week, and start time
- Week number: Choose from 1, 2, 3, 4, or the last week
- Day of week: Choose from Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
- Start time: Select in 30‑minute increments (00–23 hours, 00/30 minutes)
Table. Backup service information input fields - Summary Verify the detailed information and estimated billing amount generated in the panel, then click the Complete button.
- Once creation is complete, check the created resources on the Backup List page.
- Agent Backup applies server‑side encryption based on the AES‑256 algorithm when encryption is selected, which may cause a performance degradation of approximately 20 ~ 30%.
- The initial backup is created as a Full Backup regardless of the request details.
- Backup replication If you select a location in a different region, data transfer fees will be added.
Edit replication policy
You can change the replication status by modifying the replication policy.
To modify the replication policy, follow these steps.
- Click the All Services > Storage > Backup menu. You will be taken to the Service Home page of Backup.
- On the Service Home page, click the Backup menu. You will be taken to the Backup List page.
- On the Backup List page, click the resource to edit the replication policy. You will be taken to the Backup Details page.
- On the Backup Details page, click the Clone tab.
- Click the Edit button of the Replication Policy. The Edit Replication Policy popup opens.
- Use: Performs replication. If it is not used, you can modify it to be used.
- Unused: Stop backup replication. If unused, the Backup service can be terminated.
- Check the modified replication policy in the Replication tab of the Backup Details page.
3 - API Reference
4 - CLI Reference
5 - Release Note
Backup
- When performing Agent Backup, Virtual Server and GPU Server have been added as target servers.
- Now you can select one of Virtual Server, GPU Server, or Bare Metal Server.
- Add Backup Replication Tab
- In the Backup detail page, you can view the original and replica information on the Replication tab.
- Add download feature for backup-related information
- In the Backup detail page, you can download the Backup history, recovery targets, and recovery history list as an Excel file.
- Expand recovery scope
- When restoring from an agentless remote backup, you can select the restore location (target server or backup location).
- Expand backup location and target
- Agentless-based remote backup: You can back up and restore to a location different from the backup target server.
- Backup Agent feature added: You can back up the filesystem of a Bare Metal Server by configuring the Agent.
- Samsung Cloud Platform Common Feature Changes
- Account, IAM, Service Home, tags, and other common CX changes have been applied.
- We launched the Backup service to provide a secure data backup and recovery solution.
- Since a backup policy includes the target, frequency, retention period, and other elements, users can configure a backup plan to match their business environment and requirements.
