Loading...

Available XML Attributes for Storage Policy Copy Creation

The following table displays XML parameters that need to be provided before running the qoperation command. To add a parameter to your command, use the following syntax: (An example is provided at the end of the table.)

qoperation execute -af <template XML file> -<parameter name> <value>

If a parameter is an option, you will use following values to enable or disable the option:

  • 0 - Use this value to disable the option.
  • 1 - Use this value to enable the option.
  • 2 - Use this value if you do not want to change the configuration for an option. If the option is disabled, it remains disabled. If the option is enabled, it remains enabled.

    Element

    Description

    Parent Element

    arrayReplicaCopy

    To create an array replica copy.

    Valid values are: 1 (enable) and 0 (disable).

    extendedFlags

    useOfflineArrayReplication

    To set offline replication, if the snapshot engine supports offline replication.

    Valid values are: 1 (enable).

    extendedFlags

    copyName

    Name of the storage policy copy to be created

    App_CreateStoragePolicyCopyReq

    copyType

    Type of the storage policy copy. Valid values are:

    • SILO - to create Silo copy
    • SELECTIVE - to create selective copy.
    • Secondary SILO - to create secondary silo copy.

    storagePolicyCopyInfo

    active

    Used to enable or disable the storage policy copy. Valid values are:

    • 0 - Use this value to disable the copy.
    • 1 - Use this value to enable the copy. This is the default value of the parameter.
    • 2 - Use this value if you do not want to change the configuration for the parameter. If the parameter is disabled, it remains disabled. If the parameter is enabled, it remains enabled.

    storagePolicyCopyInfo

    isSnapCopy

    To create a snapshot copy.

    storagePolicyCopyInfo

    isMirrorCopy

    To create a snap mirror copy.

    storagePolicyCopyInfo

    deferAuxiliaryCopyDays

    To defer the Auxiliary Copy operation by 'n' days.

    storagePolicyCopyInfo

    hardWareCompression

    To enable hardware compression when the library associated with the storage policy is tape library.

    storagePolicyCopyInfo

    provisioningPolicyName

    To specify the name of the Provisioning Policy that you want to use for Storage Provisioning.

    storagePolicyCopyInfo

    vFilerName

    Specify the name of the vFiler.

    storagePolicyCopyInfo

    throttleNetworkBandWidthMBHR

    Enhancing backup performance by reducing network bandwidth overhead.

    Valid values are 1 - no limit.

    storagePolicyCopyInfo

    storagePolicyName

    Name of the storage policy copy.

    StoragePolicyCopy

    timeValue

    Use this parameter to specify the date after which the backup data will be copied from the primary copy to the secondary copy. This date can be on, before, or after the current CommServe date.

    Valid values are: yyyy-mm-dd.

    startTime

    multiplexSourceStreams

    Use this parameter if you want to concurrently run Auxiliary Copy operation of multiple data streams to the same media.

    copyFlags

    combineStreams

    Use this parameter to enable combining source data streams during an Auxiliary Copy operation.

    copyFlags

    switchIfOffline

    Use alternate data path when a resource is offline.

    copyFlags

    switchIfBusy

    Use alternate data path when all the drives in the library attached to the preferred MediaAgent are busy.

    copyFlags

    markMediaToBeErasedAfterRecycling

    If you enabled this parameter for the storage policy copy using removable media (tape media), the media will be marked for erase, when the media is recycled.

    copyFlags

    roundRobbinDataPath

    Automatically load balance between all the available data paths.

    copyFlags

    inlineAuxCopy

    Enables inline copy on a storage policy copy.

    Valid values are: 1 (enable) and 0 (disable).

    copyFlags

    enableParallelCopy

    Enables parallel copy on a storage policy copy.

    Valid values are: 1 (enable) and 0 (disable).

    copyFlags

    autoAddDataPaths

    Automatically adds the alternate data paths for a shared library.

    copyFlags

    noInlineCopyToSameLibrary

    Prevents a job from being copied when the library of the primary copy is same as the library of the inline copy.

    Valid values are: 1 (enable) and 0 (disable).

    copyFlags

    noAuxCopyToSameLibrary

    Prevents a job from being copied when the library of the source copy is same as the library of the secondary copy.

    Valid values are: 1 (enable) and 0 (disable).

    copyFlags

    storeKeyOnMedia

    To enable direct media access via media password option.

    1 (enable), 0 (disable), and 2 (to use the existing setting).

    copyFlags

    siloCopy

    Option to enable creation of Silo Copy.

    Valid values are: 1 (enable) and 0 (disable).

    copyFlags

    preserveEncryptionModeAsInSource

    For an auxiliary copy operation, data is copied to secondary storage with the existing cipher that was used to encrypt the backup data.

    Valid values are: 1 (enable) and 0 (disable).

    copyFlags

    auxCopyReencryptData

    Re-encrypts data using selected cipher.

    Valid values are: 1 (enable) and 0 (disable).

    copyFlags

    storePlainText

    The backup data is stored as plain text on the secondary storage during auxiliary copy operation.

    Valid values are: 1 (enable) and 0 (disable).

    copyFlags

    encryptOnNetworkUsingSelectedCipher

    The backup data to be copied is encrypted during transmission and then stored as plain text on the secondary storage.

    Valid values are: 1 (enable) and 0 (disable).

    copyFlags

    wormCopy

    Enables WORM copy on the storage policy copy.

    Valid values are: 1 (enable) and 0 (disable).

    Once you enable WORM copy option, you cannot disable this option on a storage policy copy.

    copyFlags

    enableMediaRefresh

    Use this parameter to enable media refresh for the copy.

    copyFlags

    useStreamsOverMultiplexing

    If enabled, the data streams are copied to each available drives first and then fills up the used up drives (spill and fill). If disabled, all the data streams are copied to one drive and once it is filled up, moves to the next drive (fill and spill).

    Valid values are: 1 (enable) and 0 (disable).

    copyFlags

    secondarySiloCopy

    To create secondary silo copy.

    Valid values are: 1 (enable) and 0 (disable).

    extendedFlags

    chunkLevelAuxCopy

    If enabled, when an auxiliary copy job with the Use Scalable Resource Allocation option enabled is performed during a backup job, the data available on the primary copy is picked for copy by the running auxiliary copy job. This option causes the auxiliary copy operation to create the secondary copy faster. This option saves time for the auxiliary copy operation, especially when the backups running are huge.

    Valid values are: 1 (enable) and 0 (disable)

    extendedFlags

    spaceOptimizedAuxCopy

    By default, the deduplication percentage is low on the storage policy copy compared to the percentage on the primary copy, because multiple streams are used for high-speed data transfer.

    If you enable this option, the storage policy copy achieves an optimized deduplication percentage during auxiliary copy operations. With this option, the auxiliary copy operation achieves a higher deduplication percentage by first copying full backups or synthetic full backups, followed by incremental backups or differential backups.

    Valid values are: 2 (enable) and 0 (disable)

    extendedFlags

    libraryName

    Name of the default library where primary copy is created.

    You must use drivePoolName and the spareMediaGroupName when creating storage policy copies for Plug and Play libraries.

    library

    mediaAgentName

    Name of the MediaAgent that is used to create the primary copy.

    mediaAgent

    drivePoolName

    Specify the drive pool name for a tape library.

    drivePool

    libraryName

    Library name to be used as data path on a storage policy copy.

    spareMediaGroup

    spareMediaGroupName

    Specify the scratch pool name for a tape library.

    spareMediaGroup

    allJobs

    All backup jobs on the storage policy copy are verified when a data verification operation is run.

    Valid values are: 1 (enable) and 0 (disable).

    dataVerification

    allFullJobs

    All FULL backup jobs on the storage policy copy are verified when a data verification operation is run.

    Valid values are: 1 (enable) and 0 (disable).

    dataVerification

    verificationExpiresAfterMonths

    The number of months for which the data verification is valid.

    Valid values are: Number of months.

    dataVerification

    timeValue

    The backup data after the specified date is verified on the storage policy copy when a data verification operation is run.

    Valid values are: yyyy-mm-dd.

    jobsOnOrAfterDate

    encryptData

    Enables data encryption options on the storage policy copy.

    Valid values are: 1 (enable) and 0 (disable).

    dataEncryption

    encryptionType

    The cipher to use for data encryption.

    Valid values are:

    • DES3
    • AES
    • Blowfish
    • GOST
    • Serpent
    • TwoFish

    dataEncryption

    encryptionKeyLength

    The key length to use with the cipher in the CipherType parameter.

    Valid values for:

    • 3-DES cipher
      • 192
    • AES (Rijndael), GOST, Blowfish, Serpent, and TwoFish ciphers
      • 128
      • 256

    dataEncryption

    viaMediaPassword

    To enable direct media access via media password option.

    Valid values are: 1 (enable) and 0 (disable).

    dataEncryption

    keyProviderName

    The name of the key provider.

    A copy gets associated with Commvault key management server by default during creation. To associate the copy to a third-party key management server, specify the key provider name.

    dataEncryption

    rotateMasterKey

    To rotate the master key when third-party key management is used.

    The value is set to 1 by default. Do not change the value.

    dataEncryption

    retainBackupDataForDays

    Number of days to retain the data of the copy.

    retentionRules

    retainBackupDataForCycles

    Number of cycles to retain the data of the copy.

    retentionRules

    retainArchiverDataForDays

    Number of days to retain the Archiver data of the copy.

    retentionRules

    jobs

    Number of jobs that needs to be retained for Snapshot or Snap Vault or Snap Mirror copies.

    retentionRules

    extendedRetentionFirst

    To use extended retention.

    Valid values are:

    1 - To retain first full backup job of the time period.

    0 - To retain last full backup job of the time period.

    retentionFlags

    enableDataAging

    To disable data aging. The Data Aging is enabled by default. If you disable data aging, data in the copy is retained for infinite time.

    retentionFlags

    enableManagedDiskSpace

    Enables managed disk space threshold for the copy.

    retentionFlags

    selectJobsFromPreviousTier

    The option to select the jobs from previous tier.

    Valid values are: 1 (enable) and 0 (disable).

    retentionFlags

    retainFullAndLastDifferential

    Enable this parameter if you do not want to retain intermediate incremental and differential copies preceding a new differential. This is useful to minimize wasted disk space.

    retentionFlags

    jobBasedRetention

    Job based retention criteria for Snapshot or Snap Vault or Snap Mirror copies.

    retentionFlags

    endDays

    Use this parameter to specify number of days to retain a backup data in a copy.

    This parameters enable extended retention for a copy.

    For infinite retention set value as -1.

    Note: If you want to enable more than one rule for extended retention, ensure that the values in rules are specified in the ascending order.

    endDays for extendedRetentionRuleOne < endDays for extendedRetentionRuleTwo < endDays for extendedRetentionRuleThree

    extendedRetentionRuleOne

    extendedRetentionRuleTwo

    extendedRetentionRuleThree

    graceDays

    Specify number of grace period. Valid values are:

    • For EXTENDED_ALLFULL rule, set the value to 0.
    • For EXTENDED_WEEK rule, set between 0 - 3
    • For EXTENDED_MONTH rule, set between 0 - 7
    • For EXTENDED_QUARTER rule, set between 0 - 15
    • For EXTENDED_HALFYEAR rule, set between 0 - 30
    • For EXTENDED_YEAR rule, set between 0 -45

    extendedRetentionRuleOne

    extendedRetentionRuleTwo

    extendedRetentionRuleThree

    isEnabled

    Use this parameter, to enable/disable extended retention for a copy. Valid values are:

    • 0 - Use this value to disable the parameter.
    • 1 - Use this value to enable the parameter.
    • 2 - Use this value if you do not want to change the configuration of the parameter. If the parameter is disabled, it remains disabled. If the parameter is enabled, it remains enabled.

    extendedRetentionRuleOne

    extendedRetentionRuleTwo

    extendedRetentionRuleThree

    rule

    Use this parameter to specify extended rule for a copy. Valid values are:

    • EXTENDED_ALLFULL,  to specify extended retention rule for all full backups
    • EXTENDED_WEEK, to specify extended retention rule for weekly full backups
    • EXTENDED_MONTH, to specify extended retention rule for monthly full backups
    • EXTENDED_QUARTER, to specify extended retention rule for quarterly full backups
    • EXTENDED_HALFYEAR, to specify extended retention rule for half yearly full backups
    • EXTENDED_YEAR, to specify extended retention rule for yearly full backups

    extendedRetentionRuleOne

    extendedRetentionRuleTwo

    extendedRetentionRuleThree

    monthStartsOn

    The days on month to use the EXTENDED_MONTH rule.

    Valid values are: 1 - 31.

    financialCalendarXML

    weekStartsOn

    Valid values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY and SUNDAY.

    financialCalendarXML

    multiplexingFactor

    Value for multiplexing factor when multiplexing is enabled on the copy.

    mediaProperties

    numberOfStreamsToCombine

    Specifies the number to which all the source streams are combined.

    For example : If one stream is specified, then the auxiliary copy operation will copy the data from all streams to one data stream.

    mediaProperties

    percentage

    Option to specify the media capacity in percentage. Media with data less than or equal to this capacity will be picked up for refresh.

    mediaRefreshProperties

    enableMediaRetirementThreshold

    Option to refresh media that exceeded the retirement threshold.

    Valid values are: 1 (enable) and 0 (disable).

    refreshFlags

    months

    Option to specify the number of months for media refresh. Media that were not written in the specified number of months will be picked up for refresh.

    monthsAfterMediaWritten

    months

    Option to specify the number of months for data aging. Media with specified number of months or more before aging will be picked up for refresh.

    monthsBeforeMediaAged

    selectiveRule

    Option to specify selective copy rules. Valid values are:

    • SELECTIVE_ALLFULL
    • SELECTIVE_DAY
    • SELECTIVE_WEEK
    • SELECTIVE_MONTH
    • SELECTIVE_QUARTER
    • SELECTIVE_HALFYEAR
    • SELECTIVE_YEAR
    • SELECTIVE_ADVANCED

    selectiveCopyRules

    weekDayStartsOn

    Specify the starting day of the week in which data is eligible to be copied to the selective copy for Weekly Full rule.

    Valid values are: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday.

    selectiveCopyRules

    monthStartsOn

    Specify the starting day of the month data is to be copied to the selective copy for a monthly full rule.

    Valid values are: 1 - 31.

    selectiveCopyRules

    everyXCycles

    Specify that the full backup after the specified number of cycles to be picked to copy.

    selectiveCopyRules

    everyXHours

    Specify that the full backup after the specified number of hours to be picked to copy.

    selectiveCopyRules

    everyXDays

    Specify that the full backup after the specified number of days to be picked to copy.

    selectiveCopyRules

    everyXWeeks

    Specify that the full backup after the specified number of weeks will be picked to copy.

    selectiveCopyRules

    everyXMonths

    Specify that the full backup after the specified number of months will be picked to copy.

    selectiveCopyRules

    lastFull

    Option to specify that the last full backup of the selected time period will be copied from the source copy to this copy.

    copyFlags

    lastFullWait

    Option to specify that the last full backup after the end of the specified time period will be copied from the source copy to this copy.

    Note: You cannot use lastFull and lastFullWait elements together.

    copyFlags

    doNotAutomaticallySelectJobs

    Option to disable automatic selection of jobs to copy. When enabled no backups will be copied to the storage policy copy

    selectiveCopyRules

    moveJobSelectionStartTime

    Option to modify the starting time of the selection period.

    selectiveCopyRules

    enableAuxCopyFallenBehindAlert

    To enable Auxiliary Copy fallen behind alert option on the storage policy copy.

    Valid values are: 1 (enable) and 0 (disable).

    auxCopyFallenBehind

    enableToBeCopiedDataTB

    To enable to be copied data over n TB option on the storage policy copy. When enabled an alert is generated when the data to be copied for this storage policy copy exceeds the specified threshold.

    Valid values are: 1 (enable) and 0 (disable).

    auxCopyFallenBehind

    toBeCopiedDataTB

    The option to set the size in terabyte for to be copied data option.

    Use this parameter when enableToBeCopiedDataTB is enabled.

    auxCopyFallenBehind

    enableDaysOldJobs

    To enable Jobs are not copied over n days option on the storage policy copy.

    When enabled an alert is generated if the number of days that the jobs have not been copied exceeds the specified number of days.

    Valid values are: 1 (enable) and 0 (disable).

    auxCopyFallenBehind

    daysOldJobs

    The option to set number of days for Jobs are not copied over n days option.

    Use this parameter when enableDaysOldJobs is enabled.

    auxCopyFallenBehind

    enableHoursToCopyData

    To enable More than n hours required to copy all data option on the storage policy copy.

    When enabled an alert is generated if the system predicts that the Auxiliary Copy operation exceeds the number of hours specified.

    Valid values are: 1 (enable) and 0 (disable).

    auxCopyFallenBehind

    hoursToCopyData

    The option to set number of hours for More than n hours required to copy all data option.

    Use this parameter when enableHoursToCopyData is enabled.

    auxCopyFallenBehind

    copyName

    Specify source copy name for Silo copy.

    sourceCopy

    storagePolicyName

    Specify storage policy name on which the Silo copy needs to be created.

    sourceCopy

    useDDBPrimingOption

    Use this parameter if you want to refer previously sealed DDBs to identify and use existing data blocks to prime the baseline for the current DDB.

    dedupeFlags

    enableDeduplication

    Option to enable deduplication.

    Valid values are: 1 (enable) and 0 (disable).

    dedupeFlags

    temporarilyDisableDeduplication

    Option to temporarily suspend deduplication.

    Valid values are: 1 (enable) and 0 (disable).

    dedupeFlags

    enableClientSideDedup

    Option to enable Source-Side deduplication.

    Valid values are: 1 (enable) and 0 (disable).

    dedupeFlags

    backupSiloEnabled

    Option to enable creation of Silo copy.

    Valid values are: 1 (enable) and 0 (disable).

    dedupeFlags

    isSilosToBeKeptInCache

    Enables number of silos to be kept in the cache option on the Silo copy.

    Valid values are: 1 (enable) and 0 (disable).

    dedupeFlags

    enableDASHFull

    Reduce CPU and disk I/O usage by using Accelerated Synthetic Full (DASH Full).

    Valid values are: 1 (enable) and 0 (disable).

    dedupeFlags

    enableSiloDiskSpaceManagement

    Option to enable Silo space management on the disk media.

    Valid values are: 1 (enable) and 0 (disable).

    dedupeFlags

    pauseAndRecoverCurrentDDB

    Option to recover an offline DDB by manually reconstructing the DDB. If an offline active DDB is detected, all jobs on that copy are paused until the DDB is manually reconstructed.

    Valid values are: 1 (enable) and 0 (disable).

    dedupeFlags

    automaticallyPauseAndRecoverDDB

    Option to automatically restore the DDB from the last completed DDB backup which was backed up using DDB subclient.

    dedupeFlags

    useGlobalDedupStore

    Use this parameter when associating a copy to global deduplication policy.

    Valid values are: 1 - to associate, 0 - to not associate.

    dedupeFlags

    mediaAgentName

    Name of the MediaAgent where deduplication database is located.

    <DDBPartitionInfo> / <maInfoList> / MediaAgent

    diskFreeThresholdMB

    The total amount of free space that must be available at all times in the volume in which the DDB is configured.

    subStoreList

    diskFreeWarningThreshholdMB

    The amount of free space in the volume in which the DDB is configured at which a warning must be generated. If the amount of free space falls below the specified amount, the system generates an event message and generates the MediaAgents (Disk Space Low) alert, if configured.

    subStoreList

    path

    The location of the DDB on a MediaAgent.

    accessPath

    mediaAgentName

    MediaAgent name hosting the DDB.

    mediaAgent

    copyName

    Name of the silo copy.

    sidbStoreInfo

    enableNumberOfSilosToBeKeptInCache

    Use this parameter to enable number of silos to be maintained in the local cache.

    sidbStoreInfo

    numberOfSilosToBeKeptInCache

    Number of recently moved silos to be maintained in the local system cache.

    sidbStoreInfo

    enableSoftwareCompression

    Use this parameter to enable software compression for a copy.

    sidbStoreFlags

    mediaAgentName

    The source MediaAgent that is used to perform the silo restore.

    mediaAgentForSiloRestores

    mediaAgentName

    The client name of the destination MediaAgent to which the silo disk volumes are restored.

    destinationClientForSiloRestores

    mediaAgentName

    Name of the MediaAgent hosting the DDB.

    createNewDDBOptions

    createNewDDBeveryXdays

    To create a new DDB based on the time interval in days.

    createNewDDBOptions

    days

    Provide the interval in number of days.

    createNewDDBOptions

    createNewDDBeveryXtb

    To create a new DDB based on the disk volume.

    createNewDDBOptions

    tb

    Provide the volume size in TB

    createNewDDBOptions

    createNewDDBeveryXmonths

    To create a new DDB based on the time interval in months.

    createNewDDBOptions

    months

    Provide the interval in months.

    createNewDDBOptions

    timeValue

    Provide starting date for DDB creation.

    startingFromDate

    resourcePoolName

    Name of the resource pool available in the OnCommand Unified Manager server.

    resourcePoolsList

    storagePolicyName

    Name of the global deduplication policy.

    useGlobalPolicy

    generateXML

    Option to export the properties of a storage policy copy as an XML file.

    Valid values are: 1 (enable) and 0 (disable).

     

    filePath

    Directory location to export the XML file with the storage policy copy properties. You can also specify the file name along with the directory location. If you do not specify the file name, an XML file with the name CreateCopy_<SPName><CopyName>_Prop.xml will be created in the given location.

    storagePolicyCopyInfo

Last modified: 7/9/2019 2:53:48 PM