How-to guides
The user can enter the required backup information and select detailed options through the Samsung Cloud Platform Console to create a service.
Creating Backup
You can create and use the Backup service in the Samsung Cloud Platform Console.
To create a backup, follow the steps below.
- All Services > Storage > Backup Click the menu. Go to Backup’s Service Home page.
- Click the Create Backup button on the Service Home page. You will be taken to the Create Backup page.
- Backup Creation page, enter the information required to create the service, and select detailed options.
| Category | Required | Detailed description |
|---|
| Backup name | Required | Backup name- Enter 3-30 characters using English letters and numbers
- Cannot be modified after service creation
|
| Backup type | Required | Select backup type- (Agentless) VM Image: Perform backup by creating Backup service without Agent configuration
- (Agent) Filesystem: Create Backup Agent service and configure Agent on target server, then perform backup by creating Backup service
- Cannot modify after service creation
|
| Backup storage | Required | Select storage location for Agentless Backup- One Backup service can be created per storage location
- Servers in the South Korea (kr-south) region can only select the same location
|
| Backup replication | Select | Select whether to replicate Agent Backup and its location- 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
- South Korea (kr-south) region is not available
|
| Backup target | Required | Backup target server- Agentless: select one pre-created server from the Virtual Server, GPU Server service
- In the case of GPU Server, the target server location and the Backup storage location must be the same
- Agent: select one pre-created server from the Bare Metal Server service/li>
|
| Filesystem | Required | Enter Backup target FileSystem- Accurate entry of the Filesystem used by the operating system is required. Backup not possible if entered incorrectly
- /dev/zero, /dev/null entered: Backup not possible
- Backup not possible if it contains the following special characters per operating system
|
| Encryption | Required/Optional | Encryption status- Agentless: Default encryption applied
- Agent: Encryption selection
|
| Retention Period | Select | Storage period of 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 | Selection | Backup automatic creation cycle- Set 1 Full Backup, up to 6 Incremental Backups
- Choose among Daily, Weekly, Monthly
- Weekly: Set Day of Week and Start Time
- Monthly: Set Week Number, Day of Week, Start Time
- Week Number: Choose among 1, 2, 3, 4, last week
- Day of Week: Choose among Mon, Tue, Wed, Thu, Fri, Sat, Sun
- Start Time: Choose in 30‑minute increments (00~23 hour, 00/30 minutes)
|
Table. Backup Service Information Input Items
- Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
- When creation is complete, check the created resources on the Backup List page.
Reference
- Virtual, GPU Server creation or termination may take about 180 minutes to be reflected in the backup target list.
- 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 the Backup service at the location where the Backup target server was created. Backup Save item, select the remote location.
- Backup target can create one Backup service per region. By creating Backup services in two or more regions, stability against failures and disasters can be ensured.
- To optimize backup and recovery speed, set the backup storage location to be the same as the target backup server’s location.
Caution
- Agentless Backup has default encryption applied and cannot be modified.
- Agent Backup applies server-side encryption based on the AES-256 algorithm when encryption is selected, and may cause a performance degradation of about 20 ~ 30%.
- Agentless Backup is not possible to backup VM Image on servers with SSD_MultiAttach connected among Block Storage disk types.
- The initial backup is created as a Full Backup regardless of the application details.
- Backup storage, Backup replication If you select the location in a different region, data transfer fees will be added.
The Backup service allows you to view and edit the full resource list and detailed information. Backup Details page consists of Detailed Information, Schedule, Backup History, Recovery Target, Recovery History, Replication, Tags, Operation History tabs.
To view detailed information of the Backup service, follow the steps below.
- Click the All Services > Storage > Backup menu. Navigate to the Service Home page of Backup.
- Service Home on the page click Backup menu. Go to the Backup List page.
- Click the resource to view detailed information on the Backup List page. You will be taken to the Backup Details page.
- Backup Details page displays status information and additional feature information, and consists of Details, Schedule, Backup History, Recovery Target, Recovery History, Replication, Tags, Operation History tabs.
| Category | Detailed description |
|---|
| Backup status | Backup status information- Available: Creation completed
- Deleting: Service termination in progress
- Editing: Changing settings
- Error Deleting: Abnormal state during deletion
|
| Instant Backup | Instantly create a backup copy at the time of creation |
| Service cancellation | Button to cancel the service |
Table. Status Information and Additional Functions
Backup list page allows you to view detailed information of the selected resource and edit the information if needed.
| Category | Detailed description |
|---|
| service | service group |
| Resource Type | Resource Type |
| SRN | Unique resource ID in Samsung Cloud Platform |
| Resource Name | Resource Name- In the Backup service, it refers to the backup name
|
| Resource ID | Unique resource ID of the service |
| Creator | User who created the service |
| Creation DateTime | DateTime when the service was created |
| Editor | User who modified the service |
| Modification DateTime | Date and time the service was edited |
| Backup name | Backup name- The copy’s backup name is the same as the original
|
| Category | Original status regarding duplication |
| Backup type | Backup type related to Agent configuration |
| Encryption | Encryption status |
| Backup target | Backup target server |
| Filesystem | Backup target FileSystem- The replica’s Filesystem is the same as the original
|
| Retention Period | Storage period of recovery target (backup)- The retention period of the replica is the same as the original
- If you need to modify the retention period, click the Edit button
|
Table. Backup Details - Detailed Information Tab Items
Schedule
You can view the automatic backup schedule of the selected resource on the Backup List page.
| Category | Detailed description |
|---|
| Schedule Edit | Schedule Edit Button- Schedule editing not allowed for copies
|
| Schedule Name | Schedule Name- Automatically set when creating a service or editing a schedule
|
| Backup type | Full, Incremental Backup type |
| Backup cycle | Automatic backup generation cycle set by the user |
Table. Backup Details - Schedule Tab Items
Reference
- 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.
- If it is in Available status, schedule can be modified.
- The schedule of the replica is the same as the original, and can be checked 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 of the selected resources.
| Category | Detailed description |
|---|
| Schedule Name | Schedule Name- Automatically set when creating a service or editing a schedule
|
| Backup Timestamp | Backup Start Time |
| Completion Date and Time | Backup Completion Time |
| Status | Backup status information (Success/Failure/In progress) |
| Backup Cancel | Cancel button while backup in progress- For detailed information about backup cancellation, refer to Cancel Backup
|
Table. Backup Details - Backup History Tab Items
Reference
- Backup and completion date and time are based on Asia/Seoul (GMT +09:00).
- Queries can be made based on backup timestamps within up to 30 days.
- Notification on backup failure and can be checked in Management > Logging&Audit.
- In the replica, the Cancel Backup button is not displayed.
- The backup history of the original and the replica is provided by the original.
- Click the Excel Download button at the top of the list to download the retrieved Backup history list as an Excel file.
Caution
- Agentless Backup: Among Block Storage disk types, servers with SSD-MultiAttach attached cannot perform VM Image backup.
Recovery Target
On the Backup list page, you can view the recovery target (backup) of the selected resource.
| Category | Detailed description |
|---|
| Schedule | Schedule Name- Automatically set when creating a service or modifying a schedule
|
| Backup Timestamp | Backup Start Time |
| Retention Period | Storage period of recovery target- The retention period of the replica is the same as the original and can be verified from the original.
|
| Capacity | Capacity of the recovery target |
| Additional Features > More | Management button for recovery target- Recovery: Restore resources as recovery target
- For detailed information about recovery, see Recover
- Delete: Delete the recovery target
|
Table. Backup Details - Recovery Target Tab Items
Reference
- Backup date and time is based on Asia/Seoul (GMT +09:00).
- You can query based on the backup date/time within up to 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
You can view the recovery execution history of the selected resource on the Backup list page.
| Category | Detailed description |
|---|
| Schedule | Schedule Name- Automatically set when creating a service or modifying a schedule
|
| Recovery server name | Name of the server created through recovery |
| Backup date/time | Backup start time of the recovery target used for recovery |
| Recovery date and time | Recovery start time |
| Recovery Completion DateTime | Recovery Completion Time |
| Status | Recovery status information (Success/Failure/In progress) |
Table. Bacup Details - Recovery History Tab Items
Reference
- Backup and recovery times are based on Asia/Seoul (GMT +09:00).
- You can query based on the recovery date within up to 30 days.
- By clicking the Excel download button at the top of the list, you can download the retrieved recovery history list as an Excel file.
Replication
You can view the replication information of the selected resource on the Backup list page.
Guide
- Replication tab information is provided only when you set Agent Backup and Backup Replication to Use 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 the backup storage location to store the backup copy in another location.
| Category | Detailed description |
|---|
| Replication Policy | User-defined replication policy |
| Replication Information | Original and replica volume information- Distinction: Distinguish original status related to replication
- Volume Name: Name of the original or replica volume
- Location: Location where the volume was created
|
Table. Backup Details - Replication Tab Items
Tag
Backup List page allows you to view the tag information of the selected resource, and you can add, modify, or delete it.
| Category | Detailed description |
|---|
| Tag List | Tag List- Tag’s Key, Value information can be checked
- Up to 50 tags can be added per resource
- When entering a tag, search and select from the existing list of created Keys and Values
|
Table. Backup Details - Tag Tab Items
Work History
Backup list page, you can view the operation history of the selected resource.
| Category | Detailed description |
|---|
| Work History List | Resource Change History- Task date/time, resource type, resource ID, resource name, task details, event topic, task result, verify operator information
|
Table. Backup Details - Job History Tab Items
Backup Resource Management
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 the tasks on the Backup Details, Schedule, Recovery Target pages.
Edit retention period
You can modify the retention period of the backup. To modify the retention period, follow the steps below.
- All Services > Storage > Backup Click the menu. Go to Backup’s Service Home page.
- Click the Backup menu on the Service Home page. Go to the Backup list page.
- Backup List page, click the resource to modify the retention period. Navigate to the Backup Details page.
- Click the Storage Period Edit button. The Storage Period Edit popup opens.
- Select the storage period and click the Confirm button.
- 2 weeks (14 days), 1 month (31 days), 3 months (93 days), 6 months (186 days), 1 year (365 days) Please select.
- Backup Details page, check the modified retention period.
- Recovery Target Click the page. Check the modified retention period of the recovery targets.
Caution
- 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.
Reference
If you modify the original, the same changes will be applied to the copy.
Filesystem Edit
You can modify the registered Filesystem. To modify the Filesystem, follow the steps below.
- All Services > Storage > Backup Click the menu. Navigate to Backup’s Service Home page.
- Service Home on the page click the Backup menu. Go to the Backup list page.
- Click the resource to modify the retention period on the Backup list page. You will be taken to the Backup details page.
- Click the Edit button of Filesystem. 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 to delete from the Filesystem list. The Filesystem will be removed from the list.
Caution
- 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 it includes the following special characters per operating system, recovery is impossible.
- Linux:
: * < > | not allowed - Windows:
/ ? * < > | not allowed
Edit Schedule
You can modify the backup schedule.
Guide
In the case of a copy, the schedule cannot be modified.
To modify the schedule, follow the steps below.
- All Services > Storage > Backup Click the menu. Go to the Service Home page of Backup.
- Click the Backup menu on the Service Home page. Go to the Backup list page.
- Backup list page, click the resource to modify the schedule. You will be taken to the Backup details page.
- Click the Schedule page. You will be taken to the Backup Schedule page.
- Click the Edit Schedule button. The Edit Schedule popup window opens.
- Select the schedule and click the Confirm button.
- Please choose among Daily, Weekly, Monthly.
- Daily: Set the Start time.
- Weekly: Set day, start time.
- Monthly: Set the week, day, and start time.
- Week: 1, 2, 3, 4, you can choose the last week.
- Day: You can select from Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
* Start Time: Can be selected in 30‑minute intervals (00~23h, 00/30 min).
Reference
- 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 registration is required.
- If the status is Available, the schedule can be modified.
- After schedule modification, the initial backup is created as a Full Backup regardless of the application details.
- If the original is edited, the same changes will be applied to the copy.
Backup Cancel
You can cancel an ongoing backup. To cancel the backup, follow the steps below.
- All Services > Storage > Backup Click the menu. Go to the Service Home page of Backup.
- Click the Backup menu on the Service Home page. Go to the Backup list page.
- Click the resource to cancel the backup on the Backup List page. You will be taken to the Backup Details page.
- Click the Backup History page. Navigate to the Backup History page.
- Check the Backup you want to cancel. If the Backup status is in progress, Backup cancellation is possible.
- Backup Cancel Click the button. Backup Cancel popup window opens.
- After checking information such as Backup name, Backup date and time, click the Confirm button. The backup will be canceled.
Reference
If you cancel the backup, the backups of both the original and the copy will be canceled.
Delete recovery target
You can delete the generated recovery target (backup). To delete the recovery target, follow the steps below.
- All Services > Storage > Backup Click the menu. Go to the Service Home page of Backup.
- Click the Backup menu on the Service Home page. Go to the Backup list page.
- Click the resource to delete the recovery target on the Backup list page. It moves to the Backup details page.
- Click the Recovery Target page. Navigate to the Backup Recovery Target page.
- After selecting all the items you want to delete, click the Delete button. Delete popup window opens.
- After checking Backup schedule name, Backup date and time, click the Confirm button.
- If you delete two or more items, you can only see the count of items to be deleted in the popup window.
- Once deletion is complete, check on the Backup Recovery Target page whether the target has been deleted.
Reference
- You can delete two or more recovery targets by using multi-select.
- Even if you delete the recovery target of the original, the replica will not be deleted.
Backup Cancel
You can reduce operating costs by terminating unused backups. However, if you terminate the service, the running service may be stopped immediately, so you should consider the impact of service interruption sufficiently before proceeding with the termination.
Caution
- All saved backup data and history will be deleted. After termination, data cannot be recovered, so be careful.
- If in the Available, Error, Error Deleting state, it can be terminated.
- 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 not used in the original, then terminate.
To cancel the backup, follow the steps below.
- All Services > Storage > Backup Click the menu. Go to the Service Home page of Backup.
- Service Home on the page click the Backup menu. Go to the Backup list page.
- On the Backup list page, select the resource to cancel and click the Cancel Service button.
- Once termination is complete, check on the Backup List page whether the resource has been terminated.
1 - Immediate Backup
You can perform an immediate backup of the current point in time, regardless of the schedule settings for the created backup. This task can be performed on the Backup Details page.
You can immediately create a backup of the current point in time. To perform an immediate backup, follow these steps:
- Click the All Services > Storage > Backup menu. You will be taken to the Service Home page of the 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 perform the backup. You will be taken to the Backup Details page.
- Click the Immediate Backup button. The Immediate Backup popup window will open.
- Click the Confirm button. The immediate backup will be performed.
- Click the Backup History page. You will be taken to the Backup History page.
- Check the backup in progress.
Note
- Immediate backup is possible when the status is Available.
- Immediate backup is performed as a Full Backup.
2 - Recover
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.
VM Image Recover
You can restore using the backup copy to be restored.
To recover, follow the steps below.
- All Services > Storage > Backup Click the menu. Go to the Service Home page of Backup.
- Click the Backup menu on the Service Home page. You will be taken to the Backup List page.
- Backup List page, click the resource to perform recovery. Navigate to the Backup Details page.
- Click the Recovery Target page. It navigates to the Backup Recovery Target page.
- After checking the Schedule and Backup date/time, click the More button of the target you want to recover.
- Click the Restore button. Backup Restore popup window opens.
- After checking the Backup target and Backup date/time, enter the recovery location, recovery server name, etc.
- Recovery Location: For remote backup copies, select the recovery location (target server or backup location).
- Recovery Server Name: Use English letters, numbers, spaces, and special characters (
-_) within 63 characters. - Server Type: Set the server type.
- Network Settings: If you are restoring to a different location than the backup target server, configure the network of the recovery server.
- Security Group: Set the Security Group of the recovery server.
- After checking the entered information, click Confirm.
- Click the Recovery History page. Go to the Backup Recovery History page.
- Check the ongoing recovery tasks.
Caution
- If it is in Available state, recovery is possible.
- The original’s Security Group, NAT IP, Delete on termination settings are not restored, so set them after recovery.
- The original server’s Server Group is not applied to the recovery server.
- Restored servers cannot use the Rebuild function.
Reference
- When restoring, 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 of the recovery target. To restore, follow the steps below.
- All Services > Storage > Backup Click the menu. Go to Backup’s Service Home page.
- Click the Backup menu on the Service Home page. It navigates to the Backup List page.
- Click the resource to perform recovery on the Backup list page. You will be taken to the Backup details page.
- Click the Recovery Target page. Navigate to the Backup Recovery Target page.
- After checking the Schedule and Backup time, click the More button of the target you want to recover.
- Restore Click the button. Backup Restore A popup window opens.
- Check the Backup target and Backup date and time, etc.
- Click the Server Selection button of the recovery target item. The Server Selection popup window will open.
- After selecting the server, click Confirm.
- Only servers that have configured the Backup Agent can be selected among servers generated at the backup storage location.
- Only servers that use the same Backup Master and OS as the target server can be selected.
- Filesystem After checking the Filesystem to recover from the list at the bottom of the item, enter the Recovery location.
- Please enter the exact name of the Filesystem being used in the OS.
- /dev/zero, /dev/null When entered, recovery is impossible.
- If it includes the following special characters for each operating system, recovery is impossible.
- Linux:
: * < > | - Windows:
/ ? * < > |
- When Overwrite is selected, files with the same type and name are overwritten. If not selected, those files are excluded from recovery.
- After verifying the entered information, click Confirm.
- Click the Recovery History page. Navigate to the Backup Recovery History page.
- Check the ongoing recovery work.
3 - Backup Agent Usage
Users can create and manage the agents 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.
All Services > Storage > Backup Click the menu. Go to the Service Home page of Backup.
Click the Backup Agent menu on the Service Home page. It moves to the Backup Agent List page.
Backup Agent List page, click the Create Service button.Backup Agent Creation page will be opened.
Backup Agent Creation page, enter the information required to create the service.
| Category | Required | Detailed description |
|---|
| Target Server | Required | Select the target server to create the Backup Agent- Click the Select button to select the Bare Metal Server to create the Backup Agent
|
Table. Backup Agent Service Information Input Items
Summary Check the detailed information generated in the panel, and click the Complete button.
- Once creation is complete, check the created resources on the Backup Agent List page.
Caution
- 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 detailed information screen is confirmed as successful, you can create a Backup service to backup the Filesystem.
Notice
- After creating the Bacup Agent service, connect to the Backup target server and install the Backup Agent.
- For detailed information about installing the Backup Agent, refer to Backup Agent 설치하기.
- After installation is complete, check the connection status on the Backup Agent Details page.
Backup Agent service can view and edit the full resource list and detailed information. Backup Agent Details page consists of Details, Tags, Job History tabs.
To view detailed information of the Backup Agent service, follow the steps below.
- All Services > Storage > Backup Click the menu. Navigate to the Service Home page of Backup.
- Service Home 페이지에서 Backup Agent 메뉴를 클릭하세요. Backup Agent 목록 페이지로 이동합니다.
- Click the resource to view detailed information on the Backup Agent List page. Move to the Backup Agent Details page.
- Backup Agent Detail page displays status information and additional feature information, and consists of Detail Information, Tag, Job History tabs.
| Category | Detailed description |
|---|
| Backup Agent status | Backup Agent status information |
| Service termination | Button to cancel the service |
Table. Status Information and Additional Functions
Backup Agent list page allows you to view detailed information of the selected resources and, if necessary, edit the information.
| Category | Detailed description |
|---|
| service | service name |
| Resource Type | Resource Type |
| SRN | Unique resource ID in Samsung Cloud Platform |
| Resource Name | Resource Name- In the Backup Agent service, it refers to the Backup Agent name.
|
| Resource ID | Unique resource ID of the service |
| Creator | User who created the service |
| Creation time | Time the service was created |
| Editor | User who modified the service |
| Modification Date/Time | Date/Time the service was modified |
| Backup Agent name | Backup Agent name |
| Backup Master name | Backup management server name |
| Number of Backup policies | Number of Backup services connected to the target server |
| Backup Master IP | Backup management server connection IP |
| Service Category | Service Category of Backup Agent Target Server |
| Target Server | Backup Agent Target Server Information- Server Name:Target Server Name
- Connection Status: Connection status between Backup Master and server
- Check Connection Status button click, reconfirm connection status
- Backup IP: Backup IP information of the target server connected to Backup Master
- Check Time: Last connection status check time
- Gateway: Backup Gateway information of the target server connected to Backup Master
|
Table. Backup Agent detailed information items
Notice
- After creating the Bacup Agent service, connect to the backup target server and install the Backup Agent.
- After installation is complete, check the connection status on the Backup Agent Details page.
Tag
Backup Agent List page allows you to view the tag information of selected resources, and you can add, modify, or delete it.
| Category | Detailed description |
|---|
| Tag List | Tag List- You can view the Key, Value information of tags
- Up to 50 tags can be added per resource
- When entering tags, search and select from the previously created Key and Value list
|
Table. Tag Tab Items
Work History
On the Backup Agent List page, you can view the operation history of the selected resource.
| Category | Detailed description |
|---|
| Work History List | Resource Change History- Work date/time, resource type, resource ID, resource name, work details, event topic, work result, operator information verification
|
Table. Work History Tab Detailed Information Items
Backup Agent Cancel
You can cancel the unused Backup Agent.
Caution
- Available, can only be terminated when in Error state.
- If there is a Backup service 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.
- All Services > Storage > Backup Click the menu. Go to the Service Home page of Backup.
- On the Service Home page, click the Backup Agent menu. It navigates to the Backup Agent List page.
- Backup Agent List On the page, select the resource to cancel, and click the Cancel Service button.
- If termination is completed, check on the Backup Agent List page whether the resource has been terminated.
4 - Backup Agent Install
Caution
To install the Backup Agent, you must first apply for the Backup Agent service. Please refer to Backup Agent Apply.
To use Agent-based Backup, you need to connect to the target server and install the Backup Agent. After installing the Backup Agent, register the backup through the Backup service.
Pre-preparation work
To install the Backup Agent, we check the installation space, download the Backup Agent file, verify Backup Master/Agent information, and perform other preparatory tasks.
Backup Agent Check Installation Space
The required capacity for installing the Backup Agent is as follows.
| OS type | Path | Required capacity | Remarks |
|---|
| Linux | /tmp (temporarily used during installation) | 3 GB | /usr space shortage, possible through linking a separate space #ln -s separate space /usr/openv |
| Linux | /opt | 3 GB | When /usr space is insufficient, it is possible to link a separate space #ln -s separate space /usr/openv |
| Linux | openv installation path (usually /usr) | 3~5 GB | If /usr space is insufficient, possible via linking separate space #ln -s separate space /usr/openv |
| Windows | Veritas installation path (usually C:) | 3~5 GB | If space on C:\ is insufficient, can be installed on another drive |
| - | installation file | 10 GB | |
Table. Required capacity when installing Backup Agent
Backup Agent installation file download
To download the Backup Agent installation file, follow these steps.
- All Services > Storage > Backup Click the menu. Go to the Service Home page of Backup.
- Click the Backup Agent menu on the Service Home page. You will be taken to the Backup Agent List page.
- Click the resource to view detailed information on the Backup Agent list page. It navigates to the Backup Agent details page.
- Installation file URL After confirming, go to the 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 [download location]
# curl -O installation file → Please insert the copied installation file download URL into the installation file.
Windows OS
If you use Windows OS, you can download using a web browser or Windows PowerShell.
When using an internet browser
After launching the internet browser, enter the copied installation file download URL into the address bar. After moving to the download screen, the download will start.
Reference
- It may take some time until it moves to the download screen.
- If you do not go to the download screen, download using Windows PowerShell.
When using Windows PowerShell
- Right-click the Windows Start icon, then run Command Prompt (Admin).
- Windows PowerShell in administrator mode.
- Please enter the command referring to the following example.
# wget "download URL" -OutFile "filename to save"
To install the Backup Agent, routing settings and Backup Master and Agent information for host file registration are required. On the Backup Agent Details page, check the Backup Master IP, Backup IP, Gateway information.
Backup Agent detailed information Please refer.
Setting up routing for communication with Backup Master
To communicate with Backup Master, you need to set up routing in the operating system.
Linux OS - CentOS/RHEL
Linux OS - To set up routing on CentOS/RHEL, follow the steps below.
Reference
- The IP, Gateway, and Vlan ID information of 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 set in the Config file of the Bare Metal Server. For more details, see Local Subnet Setup.
- Use the following command to check the backup network Interface information.
- ip a
- bash /usr/local/bin/ip.sh
- Set up 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 settings have been applied correctly.
# telnet [Backup Master name] 1556
Linux OS - ubuntu
Linux OS - To set up routing on Ubuntu, follow the steps below.
Reference
- The IP, Gateway, and Vlan ID information of 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 set in the Config file of the Bare Metal Server. For more details, see Local Subnet Setup.
Use the following command to check the backup network Interface information.
- ip a
- bash /usr/local/bin/ip.sh
50-cloud-init.yaml Open the file and set up routing.
# vi /etc/netplan/50-cloud-init.yaml (Add routes to existing content)
network:
bonds:
...................... omitted
ethernets:
...................... omitted
vlans:
bond.srv.100:
addresses:
...................... omitted
routes:
- to:10.252.8.0/24
via:10.252.25.1
# netplan apply
Check that the routing settings have been applied correctly.
# telnet [Backup Master name] 1556
Windows OS
To set up routing in Windows OS, follow the steps below.
Reference
- The IP, Gateway, and Vlan ID information of 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, see Setting Local Subnet.
Right-click the Windows Start icon, then run Command Prompt (Admin).
Run Windows PowerShell in administrator mode.
Using the ipconfig, Get-NetAdapter commands, check the backup network interface index (ifindex) setting.
# ipconfig /all → Check the interface name assigned to the Agent IP.
# Get-NetAdapter → Refer to the interface name checked above to find the 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.1
Check that the routing settings have been applied correctly.
# telnet [Backup Master name] 1556
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).
Add port for Backup Agent (when using Windows firewall)
If you are using the Windows firewall, you need to add the port for the Backup Agent, which communicates with the Backup Master, to the Windows firewall.
The ports and settings to add to the Windows firewall are as follows.
- Inbound Rule: (TCP) 443, 1556, 13720, 13724, 13782 port
- Action: allow the connection
- Profile: domain, private, public select all
Check whether 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.
- Check if the libnsl package is installed using the following command.
# rpm -qa | grep libnsl
- If the libnsl package is not installed, install the package using the following command.
# yum install libnsl
Backup Agent Install
Install the Backup Agent suitable for the operating system.
Linux OS
To install the Backup Agent on Linux OS, follow the steps below.
- Backup Agent 10.1.1 Move to the path where the installation file was extracted and change the permissions of the installation-related files.
# chmod 755 installs
# chmod –R 755 NBClients
- ./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 progress 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 enter the Agent information.
- Agent information input 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. Java GUI and JRE package installation will be excluded.
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
- Verify that the installation was completed correctly.
Windows OS
To install the Backup Agent on Windows OS, follow these steps.
Guide
Backup Agent installation must be performed with the Default Administrator account. If you are not using the Default Administrator account, log in with the Default Administrator account and then proceed with the installation.
- 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.
Guide
- If the installation zip file contains an EEB directory in the format
NB_10.4.0.1_ETXXXXXX_1, after installing the Backup Agent, you must proceed with the patch work according to the following procedure.- When the Backup Agent installation is finished, go to the
NB_10.4.0.1_ETXXXXXX_1 folder. eebinstaller_XXXXXXX_1_AMD64.exe Run the file with administrator privileges.- If there are multiple files, install all of them.
- After selecting the client to install in the client selection popup, click the OK button.
- Select Yes in the Vertias NetBackup popup window. The installation popup window 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.
- Install Type when the step description is displayed, confirm that Install to the computer only is checked, then select Custom installation. When selection is finished, click the Next button.
Notice
If any item other than Install to the computer only is checked, verify whether the program is already installed.
- Option When the step description is displayed, verify the installation path and click the Next button. Client option information is displayed.
- Change… You can click the button to change the installation path.
- After checking the Client Options information, click the Next button. Log on information will be displayed.
- After checking the Log on information, click the Next button.
- Safe Abort Option: If a system restart is required, this is an option to halt the installation (optional).
- System Name If the step description is displayed, enter the server environment information and click the Next button. 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, I recognize the fingerprint for this host. Proceed with the certificate deployment. select the item. When selection is finished, click the Next button.
- Security When the step description is displayed, confirm that the certificate deployment succeeded, then click the Next button.
- Install When the step description is displayed, after checking the Installation Summary content, click the Install button.
- When installation is complete, click the Finish button.
Backup Agent Check Status
When the installation of Backup Agent is finished, perform a communication test with Backup Master and check the status.
Linux OS
To conduct a communication test with the Backup Master on Linux OS, follow the steps below.
- After entering the following command, conduct a communication test with Backup Master and check the results.
- Samsung Cloud Platform Console에서 All Services > Storage > Backup 메뉴를 클릭하세요. Backup의 Service Home 페이지로 이동합니다.
- Click the Backup Agent menu on the Service Home page. You will be taken to the Backup Agent List page.
- Click the resource to check the communication test on the Backup Agent List page. You will be taken to the Backup Agent Details page.
- Click the Check Connection Status button in the Connection Status item. If it communicates normally with Backup Master, Success is displayed.
- Verify that the result values of the Backup Master communication test performed on the OS and Samsumg Cloud Platform Console are the same.
Reference
If the result values of the Backup Master communication test performed on the OS and Samsung Cloud Platform Console differ, please contact the Support Center. Please refer to
Inquiry.
Windows OS
To conduct a communication test with Backup Master on Windows OS, follow the steps below.
- After entering the following command, perform a communication test with Backup Master and check the results.
- Click the All Services > Storage > Backup menu in the Samsung Cloud Platform Console. Go to the Backup Service Home page.
- Click the Backup Agent menu on the Service Home page. Navigate to the Backup Agent List page.
- Click the resource to verify the communication test on the Backup Agent List page. It navigates to the Backup Agent Details page.
- Click the Check Connection Status button in the Connection Status item. If it communicates properly with Backup Master, Success is displayed.
- Verify that the result values of the Backup Master communication test performed on the OS and the Samsumg Cloud Platform Console are the same.
Reference
If the result values of the Backup Master communication test performed on the OS and Samsung Cloud Platform Console differ, please contact through the Support Center. See
InquiryBackup Agent Delete
If you do not use the Backup Agent, you must delete the Backup Agent installed on each operating system.
Linux OS
To delete 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 check
# 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 after confirming, delete remaining package
# rm -rf /usr/openv
Windows OS
To delete the Backup Agent on Windows OS, follow the steps below.
- Stop the Backup Agent service.
# [Installation Path]\Vertitas\NetBackup\bin\bpdown.exe -f -v
# [Installation Path]\Vertitas\NetBackup\bin\bpps.exe → Check remaining Process and then perform kill
- Control Panel > Programs and Features: remove the Backup Agent program.
- Delete the Backup Agent installation folder.