Preliminary tasks

Prev Next

Available in Classic and VPC

Preliminary tasks describe what to do before creating resources.

The cases where you need to perform preliminary tasks and the tasks that should be performed depending on the circumstances are as follows:

If the above cases do not apply, you can create the resource immediately without performing any additional tasks. For more information about resource creation, see Resource creation.

Windows settings

To create resources through Windows servers, follow these steps:

Setting a fixed port for WMI (required)

To set a Windows Management Instrumentation (WMI) fixed port 24158, follow these steps:

  1. Press [Windows] + [R], and enable the Run command.

  2. Enter cmd and [Ctrl] + [Shift] + [Enter] together.

    • The cmd window opens with administrator privileges.

  3. Enter the following commands and run the WMI service automatically:

    # winmgmt -standalonehost

  4. Enter the following commands and stop the WMI service and restart it:

    # net stop Windows Management Instrumentation
# net start Windows Management Instrumentation

  5. Enter the following commands and add the outbound rule for Windows firewall:

    // the rule to allow for the access to the port 24158
# netsh firewall add portopening TCP 24158 WMIFixedPort

    Example:
    resource_agent_1

Enabling Remote Registry (required)

To enable Remote Registry, follow these steps:

  1. Press [Windows] + [R], and enable the Run command.
  2. Enter control and press [Enter].
  3. When the Control Panel window appears, click System and Security > Administrative Tools > Services in order to run Services.
  4. Double-click Remote Registry to open the Remote Registry Properties (Local Computer) window.
    • You can also right-click Remote Registry and click Properties.
  5. Select Automatic from Startup type dropdown menu.
  6. Click [OK].
  7. Click i-backup_running at the top of Services page to run Services.
    resource_agent_4
    • Remote Registry services are enabled.
Note

To prevent Remote Registry from being disabled again, edit the registry as follows:

  1. Press [Windows] + [R], and enable the Run command.
  2. Enter regedit and press [Enter].
    • Registry Editor opens.
  3. Go to the HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\RemoteRegistry path.
  4. Double-click DisableIdleStop.
    • You can also right-click DisableIdleStop and click Modify.
  5. When the popup window appears, enter 1 into Value Data and click [OK].

Setting ACG rules (required)

When you use Backup services in Classic, see ACG settings and set up the ACG rule as follows:
backup-advance_acg_ko

  • Protocol: TCP
  • Access source (IP range): 10.0.0.0/8
  • Allowed ports: 135, 139, 445, and 24158

Enabling ADMIN$ shares (required)

While managing the server remotely, view whether ADMIN$ shares as the currently used resource are enabled and enable it.

View whether ADMIN$ shares are enabled

To view whether ADMIN$ shares are enabled, follow these steps:

  1. Press [Windows] + [R], and enable the Run command.
  2. Enter cmd and [Ctrl] + [Shift] + [Enter] together.
    • The cmd window opens with administrator privileges.
  3. Run net share to view whether ADMIN$ shares are enabled.
    resource_agent_2

Enable ADMIN$ shares

To enable ADMIN$ shares, follow these steps:

  1. Press [Windows] + [R], and enable the Run command.
  2. Enter regedit and press [Enter].
    • Registry Editor opens.
  3. Go to the HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\LanmanServer\Parameters path.
  4. Right-click Registry Editor window and click New > DWORD (32-bit) Value in order.
  5. Enter AutoShareServer and press [Enter].
    • Add AutoShareWks in the same way.
  6. Double-click AutoShareServer.
    • You can also right-click AutoShareServer and click Modify.
  7. When the popup window appears, enter 1 into Value data and click [OK].
    • Set AutoShareWKS in the same way.
      resource_agent_3
  8. Reboot the server.

Server ID settings

To install the agent through servers, use the root account for Linux and the Administrator account for Windows. When you cannot use the root/Administrator accounts, create an account for the agent installation and assign the root/Administrator privileges to use it. However, after the completion of the agent installation, remove the root/Administrator privileges from the account.

Linux

To create an account for the agent installation and assign the root privileges to the account, follow these steps:

  1. Access the server with the root account.

  2. To create an account for agent installation, enter the following commands:

    • When you have an existing account for the agent installation, you do not need to create an account.
    adduser {account name}
// example
// adduser test01

  3. Run the following commands:

    vi /etc/sudoers

  4. Enter the content below to assign the root privileges to the account for agent installation:

    "The name of account for the agent installation" ALL=(ALL) NOPASSWD: ALL

    Example:

    [root@backup-linux01 ~]# vi /etc/sudoers
## Allow root to run any commands anywhere
root    ALL=(ALL)       ALL
test01  ALL=(ALL) NOPASSWD:   ALL

  5. After the completion of agent installation, delete the content that was entered into at step 4 to remove the root privileges.

Windows

To assign the Administrator privileges to the account for agent installation, follow these steps:

  1. Access the server.
  2. Press [Windows] + [R], and enable the Run command.
  3. Enter netplwiz and press [Enter].
  4. When the popup window appears, click the account for the agent installation and click [Properties].
    • If you do not have any accounts for agent installation, click [Add] to create a new account.
  5. When the popup window of Properties appears, click the [Group Membership] tab.
  6. Select Administrator and click [OK].
    • After the completion of the agent installation, delete the account or change the privileges of the account back to Standard user.

End backup process and delete related directory

If the server intended for resource creation meets all of the following conditions, you must end the currently running backup process and delete the directory related to the agent stored on the server:

  • A server created from a server image with the agent installed.
  • A server that has a history of agent installation and still contains agent-related files.

Before creating resources, perform preliminary tasks according to the OS of the server you will use to create resources.

Linux

When you create the resource in the Linux server with the existing backup agent installed, follow these steps:

  1. Access the Linux server you will use to create resources.

  2. Enter the following commands with the root privileges and end the backup process installed on the server:

    • When the commands do not work, exit the backup process by following step 4.
    commvault stop -all
Redirecting stopping service for Instance001 to systemd ...
Running "systemctl stop commvault.Instance001.service" ...
Stopping Commvault services for Instance001 ...
All services stopped.

  3. Enter the following commands to check for any remaining backup processes on the server:

    • Backup processes you have to view: cvlaunchd, cvd, cvfwd, and ClMgrS.
    ps -ef | grep -i "cvlaunchd|cvd|cvfwd|ClMgrS"

  4. Use kill commands to exit the backup process.

    • When the commands do not work at step 1 or the backup process continues running afterward, perform the above step.

  5. View the following path and delete the directory related to the agent:

    • Default path: folders starting with /opt and commvault.
      • Example: /opt/commvault, /opt/commvault1, /opt/commvault2.
    • Log path: folders starting with /var/log and commvault.
      • Example: /var/log/commvault, /var/log/commvault1, /var/log/commvault2.
    • Registry route: /etc/CommVaultRegistry (single folder).
    Note

    When the agent has not been installed in the default path, delete the home directory of the account used for installation.

    Example:

When the agent is installed in the ncloud directory, its location is under /home/ncloud/ and the path is as follows.

  • Default path: /home/ncloud/commvault.
  • Log path: /home/ncloud/var/log/commvault.
  • Registry path: /home/ncloud/CommVaultRegistry.

:::

Windows

When you create the resource in the Windows server with the existing backup agent installed, follow these steps:

Caution

When deleting the directories related to the agent, you have to observe the procedure. If directories are deleted individually, they may not be completely removed, which can cause issues during resource creation.

  1. Access the Windows server you will use to create resources.
  2. Search for Commvault Process Manager in the taskbar and run Process Manager.
  3. Click the [Services] tab.
  4. Click All Services from the tree menu and click i-backup_stop.
    • You can also right-click All Services and click Stop.
  5. If there are any running backup processes, end them individually.
    • Click the backup process that is still running and click i-backup_stop, or right-click the process and click Stop.
  6. Search for Add or remove programs in the taskbar and run it.
  7. After clicking Commvault ContentStore, click the [Uninstall] button.
  8. After viewing the popup window, click the [Uninstall] button.
  9. When the COMMVAULT popup window appears, click and select Uninstall all packages in the instance and press [Enter].
  10. View the content you want to delete and press [Enter].