Available Data Protection for SQL 5.5.3 commands for use with Tivoli Storage FlashCopy® Manager

News


Abstract

New commands are being added for Data Protection for SQL CLI.

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 command allows you to delete one or more VSS backup objects.

Content


    Policy Management CLI

    Data Protection for SQL 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 c reate policy, u pdate policy, c opy policy, q uery policy, and d elete 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

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



      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

      >>- 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.


    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

      >>- 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
        >>- 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
        >>- 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
        >>-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 delete backup command to delete one or more VSS backup objects.

      NOTE: The database name is case-sensitive. If you use the wrong case for a database name, the database is not found and an error message is given.
        Delete syntax
        TDPSQLC DELete BACKUP * |dbname [,dbname,…] FULL

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

        The following positional parameters specify the databases to delete:

        * | dbname
          * Delete the backups for all the database names.

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

        F ULL
          Delete backups of an entire server database.

        Delete Optional Parameters:
        /BACKUPDESTination=LOCAL|TSM

        /CONFIGfile= configfilename

        /FROMSQLserver= sqlservername

        /LOGFile= logfilename

        /LOGPrune= numdays | No

        /OBJect= objectname[, objectname,...]

        /Quiet

        /TSMNODe= tsmnodename

        / TSMOPTFile= dsmoptfilename

        /TSMPassword= tsmpassword


        Delete optional parameters
          Optional parameters follow the delete backup 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 SQL preferences file (tdpsql.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= configfilename
            Use the /configfile parameter to specify the name of the Data Protection for SQL configuration file, which contains the values for the Data Protection for SQL configurable options. See the Set command for details on the file’s contents.

            Considerations:
            • configfilename can include a fully qualified path. If configfilename does not include a path, it uses the directory where Data Protection for SQL is installed.
            • If configfilename includes spaces, place it in double quotes.
            • If you do not specify /configfile, the default value is tdpsql.cfg.
          /FROMSQLserver= sqlservername
            The /fromsqlserver parameter specifies the SQL server that backup objects were backed up from. The default value is the /sqlserver value or the value set in the Data Protection for SQL configuration file.

          /LOGFile= logfilename
            The / logfile parameter specifies the name of the activity log that is generated by Data Protection for SQL. This activity log records significant events such as completed commands and error messages. The Data Protection for SQL activity log is distinct from the SQL Server error log. The logfilename variable identifies the name to be used for the activity log generated by Data Protection for SQL.

            Considerations:
            • If the specified file does not exist, it is created. If it does exist, new log entries are appended to the file.
            • The file name can include a fully-qualified path; however, if you specify no path, the file is written to the directory where Data Protection for SQL is installed.
            • You cannot turn Data Protection for SQL activity logging off. If you do not specify /logfile, log records are written to the default log file named tdpqsl.log.
            • When using multiple simultaneous instances of Data Protection for SQL 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
            The /logprune parameter prunes the Data Protection for SQL activity log and specifies how many days of entries are saved. By default, log pruning is enabled and performed once each day that Data Protection for SQL is executed; however, this option allows you to disable log pruning or explicitly request a prune of the log for one command run even if the log file has already been pruned for the day. The numdays variable represents the number of days to save log entries. By default, 60 days of log entries are saved in the prune process.

            Considersations:
            • If you specify numdays, it can range from 0 to 9999. A value of 0 deletes all entries in the Data Protection for SQL activity log file except for the current command entries.
            • If you specify no, the log file is not pruned during this command.
            • If you do not specify /logprune, the default value is that specified by the logprune configurable option in the Data Protection for SQL configuration file. This default value is initially 60.
            • If you specify /logprune, the numdays value is used instead of the value stored in the Data Protection for SQL 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.
            • Changes to the value of the timeformat or dataformat parameter can result in an undesired pruning of the Data Protection for SQL log file. If you are running a command that may prune the log file and the value of the timeformat or dataformat parameter has changed, perform one of the following to prevent undesired pruning of the log file:
              • Make a copy of the existing log file.
              • Specify a new log file with the /logfile parameter or logfile setting.

          /OBJect=objectname[,objectname,…]
            For the delete, restore, and inactivate operations, /object specifies that only particular backup objects for the specified SQL databases and backup object type (if specified) be deleted, restored, or inactivated. For query operations, /object includes particular objects and object types in the display. The objectname variable specifies the names of the backup objects you want to delete, restore, or inactivate. The object name uniquely identifies each backup object and is created by Data Protection for SQL. Use query to view the names of backup objects. You can use * as a wildcard character in objectname to replace zero or more characters for each occurrence.

          /Quiet
            The /quiet parameter omits displaying status information from the command. However, the information is appended to the Data Protection for SQL activity log.

          /TSMNODe= tsmnodename
            The / tsmnode parameter specifies the Tivoli Storage Manager node name that Data Protection for SQL uses to log on to the Tivoli Storage Manager server. This identifies which Tivoli Storage Manager client is requesting services. You can also store the node name in the options file (dsm.opt). The command line parameter overrides the value in the options file.

            Considerations:
            • You cannot use the /tsmnode parameter if PASSWORDACCESS GENERATE is specified in the Tivoli Storage Manager options file. You must specify the nodename in the options file. Otherwise, you can change PASSWORDACCESS to PROMPT to utilize the /tsmnode parameter. For details about the Tivoli Storage Manager options file, see the reference manual IBM Tivoli Storage Manager for Windows Backup-Archive Client Installation and User’s Guide.
            • If you do not specify /tsmnode, the default value is that specified by the nodename option in the Tivoli Storage Manager options file. Specifying this parameter does not change the value in the options file.

          /TSMOPTFile= tsmoptfilename
            The /tsmoptfile parameter specifies the Tivoli Storage Manager options file to use. This is similar to selecting a Tivoli Storage Manager server from the server list in the GUI. The Tivoli Storage Manager options file contains the configuration values for the Tivoli Storage Manager API. For details about the Tivoli Storage Manager options file, see the reference manual IBM Tivoli Storage Manager for Windows Backup-Archive Client Installation and User’s Guide.

            Considerations:
            • The tsmoptfilename variable can include a fully qualified path. If you do not include a path, the directory where Data Protection for SQL is installed is used.
            • If tsmoptfilename includes spaces, you must enclose it in double quotes.
            • If you do not specify /tsmoptfile, the default value is dsm.opt.
            • If you specify /tsmoptfile but you do not provide a tsmoptfilenamevariable, the default value is also dsm.opt.

          /TSMPassword= tsmpassword
            The /tsmpassword parameter specifies the Tivoli Storage Manager password that Data Protection for SQL 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
            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

    Rate this page:

    (0 users)Average rating

    Add comments

    Document information


    More support for:

    Tivoli Storage Manager for Databases
    Data Protection for MS SQL

    Software version:

    5.5

    Operating system(s):

    Windows

    Software edition:

    All Editions

    Reference #:

    1394729

    Modified date:

    2010-07-08

    Translate my page

    Machine Translation

    Content navigation