> CommCell Console > Tools & Utilities > Developer Tools > Command Line > Command Line Interface > CommCell Management > Subclient Configuration

Updating Subclient Common Properties Using the Command Line Interface

Use the following steps to update the common properties for all of the subclients in a client computer group.

  1. Download the update_subclients_batch_template.xml file and save it on the computer from where the command will be executed.

  2. Open the XML file and update the parameters as needed using the table below as reference.

    Parameter

    Description

    Element

    clientGroupName

    The name of the client computer group. All of the subclients in the client computer group are updated when the XML is used with the qoperation execute command. If needed, add additional client computer group names to the XML file by adding clientGroupName parameters within entity elements: 

    <entity>
   <clientGroupName>client_group_001</clientGroupName>
 </entity>
 <entity>
   <clientGroupName>client_group_089</clientGroupName>
 </entity>

    entity

    encryptionFlag

    The option to set the encryption points during backups.

    Valid values are:

    • ENC_MEDIA_ONLY, to encrypt the backup data after transmission and prior to storage on the media.

    • ENC_NETWORK_AND_MEDIA, to encrypt the backup data before transmission. The data is stored encrypted on the media.

    • ENC_NETWORK_ONLY, to encrypt the backup data for transmission and then decrypt the data prior to storage on the media.

    • ENC_NONE, to disable data encryption.

    commonProperties

    description

    The description of the subclient.

    commonProperties

    enableBackup

    The option to enable/disable backup.

    Valid values are True/False.

    commonProperties

    networkAgents

    The option to specify the number of processes the subclient uses to transfer data over a network.

    Valid values are 1-4 on Windows computers or 1-2 on UNIX computers.

    storageDevice

    softwareCompression

    The option to enable compression on the client or the MediaAgent computer.

    Valid values are:

    • ON_CLIENT, to enable software compression on the client.

    • ON_MEDIAAGENT, to enable software compression on the MediaAgent.

    • USE_STORAGE_POLICY_SETTINGS, to use the software compression options defined on the storage policy.

    • OFF, to disable software compression.

    storageDevice

    throttleNetworkBandwidth

    The option to enhance backup performance by reducing network bandwidth overhead.

    Valid values are 0/1.

    storageDevice

    applicableReadSize

    The amount of application data backup jobs will read for each unit transferred to the MediaAgent.

    Valid kilobyte values are 64, 128, 256, 512, 1024, 2048, or 4096.

    storageDevice

    storagePolicyName

    The name of the storage policy associated with the subclient backup.

    dataBackupStoragePolicy

    enableDeduplication

    The option to enable deduplication on the subclient.

    Valid values are True/False.

    deDuplicationOptions

    generateSignature

    A component of deduplication performed on the client or MediaAgent computer.

    Valid values are:

    • ON_CLIENT, to enable signature generation on the client.

    • ON_MEDIA_AGENT, to enable signature generation on the MediaAgent.

    • OFF, to disable signature generation.

    deDuplicationOptions

    isSnapBackupEnabled

    The option to enable or disable an IntelliSnap backup.

    Valid values are True/False.

    snapCopyInfo

    snapShotEngineName

    The name of the engine used for an IntelliSnap backup.

    snapToTapeSelectedEngine

    clientName

    The name of the client.

    snapToTapeProxyToUse

    snapToTapeProxyToUseSource

    The option to enable or disable using the source if the proxy is unreachable.

    Valid values are True/False.

    snapCopyInfo

    isRMANEnableForTapeMovement

    The option to enable or disable using RMAN for the backup copy.

    snapCopyInfo

    preScanCommand

    The path to the pre-process script that runs before the scan phase.

    prepostProcess

    postScanCommand

    The path to the post-process script that runs after the scan phase.

    prepostProcess

    preBackupCommand

    The path to the pre-process script that runs before the backup.

    prepostProcess

    postBackupCommand

    The path to the post-process script that runs after the backup.

    prepostProcess

    runPostBackup

    The option to run a process after the backup completes.

    Valid values are Yes/No.

    prepostProcess

    runAs

    The option to specify the user name who has permission to run the pre-process and post-process scripts.

    Valid values are:

    • USE_IMPERSONATION, to specify a user with the permission to run the scripts. When using this value, provide the user credentials.

    • USE_LOCAL_SYS_ADMIN, to use the administrator account to run the scripts.

    prepostProcess

    userName

    The name of the user with permission to run the scripts defined in the prepostProcess element. This parameter must be used when the runAs parameter is set to USE_IMPERSONATION.

    prepostUserName

  3. Save the changes to the XML file.

  4. Run the qlogin command to log on to the CommServe computer.

  5. From software_installation_directory/Base type the following command: 

     
    qoperation execute -af xml_path\update_subclients_batch_template.xml

    If the XML file is saved in the software_installation_directory/Base directory, the file path (xml_path in the example above) does not need to be included on the command line.

×

Loading...