Subclient Policies - How To
Topics | How To | Support | Related Topics
Clone a Subclient Policy
Create a New Subclient Policy
Create a New Subclient Template for an Existing Subclient Policy
Delete a Subclient Policy
Delete a Subclient Template from a Subclient Policy
Modify the Properties of a Subclient Policy
Modify the Properties of a Subclient Template
Required Capability: See
Capabilities
and Permitted Actions
To clone
a Subclient Policy:
- From the CommCell Browser, right-click the subclient policy for which you
wish to create an identical copy, and then click All Tasks -> Clone.
- From the Clone Subclient Policy dialog box, type the name of the
Subclient Policy in the Enter name box. Click OK.
- The cloned Subclient Policy is displayed in the CommCell Browser.
The newly created Subclient Policy that was cloned from another Subclient Policy
is not associated with any backup sets. To associate a Subclient Policy with a backup
set:
- Ensure that there are no user-defined subclients in the backup sets that
you will be associating with the cloned Subclient Policy.
- Right-click the cloned Subclient Policy, and then click Properties.
- From the Properties for Subclient Policy dialog box, click the
Association tab.
- Select the backup set to which you want to associate with this Subclient
Policy. Note that you cannot associate a backup set that is already associated
with another Subclient Policy. Click OK.
- The Subclient Policy is ready for use.
Create a New Subclient Policy
Before You Begin
- Ensure that no data protection operations are currently running on the backup
sets that you will be associating with the new Subclient Policy.
- Ensure that there are no user-defined subclients in the backup sets that
you will be associating with the new Subclient Policy.
Required Capability: See Capabilities and Permitted Actions
To create a new Subclient Policy:
- From the CommCell Browser, expand the Policies node then right-click the
Subclient Policies node and click New Subclient Policy. The Create New
Subclient Policy dialog box will display.
- From the
Create New Subclient Policy (General) tab of the Create New Subclient Policy
dialog box, enter a name for your subclient policy in the Name entry
field, then select the appropriate file system type from the
iDataAgent drop-down list. The display
pane will show one or more subclient templates listed for your policy.
- From the display pane of the
Create New Subclient
Policy (General) tab, assign a Storage Policy for each subclient template
by clicking in the Storage Policy column and selecting one from the list.
- If you wish to set up a Regular user-defined type of Subclient Policy Subclient,
then click Add. The Create New Subclient dialog box will display that
will allow you to enter the following information:
- Create New Subclient
(General) tab (required)
- Enter a name for your user-defined subclient in the Name
field.
- Optionally, you can change the Number of Data Readers to
a value other than 1 (which is the default), if applicable for your
agent type.
- Optionally, you can select the Allow multiple data readers within
a drive or mount point checkbox to enable this feature.
- Optionally, you can clear the Backup System State checkbox,
which is selected by default and causes the Default Subclient to
back up the system state with the file system. Clearing the checkbox
causes the Default Subclient to back up only the file system and
not the system state. You can then enable system state backup for a
different client in the Backup Set.
- Optionally, you can select the Use VSS checkbox to enable
VSS backups for this subclient, if applicable for your agent type.
- Optionally, you can select the Use QSnap checkbox to enable
backups of locked and/or open files for this subclient using QSnap,
when QSnap is installed on clients of the applicable agent type.
- Create New
Subclient (Content) tab (required)
- Specify the contents for this subclient by either clicking Browse
to browse for content, or by typing in a path in the Enter New Content
field then clicking Add. Repeat this step to include additional
objects in subclient content. If you are editing the content for a Default
subclient, see the Notes section below for more
information.
- If you are typing in a UNC path as content, then you will be prompted
to enter a user name and password for accessing that path.
- Optionally, you can select the Treat characters as regular expressions
checkbox so that any characters that are sometimes used as wildcard
characters will be treated as wildcards not as literals. See
Wildcards
for a list of supported regular expressions for your agent.
- Create New Subclient
(Filters) tab (optional)
- You can select one of the following values from the Include Global Filters
list to enable or disable global filters to exclude data from
backups on this subclient:
Do not use - Disables Global Filters for this subclient.
Always use - Enables Global Filters for this subclient.
Auto - Enables or disables Global
Filters for this subclient depending on whether the Use Global
Filters on All Subclients option is enabled or disabled on the
Control Panel (Global Filters) dialog.
- You can specify a file/folder/pattern that you want to exclude from
backups by clicking the upper Browse button to browse for an
object, or by clicking the upper Add button and then typing in
the object you want to exclude.
- You can specify an exception to your exclude filter by either clicking
the lower Browse button and browsing for the object, or by clicking
the lower Add button and then typing in the object you want to
enter as an exception to the exclusions list.
- Create New Subclient
(Pre/Post Process) tab (optional)
- You can type in or Browse for a batch file or shell script
that want executed after each job phase.
- You can also select the Run Post Process for
all attempts checkbox(es) if desired for the appropriate job phase.
- For Windows agents, you can click the Change button for the
Run As field to specify Local System Account or other username
and password that has authorization to run the specified processes.
- Create New Subclient
(Storage Device - Data Storage Policy) tab (required)
- Select a Storage Policy that you want to use for this subclient
from the drop-down list.
- Create
New Subclient (Storage Device - Data Transfer Option) tab (optional)
- You can select the desired software compression setting to be used
in case hardware compression is not available or not selected on the
destination storage policy copy. Otherwise you can leave the default
setting of Off to specify no software
compression.
- You can change the number of Network Agents to a value other
than 1 by typing in or selecting another value from the list.
- You can enable the option to Throttle Network Bandwidth
and adjust the throughput setting by selecting another value from
the list.
Once you have entered all of your configuration for the Regular user-defined
subclient type, click OK to save your changes.
- If you wish to further define the configuration settings, or enter a different
name for the Default Subclient, you can do so by selecting
the desired subclient type in the display pane and then clicking Edit.
Refer to Step 4 above for entering specific information
on each of the subclient property tabs.
|
If you want to preserve the characteristic behavior of the Default subclient
to back up all content on the client that is not assigned to other subclients
within the backup set, then we recommend leaving the default setting on
the Content tab (which is "\" or "/" depending on your file system type). |
- Click the
Association
tab of the Create New Subclient Policy dialog box.
- From the
Association
tab, expand the tree nodes and select the desired backup set checkbox(es) for
file system clients that you want to be associated to this Subclient Policy.
- Click OK to save the new Subclient Policy, then press F5 to
refresh and update the CommCell Console.
Create a New Subclient Template for an Existing Subclient Policy
Before You Begin
- Ensure that no data protection operations are currently running on backup
sets associated with the Subclient Policy that you will be modifying.
- This procedure is only applicable for creating a new Regular user-defined
type of Subclient Template, and cannot be used for creating Default or System
State types.
Required Capability: See
Capabilities
and Permitted Actions
To create
a new Subclient Template for an Existing Subclient Policy:
- From the CommCell Browser, expand the Policies node, expand the Subclient
Policies node, then right-click the Subclient Policy for which you wish to create
a new Subclient Template and click All Tasks -> New Subclient. The Create
New Subclient dialog box will display.
- Enter the following configuration information for this Subclient Template
in the tabs and fields listed below, as appropriate for your file system type:
- Create New Subclient
(General) tab (required)
- Enter a name for your user-defined subclient in the Name
field.
- Optionally, you can change the Number of Data Readers to
a value other than 1 (which is the default), if applicable for your
agent type.
- Optionally, you can select the Allow multiple data readers within
a drive or mount point checkbox to enable this feature.
- Optionally, you can select the Use VSS checkbox to enable
VSS backups for this subclient, if applicable for your agent type.
- Optionally, you can select the Use QSnap checkbox to enable
backups of locked and/or open files for this subclient using QSnap,
when QSnap is installed on clients of the applicable agent type.
- Create New
Subclient (Content) tab (required)
- Specify the contents for this subclient by either clicking Browse
to browse for content, or by typing in a path in the Enter New Content
field then clicking Add. Repeat this step to include
additional objects in subclient content.
- If you are typing in a UNC path as content, then you will be prompted
to enter a user name and password for accessing that path.
- Optionally, you can select the Treat characters as regular expressions
checkbox so that any characters that are sometimes used as wildcard
characters will be treated as wildcards not as literals. See
Wildcards
for a list of supported regular expressions for your agent.
- Create New Subclient
(Filters) tab (optional)
- You can select one of the following values from the Include Global Filters
list to enable or disable global filters to exclude data from
backups on this subclient:
Do not use - Disables Global Filters for this subclient.
Always use - Enables Global Filters for this subclient.
Auto - Enables or disables Global
Filters for this subclient depending on whether the Use Global
Filters on All Subclients option is enabled or disabled on the
Control Panel (Global Filters) dialog.
- You can specify a file/folder/pattern that you want to exclude from
backups by clicking the upper Browse button to browse for an
object, or by clicking the upper Add button and then typing the
object you want to exclude.
- You can specify an exception to your exclude filter by either clicking
the lower Browse button and browsing for the object, or by clicking
the lower Add button and then typing the object you want to enter
as an exception to the exclusions list.
- Create New Subclient
(Pre/Post Process) tab (optional)
- You can type in or Browse for a batch file or shell script
that want run after each job phase.
- You can also select the Run Post Process for
all attempts checkbox(es) if desired for the appropriate job phase
- For Windows agents, you can click the Change button for the
Run As field to specify Local System Account or other username
and password that has authorization to run the specified processes.
- Create New Subclient
(Storage Device - Data Storage Policy) tab (required)
- Select a Storage Policy that you want to use for this subclient
from the drop-down list.
- Create
New Subclient (Storage Device - Data Transfer Option) tab (optional)
- You can select the desired software compression setting to be used
in case hardware compression is not available or not selected on the
destination storage policy copy. Otherwise you can leave the default
setting of Off to specify no software
compression.
- You can change the number of Network Agents to a value other than
1 by typing in or selecting another value from the list.
- You can enable the option to Throttle Network Bandwidth
and adjust the throughput setting by selecting another value from
the list.
- Once you have entered all of the configuration information for the Subclient
Template, click OK to save the changes, then press F5 to refresh
and update the CommCell Console.
Delete a Subclient Policy
Before You Begin
- After deleting a Subclient Policy, the associated Target Subclients will revert to ordinary subclients and will retain any properties that were inherited through the policy or locally defined prior to the deletion.
Required Capability: See Capabilities and Permitted Actions
To delete a Subclient Policy:
- From the CommCell Browser, expand the Policies node, expand the Subclient Policies node, then right-click the Subclient Policy you want to delete and click All Tasks -> Delete.
- When prompted to confirm the deletion, click Yes.
- The Subclient Policy will be deleted from the CommCell Browser.
Delete a Subclient Template from a Subclient Policy
Before You Begin
- This operation is only available for Regular type (i.e., user-defined) Subclient Templates, and does not apply to Default types.
Required Capability: See Capabilities and Permitted Actions
To delete a Subclient Template from a Subclient Policy:
- From the CommCell Browser, expand the Policies node, expand the Subclient Policies node, then select the Subclient Policy that contains the Subclient Template that you want to delete.
- In the right-pane of the CommCell Browser, right-click the Subclient Template that you want to delete and then click Delete.
- When prompted to confirm the deletion, click Yes.
- The Subclient Template will be deleted from the Subclient Policy in the CommCell Browser.
Modify the Properties of a Subclient Policy
Before You Begin
- Ensure that no data protection operations are currently running on the backup sets associated with the Subclient Policy that you will be modifying.
- If you intend to associate additional backup sets with this Subclient Policy, ensure that there are no user-defined subclients in those backup sets.
Required Capability: See Capabilities and Permitted Actions
To modify the properties of a Subclient Policy:
- From the CommCell Browser, expand the Policies node, expand the Subclient Policies node, then right-click the Subclient Policy that you want to modify and select Properties. The Properties for Subclient Policy dialog box will display.
- To change the name of the Subclient Policy, enter a new name in the Name entry field of the Properties for Subclient Policy (General) tab.
- To change the association of client backup sets with this Subclient Policy, click the Properties for Subclient Policy (Association) tab, expand the tree nodes and either select or clear the desired backup set checkbox(es) for which you wish to change the association.
NOTES
- After removing the association of a Subclient Policy from selected backup sets, the Target Subclients of those objects will revert to ordinary subclients and will retain any properties that were inherited through the policy or locally defined prior to the disassociation.
- Click OK to save changes to the Subclient Policy, then press F5 to refresh and update the CommCell Console.
Modify the Properties of a Subclient Template
Before You Begin
- Ensure that no data protection operations are currently running on backup sets associated with the Subclient Policy that you will be modifying.
Required Capability: See Capabilities and Permitted Actions
To modify the properties of a Subclient Template:
- From the CommCell Browser, expand the Policies node, expand the Subclient Policies node, select the desired Subclient Policy, then right-click the desired Subclient Template in the right-hand pane of the CommCell Browser and select
Properties. The Subclient Properties dialog box will display for the selected Subclient Template.
- Click the applicable property tab listed below and enter the desired configuration changes:
- Subclient Properties (General) tab
- To rename the subclient, enter a new name in the Name field.
- To change the Number of Data Readers enter a new value in this field.
- To Allow multiple data readers within a drive or mount point select this checkbox.
- To enable VSS backups on this subclient, select the Use VSS checkbox, if applicable for your agent type.
- To enable backups of locked and/or open files for this subclient using QSnap, select the Use QSnap checkbox, provided that QSnap is installed on clients of the applicable agent type.
- Subclient Properties (Content) tab
- To change the contents for this subclient you can either click Browse to browse for new content, or type in a path in the Enter New Content field and then click Add. Repeat this step to include additional objects in subclient content.
|
If you are editing the content for a Default subclient and you want to preserve the characteristic behavior of the Default subclient to back up all content on the client that is not assigned to other subclients within the backup set, then we recommend leaving the default setting on the Content tab (which is "\" or "/" depending on your file system type). |
- If you are typing in a UNC path as content, then you will be prompted to enter a user name and password for accessing that path.
- To delete an object from the contents of this subclient, select an entry in the Contents of subclient display pane then click Delete.
- To have the system interpret wildcard characters as wildcards rather than literals, for objects entered in the Enter New Content field, select the Treat characters as regular expressions checkbox. See Wildcards for a list of supported regular expressions for your agent.
- Subclient Properties
(Filters) tab
- To enable or disable Global Filters to exclude data from backups
on this subclient, you can select one of the following values from the Include Global Filters
list:
Do not use - Disables Global Filters for this subclient.
Always use - Enables Global Filters for this subclient.
Auto - Enables or disables Global
Filters for this subclient depending on whether the Use Global
Filters on All Subclients option is enabled or disabled on the
Control Panel (Global Filters) dialog.
- To exclude a specific file/folder/pattern from backups on this subclient, you can either click the upper Browse button to browse for an object, or click the upper Add button and then type in the object you want to exclude.
- To specify an exception to the exclude filter you can either click the lower Browse button and browse for the object, or click the lower Add button and then type in the object you want to enter as an exception to the exclusions list.
- Subclient Properties (Pre/Post Process) tab
- You can type in or Browse for a batch file or shell script that want executed after each job phase.
- You can also select the Run Post Process for all attempts checkbox(es) if desired for the appropriate job phase.
- For Windows agents, you can click the Change button for the Run As field to specify or change Local System Account or other username and password that has authorization to run the specified processes.
- To remove a pre/post process entry, select the desired file/script and click Delete.
- Subclient Properties (Storage Device - Data Storage Policy) tab
- To change the Storage Policy that you want to use for this subclient select another one from the drop-down list.
- Subclient Properties (Storage Device - Data Transfer Option) tab
- To change the desired software compression setting, select the appropriate option button.
- To change the number of Network Agents, enter or select a different number.
- You can enable the option to Throttle Network Bandwidth and adjust the throughput setting by selecting another value from the list.
- Once you have entered all of the desired configuration changes for the Subclient Template, click OK to save the changes, then press F5 to refresh and update the CommCell Console.
Back To Top