Version 1 by Nathan McCoy
on Jul 08, 2016 17:07.

compared with
Current by Mario Heredia
on Aug 19, 2020 09:21.

Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (43)

View Page History
1. Select the "Control Panels" tab in the "Policy Properties" window. You can do so while [creating a new Policy|Create policies], as shown below.

!Create New Policy_English.png!
!Add New Policy.PNG|border=1!

You can also select the "Control Panels" tab in the "Edit Policy" window after the Policy has been saved and even run. See [Edit policies].

!Edit Policy_English.png!
!Edit Policy.PNG|border=1!

2. On the "Control Panels" tab of the "Edit Policy" window, click on the "Add Control Panel Instance" button.

!Add Control Panel Instance button_English.png! Instance.PNG|border=1!

3. The "Add Control Panel Instance" window will appear. Familiarize yourself with the introductory information, and click "Next" to proceed with adding the Instance.

!Add Control Panel Instance_Introduction_English.png!
!Add Control Panel Instance wizard.PNG|border=1!

4. On the following "Instance Details" screen, you can define the options for your Control Panel Instance:
** *Custom*

!Instance Details_Custom Type selection_English.png!
!add_CP_wizard_details.PNG|border=1!


The "Custom" option allows you to add your own Perl script to use a new type of Control Panel. If using this option, you must fill in two additional fields: "Custom Auth Script" and "Custom List Users Script."

!Instance Details_script names_without bottom buttons_English.png!
!add_CP_wizard_custom.png|border=1!

Click "Next".

!Edit Control Panel Instance_Next button_English.png!
!add_CP_wizard_details_next.png|border=1!

5. If your Control Panel is installed inside a Parallels Virtuozzo Containers (PVC) container, you need to specify the Virtuozzo Container ID (for cPanel, Plesk, Parallels Pro, Interworx, or DirectAdmin types). This advanced option is not available for the Virtuozzo Control Panel type.
* *None*

!1cp.png!
!add_CP_wizard_advancedoptions.png|border=1!

6. Click "Next".
6. In the advanced options, there is also an option to enable and use the InnoDB_Force_Recovery option for MySQL database restores. 
By enabling this option, control panel end users will be provided an option to select the value for InnoDB_Force_Recovery, when they attempt to restore a MySQL Database.  !add_CP_wizard_innoDB_option.png|border=1!
Once the option is enabled, you should also choose the max level, from the drop down. {color:#172b4d}The permissible nonzero values for innodb_force_recovery are 1 to 6.{color}
{color:#172b4d}If a value of 2 is set in the drop-down, then your control panel end users can only select from values of 0(default) to 2. If 4 is selected then they will be able to select from 0 to 4. {color}

!Edit Control Panel Instance_Next button_English.png!
{color:#172b4d}NOTE: MySQL does warn that a innodb_force_recovery value of greater than 0, should be used in an emergency situation. {color}
{color:#172b4d}More information on the innodb_force_recovery option can be found at{color} [https://dev.mysql.com/doc/refman/5.7/en/forcing-innodb-recovery.html|https://dev.mysql.com/doc/refman/5.7/en/forcing-innodb-recovery.html]

7. On the last "Summary" screen, the settings you have selected will be listed.
7. Click "Next".

!Summary_for Custom selection_English.png!
!add_CP_wizard_details_next.png|border=1!

8. You can verify the Instance before saving by clicking the "Verify Instance" button.
8. On the last "Summary" screen, the settings you have selected will be listed.

!Edit Control Panel Instance_Verify Instance button_English.png!
!add_CP_wizard_summary.png|border=1!

9. You can verify the Instance before saving by clicking the "Verify Instance" button.

!add_CP_wizard_details_verify.png|border=1!

If the verification is successful, a dialog window will appear. Click "OK".

!success.png!
!add_CP_wizard_verify_Success.png|border=1!

If the verification fails, the "Error Messages" window will appear. This means that Server Backup cannot find the Control Panel type you specified. Make sure you have selected the correct Control Panel type.

!Control panel instance failed verification_English.png!
!add_CP_wizard_verify_failure.png|border=1!

Click "OK" and try to fix the error. Then verify the Instance again.

9. 10. Once you have verified that the specified settings are correct, click "Save" to add your Control Panel Instance to the Policy.

!Edit Control Panel Instance_Save button_English.png!
!add_CP_wizard_details_save.png|border=1!

101. The wizard screen will close, and the added Control Panel Instance will appear on the "Control Panels" tab of the "Edit Policy" window. Instance options are displayed in under the appropriate columns. Actions icon

!Control panel instance_added_without bottom buttons_English.png!
!Control Panel Instance Edit.png|border=1!

The following actions over the Control Panel Instance are available via the icons:
11. Click on the "Save" button in the "Edit Policy" window to save your changes.

!savelast.png!
!EditPolicySaveButton.png|border=1!

12. Once you have added the Control Panel Instance to the Policy, the system will display a direct link to Backup Manager for Control Panel users in the "Login" column. Using the link, users can access their backups and restore data as a {{.zip}} or {{.tar}} file. To log in, they must use their Control Panel credentials.

!2cp.png!
!PanelLoginLink.png|border=1!

{excerpt:hidden=true}Instructions on how to add a new Control Panel Instance to a Policy in Server Backup.{excerpt}