Available Data Protection for Exchange 6.1.1 commands for use with Tivoli Storage FlashCopy® Manager

News


Abstract

New and updated commands are being provided for Data Protection for Exchange CLI.

Do differential and incremental VSS backups through the tdpexcc backup, tdpexcc restore, and tdpexcc query commands.

Local policy management and configuration is provided through the create policy, update policy, copy policy, query policy, and delete policy commands.

The query managedcapacity command gives customers the ability to query the details of their managed capacity at any time. This command can be scheduled to produce a history of managed capacity usage. The interactive and historical data can be used in the license renewal process.

The delete backup command allows you to delete one or more VSS backup objects.

Content

Data Protection for Exchange is adding function for differential and incremental VSS backups through these commands:

  • tdpexcc backup
  • tdpexcc restore
  • tdpexcc query

Differential and incremental VSS backups allow you to send the changes that help lower the storage requirements.

NOTE: Storage group names are case-sensitive. If you use the wrong case for a group name, the storage group is not found and an error message states that the storage group is not ready and does not exist.


TDPEXCC BACKup command
    The tdpexcc backup command allows differential and incremental VSS backups. The BACKUP command syntax remains unchanged. For the complete syntax and description of the tdpexcc backup command, reference the Data Protection for Microsoft Exchange Server Installation and User's Guide.

Syntax

>>- TDPEXCC BACKup -------------------->

>------+-----------------------------+----->
    '--------------* --------------'
    '-sg-name, sg-name--------'
>------+-----------------------------+----->
    '--------INCRemental-------'
    '--------DIFFerential--------'

    .-/BACKUPDESTination-=-TSM----.
>------+-------------------------------------+->
    '-/BACKUPDESTination-=-LOCAL--'
    '-/BACKUPDESTination-=-BOTH---'
    .-/BACKUPMETHod-=---LEGACY---.
>------+-------------------------------------+->
    '-/BACKUPMETHod-=--VSS--------'


Tdpexcc backup example of a differential VSS backup
    TDPEXCC BACKup “Second Storage Group” DIFFerential
    /BACKUPDESTination=TSM /BACKUPMETHod=VSS


TDPEXCC RESTore command
    The tdpexcc restore command restores from a differential VSS backup or an incremental VSS backup. The RESTORE command syntax remains unchanged. For the complete syntax of the tdpexcc restore command, reference the Data Protection for Microsoft Exchange Server Installation and User's Guide.

Syntax

>>- TDPEXCC RESTore ----------------------->

>------+-----------------------------+---------->
    '--------------* --------------'
    '-sg-name, sg-name--------'

>------+-----------------------------+---------->
    '--------INCRemental-------'
    '--------DIFFerential--------'

    .-/BACKUPDESTination-=-backupdestination or tdpexc.cfg-.
>------+-----------------------------------------------------------------+->
    '-/BACKUPDESTination-=-TSM---------------------------------'
    '-/BACKUPDESTination-=-LOCAL------------------------------'

    .-/BACKUPMETHod-=-backupmethod or tdpexc.cfg-.
>------+---------------------------------------------------------+->
    '-/BACKUPMETHod-=--LEGACY------------------------'
    '-/BACKUPMETHod-=--VSS-----------------------------'

Tdpexcc restore example
    TDPEXCC RESTore “Second Storage Group” DIFFerential
      /BACKUPDESTination=TSM /BACKUPMETHod=VSS


TDPEXCC Query command
The tdpexcc Query command displays information of the VSS backup. The Query command syntax remains unchanged. For the complete syntax of the tdpexcc query command, reference the Data Protection for Microsoft Exchange Server Installation and User's Guide.

Tdpexcc query example
This example provides a sample of the text that displays when using a variation of the tdpexcc query command.

Syntax

>>- TDPEXCC Query --- TSM ---------------->

>------+-----------------------------+---------->
    '--------------* --------------'
    '-sg-name, sg-name--------'


Command:
Tdpexcc query tsm “Second Storage Group”


Output:

Querying Tivoli Storage Manager server for a list of database backups, please wait...

Connecting to TSM Server as node ''CASSINIDP'...

                           
Backup List
                           
-----------

 
Exchange Server  : CASSINI

 
Storage Group    : Second Storage Group

Backup Date                     Size             S     Fmt   Type   Loc     Object Name/Database Na m e
----------------
---------  ------------  -  ----  ----   ----   ---------------------------
01/12/2009 22:43:17       41.02MB A Lgcy full    Srv     20090112224317
                                    38.02MB                            brovar_mdb
                                3,072.40KB                            Logs
02/03/2009 13:25:22      45.02MB A VSS  full   Srv   200902031323522
                                7,176.00KB                            Logs
                                    38.02MB                            brovar_mdb
02/04/2009 13:25:22      45.02MB A VSS  full   Srv   200902041323522
                                4,144.00KB                            Logs

_______________________________________________________

Policy Management CLI

Data Protection for Exchange provides support for local policy management and configuration. The user is able to manage policy through the use of the CLI and the GUI. The CLI is covered in the technote. The GUI information is provided through the FlashCopy® Manager online help. If you are a Data Protection for Exchange 6.1.1 customer and do not have FlashCopy® Manager, the online help is available to you.

The new commands to manage local policy are create policy, update policy, copy policy, query policy, and delete policy commands. These commands are available only when running in a tsm server-independent environment.


Create policy command
This command creates a new local policy. This command is visible and functional when the FlashCopy® Manager is working locally and is in a stand-alone environment. It does not function when FlashCopy® Manager is working with TSM Server.

Syntax

>>- TDPEXCC CREATE POLicy-- policy_name-------->
    .- /VERSretain--=--2--------------.
>------+-----------------------------------+---------------->
    '- /VERSretain--=--+-number-+-'
    '-NOLimit---------------------------'
    .- /DAYSretain--=--30------------.
>------+-----------------------------------+---------------->
    '- /DAYSretain--=--+-number-+-'
    '-NOLimit-------------------------- '

>------+-------------------------------------+-------------->
    '- /FCMOPTFile--=--+-optionFile-+-'



Create policy positional parameters
policy_name
Specifies the name of the policy that is being created.


Create policy optional parameters
Optional parameters follow the create command and positional parameters.


/VERSretain=number | NOLimit
The versretain parameter determines the number of snapshot versions to retain. The default value is 2.

Considerations:
  • If you specify number, it can range from 1 to 9999.
  • If you specify nolimit, then all the snapshot versions are retained.
  • The versretain parameter maintains control of the number of versions that are retained until that number exceeds the retention time that is specified by DAYSretain.

/DAYSretain= number | NOLimit
The daysretain parameter determines the number of days to retain a snapshot. The default value is 30.

Considerations:
  • If you specify number, it can range from 0 to 9999.
  • If you specify nolimit, then the snapshot versions are deleted based on the value assigned to the versretain parameter.

/ FCMOPTFile= optionFile
The FCMOPTFile parameter identifies the Data Protection for Exchange options file.


Update policy command
This command updates or modifies the retention parameters of an existing policy. This command is visible and functional when the FlashCopy® Manager is working locally and is in a stand-alone environment. It does not function when FlashCopy® Manager is working with TSM Server.


Syntax


>>- TDPEXCC UPDATE POLicy-- policy_name------->

>------+-----------------------------------+--------------->
    '- /NEWname----=--+-string--+-'

>------+-----------------------------------+--------------->
    '- /VERSretain-=--+-number--+-'
    '-NOLimit---------------------------'

>------+-----------------------------------+--------------->
    '- /DAYSretain-=--+-number--+-'
    '-NOLimit---------------------------'

>------+-------------------------------------+-------------->
    '- /FCMOPTFile--=--+-optionFile-+-'

Update policy positional parameters

policy_name
Specifies the name of the policy that is being updated.


Update policy optional parameters
Optional parameters follow the update command and positional parameters.


/NEWname= string
Use the /newname parameter to update the name of the policy.


/VERSretain=number | NOLimit
Use the versretain parameter to specify the number of snapshot versions to retain.

Considerations:
  • If you specify number, it can range from 1 to 9999.
  • If you specify nolimit, then all the snapshot versions are retained.
  • The versretain parameter maintains control of the number of versions that are retained until that number exceeds the retention time that is specified by DAYSretain.


/DAYSretain= number | NOLimit
Use the daysretain parameter to specify the number of days to retain a snapshot.

Considerations:
  • If you specify number, it can range from 0 to 9999.
  • If you specify nolimit, then the snapshot versions are deleted based on the value assigned to the versretain parameter.

/ FCMOPTFile= optionFile
Use the FCMOPTFile parameter to specify the Data Protection for Exchanage options file.

Copy policy command
This command copies an existing policy to a new policy. This command is visible and functional when the FlashCopy® Manager is working locally and is in a stand-alone environment. It does not function when FlashCopy® Manager is working with TSM Server.

Syntax

>>- TDPEXCC COPY POLicy-- existing_policy_name--new_policy_name->

>------+-------------------------------------+-------------->
    '- /FCMOPTFile--=--+-optionFile-+-'

Copy policy positional parameters

existing_policy_name
This parameter specifies the name of the policy that is being copied.

new_policy_name
This parameter specifies the name of the new policy.

Copy policy optional parameters

/ FCMOPTFile= optionFile
This parameter identifies the Data Protection for Exchange options file.



Query policy command
This command lists the attributes of a policy. This command is visible and functional when the FlashCopy® Manager is working locally and is in a stand-alone environment. It does not function when FlashCopy® Manager is working with TSM Server.


Syntax
>>- TDPEXCC Query POLicy -- policy_name----------------->


Query policy positional parameters
policy_name
This parameter specifies the name of the policy that is being queried.


Query output examples

Command:
query policy Default

Output:

Policy Name: Default
Number of snapshot versions to retain: 3
Number of days to retain a snapshot: 30




Delete policy command
This command deletes a policy. This command is visible and functional when the FlashCopy® Manager is working locally and is in a stand-alone environment. It does not function when FlashCopy® Manager is working with TSM Server.


Syntax
>>- TDPEXCC DELete POLicy-- policy_name--------------------->

>------+-------------------------------------+-------------->
    '- /FCMOPTFile--=--+-optionFile-+-'

Delete policy positional parameters
policy_name
This parameter specifies the name of the policy that is being deleted.

Delete policy optional parameters

/ FCMOPTFile= optionFile
This parameter identifies the Data Protection for Exchange options file.


__________________________________________________________________________


Query MANAGEDCAPacity command

The query managedcapacity command displays capacity related information about the volumes represented in FlashCopy® Manager’s locally managed inventory. The Query Managedcapacity command is invoked through the Command Line or GUI clients.

Supported Clients
This command is valid for all Windows platforms supported by FlashCopy® Manager. This command is only valid and visible when FlashCopy® Manager is installed. It is not valid and is not displayed if Data Protection is installed without FlashCopy® Manager. This command is available only when running in a tsm server-independent environment.

Note
The formatting of values adheres to the selected regional settings specified in the Data Protection client configuration files.

Syntax
>>-TDPEXCC Query MANAGEDCAPacity----------------->

>-----+----------------------------+------------------------>

    '- /Detailed ---------------'



Query Managedcapacity Optional Parameters:

Table 1. Query MANAGEDCAPacity command: Related options
Option Where to use
Detailed Command line only.

detailed
Results in a detailed listing of snapped volumes. If this option is not specified, then only the total capacity is displayed.


Query Managedcapacity output examples
These output examples provide a sample of the text that displays when using the query managedcapacity command. The capacity values are displayed with the rounded value followed by the actual byte value.

Command:
query managedcap

Output:
Total Managed Capacity : 127.00 GB (136,361,013,248 bytes)



Command:
query managedcapacity /detailed

Output:
Total Managed Capacity : 127.00 GB (136,361,013,248 bytes)

Volume : C:
Managed Capacity : 127.00 GB (136,361,013,248 bytes)



__________________________________________________________________________


DELete BACKUP command

Use the delet e backup command to delete one or more VSS backup objects.

Delete syntax

TDPEXCC DELete BACKUP * | sgname [,sgname,…] backuptype

 
 
Delete positional parameters
Positional parameters immediately follow the delet e backup command and precede the optional parameters.

The following positional parameters specify the storage groups to delete:

* | sg-name
    * Delete the backups for all the storage groups.

    sg-name Delete the backup for the specified storage group. Multiple entries are separated by commas. If separated by commas, make sure there is no space between the comma and the storage group name. If any storage group contains commas or blanks, enclose the storage group name in double quotation marks.

backuptype
The following positional parameters specify the backup type:

FULL | COPY | INCRemental | DIFFerential
    FULL (VSS only)
      Delete a full type backup.
    COPY (VSS only)
      Delete a copy type backup.
    INCRemental (VSS only)
      Delete an incremental type backup.

    DIFFerential (VSS only)
      Delete a differential type backup.


Delete Optional Parameters:

[ /BACKUPDESTination=LOCAL|TSM]

[ /CONFIGfile=tdpexc.cfg | filename]

[ /FROMEXCSERVer=servername]

[ /LOGFile=tdpexc.log | logfilename]

[ /LOGPrune= numdays | No ]

[ /OBJect=object ]

[ /Quiet]

[ /TSMNODe=nodename]

[ /TSMOPTFile=dsm.opt | filename]

[ /TSMPassword=password]




Delete optional parameters
Optional parameters follow the delete command and positional parameters.

/BACKUPDESTination=TSM | LOCAL
    Use the /backupdestination parameter to specify the location of the backup. The default is the value (if present) specified in the Data Protection for Exchange preferences file (tdpexc.cfg). If no value is present, the backup is deleted from Tivoli Storage Manager server storage.
    You can specify:
    TSM - The backup is located at the Tivoli Storage Manager server storage.
    LOCAL – The backup is located at the local shadow volumes.
/CONFIGfile= filename | tdpexc.cfg
    Use the /configfile parameter to specify the name of the Data Protection for Exchange configuration file that contains the values to use for a delete operation.
    The filename variable can include a fully qualified path. If the filename variable does not include a path, the Data Protection for Exchange installation directory is used. If the /configfile parameter is not specified, or if the filename variable is not specified, the default value is tdp exc.cfg.

    If the filename variable includes spaces, enclose the entire /configfile parameter entry in double quotation marks. For example:
      /CONFIGfile="c:\Program Files\file.cfg"

/ FROM EXCSERV er= server-name
    Use the / from exc server parameter to specify the name of the Exchange server containing the specified backup objects to be deleted.

    The default value is the local Exchange Server.


/LOGFile=logfilename | tdpexcl.log
    Use the / logfile parameter to specify the name of the activity log file that is generated by Data Protection for Exchange.

    The logfilename variable identifies the name of the activity log file.

    If the specified log file does not exist, a new log file is created. If the specified log file exists, new log entries are appended to the file. The logfilename variable can include a fully-qualified path. However, if no path is specified, the log file is written to the Data Protection for Exchange installation directory.

    If the logfilename variable includes spaces, enclose the entire /logfile parameter entry in double quotation marks. For example:
      /LOGFILE="c:\Program Files\mytdpexchange.log"
    If you do not specify the /logfile parameter, log records are written to the default log file, tdpexc.log.

    The /logfile parameter cannot be turned off, logging always occurs.

    When using multiple simultaneous instance of Data Protection for Exchange to perform operations, use the /logfile parameter to specify a different log file for each instance used. this directs logging for each instance to a different log file and prevents interspersed log file records. Failure to specify a different log file for each instance can result in unreadable log files.

/LOGPrune= numdays| No
    Use the /logprune parameter to specifically request that the log be pruned for one command run or to disable log pruning. By default, log pruning is enabled and performed once per day. The numdays variable represents the number of days to save log entries. By default, 60 days of log entries are saved in the pruning process. You can use the Data Protection for Exchange GUI or the set command to change the defaults so that log pruning is disabled, or so that more or less days of log entries are saved. If you use the command line, you can use the /logprune parameter to override these defaults. When the value of the numdays variable is a number in the range 0 to 9999, the log is pruned even if log pruning has already been performed for the day.

    Changes to the value of the timeformat or dateformat parameter can result in the log file being pruned unintentionally. If the value of the timeformat or dateformat parameter has changed prior to issuing a Data Protection for Exchange command that might prune the log file, perform one of the following actions to prevent the log file from being pruned:
    • Make a copy of the existing log file.
    • Specify a new log file with the /logfile parameter or logfile setting.

    Considersations:
    • If you do not specify /logprune, the default value is that specified by the logprune configurable option in the Data Protection for Exchange configuration file. This default value is initially 60.
    • If you specify /logprune, its value is used instead of the value stored in the Data Proection for Exchange configuration file. Specifying this parameter does not change the value in the configuration file.
    • You can specify /logprune without specifying numdays or no. In this case, the default value of 60 is used.


/OBJect=objectname
    Use the /object parameter to specify the name of the backup object you want to delete. The objectname variable specifies the name of the backup object to be deleted. The default is the current active object.

    Use the Data Protection for Exchange query tsm command to view the names of the backup objects.

/Quiet
    Use the /quiet parameter to prevent status information from being displayed.

/TSMNODe=tsmnodename
    Use the tsmnodename variable to refer to the Tivoli Storage Manager node name that Data Protection for Exchange uses to log on to the Tivoli Storage Manager server. You can store the node name in the Tivoli Storage Manager options file (dsm.opt). This parameter overrides the value in the Tivoli Storage manager options file if PASSWORDACCESS is set to PROMPT. This parameter is not valid when PASSWORDACCESS is set to GENERATE in the options file.


/TSMOPTFile= t smoptfilename | dsm.opt
    Use the t smoptfilename variable to identify the Data Protection for Exchanage options file.

    The t smoptfilename variable can include a fully qualified path name. If you do not specify a path, the directory where Data Protection for Exchange is installed is searched.

    If the t smoptfilename variable includes spaces, enclose the entire /tsmoptfile parameter entry in double quotation marks. For example:
      /TSMOPTFile="c:\Program Files\file.opt"
    If you do not specify the /tsmoptfile option, the default value is dsm.opt. If you specify specify the /tsmoptfile but you do not provide a t smoptfilename, the default value is also dsm.opt.


/TSMPassword= tsmpassword
    Use the tsmpassword variable to refer to the Tivoli Storage Manager password that Data Protection for Exchange uses to log on to the Tivoli Storage Manager server. This parameter and the option PASSWORDACCESS in the Tivoli Storage Manager options file interact in the following ways:

    /tsmpassword
    PASSWORDACCESS
    In Tivoli Storage
    Manager options file
    (dsm.opt)
    Password already
    Stored in registry?
    Result
    specified
    generate
    yes
    /tsmpassword ignored
    specified
    generate
    no
    /tsmpassword used and stored
    specified
    prompt
    --
    /tsmpassword used
    not specified
    prompt
    --
    user is prompted
    The Tivoli Storage Manager password that Data Protection for Exchange uses to log on to the Tivoli Storage Manager server can be up to 63 characters in length.

Rate this page:

(0 users)Average rating

Add comments

Document information


More support for:

Tivoli Storage Manager for Mail
Data Protection for MS Exchange

Software version:

6.1.1

Operating system(s):

Windows

Software edition:

All Editions

Reference #:

1394725

Modified date:

2010-07-08

Translate my page

Machine Translation

Content navigation