#
#  Copyright (C) 2000 Knox Software Corporation
#

Document          : $(KNOXDIR)/arkc/FAQ file
Version           : 4.1.15-1
Author            : Knox Software Corporation
Created           : 1999/06/01
Last modification : 2001/01/17


Description:
------------

This file is the FAQ file of arkc, the Arkeia command line tool. This
file contains Question/Answer concerning the general use of arkc.

If you have any suggestions, improvements or questions you would like
to be answered in this FAQ, please contact us at the following email
address: arkc@arkeia.com


1.0     CONFIGURATION

1.1     What is the best way to start with arkc?
1.2     How do I stop arkc from displaying error messages using the
        standard error output?
1.3     How do I use my own preference file?
1.4     How do I change the default TCP port connection to the backup
        server?

2.0     GENERAL

2.1     What can arkc do?
2.2     What can I do if the backup I have launched is waiting for a new
        tape?
2.3     What can I do if the restoration job I have launched seems to be
        in a waiting mode?

3.0     SYNTAX

3.1     How do I start a backup?
3.2     How do I set a value containing several words?
3.3     Why do I have to use the <ITEM> tag in few commands?

4.0     HELP AND HOW-TO

4.1     How is the arkc help organized?
4.2     How can I display a general arkc help?
4.3     How do I obtain more information on the backup options?
4.4     Can you give me more information on the [ PARAMETERS LIST ]
        section?

5.0     ERROR MESSAGES

5.1     What is the meaning of the error message: "arkc can connect to a
        backup server version >= 4.1.8"?
5.2     What is the meaning of the error message "arkc connection fails,
        please verify login information"?
5.3     What is the meaning of the error message "Parameter needed <name>"?
5.4     When I try to delete a tape, what is the meaning of the error
        message "Bad value for <name>"?
5.5     How can I get more information on the error messages of arkc?
5.6     How do I obtain more information on errors and exit values?

============================================================================

                ARKC Frequently Asked Questions (FAQs)

============================================================================
1.0     CONFIGURATION
============================================================================

1.1     What is the best way to start with arkc?

You should read the $(KNOXDIR)/arkc/README file.


1.2     How do I stop arkc from displaying error messages using the
        standard error output?

Set the arkc environment variable: ARKC_USE_NOINFO=1

1.3     How do I use my own preference file?

The preference file contains the backup server name, the login and the
password needed to establish a server connection. The preference file
used by arkc will be one of the following (in that order):

        A.      The file set with the -pref option
        B.      $(HOMEDIR)/.arkc/arkc.param
        C.      $(KNOXDIR)/arkc/arkc.param.

Therefore, you have to:

        A.      Create in your home directory the file:
                $(HOMEDIR)/.arkc/arkc.param.
                To do this, you could copy the file:
                $(KNOXDIR)/arkc/arkc.param file.
                Or:

        B.      Set the internal file parameters (backup server name,
                login, password).
                And:

        C.      Verify the above configuration. To do this, try entering:
                arkc -debug -who
                This command should display the content of the file:
                $(HOMEDIR).arkc/arkc.param

1.4     How do I change the default TCP port connection to the backup
        server?

Usually, you don't have to modify the TCP port connection. However,
you can set a new port number (i.e 618) by adding the following line
to your preference file (by default, $(KNOXDIR)/arkc/arkc.param):

        PORTNUM         "618"

============================================================================
2.0     GENERAL
============================================================================

2.1     What can arkc do?

Thanks for asking! :-)

ARKC is able to perform all the normal, basic operations. To obtain more
information, you should read the DESCRIPTION section of the main arkc help,
by entering the following command:

# arkc -usage

One section which is particularly interesting to answer your question is
the section named 'List of objects allowed'.

2.2     What can I do if the backup I have launched is waiting for a new
        tape?

This situation happens when you start a backup in a single drive
configuration. If you look at the backup management screen of the
main Arkeia GUI, you should be able to see an OK button. Click on
this button to signal to Arkeia that there is a new tape available
or enter the following command:

# arkc -backup -connect -D bksid=XXXXXXX exec=SETTAPE drvname=XXXXXXXX

where 'bksid' is the backup identifier and drvname your drive name. Both
these identifiers are displayed after entering the command:

# arkc -backup -start command

For more information, you should look at the specific help by entering the
following commands:

# arkc -usage -backup -connect
# arkc -usage -backup -status

2.3     What can I do if the restoration job I have launched seems to be
        in a waiting mode?

This situation happens when you start a restoration in a single
drive configuration. If you look at the backup management screen
of the main Arkeia GUI, you should be able to see an OK button.
Click on this button to signal to Arkeia that there is a new tape
available or enter the following command to set the drive name:

# arkc -restore -connect -D rstid=XXXXXXX exec=SETDRIVE drvname=XXXXXXXX

where 'rstid' is the restore identifier and 'drvname' is your drive name.
The rstid information is displayed after entering the command:

# arkc -restore -start.

You can also specify the drive to be used for the restoration on the
command line:

# arkc -restore -start drvname=XXXXXXXX

For more information on this problem, please enter the following
command:

# arkc -usage -backup [-connect | -status | -start ].

============================================================================
3.0     SYNTAX
============================================================================

3.1     How do I start a backup?

Look at the help on start backup, by entering the command:

# arkc -usage -backup -start

3.2     How do I set a value containing several words?

You have to use brackets. An example of this would be:

comment = [ A parameter value example ! ]

You can use the previous syntax directly on the command line or through file
that contains input parameters.

3.3     Why do I have to use the <ITEM> tag in few commands?

For some commands, arkc allows you to configure settings for several items.
Therefore, to define which settings are associated to each item, you have
to use the <ITEM>...</ITEM> tags. The correct syntax for these tags is the
following one:

<ITEM>
<param1>=item1
<param2>=value1_2
<param3>=value1_3
<param4>=value1_4
</ITEM>

<ITEM>
<param1>=item2
<param2>=value2_2
<param3>=value2_3
<param4>=value2_4
</ITEM>

This syntax can be used with the following commands:

arkc -savepack -modify
arkc -drivepack -create
arkc -drivepack -modify

For an example of use, you should look at the EXAMPLES section of the
previous commands.

============================================================================
4.0     HELP AND HOW-TO
============================================================================

4.1     How is the arkc help organized?

There are several levels of help. First of all, there is a general help which
is described Question 4.2 (see below). There is one global help per object
(tape, savepack, backup, ...). An example is given in Question 4.3 for the
'backup' object. There is also one specific help per command.

To summarize:

        A.      General help:
                # arkc -usage

        B.      Object help:
                # arkc -usage -<object>

                (For instance : #arkc -usage -pool )

        C.      Command help:
                # arkc -usage -<object> -<action>

                (For instance: #arkc -usage -pool -create)

The command help displays all the parameters for this command, whether the
parameters are mandatory or optional. If you don't know the values that
are allowed for a parameter, you should try the following command:

        # arkc -getinfo -<object> -<action> -property <parameter>

        (For instance: arkc -getinfo -backup -start -property wait )

4.2     How can I display a general arkc help?

Try the following command:

# arkc -usage

4.3     How do I obtain more information on the backup options?

You should try the following command to obtain more specific information
on the backup:

# arkc -usage -backup

4.4     Can you give me more information on the [ PARAMETERS LIST ]
        section?

For each specific help command, for example 'arkc -usage -backup -start',
there is a PARAMETERS LIST section. It describes the list of parameters
that are optional or mandatory, that you can add on the command line.
Usually, this section is based on 3 parts. The first part gives you the
required parameters. The second part, delimited by the [OPTIONAL] tag,
describes the optional parameters. The last section, which begins by the
[EXPERT] tag, gives you parameters you don't need in most cases.

============================================================================
5.0     ERROR MESSAGES
============================================================================

5.1     What is the meaning of the error message: "arkc can connect to a
        backup server version >= 4.1.8"?

You should check the version of your backup server. arkc works only with
Arkeia server version 4.1.8 or above. It doesn't work with Arkeia version
4.0 (all versions).

5.2     What is the meaning of the error message "arkc connection fails,
        please verify login information"?

This error message can come either from a bad login or password or from
a non-existent server name. If the command fails quickly, this usually
indicates a wrong login/password. If it takes arkc a few minutes to
return an error message, then it is probably a wrong server name.

To check the backup server name and login used, you can try entering the
following command:

        # arkc -debug -who.

You can also retry the failed command with the -verbose option to get more
information about the error.

5.3     What is the meaning of the error message "Parameter needed <name>"?

The command you are using requires a "name" parameter.

For instance, to create a tape, the correct syntax is:

        # arkc -tape -create -D name=MyTape type=NULL

5.4     When I try to delete a tape, what is the meaning of the error
        message "Bad value for <name>"?

You are probably trying to delete a tape which does not exist. Therefore,
the name specified isn't correct.

5.5     How can I get more information on the error messages of arkc?

You have two different arkc options which can help:

        A.      You can try the -moreinfo option. For instance, if your
        failed command is:

        # arkc -pool -create -D name=MyPoool

        You could add the -moreinfo option in the following way:

        # arkc -moreinfo -pool -creat -D name=MyPool

        To enable the -moreinfo option by default, set the environment
        variable ARKC_USE_MOREINFO to the following value:
        ARKC_USE_MOREINFO=1

        B.      You can try the -verbose option. For instance, if your
        failed command is:

        # arkc -pool -create -D name=MyPoool

        You could add the the -verbose option in the following way:

        # arkc -verbose -pool -create -D name=MyPool


You can also look at the complete error table. To display this table of
errors, use the following command :

        # arkc -usage -debug -errors


5.6     How do I obtain more information on errors and exit values?

Try the following command:

#arkc -usage -debug -errors


[End of FAQ file]

(C) Copyright 1997-2001 Knox Software Corporation
