#
#  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 : 2000/07/12


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

This file is the FAQ file of ARKC arkeia command line tool. This file 
contains Question/Answer concerning the general use of ARKC. If you have 
suggestions contact us at the following mail address: arkc@arkeia.com


+========================================================================+
|                                                                        |
| Contents :                                                             |
| ----------                                                             |
|                                                                        |
| 1.0   CONFIGURATION                                                    |
|       1.1     How do I start with ARKC ?                               |
|       1.2     I want to stop ARKC displaying  error messages using     |
|               standard error output.                                   |
|       1.3     I want to use my own preference file.                    |
|       1.4     How do I change default tcp port connection to the       |
|               backup server ?                                          |
|                                                                        |
| 2.0   ERRORS                                                           |
|       2.1     When I use arkc, the command displays an error message   |
|               "arkc can connect to a backup server version >= 4.1.8".  |
|               What is It ?                                             |
|       2.2     When I use arkc, the command displays an error message   |
|               "arkc connection fails, please verify login information".|
|               What is It ?                                             |
|       2.3     When I use arkc, command displays an error message       |
|               "Parameter needed <name>". What I am doing wrong ?       |
|       2.4     When I try to delete a tape , command displays an error  |
|               message "Bad value for <name>". Why ?                    |
|       2.5     arkc command returns with an error displaying an error   |
|               message. How can I get more information ?                |
|       2.6     I want more information on errors and exit values.       |
|                                                                        |
| 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 <ITEM> tag in some commands ?       |
|                                                                        |
| 4.0   HELP - HOWTO                                                     |
|       4.1     How is ARKC help organized ?                             |
|       4.2     How do I get general ARKC help ?                         |
|       4.3     I want information on backup options.                    |
|       4.4     Tell me more about the  [ PARAMETERS LIST ] section.     |
|                                                                        |
| 5.0   GENERAL                                                          |
|       5.1     What can I accomplish  using ARKC ?                      |
|       5.2     I have started a backup but the current job is waiting   |
|               for a new tape. What can I do ?                          |
|       5.3     I have started a restore but the current job seems to    |
|               be in waiting mode. What can I do ?                      |
|                                                                        |
+========================================================================+


                ARKC Frequently Asked Questions (FAQs)


============================================================================
1.0     CONFIGURATION
1.1     How do I start with ARKC ?

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

============================================================================
1.2     I want to stop ARKC displaying error messages using standard error 
        output.

Set the ARKC environment variable: ARKC_USE_NOINFO=1

============================================================================
1.3     I want to use my own preference file.

The preference file contains backup server name, login and password needed to 
establish a server connection. The preference file used is the following in 
order.First, the file set with {B}-pref{/B} option, then 
$(HOMEDIR)/.arkc/arkc.param, and finally $(KNOXDIR)/arkc/arkc.param. 

Therefore, you have to :

(1) create in your home directory the file $(HOMEDIR)/.arkc/arkc.param.
    You could copy $(KNOXDIR)/arkc/arkc.param file.  

(2) set internal file parameters (backup server name, login, password). 

(3) verify the above configuration. Try {B}arkc -debug -who{/B}. This command 
    must display $(HOMEDIR).arkc/arkc.param file content. 

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

Usually, you don't have to modify TCP port connection. However, you canset 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     ERRORS
2.1     When I use arkc, the command displays an error message "arkc can 
        connect to a backup server version >= 4.1.8". What is It ?

You should verify your backup server version. In fact ARKC works only with
server versions more recent than Arkeia 4.1.8. So, ARKC doesn't work with 
Arkeia 4.0 (all versions).

============================================================================
2.2     When I use arkc, the command displays an error message "arkc 
        connection fails, please verify login information". What is It ?

It depends. If the command fails immediatly then it could be a bad login or
a bad password if it exists. If the command fails after few minutes, so it 
could be a bad server name. To verify the backup server name and login used 
you should try : 

   # arkc -debug -who. 

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

============================================================================
2.3     When I use arkc, command displays an error message "Parameter 
        needed <name>". What I am doing wrong ?

The command you are using needs a parameter named "name". For tape creation,
the syntax is : # arkc -tape -create -D name=MyTape type=NULL


============================================================================
2.4     When I try to delete a tape , command displays an error message 
        "Bad value for <name>". Why ?

You are trying to delete a tape which doesn't exist. Therefore, name value 
specified isn't correct.  


============================================================================
2.5     arkc command returns with an error displaying an error message. 
        How can I get more information ?

You have 2 different ARKC options which can help.
    (*) You can try -helpme. For example if your failed command is 
        # arkc -pool -create -D name=MyPoool

        add the -moreinfo option 
        # arkc -moreinfo -pool -creat -D name=MyPool 

        To have the -moreinfo option by default, set ARKC_USE_MOREINFO=1 
        environment variable. 

    (*) You can try -verbose. For example if your failed command is 
        # arkc -pool -create -D name=MyPoool

        add the -verbose option 
        # arkc -verbose -pool -creat -D name=MyPool 

    
You could also look at the errors table
    (*) To display table of errors. 
        # arkc -usage -debug -errors  
  

============================================================================
2.6     I want more information on errors and exit values.

Try the following command :   #arkc -usage -debug -errors 



============================================================================
3.0     SYNTAX
3.1     How do I start a backup ?

Look at the 'start backup' specific help.
# arkc -usage -backup -start

============================================================================
3.2     How do I set a value containing several words ?

You have to use brackets. An example of use:
comment = [ A parameter value example ! ]

You can use the previous syntax directly in the command line or with an input 
parameters file.

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

For some commands, ARKC allows you to set settings for several items. 
Therefore, to define which settings are associated to each item, you have to use <ITEM></ITEM> tags. The Syntax is:

paramg1=value1
paramg2=value2
.....
.....
<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 is available with following commands :

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

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


============================================================================
4.0     HELP-HOWTO
4.1     How is ARKC help organized ?

There are several levels of help. First of all, there is a general help which 
is described Question 4.2. 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 :
(*) General help: # arkc -usage

(*) Object help : # arkc -<object>           (i.e: #arkc -usage -pool ) 

(*) Command help: # arkc -<object> -<action> (i.e: #arkc -usage -pool -create) 

Reading the command help, you have parameters which you must or could set. If 
you don't know parameter values allowed, you should try:

(*) Parameter help: # arkc -getinfo -<object> -<action> -property <parameter> 
(i.e: arkc -getinfo -backup -start -property wait )


============================================================================
4.2     How do I get general ARKC help ?

Try the following command: # arkc -usage  

============================================================================
4.3     I want information on backup options.

So, you should look at backup specific information.
# arkc -usage -backup  

============================================================================
4.4     Tell me more about the [ PARAMETERS LIST ] section.

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

============================================================================
5.0     GENERAL
5.1     What can I accomplish using ARKC ?

Really a good question :-) ! ARKC allows basic operations. You should see the
DESCRIPTION section of the main ARKC help: 
        # arkc -usage
  
Particulary, 'List of objects allowed' part. 

============================================================================
5.2     I have started a backup but the current job is waiting
        for a new tape. What can I do ?

That happens when you start a backup in a single drive configuration. If you 
look at GUI and backup management screen, you can see OK button. Arkeia is 
waiting for a new tape! So, you have to insert the new tape into your tape 
drive then type the following command:

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

where bksid value is the backup identifier printed after the 'arkc -backup 
-start' command and drvname your drive name.

You should look at the specific help, '# arkc -usage -backup -connect' and 
'# arkc -usage -backup -status'.

============================================================================
5.3     I have started a restore but the current job seems to be in waiting 
        mode. What can I do ?

That happens when you start a restore in a single drive configuration. If you 
look at GUI and restore management screen, you can see OK button. Arkeia is 
waiting for drive's name to use, even though there is only one drive to use !
So, you have to set drive name with the following command:

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

where rstid value is the restore identifier printed after the 'arkc -restore 
-start' command and drvname is your drive name. You can also specify the drive
 to use directly in the '# arkc -restore -start' command.

You should look at the specific help, ' # arkc -usage -backup [-connect | 
-status | -start ].



(C)Copyright 1997-2000 Knox Software Corporation
