Home

arkc: arkeia command

1. ARKEIA SERVER 1 SERVER 2 C 2 on ARKEIA MANAGEMENT WORKSTATION 0 ARKEIA SERVER 3 MEE opr gt _ oT gt o S SERVER 3 SERVER 3 CLIENT 1 CLIENT 2 In the example above the system administrator uses a single workstation with the Arkeia interface installed to control three different Arkeia servers From these backup servers he is able to backup all the clients of his network such as the two clients con nected to the Arkeia server 3 in the example Each Arkeia server can be connected to its own backup device tape drive tape library backup robot which are not repre sented in the example above Arkeia command line interface Manual 2 144 This three tier architecture offers a great flexibility to system administrators since they can control Arkeia servers in different locations through a single point of administra tion without having to be physically present next to the backup server However most of the interactions performed by the administrators is done through the Arkeia graphical user interface GUI While this interface has many advantages it has the usual limitations of graphical interfaces in the sense that it does not allow other programs to inter
2. retention Optional The parameter retention determines the duration of the data retention of the backup This parameter must be completed by the retunit parameter see below and can accept values starting at 1 For instance retention 6 retunit Optional The parameter re tun it determines the type of unit used by the retention param eter It can accept the following values DAY WEEK MONTH and YEAR For instance to take back the example above retention 6 retunit MONTH This defines a retention period of 6 months for the data of the backup being started with arkc parallelism Optional The parameter parallelism determines the number of concurrent data flows that will be used for the backup This parameter can accept numerical values from 1 to 128 By default Arkeia uses the maximum number of flows available for its backups type Optional The parameter type determines the type of backup that will be performed by Arkeia This parameter can accept three values TOTAL INCREMENTAL and ARCHIVE By default the value of type is TOTAL For more information about the different type of backup available under Arkeia please refer to the Arkeia User Manual Arkeia command line interface Manual 127 144 based_on_bksid Optional The based_on_bksid parameter is valid only if the type parameter is s
3. delete etc that have been detailed in the previous chapters 10 1 Tape creation The creation of a tape with arkc through the create command uses the following syntax arkc tape create D I lt parameters gt Please refer to the section named arkc options general on page 8 for more informa tion on the different options that can be used with arkc The parameters that can be used with the create command are the followings name Required The name parameter indicates the name which is going to be used by Arkeia to refer to the new tape This parameter is required by the create command The correct syntax for this parameter is name XXXXX where XXXXX is the name string to assign to the new tape For instance name DemoTape name DAT_Database type Required The type parameter indicates the type of the tape being created This parameter is required by the create command Please note that the names should be entered pre cisely as shown below and that whenever a name contain spaces it should be enclosed with square brackets E 1 after the type function For instance type EXB 85001 is a valid syntax while type exb 8500 or type Exb8500 are not The available tape types are listed below AIT 1 AIT 1XL AIT 2 DAT DDS4 DAT DDS3 DAT 120 DAT 60 DAT 90 D3 10GB D3 25G6B D3 50GB EXB 8500 EXB 8505XL Arkeia command line interfa
4. The o output file option The option 0 allows the user to save the output of an arkc command to an external file for editing or debugging purposes The correct syntax for this option is Arkeia command line interface Manual 11 144 arkc tape list D name tape0O1x Oresults txt In the example above the information on the tape named tape01x is requested and the result of the command is sent to the file results txt Please note When using the 0 option it is important to note that this option does not take into account the error messages generated by arkc Error messages are always sent to the standard output Therefore the command arkc tape list D name tape01x Oresults txt verbose would not redirect the error messages generated by arkc to the file named results txt assuming the tape tape01x does not exist on the backup server used by arkc The F filter option The filter option F can be used for some functions of arkc in order to modify the information returned by the program The correct syntax for this option is the follow ing arkc object command CD I lt input file gt lt parameters gt F lt filters gt The filters usually take the form of a single word that must follow the F letter Please note that there should be no spaces between the option itself and the filter word and that the filter word itself should be e
5. ibid Library name and ID libdev control device for the library and com ment For more information on these parameters please refer to the section named Library creation on page 114 15 4 Listing available libraries with the list command The arkc list command provides detailed information on the different libraries that are available on a give server For more information on this command please refer to The informational commands and objects of arkc on page 48 15 5 Listing the drives of a library with the drvlist command For the Library object arkc offers an additional list command available which is the drvlist command While the List command when applied to the Library object will list all the available libraries connected to a Arkeia server the drvlist command will list the drives that are installed in a specific library The syntax of this command is the follow ing arkc library drvlist CD IJ lt parameters gt The parameters that can be applied to this command are the following ones name Required The name parameter contains the name that was assigned to the library when it was cre ated Please note that this parameter is required by the drv list command For example arkc library drvlist D name ArkeiaLibO 1 The above command will list all the tape drives installed within the library named Arkeia
6. For example the following line will create a new Drivepack based on the Create_Drivepack dat input file arkc create drivepack ICreate_Drivepack dat priority Optional The parameter priority assigns a priority to a drive contained in a Drivepack This allows an administrator to define precisely which drive will receive first the data from a back up operation For instance if drive A has a priority of 1 and drive B has a priority of 5 the A drive will be used first for a backup operation If this operation requires more drives then drive B will be used followed by any other drives in the order of their priority Arkeia command line interface Manual 25 144 This parameter can accept values from 1 to 128 with a value of 1 highest priority being assigned by default Combining the priority parameter with the nbdr ive offers a high level of flexibil ity for the operation of a group of drives Please refer to the above information for more examples on how to add this parameter to a Drivepack input file 4 6 User creation Creating a user can be accomplished with the create command with the following syntax arkc user create LD IJ lt parameters gt The parameters that can be used to create a user are the following ones name Required The parameter name assigns a descriptive name to the user being created The correct sy
7. lt ITEM gt drvname DLT01 lt ITEM gt The above lt I TEM gt will add the drive DLT01 to a Drivepack assuming a drive of that name exists on the Arkeia server drvid Optional The parameter dr vid contains the ID of the drive to be added to the Drivepack This parameter is used in much the same way than the parameter drvname above For instance the following lt ITEM gt statement will add the drive DLTO1 to a Drivepack assuming 3bc419c3 is the correct ID of this drive lt ITEM gt drvid 3bc419c3 lt ITEM gt priority Optional The parameter priority defines the priority level assigned to the drive This parameter can accept values from 1 to 128 with the default and highest possible value being 4 Please note that this parameter can only be used within an input file and not on the command line The following parameters can also be modified using the modify command of arkc name dkid Drivepack name and ID and nbdrive number of drives to be used in the Drivepack Since these are functionally equivalent to the parameters of the create command please refer to The create command of arkc on page 14 for more information 6 5 User modification To modify an Arkeia user the parameters to be used are the same as with the create command For more information please refer to The create command of ar
8. is the internal information contained within the Arkeia database The examples above are valid for UNIX machines running operating systems such as Linux or Solaris For Windows machines the complete syntax of t ree_name is the following tree_name machine_name drive_letter directory1 For instance tree_name dune c common documents sales 2000 Arkeia command line interface Manual 41 144 Please note the second after the drive letter Please note also that arke requires normal slashes instead of the standard inverted slashes of Windows Please note Never use the internal Arkeia name FULLNAME when ever you enter a command or edit an arkc input file Please note as well that the name of a Savepack and the name of a tree are two different parameters To add a new tree to an existing Savepack it is therefore nec essary to enter either on the command line arkc savepack modify D name station01 tree_name station0O1 home Linda or within an input file Saves Linda home directory on computer station0O1 lt ITEM gt tree_name station0O1 home Linda lt ITEM gt Any other syntax than the two shown above will be rejected by arkc Please note that the two possibilities above are equivalent tree_family Optional Arkeia uses a sequential procedure to save the trees contained within a Savepack In order to benefit from Arkeias advanced parallelism functions it is nec
9. rewind_dev is used to define the system device used by the operating system to access the tape drive This device is usually used by the m t UNIX command For instance under most Linux systems this device is dev s t0 access Optional This parameter is used to define the access rights to be assigned to the device being created Arkeia command line interface Manual 19 144 These rights can be READ WRITE RECYCLE and DELETE To authorize certain access rights these should be included as values of the access parameter for instance access LREAD WRITE The parameter above indicates that the drive being created can be accessed for read write operations but not for deleting or recycling By default all four type of rights are granted on a new tape drive comment Optional This parameter is used to assign a descriptive comment to the tape drive being created This comment can be useful to display additional information related to the tape drive as for instance its location purpose etc The correct syntax for this parameter is comment DLT tape drive for CAD machines 4 4 Savepack creation Within Arkeia a Savepack is a group of files directories disks or even whole set of machines which is used to simplify a backup operation Instead of choosing individual files an administrator can create a Savepack name it and use the Savepack to quickly and effortlessly
10. drvname DLTO1 priority 1 lt ITEM gt Adding several drives to a Drivepack is therefore a question of adding several lt ITEM gt lt ITEM gt statements into the same input file each statement containing different drvname and priority parameters drvid Optional To add drives to a Drivepack it is possible to use either the drvname or the drv id parameters Both these parameters should be contained in an input file with each drive to be added to the Drivepack contained in a pair of lt ITEM gt lt ITEM gt statements For instance the following lines of an input file would add the drive with the ID of DLT01 in a Drivepack Comment First DLT drive of drivepack lt ITEM gt drvid 3bc419c3 priority 1 lt ITEM gt Adding several drives to a Drivepack is therefore a question of adding several lt ITEM gt lt ITEM gt statements into the same input file each statement containing different drvname and priority parameters Please note It is possible to add drives to a Drivepack by using the p option followed by the drvname or the drvid parameters But using the command line does not allow the use of a specific priority parameter for each drive In most cases it is highly recommended to use an input file containing the drive parameters with the 1 command line option in order to set priority for each specific drive
11. for all intent and purposes equivalent arkc tape create arkc create tape For more example please refer to the rest of this manual 3 1 arkc objects The possible objects for ar kc are the following ones tape for all Arkeia operations on tapes pool for all Arkeia operations on tape pools savepack forall Arkeia operations on Savepacks drive for all Arkeia operations on drives e drivepack forall Arkeia operations on Drivepacks library for all Arkeia operations on Tape libraries backup for all Arkeia commands related to backups restore for all Arkeia commands related to restore journal for all Arkeia operations on journals file for all Arkeia operations on files user for all Arkeia operations regarding users debug for debugging purposes only duplicationfor duplicating tapes version 5 x only Arkeia command line interface Manual 7 144 3 2 arkc options general Help options usage and help At any time it is possible to obtain an online help on an Arkeia object by entering arkc usage object Or by entering arkc help object For example if youd like to obtain more information on the tape object of arkc you can enter the following arkc usage tape If you need a more detailed online help on a given command and the way it affects an object you can enter arkc usage object command To take back our tape example to display additio
12. p L i d below or c perform a piping operation such as arkc tape list grep Test_ arkc tape delete In the command above arke first makes a list of tapes which is piped to and parsed by the UNIX grep command In the example above all tapes with a name starting with gt Test_ will be returned The result is then piped back into ar kc for deletion Please note the usage of the input option in this example tpid Optional The parameter t pid can replace the name parameter that we have detailed above The tpid value is assigned to a tape when it is first created by Arkeia This value can be dis played for a given tape by entering the command arkc tape list D name name_of_tape Since the tpid parameter is equivalent to the name parameter the two commands below are equivalent provided that 3a7834d7 is the correct tp id value of the tape Test_Tape_01 arkc tape delete D name Test_tape_01 arkc tape delete D tpid 3a7834d7 plid Optional The pl id parameter is one way to delete several tapes in one operation as long as all the tapes to be deleted are included in the same tape pool The p Llid of a given tape can be obtained by entering the following command arkc tape list D name name_of_the_tape Once obtained it is possible to delete all the tapes contained in a given pool tape by entering the command arkc
13. type parameters are enclosed within square brackets Parameters are case sensitive and predefined within Arkeia For instance the type parameter above must be entered exactly as it is dis played by the command arkc tape type In the example above the FILE 50MB must be in capital letters and must include a space between FILE and 50MB The following values would therefore be rejected by arkc File 50MB file 50mb file50mb If the rules above are not respected arke will reject the input file and display an error message Please note that the correct syntax for the 1 option is the following arkc tape create Ifoobar arkc Whenever the option 1 is used there should be no space between the option and the name of the input file to be used In the example above the name of the file is foobar arkc The standard input option It is possible to use the standard input to pipe information from other programs or commands to arkce The correct syntax for this command is the following foobar arkc tape create In the example above arke will create a tape based on the information piped by the command foobar Please note that the command foobar itself must respect the syntax used by arkc including the remarks we have detailed above 3 4 Output options As with the input options it is possible for ar kc to output its messages in several differ ent ways
14. ADDSK Add a new Savepack to the current backup SETTAPE Indicates that a new tape has been inserted SETMODE Modifies the mode of the backup For instance the following command would abort the running backup with the ID 3a6718dc arkc backup connect D bksid 3a6718dc exec ABORT Arkeia command line interface Manual 128 144 drvname Optional The parameter dr vname determines the drive that contains the new tape This parameter is required if the exec parameter has the value SETTAPE Please refer to the exec parameter above for more information For instance arkc backup connect D bksid 3a6718dc exec SETTAPE drvname ecrix_2 The command above indicates to the running backup with an ID of 3a6718dc that a new tape has been inserted in the drive named ec ri x_2 and can be used to save the data being backed up Please note that this command should be placed all on one line mode Optional The parameter mode should only be used if the exec parameter is set to SETMODE There are two possible values for mode which are STANDARD the job will be stopped once the backup is finished and CONTINUOUS the job will stay active even after the end of the backup skname Optional The parameter skname should only be used if the exec parameter is set to ADD SK add a Savepack The value of skname should then be the name of the Savep
15. Required The name and the lL ibid parameters contain respectively the name and the ID of the library that will be re configured by the detach command Please note that only one parameter needs to be set for the de tach command to work properly For instance the fol lowing parameters are equivalent assuming 3b614 30 is the correct ID of the library named Autopack30 name Autopack30 lLibid 3b614c30 drvname drvid Required The drvname and drvid parameters contain respectively the name and the ID of the drive that will be detached from the tape library Please note that only one parameter needs to be set for the detach command to work properly For instance the following parameters are equivalent assuming 3bc419c3 is the correct ID of the tape drive named DLT01 drvname DLT01 drvid 3bc419c3 Please note that is is possible to use several names of IDs on the command line to detach sev eral drives with only one command For instance arke library detach D name Lib04 drvname DLT1 drvname DLT2 Arkeia command line interface Manual 124 144 16 The backup object This chapter of the arke manual will detail the commands that can be applied to the backup object 16 1 Starting a backup The start command can be used to launch a backup with arkc The standard syn tax for this command is the following one arkc backup start D I lt parameter
16. SETMODE There are two possible values for mode which are STANDARD the job will be stopped once the backup is finished and CONTINUOUS the job will stay active even after the end of the backup skname Optional The parameter skname should only be used if the exec parameter is set to ADD SK add a Savepack The value of skname should then be the name of the Savepack to be added to the running job For instance arkc backup connect D bksid 3a6718dc exec ADDSK skname JackFiles The command above adds the Savepack named JackFi les to the running backup des ignated by the ID 3a6718dc Please refer to the exec parameter above for more information e Modifying a running restoration The standard syntax to modify a running restoration with the connect command is the following Arkeia command line interface Manual 76 144 arkc restore connect LD I lt input file gt lt parameters gt The following parameters can be used to modify a running restoration bksid Required The bksid parameter contains the ID of the restoration to be modified This ID is returned by arkc when a restoration is started with the start command wait Optional The wait parameter is used to determine the behavior of arkc at the end of the restora tion This parameter can accept two values YES and NO If the value YES is used arkc
17. and drvid parameters contain respectively the name and the ID of the drive that will be attached to a tape library Please note that only one parameter needs to be set for the at tach command to work properly For instance the following parameters are equivalent assuming 3bc419c3 is the correct ID of the tape drive named DLTO1 drvname DLTO1 drvid 3bc419c3 drvnum Optional The drvnum is the logical number that will be assigned to the drive defined by the parameter drvname or drv id see above for more information on these parameters For instance the following parameter would assign the number 6 to the drive attached to a tape library drvnum 6 Arkeia command line interface Manual 123 144 Please note Assigning the wrong logical number to a drive attached to a library can result in severe problems In case of a doubt remove all the drives attached to a library and re attach them in a correct order paying attention to the logical numbers that are assigned to each For more information on the de tach command please see below e Removing drives from a library with detach The detach command allows the drives previously attached to library to be removed from it The syntax of this command is the following arkc Library detach LD I lt input file gt lt parameters gt The parameters that are accepted by htis command are the following name Libid
18. arkc savepack delete D plid 3a64332e 5 5 Drivepack deletion The correct syntax to delete a Drivepack is the following one arkc drivepack delete D I lt parameters gt Where the parameters can be the following ones name Required The name parameter should contain the name of the Drivepack to be deleted For instance arkc drivepack delete D name DLT_drivepack A list of all the Drivepacks available on a given Arkeia server can be obtained with the com mand arkc drivepack list dkid Optional The dkid parameter is the ID assigned to the Drivepack when it was created by Arkeia This ID value can be used instead of the name parameter described above For instance the two commands below are equivalent assuming that 3bc 46702 is the correct ID of the Drivepack named DLT_drivepack arkc drivepack delete D name DLT_drivepack arke drivepack delete D plid 3bc46702 5 6 User deletion The correct syntax to delete an Arkeia user is arkc user delete D I Cname User_Name Where the parameters can be the following ones name Required The name parameter should contain the name of the user to be deleted For instance arkc user delete D name John Arkeia command line interface Manual 36 144 A list of all the users available on a given Arkeia server can be obtained with the command arkc user list 5 7 Library deletion The correct syntax to
19. in directory home jack docs Please note that the command above should be entered on a single line from to Optional The parameter f rom allows the restoration to take place with a redirection This means that a file restored from a directory X can be restored to another directory Y For instance taking back the example above arkc restore start Ireports txt Content of reports txt Example of restoration file AnnualReport_2000 ps from babylon home jack files Reports to babylon home jack tmp arkeia temporary In the example above the file Annual Report_2000 ps whose original directory was fhome jack files Reports on the workstation babylon from line will be restored instead to the directory home jack tmp arkeia temporary to line This allows the user to check the content of the restored file before moving it back to its original position Arkeia command line interface Manual 132 144 Please note A from parameter should always be followed and com pleted with a to parameter If this is not the case the restoration will be rejected by a rkc with an error message J y 8 wait Optional The parameter wait determines the behavior of arkc once a restoration is launched with arkc restore start This parameter can accept two values YES or NO If the value YES is used arke will wait u
20. lowing entries in a data file would create five 5 tapes Arkeia command line interface Manual 80 144 Create 5 tapes firstnum 1 lLastnum 5 Please note that the name of the tapes will be the value assigned to the command name followed by the tape number The value of f irs tnum can be different than 1 plname plid Optional The parameters plname and p Ll id indicates to which tape pool the new tapes should be added The parameter pl name indicates the pool chosen by its name and p lid indicates the pool chosen by its internal Arkeia ID For instance plname Test_Pool In the example above the tape created with tape create will be added to the tape pool named Test_Pool recycle_in Optional The parameter recycle_in determines in which tape pool the tape created should be placed when it is recycled There are two possible pools defined by default SCRATCH_POOL default recycling pool and CURRENT_POOL For instance the parameter recycle_in CURRENT_POOL will recycle the tape created in example above to Test_Pool if the tape was assigned to this pool when it was created By default the tape is recycled in the pool it was assigned to when it was created recycle_mode Optional The parameter recycle_mode determines the type of recycling operation that will be applied to the tape being created This parameter can take two value
21. NO is used then Arkeia will not send an email The default value of email is YES Please_note In order to receive an email the parameter email defined for a user must contain a valid email address Even if the email parameter of a backup is defined it will not send any informa tion if the user email parameter does not contain any information mode Optional The parameter mode controls the operational mode of Arkeia for a backup Two modes and values of mode are available CONTINUOUS and STANDARD When the STANDARD mode of operation is chosen the backup will stop once it is completed and Arkeia command line interface Manual 65 144 will be considered as terminated by the Arkeia server When the CONTINUOUS mode is selected the backup task will not be considered as finished once it has saved all the files in the Savepack and more Savepacks can be added to the backup task By default the value of mode is STANDARD if you are unsure which mode is best suited to your need please use the default comment Optional The parameter comment is used to add a more descriptive comment to a backup For instance comment LComplete user data backup including email dir Please note that as seen above comments that contain spaces should be enclosed within square brackets E I retention Optional The parameter retenti
22. The default value for this parameter is 1 ZW E which displays all the log messages information warnings and errors For instance arke journal jdrive D lLevel ZWZE The command above will only display the drive related warnings and errors that were reported by the Arkeia server On the other hand the information messages wont be dis played The Level parameter therefore limits the information to the most interesting messages which can be quite useful to track the source of a problem filter Optional The filter parameter adds or removes specific data from the information returned by the Arkeia log This parameter accepts the following values D date T time L level see above 1 information code and S message string The default value for the filter parameter is D T L 1 S meaning that all information returned by the log is displayed For instance arke journal jdrive D filter Z1ZS The command above would limit the drive information returned by the Arkeia log to the information code followed by the message string Arkeia command line interface Manual 107 144 13 6 Checking the label on a tape with the read command The read command checks if a tape is present in a given tape drive If this is the case it will then display the tape header The syntax for this command is the following arkc drive read LD I lt input fil
23. apply to all the commands that were detailed above a LL jtape jdrive and jres tore and that they are all optional The only exception to this rule is the jbackup command which has one parameter bksid that is not required by all the other commands This command will be detailed after the common parameters that apply to all the journal commands Arkeia command line interface Manual 61 144 month Optional The parameter month limits the display of the journal object to a specific month The value of month can go from 1 January to 12 December For instance arke journal jbackup D month 10 The command above will display all the backups that took place during the month of Octo ber of the current year By default the month displayed by the journal object is the current month level Optional The parameter Leve L specifies the quantity of information that should be displayed by a command This parameter can accept three different values 1 information messages W warning messages and E error messages The default value for this parameter is 1 ZW E which displays all the log messages information warnings and errors For instance arke journal jrestore D lLevel ZWZE The command above will only display the warnings and errors that were reported by the Arkeia server during the restoration operations On t
24. by ar kc for a tape duplication command Arkeia command line interface Manual 142 144 src_drv_name RD_LTO src_drvid 3a530bcf As can be seen above the src_drv_name may be easier to remember but both these values are valid and accepted by arkc To display a list of available drives enter the com mand arke drive list without the quotes dst_drv_name or dst_drvid Required These parameters are required by ar kc These parameters should contain either the name or the ID of the destination drive This drive must be compatible with the source drive For instance the following names and IDs are considered valid and will be accepted by ar kc for a tape duplication command dst_drv_name RD_LTO dst_drvid 3a530bcf As can be seen above the ds t_drv_name may be easier to remember but both these values are valid and accepted by arkc To display a list of available drives enter the com mand arke drive list without the quotes Additionally the following parameters can be entered when duplicating a tape that is contained in a tape library dst_lib_name or dst_libid Required These parameters are required when using ar kc if duplicating in a library These parameters should contain either the name or the ID of the destination library This library must contain the destination drive defined above For instance the following names and IDs are con
25. can obtain a complete list of all the hardware supported by Arkeia by typing the com mand arke library type onacommand line For more information please see chapter 6 The informational commands of arko Please note The value of type should be entered exactly as shown in the list above These values are case sensitive Therefore the value hp19 dlt and HP19 DLT are not equivalent A library creation requires the appropriate license of Arkeia If you do not have a license for a library arke will produce an error message and exit For more information on the Arkeia licensing scheme please con tact salesd arkeia com Libdev Required The parameter Libdev indicates which UNIX device is the controller of the library being created This device will vary according to the system and its configuration For instance here are two possible values for Libdev Libdev dev sg0O Linux Libdev dev rsst4 Sun Solaris For more information on control devices please refer to the manual of your UNIX Linux system and to the output of the dmesg UNIX command Arkeia command line interface Manual 115 144 comment Optional The parameter comment assigns a descriptive comment to the library being created This parameter is useful to display more information on a given library For instance the follow ing is a valid comment for ar kc comment LDLT Library for Accounting Departm
26. changed using the modify command rewind_dev tape drive UNIX controller access access rights of the tape drive comment These parameters are described in more detail in chapter 3 of this manual The create command of arke 6 3 Savepack modification To modify a Savepack with arkc the following syntax should be used arkc savepack modify LCD I lt input file gt lt parameters gt Please note that when modifying a Savepack with arkc it is necessary to supply the parameter name or the parameter skid name or ID of the Savepack to be modi fied The following Savepack parameters can be changed through the modi fy command allowed_fs file systems allowed retry number of allowed retries compress compression scheme to be used for back up crypt cryptographic function to be used symb_Link follow through of symbolic links follow_fs follow through of file systems inc_filter inclusion filter exc_filter exclusion filters cmd_before do_cmd_before pre backup command cmd_after and do_cmd_af ter post backup commands behavior comment Arkeia command line interface Manual 40 144 For more information on these parameters please refer to The create command of arkc on page 14 The main use of the modify command when it applies to Savepack is to add or remove trees files and their relevant parameters The rest of this section w
27. command should be saved RAW physical device such as dev fd0 Arkeia command line interface Manual 43 144 This parameter determines which other parameters can be applied to the tree Please see below for more examples By default the value of tree_type is TREE The following parameters can be used only if the tree_type parameter is set to TREE They are the equivalent for a single tree of the general commands available for a compete Savepack As such they will not be detailed please refer to The create command of arkc on page 14 for more information on these different parameters tree_comment Optional The parameter tree_comment assigns a descriptive information to the tree For more information on this parameter please refer to Savepack creation on page 20 tree_retry Optional The parameter tree_retry assigns a retry value to the tree For more information please refer to the retry parameter in Savepack creation on page 20 tree_compress Optional The parameter tree_compr ess chooses a compression scheme for the tree For more information please refer to the compress parameter in Savepack creation on page 20 tree_crypt Optional The parameter tree_crypt chooses a cryptographic scheme for the tree For more information please refer to the crypt parameter in Savepack creation on page 20 tree_cmd_before Op
28. creation on page 20 tree_cmd_before Optional The parameter tree_cmd_before describes a command that should be executed before the tree is backed up For more information please refer to the cmd_before parameter in Savepack creation on page 20 tree_do_cmd_before Optional The parameter t ree_do_cmd_be fore describes the behavior of Arkeia in the case of a failure of the command described in tree_cmd_before For more information please refer to the do_cmd_be fore parameter in Savepack creation on page 20 tree_cmd_after Optional The parameter tree_cmd_a f ter assigns a command to be executed after the back up of the tree by Arkeia For more information please refer to the cmd_af ter parameter in Savepack creation on page 20 Arkeia command line interface Manual 101 144 tree_do_cmd_after Optional The parameter tree_do_cmd_a fter describes the behavior of the command entered in tree_cmd_after in the case of a failure of the tree backup For more information please refer to the do_cmd_after parameter in Savepack creation on page 20 tree_allowed_fs Optional The parameter tree_allowed_fs determines the behavior of the Arkeia backup in case the tree contains NFS links For more information please refer to the al Lowed_fs parameter in Savepack creation on page 20 tree_follow_fs Optional The parameter
29. crypt is DES_BLOWFISH Using the value NO_CRYPT turns off the encryption features of Arkeia The encryption functions that are available Arkeia command line interface Manual 21 144 within Arkeia are described in much more details in the Arkeia User Manual which is avail able on Knox Software web site http www arkeia com symb_link Optional The parameter symb_link determines the behavior of Arkeia when it encounters a UNIX symbolic link within the files contained in a Savepack The possible values for this parameter are YES or NO A value of YES indicates that Arkeia should follow the symbolic links and a value of NO indicates that symbolic links should not be followed The default value for this parameter is NO Please note The symb_l ink parameter should be used with caution as symbolic links can sometimes reference each other in a loop For instance link a can point to link B which in turn points back to link a Such a situation creates an infinite loop which will block Arkeia s normal operations Caution is therefore strongly advised follow_fs Optional The parameter follow_fs determines the behavior of Arkeia when it encounters a mounted file system contained within a Savepack to be backed up This parameter can accept two values YES back up mounted file systems and NO do not back up mounted file systems By d
30. delete an Arkeia library is the following one arkc library delete D I lt parameters gt Where the parameters can be the following ones name Required The name parameter should contain the name of the library to be deleted For instance arkc library delete D name Lib04 A list of all the libraries available on a given Arkeia server can be obtained with the com mand arkc library list Libid Optional The Libid parameter is the ID assigned to the library when it was created by Arkeia This ID value can be used instead of the name parameter described above For instance the two commands below are equivalent assuming that 3cb46702 is the correct ID of the Library named Lib04 arkc library delete D name Lib04 arkc library delete D libid 3cb46702 5 8 Duplication deletion The correct syntax to delete a duplication object is the following one arkc duplication delete D I lt input file gt lt parameters gt The following parameters can be accepted for the deletion of a duplication object name Required The name parameter should contain the name of the duplication object to be deleted For instance arkc duplication delete D name FinanceDup Arkeia command line interface Manual 37 144 dupid Optional The dup id parameter is the ID assigned to the duplication object when it was created by Arkeia This ID value can be used instea
31. files present on a tape with the list command The object f i Le is used to obtain a list of files contained on a given tape When using the command arke file list it is therefore necessary to supply the name of the tape to be listed with the tpname parameter The standard syntax is therefore arkc file list D tpname name_of_tape For instance arkc file list D tpname DLT_140 The command above will list all the files contained on the tape named DLT_140 For more information on the file object please refer to the second part of this manual It is possible to filter the output of file list command with the following filter e file Displays only the files present on the tape 7 3 Listing the drives of a library with the drvlist command For the Library object arkc offers an additional l i s t command available which is the drv List command While the List command when applied to the Library object will list all the available libraries connected to a Arkeia server the drv List command will list the drives that are installed in a specific library The syntax of this command is the follow ing arke library drvlist CD IJ lt parameters gt The parameters that can be applied to this command are the following ones name Required The name parameter contains the name that was assigned to the library when it was cre ated P
32. gt The parameters that can be accepted by this command are Arkeia command line interface Manual 87 144 name tpid Required The name and tp id parameters contain respectively the name and the ID of the tape to be recycled Please note that only one parameter is needed For instance the following commands are equivalent assuming 3b98c4b3 is the correct ID for the tape named DLTOO4x arkc tape recycle D name DLTOO4x arkc tape recycle D tpid 3b98c4b3 plname plid Optional The plname and p Llid parameters contain respectively the name and the ID of the tape pool to be recycled Please note that only one parameter is needed If a tape pool is recy cled all the tapes it contains are recycled and considered as available for future operations For instance the following commands would recycle the tape pool named VX A whose ID is Baaf90a4 arkc tape recycle D plname VXA arkc tape recycle D plid 3aaf90a4 10 9 Writing a label on a tape with the write command The write command writes a new Arkeia header on a tape The correct syntax for this command is the following arkc drive write LD I lt input file gt lt parameters gt The parameters that can be accepted by this command are the following ones name drvid Required The name and drvid parameters respectively contain the name or the ID of the drive containing the tape w
33. is 3aaf90a4 arkc tape recycle D plname VXA Arkeia command line interface Manual 72 144 arkc tape recycle D plid 3aaf90a4 9 2 Recycling duplication tapes with recycle _tpused The Arkeia tape duplication object duplication provides a mechanism to notify if a tape has been modified since its last duplication Internally Arkeia stores a special file named tpused Lst which is used to track the tapes that have been duplicated By recycling deleting one entry in this file it is possible to indicate that a tape has been modified since its last duplication and should probably be duplicated again The proper syntax for this recycling operation is the following one arkc duplication recycle_tpused LD I lt input file gt lt parameters gt The only parameter required for this operation is the following one name Required The name parameter should contain the name of the duplication object whose entry should be recycled For instance arkc duplication recycle_tpused D name CAD_Dup The parameter above indicates that the source tape of the CAD_Dup duplication object has been modified and should be duplicated again if the data it contains is important enough to warrant a duplication Please note that this parameter can be replaced by the dupid parameter which should contain the ID of the same object The value of dup id like the value of name is assi
34. is possible to use or the other to des ignate a specific drive with the wr i te command For instance arke drive write D name CDLT 8000 tpname JackTape arkc drive write D drvid 3aeffff3 tpname JackTape Please note that the two commands above are equivalent assuming 3ae f f f f 3 is the cor Arkeia command line interface Manual 108 144 rect ID for the drive named DLT 8000 For more information on the t pname param eter please see below tpname Required The tpname parameter should contain the new header name of the tape For an exam ple of the syntax of this parameter please see the name drvid parameter examples above Please note arkc does not allow the header of a tape to be written if the tape already has an existing header To force the header to be written to the tape using the write command use the overwrite parameter see below overwrite Optional Using the overwrite parameter it is possible to delete the existing header of a tape and replace it with the new header For instance arke drive write D name CDLT 8000 tpname JackTape overwrite Please note that the command above should be entered all on one line This replaces the existing header of the tape introduced in the drive DLT 8000 by the header Ja ck Tape Arkeia command line interface Manual 109 144 14 The drivepack object This chapter will detai
35. itself is a normal UNIX regular expressions For instance exc_filter D dat The filter above won t backup the files whose name contain an upper case w followed by any two characters and by the letters dat For instance a file named Data Base D56 dat would not be backed up with such a filter in place cmd_before Optional The parameter cmd_before defines a command that has to be executed before the Savepack is processed by Arkeia Please note that the command will be executed on the cli ent machine This parameter accepts any command that can be executed including the path if necessary For instance cmd_before LErm fv home jack temp tmpJ Arkeia command line interface Manual 95 144 This command will remove all files ending with tmp in the directory home jack temp prior to the backup of the directory home jack contained in the Savepack do_cmd_before Optional The parameter do_cmd_be fore defines the behavior of Arkeia if the command defined by the parameter cmd_be fore fails This parameter can accept two values YES or NO If do_cmd_before is set to YES the back up will proceed even if the com mand failed If it is set to NO the backup of the Savepack will be aborted if the command launched before the backup fails cmd_after Optional The parameter cmd_after defines a command that has to be executed after the Save pac
36. jack mail tree_family 1 tree_priority 1 lt ITEM gt lt ITEM gt tree_name station0O1 home jack CADfiles tree_family 0 tree_priority 0 lt ITEM gt lt ITEM gt tree_name station0O1 home jack project documentation tree_family 0 tree_priority 0 lt ITEM gt In the example above the two families 0 and 1 are given different levels of priority Tree family number 0 home jack CADfiles and home jack project docu mentation are given a higher priority to reflect their higher importance while tree 1 is given a lower priority This gives the result that both families will be backed up in parallel by Arkeia while giving a higher priority to the documentation and CADfiles direc tories The default value of tree_priority is 50 tree_chain Optional The parameter t ree_chain is used to create a dependency between trees contained in a Savepack If two trees are created with the same tree_chain value from 1 to 128 a dependency is created between the two trees To control the backup order the tree_priority should be used please see above for more information Please note that a value of O means there are no chaining no dependencies between trees tree_type Optional The parameter tree_type defines the type of tree that will be a part of the Savepack This parameter can accept three different values which are TREE standard ob
37. loading command parameters 21 Error while executing request 22 Error while displaying command result 23 Internal error 24 Error wrong server version 25 Arkeia command line interface Manual 57 144 Exit codes returned by the drive read command is full 0 is empty 1 Error messages string MLC_ERROR_DEFAULT Internal error MLC_ERROR_ALLOCATION Internal error MLC_ERROR_BAD_SERVER_VERSION You tried to use arkc with an Arkeia Backup Server whose version is older than version 4 1 8 MLC_ERROR_INVALID_PARAMETER_X Internal error MLC_ERROR_ARGUMENT_NOT_FIND You haven t set a parameter or an option with a proper value For example property without a parameter name MLC_ERROR_INVALID_OBJECT The current command is waiting for an object value Your command may contain two different objects MLC_ERROR_INVALID_ACTION You tried to execute an operation which is not allowed with the object chosen MLC_ERROR_LOADING_OBJECT The arkc command Line contains a command but not an object MLC_ERROR_LOADING_ACTION A command could not be found on the command Line MLC_ERROR_INPUTFILE_ARGUMENT An input file option I has been used without specifying a file name Do not insert a space character between I and the filename MLC_ERROR_OUTPUTFILE_ARGUMENT An output file option 0 has been used without specifying a file name Do not insert a space character between 0 and the filename MLC_ERROR
38. lt ITEM gt lt ITEM gt tree_name station01 home jack CADfiles tree_family 0 tree_priority 0 lt ITEM gt lt ITEM gt tree_name station01 home jack project documentation tree_family 0 tree_priority 0 lt ITEM gt In the example above the two families 0 and 1 are given different levels of priority Tree family number 0 home jack CADfiles and home jack project docu mentation are given a higher priority to reflect their higher importance while tree 1 is given a lower priority This gives the result that both families will be backed up in parallel by Arkeia while giving a higher priority to the documentation and CADfiles direc tories The default value of tree_priority is 50 tree_chain Optional The parameter t ree_chain is used to create a dependency between trees contained in a Savepack If two trees are created with the same tree_chain value from 1 to 128 a dependency is created between the two trees To control the backup order the tree_priority should be used please see above for more information Please note that a value of O means there are no chaining no dependencies between trees tree_type Optional The parameter tree_type defines the type of tree that will be a part of the Savepack This parameter can accept three different values which are TREE standard object file or directory OBJECT the result of a
39. read command checks if a tape is present in a given tape drive If this is the case it will then display the tape header The syntax for this command is the following arke drive read LD I lt input file gt lt parameters gt This command accepts only one parameter drvname or drvid which is detailed below drvname drvid Required The parameter drvname contains the name of the drive that should be checked for the presence of a tape For instance arke drive read D drvname ecrix_2 The command above indicates that the drive to be checked for the presence of a tape is ecrix_2 If drvid should be used the following command would be equivalent to the command above assuming the ID of the drive ecrix_2 is 3aaf7e63 arke drive read D drvid 3aaf e63 It is possible to filter the output of the read command with the following filters tpname Displays only the name of the tape present in the drive tpid Displays only the ID of the tape present in the drive For instance the following command will display the ID of the tape present in a drive arkc drive read D name 3RD_DLT Ftpid Arkeia command line interface Manual 89 144 11 The pool object This chapter of the manual details all the commands that can be applied to the pool tape pool object of arkc 11 1 Pool creation The creation of a tape pool with arkc through the create command
40. syntax is the following arkc duplication start CD I lt input file gt lt parameters gt The following parameters are valid when starting a tape duplication operation name Required The name parameter contains the name of the duplication object that should be started This name is assigned to the duplication object during its creation For instance arkc duplication start D name LTCD Duplication The command above would start the tape duplication named TCD Duplication dupid Optional The dupid parameter contains the ID of the duplication object that should be started Please note that this parameter can be used instead of the name parameter described above The ID of the duplication object is assigned to it when it is created and can be obtained by entering the command arkc duplication list D name lt duplication_name gt For instance the two commands below are equivalent assuming 3b98c4b1 is the cor rect ID for the tape duplication named TCD Duplication arke duplication start D name LTCD Duplication arkc duplication start D dpid 3b98c4b1 force Optional The force parameter will force the duplication even if the copy and the original tape appear to be identical The force parameter accepts only value 1 which forces Arkeia to duplicate the tapes which can be interesting if it is necessary to copy a tape several times Arkeia command lin
41. the new pool For instance name Safe_Pool creates a tape pool named Sa fe_Poo L Please note that it is possible to assign a name that contains space if this name is entered between square brackets E 1 For instance name LR amp D tape pool The parameter above will create a Tape Pool named R amp D tape pool owner Optional The owner parameter indicates which Arkeia user is the owner of the tape pool By default the value of owner is set to the user who opened the session It is possible to spec ify a different user than the user currently logged in to the session For instance if the com mand arkc user list returns the following list of users name jsmith John Smith name tchang Tina Chang name root The owner value can be either jsmith tchang or root comment Optional The comment parameter can be used to insert a short string to offer more information to the user about the tape pool being created The comment is displayed in the Arkeia GUI or with the List command of arke For more information on this command please refer to Listing objects with the list command on page 48 The correct syntax for this parameter is as follows comment LThis group of tape should be placed in the safel Please note that comment containing spaces should be placed between square brackets L I as shown above 4 3 D
42. tree_follow_fs determines if Arkeia should follow shared file sys tems for instance NFS while saving the tree For more information please refer to the follow_fs parameter in Savepack creation on page 20 tree_inc_filter Optional The parameter tree_inc_filter determines an include filter for the tree backup For more information please refer to the inc_f ilter parameter in Savepack creation on page 20 tree_exc_filter Optional The parameter tree_inc_filter determines an exclusion filter for the tree backup For more information please refer to the exc_f ilter parameter on page 22 12 4 Listing avalaible savepacks wit the list command For more information on the list command please refer to the chapter named The informational commands and objects of arkc on page 48 and especially the section Listing objects with the list command on page 48 Arkeia command line interface Manual 102 144 13 The drive object This chapter will detail the ar kc commands applicable to the drive object 13 1 Drive creation The creation of a tape drive with arkc through the create command uses the fol lowing syntax arkc drive create D I lt parameters gt The parameters that can be used while creating a tape drive are the following ones name Required The name parameter indicates the name which is going to be us
43. useful when the time comes to retire a tape at the end of its life and delete it from the Arkeia database The syntax for the statistics command is the following one arkc tape statistics LD I lt input file gt lt parameters gt The possible parameters of the statistics command are the following name tpid Required The name and tp id parameters contain respectively the name and the ID of the tape whose statistics should be displayed Please note that only one parameter is needed For instance the following commands are equivalent assuming 3b98c 4b3 is the correct ID for the tape named DLTOO arkc tape statistics D name DLTOO arkc tape statistics D tpid 3b98c4b3 plname plid Optional The plname and p Lid parameters contain respectively the name and the ID of the tape pool to be analyzed by the statistics command Please note that only one parameter is needed Ifa tape pool is used all the tapes it contains are analyzed and their sta tistics displayed For instance the following commands would display the statistics of the tape pool named V XA whose ID is 3aaf90a4 arkc tape statistics D plname VXA arkc tape statistics D plid 3aaf90a4 Arkeia command line interface Manual 85 144 10 7 Displaying log information with the journal object The arke journal object is used to display the log of the Arkeia server The correc
44. was created by Arkeia This ID value can be used instead of the name parameter described above For instance the two commands below are equivalent assuming that 3bc 46702 is the correct ID of the Drivepack named DLT_drivepack arkc drivepack delete D name DLT_drivepack arke drivepack delete D plid 3bc46702 14 3 Drivepack modification To modify a Drivepack using the modify command of arkc the following syntax should be respected arkc drivepack modify D name name_of_drivepack lt parameters gt Arkeia command line interface Manual 112 144 It is highly recommended to use an input file with the option 1 to modify a Drive pack Each item to be added to a Drivepack should be contained within an lt ITEM gt lt ITEM gt statement The parameters that can be added to such an input file are the following ones drvname Optional The parameter drvname contains the name of the drive to be added to the Drivepack You can obtain a list of drives installed on the Arkeia server by entering the following com mand arkc drive list To add a drive to a Drivepack the following syntax should therefore be used lt ITEM gt drvname DLT01 lt ITEM gt The above lt I TEM gt will add the drive DLT01 to a Drivepack assuming a drive of that name exists on the Arkeia server drvid Optional The parameter dr vid contains the ID of the drive to be adde
45. will only accept new commands from the user after the restoration is completed If the value NO is used arke will immediately accept new commands from the user exec Optional The exec parameter modifies the behavior of the restoration The following operation can be entered as the value of this parameter ABORT Stops the current restoration SETTAPE Indicates that a new tape has been inserted SETDRIVE Set a drive for the current restoration For instance the following command would abort the running restoration with the ID 3a6729dc arkc restore connect D rstid 3a6 729dc exec ABORT drvname Optional The parameter drvname indicates either a the drive that contains the new tape if exec has the value SETTAPE or b the drive that should be used for the restoration if exec has the value SETDRIVE This parameter is required if the exec parameter has the value SETTAPE or SETDRIVE Please refer to the exec parameter above for more information For instance arkc restore connect D rstsid 3a6 729dc exec SETDRIVE drvname ecrix_2 The command above indicates to the restoration with an ID of 3a6729dc that the drive to be used for the operation is the ec r ix_2 drive Please note that this command should be placed all on one line 9 6 Finding a file with the where command Finding a file that should be restored can be a time consuming p
46. you can see in the example above all the parameters that follow the option D are in the format parameter vaLlue In the remainder of this manual the different parameters will be given with a short explanation of the values they can take e The 1 input file option The syntax of the 1 option is the following arkc object command linput_file If the 1 option is used arkc will search the input_file for the parameters requested by the command This file is a standard UNIX configuration file and can con tain comments if these are placed on a line that starts with the number character To go back to the tape example above here is the content of an input file that cre ates a file tape Demonstration Input File for arkc Name of the tape name DemoTape Comment comment LThis is a demonstration tape J Type of tape type CFILE 50MB Localization of the tape voltag home jack arkc files Recycling rules RECYCLE_IN SCRATCH_POOL RECYCLE_MODE FIFO This demo input file for arkc should create a file tape with a size of 50MB within the directory indicated Arkeia command line interface Manual 10 144 at the voltag Line Please note the following points in the file displayed above Whenever a value assigned to a parameter contains spaces it must be enclosed within square brackets E 1 For instance the comment and
47. 1090001 SO Tape X4 created by root 2000 11 19 20 00 43 1090001 1005065323 Tape X4 removed by root In the example messages above we can see that the user root has created a tape named x4 and deleted it 13 days later A normal log would of course contain a lot more information For more information on the parameters that can be accepted by this command please refer to the section named Possible parameters for the journal object and commands on page 61 Displaying the tape related information The syntax to display only the tape related information contained in the Arkeia log is the following arkc journal jtape D lt parameters gt For more information about the parameters that can be accepted by this command please refer to the section named Possible parameters for the journal object and com mands on page 61 Displaying the drive related information The syntax to display only drive related information from the Arkeia log is the follow ing arkc journal jdrive D lt parameters gt Displaying the restoration related information The syntax to display only restoration related information from the Arkeia log is the following arkc journal jrestore D lt parameters gt Possible parameters for the journal object and commands The parameters that can be accepted by the journal object are detailed below Please note that these parameters
48. 1D its name NAME and the number of tapes it contains NB_TAPES Arkeia command line interface Manual 92 144 12 The savepack object This chapter of the manual will detail all the ar kc commands that can be applied to the savepack object 12 1 Savepack creation Within Arkeia a Savepack is a group of files directories disks or even whole set of machines which is used to simplify a backup operation Instead of choosing individual files an administrator can create a Savepack name it and use the Savepack to quickly and effortlessly create and launch repetitive backup operations To create a Savepack with arkc and its create command use the following syntax arkc savepack create LCD I lt parameters gt empty Savepack To add files and trees to a new Savepack it is neces Please note using arkc create savepack only creates an sary to use the command arkc savepack modi fy See below The parameters that can be used while creating a Savepack are the following ones name Required The name parameter assign a name to the Savepack that will be created by arkc This parameter is required by the create command The correct syntax for this parameter is name XXXXX where XXXXX is the Savepack s name For instance name Accounting creates a Savepack named Accounting If youd like to insert spaces in the name of the Savepack you s
49. ARKC ARKEL arkeia COMMAND LINE INTERFACE e Summary This manual contains detailed explanations on the commands of arkc the Arkeia command line interface e Table of contents LPOG OU nasen E A E E eniaanala 2 Installation and configuration of AIR et cesar tetas beta eebaldee ceeded odasteauesiis 4 rke syntax ANd ONT oe ceca eat entvecivecadecca vee cafchbven len sabe fede acancligian aira 7 The create command of arkC s sssssssssssssssssisssrssnissnssnesenrsenrnnrenrnnntnnnrnnrnntnnnrnnnrnnnrnntrnnnrennnnne aereerre 14 The delete command of ANC s sssssssssssssssssisssrssnrssnssnrsenrsenrssnrnnrnnnrnnnrnnrnntnnnrnnnrnnrnntnnnnrennnnnt deinen 32 The modify command of ark ss Sa cheetah alten er cell ede pl 39 The informational commands and objects Of Ark csssssseessecseesssssssnseeeessessssneneie eeeeeeee 48 The start and the stop commands of arkc ccxcs accasssstercastectatsadaacustecinesuesaertranlecceline aves 64 Miscellaneous commands ss ssssssissstsssrsstrsstnssrnssrssennntnntnnernnennnnnnntnnernnnnnnnnnnnnnnnnnnaannnnnnnnnn ae Odes 72 The tape object een er eee eee nee ono ne En ee EOE Oe ce nT 79 The pool opjeChisnsenninis aa ener ESRC An ree 90 The SAVED ACK object cs erate aera en tte tein in eared rennin 93 The drive ONG GY aces tate ce alte react annn a Prarie meen ea tacit Deen need ope ee thee 103 The driv pack Obja Otni 110 Wie TINY ODJECU hxc
50. ES the command defined by the parameter cmd_af ter will always be executed even if the backup itself fails If it is set to NO the command defined by cmd_af ter will not be executed if the backup of the Savepack has failed Arkeia command line interface Manual 23 144 4 5 Drivepack creation A Drivepack is a group of drives that is created within Arkeia in order to ease the man agement of large backups that may span several tapes drives Drivepacks allow the user to group drives and use them as a single entity for all backup operations Drivepacks are created with the following command arkc create drivepack LCD I J lt parameters gt The parameters that can be accepted while creating a Drivepack are the following name Required The name parameter assign a name to the Drivepack that will be created by arkc This parameter is required by the create command The correct syntax for this parameter is name XXXXX where XXXXxX is the Drivepack s name For instance name 3rd_Floor creates a Drivepack named 3rd_Floor If youd like to insert spaces in the name of the Drivepack you should enter the name between square brackets E 1 For instance name LDLT Drivepack J comment Optional This parameter is used to assign a descriptive comment to the Drivepack being created This comment can be useful to display additional information The correct syntax for this p
51. FIFO first in first out or L I FO last in first out If the value chosen is F 1 F 0 the oldest recycled tape will be used for a backup If the value is L 1 F0 the newest recycled tape is used for the backup For instance recycle_mode FIFO Please note that the values of this parameter should be entered all in uppercase letters The default value is F I FO access Optional The parameter access defines the access rights for the tape created The possible access rights are the following WRITE READ RECYCLE DELETE CLEAN The different rights are defined within the same access parameters as follows Arkeia command line interface Manual 81 144 access LWRITE READ RECYCLEJ D The parameter above authorize the WRITE READ and RECYCLE operations on the tape that was created but not any other The default rights on all tapes are READ WRITE RECYCLE and DELETE voltag Optional The parameter vo l tag is applied only to the tape of the type F ILE see above for tape types The value of this parameter is the path which will be used to create the file itself For instance Directory for the tape voltag home jack arkeia files arkeia_file The parameter above will create an Arkeia FILE tape in the directory home jack arkeia files arkeia_file Please note that this parameter is required by all FILE tapes You cannot put more than one
52. IND_DEV dev st0O DRV_TYPE STD_AIT NAME Sony AIT2 Arkeia command line interface Manual 105 144 TIME_AFTER_CLEAN 14924 The following tape drive parameters can be changed using the modify command rewind_dev tape drive UNIX controller access access rights of the tape drive and comment These parameters are described in more detail in the section above Drive creation on page 103 13 4 Obtaining information on drives with the type command The type command is designed to provide information on the type of objects that can for instance be created by arkc Its syntax is as simple as the one of the List command arkc object type We have seen several examples of this command in the previous chapters and sections of this manual For drives the command arke drive type will list all the drive standards that can be managed by Arkeia 13 5 Displaying drive related logs with the journal object The arke journal object is used to display the log of the Arkeia server The correct syntax to use for this is the following arkc journal command D lt parameters gt The different commands that can be used with the journal object are the following journal all Displays all log information journal jtape Displays only tape related information journal jdrive Displays only drive related information journal jbackup Displays only backup rel
53. Lib01 Libid Optional The lL ibid parameter is the ID that was assigned to the library when it was created It can replace the name parameter For instance the two commands below are equivalent assuming that 3b614c 30 is the valid ID for library Autopack30 arke library drvlist D name Autopack30 arke library drvlist D lLibid 3b614c30 The output of the drv List command can be modified with the help of the follow ing filters drvname Displays only the names of the drives present in a library Arkeia command line interface Manual 117 144 drvid Displays only the IDs of the drives present in a library drvnum Displays only the numbers of the drives present in a library Please note it is possible to combine several filters For instance the following command would list the drives present in library IBM Lib and display both their names and IDs arkc library drvlist D name IBMLib Fdrvname Fdrvid 15 6 Additional library information with the type command The type command is designed to provide information on the type of objects that can for instance be created by arkc Its syntax is as simple as the one of the List command arkc object type We have seen several examples in the previous sections of this manual For libraries the command arke Library type will list all the libraries that can be managed by Arkeia 15 7 Starting and sto
54. Library e duplication In addition the command list accepts the following filters Filters for the dr i ve object The following filters are available for the dr i ve object name to list the names of the drives and drv id to list the ID of the drives It is possible to combine the two with for instance arke drive list Fname Fdrvid The command above would list all the drives available on a server by putting the name of the drive first followed by its ID Please note that there is no space between F and the name of the filter Filters for the savepack object The following filters are available for the savepack object name lists only the name of the savepacks and skid lists only the ID of the savepacks Please see above for an example of combined filters Filters for the dr ivepack object The following filters are available for the drivepack object name to display only the name of the drivepacks and dk id to display only the IDs of the drivepacks Please see above for an example of combined filters Filters for the Library object The following filters are available for the Library object name displays only the Arkeia command line interface Manual 49 144 name of the library and L ibid displays only the ID of the library Please see above for an example of combined filters 7 2 Listing
55. NCTION Internal error MLC_ERROR_BAD_VALUE arkc has found an incorrect parameter value on the command Line MLC_ERROR_LOADING_HELP_FILE Internal error MLC_ERROR_LOADING_INDEX_FILE Internal error MLC_ERROR_UNKNOWN_INDEX Internal error MLC_ERROR_PARSING_HELP_FILE Internal error 7 11 Displaying log information with the journal object The arke journal object is used to display the log of the Arkeia server The correct syntax to use for this is the following arkc journal command D lt parameters gt The different commands that can be used with the journal object are the following journal all Displays all log information journal jtape Displays only tape related information journal jdrive Displays only drive related information journal jbackup Displays only backup related information journal jrestore Displays only restoration related information The rest of this section will detail the different commands listed above Since all the commands accept the same parameters these will be detailed at the end of the section Displaying the complete log information The correct syntax to display the complete information contained in the Arkeia log is the following arkc journal all D lt parameters gt For instance the following command will display the complete Arkeia logs arkc journal all Arkeia command line interface Manual 60 144 2000 11 06 17 46 46
56. Recycling functions access Access rights of the tape comment These parameters are described in more detail in the chapter The create command of arkc on page 14 of this manual 6 2 Drive modification To modify a tape drive characteristics the syntax of arkc is the following arkc drive modify CD I lt input file gt lt parameters gt To modify a tape drive it is necessary to supply to arkc its name or its drv id For more information on this parameter please refer to The create command of arkc on page 14 To obtain a list of the names of the available tape drives it is always possible to enter the following command arkc drive list To obtain a detailed list of the existing characteristics of a specific tape drive including the drv id parameter it is possible to enter the command Arkeia command line interface Manual 39 144 arkc drive list D name name_of_drive For instance the following command will return all relevant information on the tape drive named Sony AIT2 arkc drive list D name Sony AIT2 PID 19533 DRVID 3bc1d31b COMMENT Sony AIT 2 drive plugged on Zeus NODE zeus OWNER jsmith DRV_NUM 0 LIBID 0 DRV_DENY 0 STATUS E TIME_BEFORE_CLEAN 32767 USAGE_TIME 14924 NB_LOADS 0 CONTROL_DEV dev stO NONREWIND_DEV dev nulLl REWIND_DEV dev stO DRV_TYPE STD_AIT NAME Sony AIT2 TIME_AFTER_CLEAN 14924 The following tape drive parameters can be
57. UNIX system 2 1 Installation using tar gz packages To install the ar kc package on a system using a tar gz package please go through the steps indicated below Login as the root user This is usually achieved through the su command su root Check the presence of the arke package with Ls command The package name usu ally contains a version number as indicated below Ls arkc 4 1 17 1 tar gz Please note that the version number may be different than the one indicated above You should first unzip the file by entering the gunzip command gunzip arkc 4 1 17 1 tar gz You should now have a tar archive file named arkce 4 1 17 1 tar You should untar this file with the command tar xf arkc 4 1 17 1 tar Arkeia command line interface Manual 4 144 To complete the installation you should enter the directory created by the tar com mand and launch the installation script that should be present For instance cd arkc 4 1 17 1 install The install script will then proceed to install the arkc software on the target machine It will ask several questions as well as default answers for these questions Once the script has finished running a valid installation should have been performed For instance here is the start of the installation procedure install 11800020 main xxxxxexxxxeeeKe Start of installation x kx kx 11800020 distrbinstall The path is h
58. YES and NO If the value YES is used arkc will only accept new commands from the user after the backup is completed If the value NO is used a rkc will immediately accept new commands from the user exec Optional The exec parameter modifies the behavior of the running backup The following opera tion can be entered as the value of this parameter ABORT Stops the current backup Arkeia command line interface Manual 75 144 ADDSK Add a new Savepack to the current backup SETTAPE Indicates that a new tape has been inserted SETMODE Modifies the mode of the backup For instance the following command would abort the running backup with the ID 3a6718dc arkc backup connect D bksid 3a6718dc exec ABORT drvname Optional The parameter dr vname determines the drive that contains the new tape This parameter is required if the exec parameter has the value SETTAPE Please refer to the exec parameter above for more information For instance arkc backup connect D bksid 3a6718dc exec SETTAPE drvname ecrix_2 The command above indicates to the running backup with an ID of 3a6718dc that a new tape has been inserted in the drive named ec ri x_2 and can be used to save the data being backed up Please note that this command should be placed all on one line mode Optional The parameter mode should only be used if the exec parameter is set to
59. _ARGUMENT_SYNTAX arkc has detected a syntax error while parsing the parameters list Perhaps a parameter value or a character has not been entered MLC_ERROR_ARGVALUE_MISSED arkc has detected a syntax error while parsing the parameters list Perhaps a parameter value or a character has not been entered MLC_ERROR_ARGUMENT_MISSED arkc has detected a syntax error while parsing the parameters list Perhaps a parameter value or a character has not been Arkeia command line interface Manual 58 144 entered MLC_ERROR_TO_MUCH_BRACKETS arkc has detected a syntax error while parsing the parameters List It may be possible that there are too many characters COC or present on the command Line MLC_ERROR_TO_MUCH_AFFECTATION arkc has detected a syntax error while parsing the parameters List It may be possible that there are too many characters on the command Line MLC_ERROR_ARGUMENT_NOT_USED Internal error MLC_ERROR_UNKNOWN_ARGUMENT arkc has detected a syntax error on the command Line There may be a bad argument Please try the helpme option see FAQ help section MLC_ERROR_INPUTFILE_OPEN arkc could not open the file specified as the input file with the I option on the command Line MLC_ERROR_INPUTFILE_NOT_EXIST arkc could not find the file specified as the input file with the I option on the command Line MLC_ERROR_INPUTFILE_PARSING arkc could not find the file specified as the inp
60. _LZ3 LZ1 LZ3 NO_COMPRESS The default value for the compress parameter is LZ1_LZ3 which lets Arkeia choose the optimal compression scheme between LZ1 and LZ3 based on the data contained in the file being backed up The value NO_COMPRESS turns the file compression function off crypt Optional This parameter defines the type of encryption that will be applied to the files contained in a Savepack The possible values for c ryp t are the following DES_BLOWFISH DES BLOWFISH NO_CRYPT By default the value of crypt is DES_BLOWFISH Using the value NO_CRYPT turns off the encryption features of Arkeia The encryption functions that are available within Arkeia are described in much more details in the Arkeia User Manual which is avail able on Knox Software web site http www arkeia com symb_link Optional The parameter symb_link determines the behavior of Arkeia when it encounters a UNIX symbolic link within the files contained in a Savepack The possible values for this parameter are YES or NO A value of YES indicates that Arkeia should follow the symbolic links and a value of NO indicates that symbolic links should not be followed The default value for this parameter is NO Arkeia command line interface Manual 94 144 Please note The symb_l ink parameter should be used with caution as symbolic links can sometimes refer
61. abase which is a long and time consuming process For more information on the delete command please refer to the chapter named The delete command of arkc on page 32 and especially to the section named Tape dele tion Recycling a tape means the tape related information is still contained in the Arkeia data base but the tape data itself can be erased for instance for a newer backup In effect the tape is marked as available for all future backup operations The recycle command has the following syntax arkc tape recycle LD I lt input file gt lt parameters gt The parameters that can be accepted by this command are name tpid Required The name and tp id parameters contain respectively the name and the ID of the tape to be recycled Please note that only one parameter is needed For instance the following commands are equivalent assuming 3b98c4b3 is the correct ID for the tape named DLTOO4x arkc tape recycle D name DLTOO4x arkc tape recycle D tpid 3b98c4b3 plname plid Optional The plname and p Lid parameters contain respectively the name and the ID of the tape pool to be recycled Please note that only one parameter is needed If a tape pool is recy cled all the tapes it contains are recycled and considered as available for future operations For instance the following commands would recycle the tape pool named VX A whose ID
62. ack to be added to the running job For instance arkc backup connect D bksid 3a6718dc exec ADDSK skname JackFiles The command above adds the Savepack named JackFi les to the running backup des ignated by the ID 3a6718dc Please refer to the exec parameter above for more information 16 3 Displaying the completed backups with done It is possible to display a list of all backup operations completed by using the done command of arkc The syntax of this command is the following one arkc backup done C LCD I lt input file gt lt parameters gt J The command arke backup done will simply list all the backup that have been completed To obtain a more informational message it is necessary to filter the output of this command with the following filters bksid Displays only the ID of the backups Arkeia command line interface Manual 129 144 date Displays only the date numerical of the backups sdate Displays only the date string of the backups For instance here are a few examples of filters and their outputs arkc backup done bksid 3a6718dc arkc backup done Fsdate sdate 2001 01 18 16 25 arkc backup done Fsdate Fbksid bksid 3a6718dc sdate 2001 01 18 16 25 16 4 Displaying the list of backups in progress with running The running command can be used to display the list of backups that are in progress on the Arkeia server Further i
63. act with Arkeia To allow other programs to interact with Arkeia Knox Software has created arke which is a command line interface to most of the functions of Arkeia Through arkc system administrators as well as other programs and utilities can access the full power of Arkeia Within arkc every function of Arkeia can be accessed by using a command typed on standard UNIX command line Therefore the user or the utility accessing arke can create tapes and drives start a backup or a restoration etc 1 2 About this manual This manual is designed primarily for system administrators Knox Software recom mends to every user to read through this manual before attempting to use arkc This manual has been designed to be as clear as possible To that end it uses different typefaces to ease the presentation of information to its readers This font represents the command or the options of arkc that should be entered by the user on a UNIX command Line This type of paragraph represents steps that should be followed to obtain a desired result or the different uses and parameters of a command This type of paragraph represents important information that should be read by all users The information contained in such a paragraph could for instance potentially affect the proper operation of ar kc or Arkeia This manual is divided into three parts the first one will present the installation the configuration the syntax as wel
64. al 140 144 For more information on the List command please refer to the section named Listing objects with the list command on page 48 of this manual 19 5 The role command The role command is a limited version of the t ype command that applies only to the user objects of Arkeia To obtain all the roles available to Arkeia users enter the command arkc user role The three roles that are available for Arkeia users are OPERATOR USER and ADMINISTRATOR Please note that when a user is created a role should be defined and entered in upper case under the parameter role For instance the following input file defines a valid Arkeia user i TUTTA File name jack txt User creation file for arkc EE EE EN EE E E S E E E E SS Se E Basic features name Jack Smith role ADMINISTRATOR node station01 Optional features email jackafoobar com End of file To create the user Jack Smith the following command should therefore be entered assuming the input file is named jack txt arkc user create Ijack txt Arkeia command line interface Manual 141 144 20 The tape duplication object Y This chapter will detail the ar kc commands that can be applied to the tape dupli cation object Important information Please note that the tape duplication functions are only available in version 5 x and following of ar
65. alent to the command above assuming the ID of the drive ecrix_2 is 3aaf7e63 arke drive read D drvid 3aaf e63 It is possible to filter the output of the read command with the following filters tpname Displays only the name of the tape present in the drive tpid Displays only the ID of the tape present in the drive For instance the following command will display the ID of the tape present in a drive arkc drive read D name 3RD_DLT Ftpid 9 5 Modifying a job with the connect command The connect command allows a job in process backup or restoration to be modi fied on the fly while it is being performed by Arkeia This command is very useful if the configuration of your Arkeia server is limited to one drive as it allows the running task to proceed even if it is waiting for a new tape e Modifying a running backup The standard syntax to modify a running backup with the connect command is the following arkc backup connect LD I lt input file gt lt parameters gt The following parameters can be used to modify a running backup job bksid Required The bksid parameter contains the ID of the backup to be modified This ID is returned by arkc when a backup is started with the st art command wait Optional The wait parameter is used to determine the behavior of ar kc at the end of the backup operation This parameter can accept two values
66. an be accepted while deleting a tape pool are the following ones name Required The name parameter should contain the name of the pool to be deleted For instance arkc pool delete D name Test_Pool A list of all the tape pools available on a given Arkeia server can be obtained with the com mand arkc pool list plid Optional The p Lid parameter is the ID assigned to the tape pool when it was created by Arkeia This ID value can be used in place of the name parameter described above For instance the two commands below are equivalent assuming that 3a78354e is the correct ID of Test_Pool arkc pool delete D name Test_Pool arkc pool delete D plid 3a 78354e Please note To delete a tape pool it is necessary to first delete all the tapes that it contains A tape pool which is not empty of tapes cannot be deleted by arkc Any attempt to delete a non empty tape pool will pro duce an error message 5 3 Drive deletion Deleting a drive allows the system administrator to quickly reconfigure Arkeia in the case maintenance or replacement is needed for a hardware unit The correct syntax to delete a drive is the following one arkc drive delete D I lt parameters gt Arkeia command line interface Manual 34 144 Where the parameters can be the following ones name Required The name parameter should contain the name of the drive to be deleted For i
67. and debug input is the input file to be analyzed Arkeia command line interface Manual 56 144 Displaying error codes and their meanings The final use of the debug object is to display a list of all arke error codes along with their meanings To display error codes and meanings it is necessary to use the e rror 5 command The syntax for this command is the following arkc debug errors This command does not accept any parameters On some systems it may be useful to redirect the result of this command into a file and to save or print this file for future reference as illustrated below arkc debug errors gt arkc_error_list txt The command above will create a short text only file containing all the error codes of arkc e A short list of arkc error and exit codes The following is a short list of all the error codes that can be encountered while using arkc Please note that this list is not the full output of the debug errors com mand but rather a list of the most frequent errors For each error code a short explana tion is also given Main exit codes Request succeeded 0 Internal error 11 Internal error 12 Error while loading command Line options 13 Error while checking command Line options 14 Error loading preference file 15 Internal error 16 Internal error 17 Connection error 18 License error 19 Internal error 20 Error while
68. and are the following name tpid Required The name and tp id parameters contain respectively the name and the ID of the tape whose statistics should be displayed Please note that only one parameter is needed For instance the following commands are equivalent assuming 3b98 c4b3 is the correct ID for the tape named DLTOO arkc tape statistics D name DLTOO arkc tape statistics D tpid 3b98c4b3 plname plid Optional The plname and p Lid parameters contain respectively the name and the ID of the tape pool to be analyzed by the statistics command Please note that only one parameter is needed Ifa tape pool is used all the tapes it contains are analyzed and their sta tistics displayed For instance the following commands would display the statistics of the tape pool named V XA whose ID is 3aaf90a4 arkc tape statistics D plname VXA arkc tape statistics D plid 3aaf90a4 7 10 Checking parameters and errors with debug The debug object has several different uses which may be of interest The following commands can be applied to debug debug who Displays information on the Arkeia server login debug input Displays a detailed analysis of an input file debug errors Displays detailed information on error messages Arkeia command line interface Manual 55 144 The different uses of debug are detailed below e Displaying use
69. and line interface Manual 13 144 4 The create command of arkc The arke create command is used to create the following objects on an Arkeia server be tape e pool drive e savepack e drivepack user Library tape duplication We are going to detail each object that can be created with this command in the rest of this chapter Each object will include the different options that can be applied to its cre ation Please note The creation of certain objects especially the creation of libraries requires a correct license of Arkeia to be installed on the Arkeia server If the correct license is not installed ar kc will refuse the creation of the objects that are not covered by the current license 4 1 Tape creation The creation of a tape with arkc through the create command uses the following syntax arkc tape create D I lt parameters gt Please refer to the section named arkc options general on page 8 for more informa tion on the different options that can be used with arkc The parameters that can be used with the create command are the followings name Required The name parameter indicates the name which is going to be used by Arkeia to refer to the new tape This parameter is required by the create command The correct syntax for this parameter is name XXXXX where XXXXX is the name string to assign to the new tape For instance name Dem
70. and the stop commands of arke on page 64 Arkeia command line interface Manual 53 144 For instance the following command arkc backup status D bksid 3bcc2793 will return the possible values 0 The backup job is running 1 The backup needs a new tape 2 The backup is now finished If the value returned is 1 the status command also returns two values which are drvname Name of the drive to be used for the new tape tpname Name of the new tape to be inserted in the drive P Please note that it is possible to modify the behavior of a running backup by using the connect command to modify its parameters For more information on the con nect command please refer to Modifying a job with the connect command on page 75 Status of a running restoration To obtain detailed information on a running restoration the status command should be used This command has the following syntax arkc restore status LD I lt input file gt lt parameters gt This command accepts only one parameter which is detailed below rstid Required The rstid parameter contains the ID of the restoration whose detailed status should be displayed This ID is displayed when a restoration is started with the start command For more information please refer to the The start and the stop commands of arkc on page 64 For instan
71. ands below are equivalent assuming that 3a78354e is the correct ID of Test_Pool arkc pool delete D name Test_Pool arkc pool delete D plid 3a78354e Please note To delete a tape pool it is necessary to first delete all the tapes that it contains A tape pool which is not empty of tapes cannot be deleted by arkc Any attempt to delete a non empty tape pool will pro duce an error message Arkeia command line interface Manual 91 144 11 3 Displaying information on tape pools It is possible to obtain detailed information on a specific tape pool by using the list command of arkc For more information on this command please refer to the chapter of this manual titled The informational commands and objects of arkc on page 48 and especially to the section named Listing objects with the list command on page 48 For instance to list all the pools that have been defined on a server it is possible to enter the command arkc pool list name scratch pool name Sony AIT2 name MiniLTO name null name File name VXA name DAT 90 name DAT 120 name Lto By entering the name of the pool arke displays the relevant pool related information arkc pool list D name VXA NB_THREADS 000 PLID 3aaf90a4 NAME VXA lt ITEM gt THREAD 000 NB_TAPES 00009 lt ITEM gt In the example above all the information on the tape pool named vxa is displayed including its ID line PL
72. anuary to 12 December For instance arke journal jtape D month 10 The command above will display all the tape related information and messaes that took place during the month of October of the current year By default the month displayed by the journal object is the current month Level Optional The parameter level specifies the quantity of information that should be displayed by a command This parameter can accept three different values 1 information messages W warning messages and E error messages The default value for this parameter is Arkeia command line interface Manual 86 144 1 ZW E which displays all the log messages information warnings and errors For instance arke journal jtape D Level ZWZE The command above will only display the tape related warnings and errors that were reported by the Arkeia server during the restoration operations On the other hand the information messages won t be displayed The level parameter therefore limits the information to the most interesting messages which can be quite useful to track the source of a problem filter Optional The filter parameter adds or removes specific data from the information returned by the Arkeia log This parameter accepts the following values D date T time L level see above 1 information code and S message string The
73. aram eter is comment DAT Drivepack for small backups nbdrive Optional This parameter defines the number of drives that can be used by the Drivepack for a given operation By default the value of nbdr ive is the number of drives that are contained in the Drivepack If nbdrive has a lower value this means a group of drives within the Drivepack will be used for the first task while some drives will be reserved for other tasks For instance if a Drive pack contains 5 drives it is possible to reserve three of these nbdrive 3 for backup and keep 2 drives for restoration operations Combining this parameter with the priority parameter see below for more information offers a great flexibility to system administrators in deciding which drive will be used for what purpose Please refer to the information below drvname and drvid parameters for more details on adding new drives to a Drivepack drvname Optional To add drives to a Drivepack it is possible to use either the drvname or the drvid P P parameters Both these parameters should be contained in an input file with each drive to Arkeia command line interface Manual 24 144 be added to the Drivepack contained in a pair of lt I TEM gt lt 1TEM gt statements For instance the following lines of an input file would add the drive named DLTO1 in a Drivepack Comment First DLT drive of drivepack lt ITEM gt
74. ated information journal jrestore Displays only restoration related information The rest of this section will detail the jdr ive command listed above Displaying the drive related information The syntax to display only drive related information from the Arkeia log is the follow ing arke journal jdrive C D lt parameters gt Arkeia command line interface Manual 106 144 e Possible parameters for the journal object and jdrive command The parameters that can be accepted by the journal object are detailed below Please note that these parameters apply to all the commands that were listed above D all jtape jdrive and jrestore gt and that they are all optional month Optional The parameter month limits the display of the journal object to a specific month The value of month can go from 1 January to 12 December For instance arke journal jdrive D month 10 The command above will display all the drive related information that was logged during the month of October of the current year By default the month displayed by the j our nal object is the current month level Optional The parameter Leve Ll specifies the quantity of information that should be displayed by a command This parameter can accept three different values 1 information messages W warning messages and E error messages
75. bks id parameter should contain the ID of the previous backup the new backup is based on based_on_date Optional The based_on_date parameter is valid only if the type parameter is set to INCREMENTAL In this case the based_on_date parameter should contain the date of the previous backup the new backup is based on 8 2 Starting a restoration The command start allows you to start a restoration operation from the command line The standard syntax for this command is arkc restore start LCD I lt input file gt lt parameters gt The parameters that can be accepted by arke with this command are the following ones file Required The file parameter must be inserted on the command line or in an input file This P P parameter contains the name of the file or directory that should be restored For instance arkc restore start D file stormbringer home jack docs AnnualReport_2000 ps The arkc command above if entered on a command line will start the restoration of the file named AnnualReport_2000 ps which can be found on the machine named stormbringer in directory home jack docs Please note that the command above should be entered on a single line from to Optional The parameter f rom allows the restoration to take place with a redirection This means that a file restored from a directory X can be restored to another directory Y For in
76. brary load CD I lt input file gt lt parameters gt The parameters that can accepted by the load command are the following ones name Libid Required The name and Libid parameters contain the name and the ID of the library respec tively This parameter is required to indicate which library is going to be affected by the Load command For instance the following parameters are equivalent assuming 3b614c30 is the correct ID of the library named Aut opack30 name Autopack30 Libid 3b614c30 Or for a complete command arke library load D name Autopack30 slot Required The slot parameter contain the number of the slot that should contain a tape This parameter only accepts numerical values ranging from 1 first slot to the last slot avail able in the library For more information on the number of slots available please refer to the documentation supplied with the library hardware For instance the following parameter would load the tape of slot number 8 slot 8 Arkeia command line interface Manual 121 144 drvnum Optional The drvnum is the logical number of the drive that should receive the tape from the slot For instance the following parameter would load a tape into the drive number 6 of a tape library drvnum 6 Please note that by default the load command transfers the tape into the first drive e Removing a tape from a slo
77. ce the following command arke restore status D rstid 3bcc4545 will return the possible values The restoration is in progress The restoration needs a new tape The restoration is now completed The restoration requires a new drive If the value returned is 1 the status command also displays two values which are drvname Name of the drive to be used for the new tape tpname Name of the new tape to be inserted in the drive P Arkeia command line interface Manual 54 144 If the value returned is 3 the only value displayed will be dr vname as the restora tion only requires a new drive and not a new drive and a new tape Please note that it is possible to modify the behavior of a restoration in progress by using the connect command to modify its parameters For more information on the connect command and its uses please refer to Modifying a job with the connect command on page 75 7 9 Displaying additional tape information with statistics It is possible to obtain detailed statistics on a given tape by using the statistics command of arkc This command is especially useful when the time comes to retire a tape at the end of its life and delete it from the Arkeia database The syntax for the statistics command is the following one arkc tape statistics CD I lt input file gt lt parameters gt The possible parameters of the statistics comm
78. ce Manual 79 144 EXB MAMMOTH EXB MAMMOTH 2 NULL FILE 20MB FILE 50MB FILE 100MB FILE 500MB DLT 2000 DLT 2000XT DLT 4000 DLT 7000 DLT 8000 DLT1 SDLT MAGSTAR MP MAGSTAR MP C MAGSTAR MP CXL DTF GW 730L QIC 50GB QIC 25GB QIC 16GB QIC 13GB QIC 4GB QIC 2GB 3590 CART 9840 CART LTO Ultrium VXA V17 VXA V6 Please_note It is possible to obtain this list of available tape types by entering the following command arkc tape type For more information about the type command please refer to the chapter named The informational commands and objects of arkc on page 48 of this manual comment Optional The comment parameter can be used to insert a short string to offer more information to the user about the tape The comment is displayed within the Arkeia GUI or with the List command of arkc Please see the command list below for more informa tion The correct syntax for this parameter is as follows comment LThis tape is for database backup only Please note that a comment containing spaces should be placed between square brackets L I as shown above firstnum Lastnum Optional firstnum and Llas tnum allow the user to define several identical tapes with only two commands To do this it s only necessary to enter the number of the first tape after fi rstnum and the number of the last tape after Las tnum For instance the fol
79. cessary to define a source slot for the source tape as Arkeia is able to retrieve the correct tape based on its ID and or name Also please note that defining dst_slot means that dst_lib_name or dst_libid see above must be defined as well Arkeia command line interface Manual 31 144 5 The delete command of arkc The delete command of arkc while important is usually much more simple than the create command Its function is to delete objects from the Arkeia configuration Its general syntax is arkc Lobject delete D I lt parameters gt Where parameters is usually name followed by the full name that has been assigned to the object when it has been created The rest of this chapter will go into more details on the objects that can be deleted 5 1 Tape deletion To delete a date with ar kc use the following syntax arkc tape delete D lt parameters gt Please note Deleting an Arkeia tape does not affect the physical tape itself it means that the entry of the tape in the Arkeia database will be deleted The tape data won t be accessible anymore since the Arkeia data base will not have a record of the tape The only way to access the tape data again is to import the tape informa tion back in the Arkeia database with the arkrstb utility an opera tion which can be complex and time consuming if several tapes have been deleted For more information on this op
80. ck the tape pool and the Drivepack to be used The following optional parameters can be used to start a backup with arke policy Optional The parameter policy determines the tape policy to be used for the backup This parameter can accept two values COMPLETE or NEW When using the COMPLETE value Arkeia will always complete fill up the tape which has been used If the NEW value is used Arkeia will always use a new tape when starting a backup By default policy has the value COMPLETE wait Optional The parameter wait determines the behavior of arke once a backup is launched with arke backup star t This parameter can accept two values YES or NO If the value YES is used ar kc will wait until the end of the backup to return which means the user will not be able to enter any new command until the completion of the backup If the value NO is used arkc will return immediately and allow the user to enter other com mands email Optional The parameter ema i L determines if Arkeia sends an email once the backup is finished or if the backup requires a new tape to be completed This parameter can accept two values YES and NO If the value YES is used Arkeia will send an email to the user indicating if the backup is finished and or if the software requires an additional tape to complete the backup operation If the value
81. create and launch repetitive backup operations To create a Savepack with arkc and its create command use the following syntax arkc savepack create LD I lt parameters gt empty Savepack To add files and trees to a new Savepack it is neces sary to use the command arkc savepack modi fy See below Please note using arke create savepack only creates an The parameters that can be used while creating a Savepack are the following ones name Required The name parameter assign a name to the Savepack that will be created by arkc This parameter is required by the create command The correct syntax for this parameter is name XXXXX where XXXXX is the Savepack s name For instance name Accounting The parameter above creates a Savepack named Accounting If youd like to insert spaces in the name of the Savepack you should enter the name between square brackets L I For instance name LCAD CAM Savepack comment Optional This parameter is used to assign a descriptive comment to the Savepack being created This comment can be useful to display additional information The correct syntax for this param Arkeia command line interface Manual 20 144 eter is comment CSavepack for CAD machines allowed_fs Optional The parameter al Lowed_f s defines how Arkeia is going to process different file systems while backing up the Savepack This paramet
82. d RECYCLE operations on the tape that was created but not any other The default rights on all tapes are READ WRITE RECYCLE and DELETE voltag Optional The parameter vo L tag is applied only to the tape of the type F ILE see above for tape types The value of this parameter is the path which will be used to create the file itself For instance Directory for the tape voltag home jack arkeia files arkeia_file The parameter above will create an Arkeia FILE tape in the directory home jack arkeia files arkeia_file Please note that this parameter is required by all FILE tapes You cannot put more than one tape in a given directory 4 2 Pool creation The creation of a tape pool with arkc through the create command uses the follow ing syntax arkc pool create D I lt parameters gt Please refer to arkc options general on page 8 for more information on the different options that can be used with ar kc The parameters that can be accepted by the cr e ate command when it is used to create a new tape pool are the following name Required The name parameter indicates the name which is going to be used by Arkeia to refer to the new tape pool This parameter is required by the c r ea t e command The correct syn Arkeia command line interface Manual 17 144 tax for this parameter is name XXXXX where XXXXX is the name string to assign to
83. d of the name parameter described above For instance the two commands below are equivalent assuming that 3ca99702 is the cor rect ID of the duplication object named FinanceDup arkc duplication delete D name FinanceDup arkc duplication delete D dupid 3ca99702 Arkeia command line interface Manual 38 144 6 The modify command of arkc The modify command of arkc is used to change the characteristics of an Arkeia object once it has been created To create an object please refer to The create com mand of arkc on page 14 The modify command has the following general syntax arkc Lobject modify CD I lt input file gt lt parameters gt The rest of this chapter will deal with the different objects that can be manipulated using the modify command 6 1 Tape modification To modify a tape s characteristics the syntax of arkc is the following arkc tape modify LD I lt input file gt lt parameters gt To modify a tape it is necessary to supply to arkc its name or its tpid For more information on these parameters please refer to The create command of arkc on page 14 To obtain a list of the names of the available tapes it is always possible to enter the following command arkc tape list The following tape parameters can be changed using the modify command plname plid Tape Pool name and ID recycle_in recycle_mode
84. d the helpful information they can supply to Arkeia users 7 1 Listing objects with the list command The standard syntax for the List command is the following one arkc object list D I lt parameters gt This command will display all the objects currently available on the Arkeia server For instance the following command will display a list of all the tapes available on the Arkeia server arkc tape list name DLT_Tape_1 name DLT_Tape_2 name DLT_Tape_3 name DLT_Tape_4 name DLT_Tape_5 name Test_Tape_0O1 If more information is needed on a specific object the List command is able to dis play all relevant information provided the name of the object is supplied as a parameter Based on the example above here is the way to display all the information on Test_Tape_01 which is contained in the Arkeia database arkc tape list D name Test_Tape_0O1 REMAIN_SPACE 50 TOTAL_SPACE 0 REMAIN_USE 0 CID 3a7834d7 TPID 3a7834d7 PLID 3a78354e RECYCLE_MODE 0 RECYCLE_IN 0 VOLTAG home jack files test arkeia backup tmp Arkeia command line interface Manual 48 144 COMMENT This is a test tape USED_SPACE 0 CREATION_DATE 980956375 OWNER root SEG_END 0 ST_WORN 0 ST_ACCESS TPSTA_MANUAL ST_CONTENT TPSTC_NEW ST_DENY 16 TP_TYPE FILE 50MB NAME Test_Tape_0O1 The List command can be applied to the following Arkeia objects s tape e pool e drive savepack e drivepack e user e
85. d to the Drivepack This parameter is used in much the same way than the parameter drvname above For instance the following lt ITEM gt statement will add the drive DLTO1 to a Drivepack assuming 3bc419c3 is the correct ID of this drive lt ITEM gt drvid 3bc419c3 lt ITEM gt priority Optional The parameter priority defines the priority level assigned to the drive This parameter can accept values from 1 to 128 with the default and highest possible value being 4 Please note that this parameter can only be used within an input file and not on the command line The following parameters can also be modified using the modify command of arkc name dkid Drivepack name and ID and nbdrive number of drives to be used in the Drivepack Since these are functionally equivalent to the parameters of the create command please refer to The create command of arkc on page 14 for more information 14 4 Listing available drivepacks with the list commands It is possible to display detailed information on the Drivepacks with the list command For more information on this command please refer to the chapter of this manual titled The informational commands and objects of arkc on page 48 Arkeia command line interface Manual 113 144 15 The library object This chapter will detail all the arkc commands that can be applied to the
86. default value for the filter parameter is D T L 1 S meaning that all information returned by the log is displayed For instance arke journal jtape D filter Z1Z S The command above would limit the information returned by the Arkeia log to the infor mation code followed by the message string 10 8 Tape recycling the recycle command The recycle command of arkc allows the manual recycling of a tape If applied to a pool the recycle command will recycle all the tapes contained in the pool It is important to understand the distinction between the recycle command and the delete command Deleting a tape means removing its entry in the Arkeia database The data contained on the tape is therefore unavailable to Arkeia and cannot be accessed unless the tape data is re imported into the Arkeia database which is a long and time consuming process For more information on the delete command please refer to the chapter named The delete command of arkc on page 32 and especially to the section named Tape dele tion Recycling a tape means the tape related information is still contained in the Arkeia data base but the tape data itself can be erased for instance for a newer backup In effect the tape is marked as available for all future backup operations The recycle command has the following syntax arkc tape recycle LD I lt input file gt lt parameters
87. dvanced parallelism functions it is necessary to group the different trees in different families using the tree_family parameter This allows Arkeia to save these tree families at the same time The values that can be accepted by tree_family are numerical from 0 to 128 For instance Savepack configuration file for station0O1 This contains Jack Smith files lt ITEM gt tree_name station01 home jack mail tree_family 1 lt ITEM gt lt ITEM gt tree_name station01 home jack CADfiles tree_family 0 lt ITEM gt lt ITEM gt tree_name station01 home jack project documentation tree_family 0 lt ITEM gt The example above defines two tree families O and 1 Between these two families it is now possible to define the importance of each and the order in which they are going to be saved Please see below the t ree_priority and tree_chain parameters for more information Arkeia command line interface Manual 99 144 tree_priority Optional The parameter tree_priority defines the priority to be assigned to a particular tree This parameter accepts numerical values starting from 0 highest priority to 100 low est priority Trees are then backed up according to their priorities For instance starting with the example above Savepack configuration file for station0O1 This contains Jack Smith files lt ITEM gt tree_name station0O1 home
88. e existing file if any is newer Arkeia command line interface Manual 133 144 17 2 Modifying a restoration with the connect command The standard syntax to modify a running restoration with the connect command is the following arkc restore connect LCD I lt input file gt lt parameters gt The following parameters can be used to modify a running restoration bksid Required The bksid parameter contains the ID of the restoration to be modified This ID is returned by arkc when a restoration is started with the start command wait Optional The wait parameter is used to determine the behavior of arkc at the end of the restora tion This parameter can accept two values YES and NO If the value YES is used arkc will only accept new commands from the user after the restoration is completed If the value NO is used a rkc will immediately accept new commands from the user exec Optional The exec parameter modifies the behavior of the restoration The following operation can be entered as the value of this parameter ABORT Stops the current restoration SETTAPE Indicates that a new tape has been inserted SETDRIVE Set a drive for the current restoration For instance the following command would abort the running restoration with the ID 3a6729dc arkc restore connect D rstid 3a6 729dc exec ABORT drvname Optional The parameter drv
89. e gt lt parameters gt This command accepts only one parameter drvname or drvid which is detailed below drvname drvid Required The parameter drvname contains the name of the drive that should be checked for the presence of a tape For instance arke drive read D drvname ecrix_2 The command above indicates that the drive to be checked for the presence of a tape is ecrix_2 If drvid should be used the following command would be equivalent to the command above assuming the ID of the drive ecrix_2 is 3aaf7e63 arke drive read D drvid 3aaf e63 It is possible to filter the output of the read command with the following filters e tpname Displays only the name of the tape present in the drive tpid Displays only the ID of the tape present in the drive For instance the following command will display the ID of the tape present in a drive arkc drive read D name 3RD_DLT Ftpid 13 7 Writing a label on a tape with the write command The write command writes a new Arkeia header on a tape The correct syntax for this command is the following arkc drive write LD I lt input file gt lt parameters gt The parameters that can be accepted by this command are the following ones name drvid Required The name and drvid parameters respectively contain the name or the ID of the drive containing the tape whose header should be written It
90. e interface Manual 69 144 For more information on tape synchronization please refer to the section named Tape duplication creation on page 29 of this manual 8 4 Starting and stopping a library The final application of the start and stop commands are related to the tape libraries which can be managed with the help of these two commands e Starting a library In order to use a given library Arkeia has to start a specialized module that allows it to drive meaning use all the functions of a library This module is usually launched automatically for instance when a backup is started However it is sometimes necessary to start a library manually To do this the following syntax should be respected arke library start CD I lt input file gt lt parameters gt This command accepts only one parameter which is name Required The name parameter contains the name of the tape library to be started This name is assigned to the tape library during its creation For instance arkc library start D name HP SureStore 1 9 DLTI The command above would start the tape library named HP SureStore 1 9 DLT Please note the use of the square brackets around the name of the library Please _note it is possible to replace the name parameter by the Libid parameter The Ll ibid parameter is the ID of the library that should be started It can be obtained by entering the com
91. e name and the ID of the library respec tively This parameter is required to indicate which library is going to be configured by the rest of the set tape command For instance the following parameters are equivalent assuming 3b614c30 is the correct ID of the library named Aut opack30 name Autopack30 Libid 3b614c30 Or for a complete command arke library settape D name Autopack30 tpname tpid Required The tpname and tpid parameters contain the name and the ID of the tape that should be assigned to a slot in the library Only one of these parameters need to be set for the settape to be carried out correctly For instance the following command would assign the tape named VVXX01 to a slot in the library named Aut opack30 arke library settape D name Autopack30 tpname VVXX0O1 slot Required The slot parameter contain the number of the slot the tape defined above should be assigned to This parameter only accepts numerical values ranging from 1 first slot to the last slot available in the library For more information on the number of slots available please refer to the documentation supplied with the library hardware For instance the fol lowing parameter would assign a tape to slot number 5 slot 5 e Removing logical tapes from library slots with unsettape The unsettape command provides a way to remove un assign logical tapes from Ark
92. e parameters that should be entered are the name of the node server to be administered through arkc the login used for this node as well as the password Please note Entering the user name and password in a file readable by all users may pose a security risk Therefore it is sound policy to protect the arkc param file as much as possible To do this depending on the the architecture used it may be necessary to change the ownership or readable flags of this file Arkeia command line interface Manual 6 144 3 arkc syntax and options The standard arke syntax is the following arkc object command Cinput Loutput lt parameters gt lt filters gt Please note that arke diverge from the GNU convention of having short command names preceded by one dash for instance v and long command names pre ceded by two dashes for instance verbose With arkc all commands and objects should be entered fully Please refer to the objects and commands listed below for more information Please note In addition to the canonical syntax described above it is also possible to use the following syntax arkc command object input output lt parameters gt lt fil ters gt The two syntax are functionally equivalent except the arke com mand object syntax may be easier to read Both syntax are going to be used in this manual For instance the two following commands are
93. e user about the tape The comment is displayed within the Arkeia GUI or with the List command of arkc Please see the command list below for more informa tion The correct syntax for this parameter is as follows comment LThis tape is for database backup only Please note that a comment containing spaces should be placed between square brackets L I as shown above firstnum Lastnum Optional firstnum and Llas tnum allow the user to define several identical tapes with only two commands To do this it s only necessary to enter the number of the first tape after firs tnum and the number of the last tape after Las tnum For instance the fol lowing entries in a data file would create five 5 tapes Create 5 tapes firstnum 1 lLastnum 5 Please note that the name of the tapes will be the value assigned to the command name followed by the tape number The value of f irs tnum can be different than 1 plname plid Optional The parameters plname and p Ll id indicates to which tape pool the new tapes should be added The parameter p lname indicates the pool chosen by its name and plid indicates the pool chosen by its internal Arkeia ID For instance plname Test_Pool In the example above the tape created with tape create will be added to the tape pool named Test_Pool recycle_in Optional The parameter recycl
94. e_in determines in which tape pool the tape created should be placed when it is recycled There are two possible pools defined by default SCRATCH_POOL default recycling pool and CURRENT_POOL For instance the parameter recycle_in CURRENT_POOL will recycle the tape created in example above to Test_Pool if the tape was assigned to this pool when it was created By default the tape is recycled in the pool it was assigned to when it was created Arkeia command line interface Manual 16 144 recycle_mode Optional The parameter recycle_mode determines the type of recycling operation that will be applied to the tape being created This parameter can take two value FIFO first in first out or L I FO last in first out If the value chosen is F 1 F 0 the oldest recycled tape will be used for a backup If the value is L 1 F0 the newest recycled tape is used for the backup For instance recycle_mode FIFO Please note that the values of this parameter should be entered all in uppercase letters The default value is F I FO access Optional The parameter access defines the access rights for the tape created The possible access rights are the following WRITE READ RECYCLE DELETE CLEAN The different rights are defined within the same access parameters as follows access LWRITE READ RECYCLEJ 9D The parameter above authorize the WRITE READ an
95. ecure UNIX passwords to avoid security problems For instance Arkeia command line interface Manual 139 144 passwd DF56AX82VV08 vpasswd DF56AX82VV08 Please note the password defined by the passwd parameter should always be confirmed with the vpasswd parameter as in the example above 19 2 User deletion The correct syntax to delete an Arkeia user is arkc user delete D I Cname User_Name Where the parameters can be the following ones name Required The name parameter should contain the name of the user to be deleted For instance arkc user delete D name John A list of all the users available on a given Arkeia server can be obtained with the command arkc user list 19 3 User modification To modify an Arkeia user the parameters to be used are the same as with the create command For more information please refer to the section User creation on page 139 The valid syntax is therefore arkc user modify D I lt parameters gt The parameters used to modify a user are name role node email lt 9 bpi cc passwd and vpasswd For more information on these please refer to the section above 19 4 Listing available users with list It is possible to list all the valid users for a given Arkeia server by using the List com mand To do this simply enter arkc user list Arkeia command line interface Manu
96. ed If the value returned is 1 the s ta tus command also returns two values which are drvname Name of the drive to be used for the new tape tpname Name of the new tape to be inserted in the drive Please note that it is possible to modify the behavior of a running backup by using the connect command to modify its parameters For more information on the con nect command please refer to Modifying a job with the connect command on page 75 Arkeia command line interface Manual 131 144 17 The restore object This chapter will detail all the a rkc commands that can be applied to the restore object 17 1 Starting a restoration The command start allows you to start a restoration operation from the command line The standard syntax for this command is arkc restore start CD I lt input file gt lt parameters gt The parameters that can be accepted by arke with this command are the following ones file Required The file parameter must be inserted on the command line or in an input file This parameter contains the name of the file or directory that should be restored For instance arkc restore start D file stormbringer home jack docs AnnualReport_2000 ps The arke command above if entered on a command line will start the restoration of the file named AnnualReport_2000 ps which can be found on the machine named stormbringer
97. ed by Arkeia to refer to the new tape drive This parameter is required by the create command The correct syntax for this parameter is name XXXXX where XXXXX is the name string to assign to the new drive For instance name Accounting The parameter above creates a drive named Accounting type Required The type parameter indicates which type of tape drive is going to be created by arkc Please note that this parameter is required by the create command Here is a list of available types of tape drive that are valid for this parameter NULL FILE STD_AIT STD_DAT STD_EXABYTE STD_DLT STD_DTF DAT_SONY_7000 AIT_AUTOLOADER STD_QIC STD_CARTRIDGE REDWOOD_SD3 LTO MAGSTAR_MP ECRIX_VXA 9840 For instance to create a DLT tape drive a correct command syntax would be the following one arkc drive create D name DLT02 type STD_DLT rewind_dev dev st0 Arkeia command line interface Manual 103 144 Please note that this command should be entered all on one line You can also refer to the parameter rewind_dev below rewind_dev Required The parameter rewind_dev is used to define the system device used by the operating system to access the tape drive This device is usually used by the mt UNIX command For instance under most Linux systems this device is dev st0 access Optional This parameter is used to define the access rights to be assigned to the dev
98. efault the value of fol Low_fs is YES inc_filter Optional The inc_filter defines an inclusion filter that will be applied to the backup of a Save pack Once a filter is defined Arkeia will backup the Savepack files only if they match the fil ter All other files will be ignored The filter itself is a normal UNIX regular expressions For instance inc_filter W dat The filter above will only backup the files whose name contain an upper case W followed by any two characters and by the letters dat For instance a file named CAD_Project W55 dat would be backed up with such a filter exc_filter Optional The exc_filter defines an exclusion filter that will be applied to the backup of a Save pack Once a filter is defined Arkeia will not backup the Savepack files if they match the fil ter All other files will be saved The filter itself is a normal UNIX regular expressions For instance exc_filter D dat The filter above won t backup the files whose name contain an upper case W followed by Arkeia command line interface Manual 22 144 any two characters and by the letters dat For instance a file named Data Base D56 dat would not be backed up with such a filter in place cmd_before Optional The parameter cmd_before defines a command that has to be executed before the Savepack is processed by Arkeia Please note that the command will be
99. eia tape libraries This command has the following syntax arkc library unsettape LD I lt input file gt lt parameters gt This command accepts the following parameters name Libid Required The name and Libid parameters contain the name and the ID of the library respec tively This parameter is required to indicate which library is going to be targeted by the rest of the unsettape command For instance the following parameters are equivalent assuming 3b614c30 is the correct ID of the library named Autopack30 name Autopack30 Libid 3b614c30 Arkeia command line interface Manual 120 144 Or for a complete command arkc library unsettape D name Autopack30 slot Required The slot parameter contain the number of the slot that should not contain a tape This parameter only accepts numerical values ranging from 1 first slot to the last slot avail able in the library For more information on the number of slots available please refer to the documentation supplied with the library hardware For instance the following parameter would unassign the tape of slot number 8 slot 8 Loading a tape from a slot with load Once a tape has been set to a slot it is possible to oad transfer the tape from its slot into one of the tape drives of the library This is done with the Load command The syntax of this command is the following arkc li
100. ence each other in a loop For instance link a can point to link B which in turn points back to link a Such a situation creates an infinite loop which will block Arkeia s normal operations Caution is therefore strongly advised follow_fs Optional The parameter follow_fs determines the behavior of Arkeia when it encounters a mounted file system contained within a Savepack to be backed up This parameter can accept two values YES back up mounted file systems and NO do not back up mounted file systems By default the value of fol lLow_fs is YES inc_filter Optional The inc_filter defines an inclusion filter that will be applied to the backup of a Save pack Once a filter is defined Arkeia will backup the Savepack files only if they match the fil ter All other files will be ignored The filter itself is a normal UNIX regular expressions For instance inc_filter W dat The filter above will only backup the files whose name contain an upper case W followed by any two characters and by the letters dat For instance a file named CAD_Project W55 dat would be backed up with such a filter exc_filter Optional The exc_filter defines an exclusion filter that will be applied to the backup of a Save pack Once a filter is defined Arkeia will not backup the Savepack files if they match the fil ter All other files will be saved The filter
101. ent Please note that as you can see above comments that contain spaces should be included between square brackets E I 15 2 Library deletion The correct syntax to delete an Arkeia library is the following one arkc library delete D I lt parameters gt Where the parameters can be the following ones name Required The name parameter should contain the name of the library to be deleted For instance arkc library delete D name Lib04 A list of all the libraries available on a given Arkeia server can be obtained with the com mand arkc library list Libid Optional The Libid parameter is the ID assigned to the library when it was created by Arkeia This ID value can be used instead of the name parameter described above For instance the two commands below are equivalent assuming that 3cb46702 is the correct ID of the Library named Lib04 arke library delete D name Lib04 arke library delete D Libid 3cb46702 15 3 Library modification To modify an existing library please refer to the library creation described in Library creation on page 27 of this manual or to the section of the same title above Please note that the correct syntax is the following arkc library modify D I lt input file gt lt parameters gt Arkeia command line interface Manual 116 144 While modifying a library only the following parameters can be used name
102. er can accept the three following values NORMAL ALL ALL_EXCEPT_NFS When al lowed_fs is set to NORMAL the back up of a Savepack will only process normal file systems The value ALL indicates that all file systems local NFS and others should be backed up The value ALL_EXCEPT_NFS indicates that all file systems except NFS should be backed up while Arkeia is backing up a given Savepack retry Optional This parameter defines the number of times Arkeia should try to connect to a remote machine that contains a tree included in the Savepack being backed up By default the value of retry is 3 The possible values are numbers from 1 through 10 compress Optional This parameter defines what type of compression should be applied to the files contained in the Savepack The possible values for compr es s are the following LZ1_LZ3 LZ1 LZ3 NO_COMPRESS The default value for the compress parameter is LZ1_LZ3 which lets Arkeia choose the optimal compression scheme between LZ1 and LZ3 based on the data contained in the file being backed up The value NO_COMPRESS turns the file compression function off crypt Optional This parameter defines the type of encryption that will be applied to the files contained in a Savepack The possible values for c ryp t are the following DES_BLOWFISH DES BLOWFISH NO_CRYPT By default the value of
103. eration and the utilities provided to perform it please refer to the Arkeia User s Manual The following parameters can be used to delete a tape name Required The name parameter indicates which tape should be deleted by arkc For instance the following command will delete the tape named Test_Tape_01 arkc tape delete D name Test_Tape_01 To delete several tapes you can either a Enter several names on the command line arkc tape delete D name Test_Tape_01 name Test_Tape_02 b Delete all the tapes contained in a pool of tape if all the tapes to be deleted are assigned to the same pool Arkeia command line interface Manual 32 144 arkc tape delete D plid 3a 78354e For more information on tape pool deletion please see the parameter p L i d below or c perform a piping operation such as arkc tape list grep Test_ arkc tape delete In the command above arke first makes a list of tapes which is piped to and parsed by the UNIX grep command In the example above all tapes with a name starting with Test_ will be returned The result is then piped back into ar kc for deletion Please note the usage of the input option in this example tpid Optional The parameter t pid can replace the name parameter that we have detailed above The tpid value is assigned to a tape when it is first created by Arkeia This value can be dis played for a gi
104. ercreee tect accent chess na E ART EN 114 The backup ODjeCt imussa a as Pane 125 The restore object ae mena er a nO en Ene De DEO eee aeeatee 132 The file 9 o dgppremeenreertreeneneneeresme tre mceer pret Terermenpepenerenyry ores Coren CTORITTT a SmIN ED SPOR TE Ee meee DE 137 Th user ODI OCE niinniin an hae Acute end gas 139 The tape duplication object ss caceccsxecacascasksates tice cateiacasiaiste fete iatelarenieiaetednraniaentebtendav 142 Document version Name of Document Version Number arkc Manual 2002 11 28 v1 6 B Arkeia command line interface Manual 1 144 1 Introduction This manual presents arke the Arkeia command line interface as well as its differ ent commands 1 1 Overview Arkeia the market leader for Linux network backup has been designed around a mod ern three tiered architecture This means that Arkeia is divided in three different parts backup server client and management administration interface This allows a network administrator to fine tune the installation of Arkeia on a net work and to administer the different Arkeia backup servers in use from a single man agement workstation The servers in turn will backup the different clients that have been assigned to them This is shown in the figure below 0 alll al
105. essary to group the different trees in different families using the tree_family parameter This allows Arkeia to save these tree families at the same time The values that can be accepted by tree_family are numerical from 0 to 128 For instance Savepack configuration file for station0O1 This contains Jack Smith files lt ITEM gt tree_name station01 home jack mail tree_family 1 lt ITEM gt lt ITEM gt tree_name station01 home jack CADfiles tree_family 0 lt ITEM gt lt ITEM gt tree_name station01 home jack project documentation tree_family 0 lt ITEM gt The example above defines two tree families O and 1 Between these two families it is now possible to define the importance of each and the order in which they are going to be saved Please see below the tree_priority and tree_chain parameters for more information Arkeia command line interface Manual 42 144 tree_priority Optional The parameter tree_prior ity defines the priority to be assigned to a particular tree This parameter accepts numerical values starting from 0 highest priority to 100 low est priority Trees are then backed up according to their priorities For instance starting with the example above Savepack configuration file for station0O1 This contains Jack Smith files lt ITEM gt tree_name station0O1 home jack mail tree_family 1 tree_priority 1
106. et to INCREMENTAL In this case the based_on_bks id parameter should contain the ID of the previous backup the new backup is based on based_on_date Optional The based_on_date parameter is valid only if the type parameter is set to INCREMENTAL In this case the based_on_date parameter should contain the date of the previous backup the new backup is based on 16 2 Modifying a running backup with the connect command The standard syntax to modify a running backup with the connect command is the following arkc backup connect D I lt input file gt lt parameters gt The following parameters can be used to modify a running backup job bksid Required The bks id parameter contains the ID of the backup to be modified This ID is returned by arkc when a backup is started with the st art command wait Optional The wait parameter is used to determine the behavior of ar kc at the end of the backup operation This parameter can accept two values YES and NO If the value YES is used arkc will only accept new commands from the user after the backup is completed If the value NO is used a rkc will immediately accept new commands from the user exec Optional The exec parameter modifies the behavior of the running backup The following opera tion can be entered as the value of this parameter ABORT Stops the current backup
107. example above are equivalent FULLNAME is the internal information contained within the Arkeia database The examples above are valid for UNIX machines running operating systems such as Linux or Solaris For Windows machines the complete syntax of t ree_name is the following tree_name machine_name drive_letter directory1 For instance tree_name dune c common documents sales 2000 Please note the second after the drive letter Please note also that arke requires normal slashes instead of the standard inverted slashes of Windows Arkeia command line interface Manual 98 144 Please note Never use the internal Arkeia name FULLNAME when ever you enter a command or edit an arkc input file Please note as well that the name of a Savepack and the name of a tree are two different parameters To add a new tree to an existing Savepack it is therefore nec essary to enter either on the command line arkc savepack modify D name station0O1 tree_name station0O1 home Linda or within an input file Saves Linda home directory on computer station0O1 lt ITEM gt tree_name station0O1 home Linda lt ITEM gt Any other syntax than the two shown above will be rejected by arkc Please note that the two possibilities above are equivalent tree_family Optional Arkeia uses a sequential procedure to save the trees contained within a Savepack In order to benefit from Arkeia s a
108. executed on the cli ent machine This parameter accepts any command that can be executed including the path if necessary For instance cmd_before LErm fv home jack temp tmpJ This command will remove all files ending with tmp in the directory home jack temp prior to the backup of the directory home jack contained in the Savepack do_cmd_before Optional The parameter do_cmd_be fore defines the behavior of Arkeia if the command defined by the parameter cmd_before fails This parameter can accept two values YES or NO If do_cmd_before is set to YES the back up will proceed even if the com mand failed If it is set to NO the backup of the Savepack will be aborted if the command launched before the backup fails cmd_after Optional The parameter cmd_a f ter defines a command that has to be executed after the Save pack is processed by Arkeia Please note that the command will be executed on the client machine This parameter accepts any command that can be executed including the path if necessary For instance cmd_after dvrt xc This means that the command dvr t will be executed once all the files contained in the Savepack have been backed up do_cmd_after Optional The parameter do_cmd_a fter defines the behavior of Arkeia if the file backup fails This parameter can accept two values YES or NO If do_cmd_after is set to Y
109. fferent drvname and priority parameters drvid Optional To add drives to a Drivepack it is possible to use either the drvname or the drv id parameters Both these parameters should be contained in an input file with each drive to be added to the Drivepack contained in a pair of lt ITEM gt lt ITEM gt statements For instance the following lines of an input file would add the drive with the ID of DLT01 in a Drivepack Comment First DLT drive of drivepack lt ITEM gt drvid 3bc419c3 priority 1 lt ITEM gt Adding several drives to a Drivepack is therefore a question of adding several lt ITEM gt lt I1TEM gt statements into the same input file each statement containing different drvname and priority parameters Please note It is possible to add drives to a Drivepack by using the p option followed by the drvname or the drvid parameters But using the command line does not allow the use of a specific priority parameter for each drive In most cases it is highly recommended to use an input file containing the drive parameters with the 1 command line option in order to set priority for each specific drive For example the following line will create a new Drivepack based on the Create_Drivepack dat input file arkc create drivepack ICreate_Drivepack dat Arkeia command line interface Manual 111 144 prio
110. formational commands of arke Please note The value of type should be entered exactly as shown in the list above These values are case sensitive Therefore the value hp19 dlt and HP19 DLT are not equivalent A library creation requires the appropriate license of Arkeia If you do not have a license for a library arke will produce an error message and exit For more information on the Arkeia licensing scheme please con tact salesd arkeia com Libdev Required The parameter Libdev indicates which UNIX device is the controller of the library being created This device will vary according to the system and its configuration For instance here are two possible values for Libdev Arkeia command line interface Manual 28 144 Libdev dev sg0O Linux Libdev dev rsst4 Sun Solaris For more information on control devices please refer to the manual of your UNIX Linux system and to the output of the dmesg UNIX command comment Optional The parameter comment assigns a descriptive comment to the library being created This parameter is useful to display more information on a given library For instance the follow ing is a valid comment for ar kc comment LDLT Library for Accounting Department Please note that as you can see above comments that contain spaces should be included between square brackets E I 4 8 Tape duplication creation One of the newest
111. ful information on the Arkeia server login in use The first use of the debug object is to display a terse summary of the information related to the Arkeia server and the login currently in use This command does not accept any parameters Its syntax is the following arkc debug who A typical output of debug who could be the following arkc debug who Preference file usr knox arkc arkc param Backup server stormbringer Server version 4 2 8 1 Login root In the example above the preference file used by arkc is usr knox arkc arkc param the Arkeia backup server is named stormbringer its version is 4 2 8 1 and the login used is root e Checking the content of an input file Another use of debug with the input command is to quickly parse an input file and return any and all errors found in this input file The correct syntax of this com mand is the following arkc debug input I lt input file gt For instance the following command would check the file named create_user txt arkc debug input Icreate_user txt name Jack Hill role ADMINISTRATOR node stormbringer email jack hillafoobar com The output of the command should be self explanatory For more information on the creation of a user please refer to The create command of arkc on page 14 From the example above it is easy to understand that the only parameter accepted by the comm
112. function of ar kc is the tape duplication By creating a tape duplica tion object it is possible to make a perfect copy of the most important Arkeia tapes and of the data they contain Once created a duplication object can be started to make a copy of a given tape to keep the copy in a separate location in case the original tape is lost or damaged Important information 9 Please note that the tape duplication functions are only available in ver sion 5 x or older of arkc Previous versions of arke do not offer the tape duplication functions The normal syntax of the tape duplication is the following arkc duplication start D lt parameters gt The b parameter indicates to ar kc that its arguments and parameters are entered on the command line The following parameters must be entered on the command line when duplicating a tape from one drive to another src_tape_name or src_tapeid Required These parameters are required by ar kc These parameters should contain either the name or the ID of the source tape For instance the following names and IDs are considered valid and will be accepted by ar kc for a tape Arkeia command line interface Manual 29 144 duplication command src_tape_name DLTO04 src_tapeid 3bc1d2e2 As can be seen above the src_tape_name may be easier to remember but both these values are valid and accepted by arkc To display a list of avai
113. gned to the duplication object during its creation It is not necessary to set both parame ters For more information on the tape duplication object please refer to the section named Tape duplication creation on page 29 of this manual 9 3 Writing a label on a tape with the write command The write command writes a new Arkeia header on a tape The correct syntax for this command is the following arkc drive write LD I lt input file gt lt parameters gt The parameters that can be accepted by this command are the following ones name drvid Required The name and drv i d parameters respectively contain the name or the ID of the drive containing the tape whose header should be written It is possible to use or the other to des ignate a specific drive with the wr i te command For instance arke drive write D name CDLT 8000 tpname JackTape Arkeia command line interface Manual 73 144 arkc drive write D drvid 3aeffff3 tpname JackTape Please note that the two commands above are equivalent assuming 3 ae f f f f 3 is the cor rect ID for the drive named DLT 8000 For more information on the t pname param eter please see below tpname Required The tpname parameter should contain the new header name of the tape For an exam ple of the syntax of this parameter please see the name drvid parameter examples above Please note arkc does n
114. h tchang or root Arkeia command line interface Manual 90 144 comment Optional The comment parameter can be used to insert a short string to offer more information to the user about the tape pool being created The comment is displayed in the Arkeia GUI or with the List command of arke For more information on this command please refer to Listing objects with the list command on page 48 The correct syntax for this parameter is as follows comment LThis group of tape should be placed in the safe Please note that comment containing spaces should be placed between square brackets L I as shown above 11 2 Tape pool deletion Deleting a tape pool is almost the same as deleting a single tape The correct syntax to delete a tape pool with arkc is the following one arkc pool tape D Ename plidJ lt value gt The parameters that can be accepted while deleting a tape pool are the following ones name Required The name parameter should contain the name of the pool to be deleted For instance arkc pool delete D name Test_Pool A list of all the tape pools available on a given Arkeia server can be obtained with the com mand arkc pool list plid Optional The p Lid parameter is the ID assigned to the tape pool when it was created by Arkeia This ID value can be used in place of the name parameter described above For instance the two comm
115. he other hand the information mes sages wont be displayed The Level parameter therefore limits the information to the most interesting messages which can be quite useful to track the source of a problem filter Optional The filter parameter adds or removes specific data from the information returned by the Arkeia log This parameter accepts the following values D date T time L level see above 1 information code and S message string The default value for the filter parameter is D T L 1 S meaning that all information returned by the log is displayed For instance arke journal jrestore D filter ZI1 S The command above would limit the information returned by the Arkeia log to the infor mation code followed by the message string For instance here is a typical output of such a command arkc journal jrestore D filter ZLZS WO60006 Start of restoration 1060016 wks_dtp home tina Documents Tips_MLO4 txt 1060021 Loading tape DLTO2 in drive TinaDLT 1060008 1 Errors 0 1060010 1 Directories not treated 0 1060011 1 Components not treated 0 1060020 Unloading tape from drive TinaDLT w060020 End of restoration Arkeia command line interface Manual 62 144 e Displaying the backup related information The syntax to display only backup related information from the Arkeia log is the fol lowing arkc journal jbackup D l
116. he tape back to the slot For instance the following parameter would eject the tape contained into drive number 6 drvnum 6 Arkeia command line interface Manual 122 144 15 9 Additional drive related commands for tape libraries There are two arke commands that provide additional drive related functionality for tape libraries These commands are attach Attach additional tape drives to a library detach Remove additional tape drives from a library The rest of this section will detail the syntax and usage of these commands e Attaching additional drives to a tape library with attach The attach command allows the library to be re configured to attach additional drives to it Please note that this command cannot be used if the target tape library has only one drive The syntax for this command is arke Library attach LD I lt input file gt lt parameters gt The valid parameters for this command are name Libid Required The name and the lL ibid parameters contain respectively the name and the ID of the library that will be re configured by the attach command Please note that only one parameter needs to be set for the at tach command to work properly For instance the fol lowing parameters are equivalent assuming 3b614 30 is the correct ID of the library named Autopack30 name Autopack30 Libid 3b614c30 drvname drvid Required The drvname
117. hese parameters are respectively the IDs for the Savepack the tape pool and the Drivepack to be used The following optional parameters can be used to start a backup with arke policy Optional The parameter policy determines the tape policy to be used for the backup This parameter can accept two values COMPLETE or NEW When using the COMPLETE value Arkeia will always complete fill up the tape which has been used If the NEW value is used Arkeia will always use a new tape when starting a backup By default policy has the value COMPLETE wait Optional The parameter wait determines the behavior of arke once a backup is launched with arke backup star t This parameter can accept two values YES or NO If the value YES is used ar kc will wait until the end of the backup to return which means the user will not be able to enter any new command until the completion of the backup If the value NO is used arkc will return immediately and allow the user to enter other com mands email Optional The parameter ema i L determines if Arkeia sends an email once the backup is finished or if the backup requires a new tape to be completed This parameter can accept two values YES and NO If the value YES is used Arkeia will send an email to the user indicating if the backup is finished and or if the software requires an additional ta
118. hich contains the ID of the duplication object to be modified The optional parameters that can be modified by the modify command are the fol lowings src_tape_name src_tape_id Source tape name or ID src_drv_name src_drv_id Source drive name or ID dst_drv_name dst_drv_id Destination drive name or ID dst_lib_name dst_lib_id Destination library name or ID dst_slot Destination slot in library comment Informational comment For more information on these parameters and the values they can accept please refer to The create command of arkc on page 14 Arkeia command line interface Manual 47 144 7 The informational commands and objects of arkc The following arke commands and objects are informational in nature designed to offer the user detailed or terse data about Arkeia objects and operations List Displays existing objects drvlist Displays existing drives type Displays drives and tapes that Arkeia can manage role Displays users roles and attributions done Displays completed backups running Displays backups or restorations in progress status Displays progress information on running jobs statistics Displays tape statistics information debug Displays miscellaneous information journal Displays information from Arkeia log This chapter will detail all these objects and command their usage an
119. hose header should be written It is possible to use or the other to des ignate a specific drive with the wr i te command For instance arke drive write D name CDLT 8000 tpname JackTape arkc drive write D drvid 3aeffff3 tpname JackTape Please note that the two commands above are equivalent assuming 3ae f f f f 3 is the cor rect ID for the drive named DLT 8000 For more information on the t pname param eter please see below tpname Required The tpname parameter should contain the new header name of the tape For an exam ple of the syntax of this parameter please see the name drvid parameter examples above Arkeia command line interface Manual 88 144 Please note arkc does not allow the header of a tape to be written if the tape already has an existing header To force the header to be written to the tape using the wr i te command use the overwrite parameter see below overwrite Optional Using the overwrite parameter it is possible to delete the existing header of a tape and replace it with the new header For instance arke drive write D name CDLT 8000 tpname JackTape overwrite Please note that the command above should be entered all on one line This replaces the existing header of the tape introduced in the drive DLT 8000 by the header Ja ck Tape 10 10 Checking the label on a tape with the read command The
120. hould enter the name between square brackets E 1 For instance name LCAD CAM Savepack comment Optional This parameter is used to assign a descriptive comment to the Savepack being created This comment can be useful to display additional information The correct syntax for this param eter is comment Savepack for CAD machines allowed_fs Optional The parameter al Lowed_fs defines how Arkeia is going to process different file systems while backing up the Savepack This parameter can accept the three following values NORMAL ALL ALL_EXCEPT_NFS Arkeia command line interface Manual 93 144 When al lLowed_fs is set to NORMAL the back up of a Savepack will only process normal file systems The value ALL indicates that all file systems local NFS and others should be backed up The value ALL_EXCEPT_NFS indicates that all file systems except NFS should be backed up while Arkeia is backing up a given Savepack retry Optional This parameter defines the number of times Arkeia should try to connect to a remote machine that contains a tree included in the Savepack being backed up By default the value of retry is 3 The possible values are numbers from 1 through 10 compress Optional This parameter defines what type of compression should be applied to the files contained in the Savepack The possible values for compress are the following LZ1
121. ice being created These rights can be READ WRITE RECYCLE and DELETE To authorize certain access rights these should be included as values of the access parameter for instance access LREAD WRITE The parameter above indicates that the drive being created can be accessed for read write operations but not for deleting or recycling By default all four type of rights are granted on a new tape drive comment Optional This parameter is used to assign a descriptive comment to the tape drive being created This comment can be useful to display additional information related to the tape drive as for instance its location purpose etc The correct syntax for this parameter is comment DLT tape drive for CAD machines 13 2 Drive deletion Deleting a drive allows the system administrator to quickly reconfigure Arkeia in the case maintenance or replacement is needed for a hardware unit The correct syntax to delete a drive is the following one arkc drive delete D I lt parameters gt Where the parameters can be the following ones name Required The name parameter should contain the name of the drive to be deleted For instance arkc drive delete D name DLTO2 A list of all the tape drives available on a given Arkeia server can be obtained with the com mand Arkeia command line interface Manual 104 144 arke drive list drvid Optional The drv id para
122. ile name jack txt User creation file for arkc y ang es een ee ea AEA a ey a ADA ny ARA Aa A AADA ee ea ny ny A A i A A Basic features name Jack Smith role ADMINISTRATOR node station01 Optional features email jackafoobar com End of file To create the user Jack Smith the following command should therefore be entered assuming the input file is named jack txt arkc user create Ijack txt 7 6 Displaying the backups completed with the done command It is possible to display a list of all backup operations completed by using the done command of arkc The syntax of this command is the following one arkc backup done C LCD I lt input file gt lt parameters gt J The command arke backup done will simply list all the backup that have been completed To obtain a more informational message it is necessary to filter the output of this command with the following filters bksid Displays only the ID of the backups date Displays only the date numerical of the backups sdate Displays only the date string of the backups For instance here are a few examples of filters and their outputs Arkeia command line interface Manual 52 144 arkc backup done bksid 3a6718dc arkc backup done Fsdate sdate 2001 01 18 16 25 arkc backup done Fsdate Fbksid bksid 3a6718dc sdate 2001 01 18 16 25 7 7 Displaying the list of jobs in progress with
123. ill therefore detail the modification of the Arkeia Savepacks through the use of the modi fy com mand of arkc The information regarding a specific tree have to entered in a configuration file and each item should be separated by a pair of lt ITEM gt lt ITEM gt statements For instance the following lines are valid tree information lt ITEM gt tree_name station0O1 home jack mail lt ITEM gt lt ITEM gt tree_name station0O1 home jack CADfiles lt ITEM gt lt ITEM gt tree_name station0O1 home jack project documentation lt ITEM gt These lines inserted in a configuration file would indicate that on the computer named station01 the following directories and their contents should be backed up by Arkeia home jack mail home jack CADfiles and home jack project documentation The following parameters can be added to the lt I TEM gt lt ITEM gt statements tree_name Optional The tree_name parameter defines the new tree that will be added to a Savepack This parameter has the following format name_of_machine directory1 directory2 For instance tree_name station01 home jack project programming C_files Please note that to delete a specific tree from within a Savepack you need to use the param eter dt ree_name on the command line The parameter t ree_name and its output FULLNAME see example above are equivalent FULLNAME
124. ined in a tape library dst_lib_name or dst_libid Required These parameters are required when using ar k c if duplicating in a library These parameters should contain either the name or the ID of the destination library This library must contain the destination drive defined above For instance the following names and IDs are considered valid and will be accepted by arkc for a tape duplication com mand dst_lib_name RD_LTO Arkeia command line interface Manual 30 144 dst_libid 3a530bcf As can be seen above the ds t_lib_name may be easier to remember but both these values are valid and accepted by arkc To display a list of available libraries enter the com mand arke library List without the quotes Please note that defining dst_lLib_name or dst_libid means that dst_slot see below must be defined as well dst_slot Required This parameter is required when using ar k c but only if duplicating in a library This parameter should contain the number of the slot that contains the destination tape This parameter must be defined if duplicating to a library For instance the following is con sidered as valid value and will be accepted by ar kc for a tape duplication command dst_slot 6 This slot must contain the tape that will be used as a target by the duplication operation Please note that when duplicating from to a library it is not ne
125. ist it is therefore necessary to supply the name of the tape to be listed with the t pname parameter The standard syntax is therefore arkc file list D tpname name_of_tape For instance arkc file list D tpname DLT_140 The command above will list all the files contained on the tape named DLT_140 For more information on the f i Le object please refer to the second part of this manual It is possible to filter the output of file list command with the following filter file Displays only the files present on the tape Arkeia command line interface Manual 84 144 10 5 Obtaining information on tapes with the type command The type command is designed to provide information on the type of objects that can for instance be created by arkc Its syntax is as simple as the one of the List command arkc object type We have seen several examples of this command in the previous sections of this manual For tapes the command arkc tape type will list all the tape standards that can be managed by Arkeia A complete list can be found in this chapter in section Tape creation on page 79 or in the equivalent section Tape creation on page 14 of the create command 10 6 Displaying additional tape information with statistics It is possible to obtain detailed statistics on a given tape by using the statistics command of arkc This command is especially
126. ject type We have seen several examples in the previous sections of this manual Here is a com plete list of the information that can be obtained with the type command e tape The command arkc tape type will list all the tape standards that can be managed by Arkeia A complete list can be found in chapter 3 the create command in the section titled tape creation drive The command arkc drive type will list all the drive standards that can be man aged by Arkeia A complete list can be found in chapter 3 the create command in the sec tion titled drive creation library The command arke library type will list all the libraries that can be managed by Arkeia A complete list can be found in chapter 3 the create command in the section titled library creation Arkeia command line interface Manual 51 144 7 5 The role command The role command is a limited version of the t ype command that applies only to the user objects of Arkeia To obtain all the roles available to Arkeia users enter the command arkc user role The three roles that are available for Arkeia users are OPERATOR USER and ADMINISTRATOR Please note that when a user is created a role should be defined and entered in upper case under the parameter role For instance the following input file defines a valid Arkeia user fr SSSS gt F
127. ject file or directory OBJECT the result of a command should be saved RAW physical device such as dev fd0 This parameter determines which other parameters can be applied to the tree Please see below for more examples By default the value of tree_type is TREE Arkeia command line interface Manual 100 144 The following parameters can be used only if the tree_type parameter is set to TREE They are the equivalent for a single tree of the general commands available for a compete Savepack As such they will not be detailed please refer to The create command of arkc on page 14 for more information on these different parameters tree_comment Optional The parameter tree_comment assigns a descriptive information to the tree For more information on this parameter please refer to Savepack creation on page 20 tree_retry Optional The parameter tree_retry assigns a retry value to the tree For more information please refer to the retry parameter in Savepack creation on page 20 tree_compress Optional The parameter tree_compr ess chooses a compression scheme for the tree For more information please refer to the compress parameter in Savepack creation on page 20 tree_crypt Optional The parameter tree_crypt chooses a cryptographic scheme for the tree For more information please refer to the crypt parameter in Savepack
128. k is processed by Arkeia Please note that the command will be executed on the client machine This parameter accepts any command that can be executed including the path if necessary For instance cmd_after Cdvrt xc This means that the command dvrt will be executed once all the files contained in the Savepack have been backed up do_cmd_after Optional The parameter do_cmd_a fter defines the behavior of Arkeia if the file backup fails This parameter can accept two values YES or NO If do_cmd_after is set to YES the command defined by the parameter cmd_after will always be executed even if the backup itself fails If it is set to NO the command defined by cmd_af ter will not be executed if the backup of the Savepack has failed 12 2 Savepack deletion The correct syntax to delete a Savepack is the following one arkc savepack delete LCD IJ lt parameters gt Where the parameters can be the following ones name Required The name parameter should contain the name of the Savepack to be deleted For instance arkc savepack delete D name WebDesign Arkeia command line interface Manual 96 144 A list of all the savepacks available on a given Arkeia server can be obtained with the com mand arke savepack list skid Optional The skid parameter is the ID assigned to the Savepack when it was created by Arkeia This ID value can be
129. kc Previous versions of arke do not offer the tape duplication functions Contrary to a lot of arke objects the tape duplication is started automatically and cannot be created deleted or modified The normal syntax of the tape duplication is the following arkc duplication start D lt parameters gt The b parameter indicates to ar kc that its arguments and parameters are entered on the command line The following parameters must be entered on the command line when duplicating a tape from one drive to another src_tape_name or src_tapeid Required These parameters are required by ar kc These parameters should contain either the name or the ID of the source tape For instance the following names and IDs are considered valid and will be accepted by ar kc for a tape duplication command src_tape_name DLTO04 src_tapeid 3bc1d2e2 As can be seen above the src_tape_name may be easier to remember but both these values are valid and accepted by arkc To display a list of available source tapes enter the command arke tape Lli st without the quotes The tape name is assigned when a tape is created by Arkeia src_drv_name or src_drvid Required These parameters are required by ar kc These parameters should contain either the name or the ID of the source drive For instance the following names and IDs are considered valid and will be accepted
130. kc on page 14 The valid syntax is therefore arkc user modify D I lt parameters gt The parameters used to modify a user are name role node email passwd and vpasswd For more information on these please refer to The cre ate command of arkc on page 14 Arkeia command line interface Manual 46 144 6 6 Library modification To modify an existing library please refer to the library creation described in Library creation on page 27 of this manual Please note that the correct syntax is the following arke Library modify LD I lt input file gt lt parameters gt While modifying a library only the following parameters can be used name ibid Library name and ID l ibdev control device for the library and com ment For more information on these parameters please refer to The create com mand of arkc on page 14 6 7 Duplication modification To modify an existing tape duplication object the correct syntax is arkc duplication modify LCD I lt input file gt lt parameters gt The parameter required to modify a duplication object is the following one name Required The name parameter is assigned to the duplication object during its creation To modify an object its name is required by ar kc For instance name CAD_Dup Please note that this parameter can be replaced by the parameter dup id w
131. ke and the Arkeia server can be traced in a precise manner by entering arkc object command verbose Please note that verbose option by itself does not provide additional information or online help it simply lists the transactions that took place between arke and the Arkeia server as well as the results of these transactions For more information on the errors that can be encountered while using arkc please refer to Checking parameters and errors with debug on page 55 3 3 Input options With any command arke can accept input from three different sources the command line itself a configuration file or the standard input which allows a user to pipe com mands into arkc Please note All the options indicated below should be entered exactly as shown For instance the D option detailed below should always be entered with a capital p If this syntax is not respected arkc will not process the command and display an error message The possible input output options are the following Arkeia command line interface Manual 9 144 The v command line option The syntax for this option is arkc object command D parameters The option D indicates that the required parameters should appear on the command line itself For instance the following command will list all the available information on the tape named foobar arkc tape list D name foobar As
132. l all the arke commands that can be applied to the drive pack object 14 1 Drivepack creation A Drivepack is a group of drives that is created within Arkeia in order to ease the man agement of large backups that may span several tapes drives Drivepacks allow the user to group drives and use them as a single entity for all backup operations Drivepacks are created with the following command arkc create drivepack LD I 1 lt parameters gt The parameters that can be accepted while creating a Drivepack are the following name Required The name parameter assign a name to the Drivepack that will be created by arkc This parameter is required by the create command The correct syntax for this parameter is name XXXXX where XXXXX is the Drivepack s name For instance name 3rd_Floor creates a Drivepack named 3rd_F Loor If youd like to insert spaces in the name of the Drivepack you should enter the name between square brackets E 1 For instance name LDLT Drivepack comment Optional This parameter is used to assign a descriptive comment to the Drivepack being created This comment can be useful to display additional information The correct syntax for this param eter is comment DAT Drivepack for small backups nbdrive Optional This parameter defines the number of drives that can be used by the Drivepack for a given operation By default the value of nbdr i
133. l as the most common options of ar kc The second part will present the functions of arkc divided by commands The third part will present the objects tapes drives etc that arke can manage along with the commands they can accept Users starting with arkc should read the first and third part of this man ual installation syntax and objects while advanced users will benefit most from the second part commands of this manual Arkeia command line interface Manual 3 144 2 Installation and configuration of arkc Like the other software products released by Knox Software arkc is available in several formats Which format should be selected for installation depends on the architecture and operating system used Most UNIX architectures such as Solaris or AIX will use the tar gz tar gzip package format This package provides minimal functionality but is based on highly standardized UNIX utilities which should be available in most systems Most Linux architectures such as Red Hat or SuSE use the rpm Red Hat Package Manager package format This package provides more functionality such as package installation tracking and is mainly used on Linux and Linux based operating systems The rest of this chapter will provide basic installation instructions for both type of pack ages For more information on the utilities or system functions involved please refer to the manual that was supplied with your
134. lable source tapes enter the command arke tape list without the quotes The tape name is assigned when a tape is created by Arkeia src_drv_name or src_drvid Required These parameters are required by ar kc These parameters should contain either the name or the ID of the source drive For instance the following names and IDs are considered valid and will be accepted by arkc for a tape duplication command src_drv_name RD_LTO src_drvid 3a530bcf As can be seen above the src_drv_name may be easier to remember but both these values are valid and accepted by arkc To display a list of available drives enter the com mand arke drive list without the quotes dst_drv_name or dst_drvid Required These parameters are required by ar kc These parameters should contain either the name or the ID of the destination drive This drive must be compatible with the source drive For instance the following names and IDs are considered valid and will be accepted by ar kc for a tape duplication command dst_drv_name RD_LTO dst_drvid 3a530bcf As can be seen above the ds t_drv_name may be easier to remember but both these values are valid and accepted by arkc To display a list of available drives enter the com mand arke drive Lli st without the quotes Additionally the following parameters can be entered when duplicating a tape that is conta
135. lease note that this parameter is required by the drv list command For example arke library drvlist D name ArkeiaLibO1 The above command will list all the tape drives installed within the library named ArkeiaLibO1 Arkeia command line interface Manual 50 144 Libid Optional The lL ibid parameter is the ID that was assigned to the library when it was created It can replace the name parameter For instance the two commands below are equivalent assuming that 3b614c 30 is the valid ID for library Autopack30 arke library drvlist D name Autopack30 arke library drvlist D Libid 3b614c30 The output of the drv List command can be modified with the help of the follow ing filters drvname Displays only the names of the drives present in a library e drvid Displays only the IDs of the drives present in a library drvnum Displays only the numbers of the drives present in a library Please note it is possible to combine several filters For instance the following command would list the drives present in library IBM Lib and display both their names and IDs arkc library drvlist D name IBMLib Fdrvname Fdrvid 7 4 Obtaining information on objects with the type command The type command is designed to provide information on the type of objects that can for instance be created by arkc Its syntax is as simple as the one of the List command arkc ob
136. library object 15 1 Library creation Arkeia is able to manage complex backup hardware such as large tape libraries This type of hardware should be defined within Arkeia in order to be used for back up and restore operations The standard syntax to create a library with arkc is the following arkc library create LD I lt input file gt lt parameters gt The parameters that can be accepted by arkc while creating a library are the following ones name Required The parameter name assigns a descriptive name to the library being created This parame ter is mandatory For instance name DLT_Lib04 or name LAccounting DLT Library type Required The parameter type defines the type of library being created Please note that the value of type must be entered precisely as shown Some possible values for this parameter are ADIC100 LTO ATL L200 AUTOPAK BLACKJACK_X_21 DLT4700 DLT DLTSTOR114 EXB 17D7 EXB 60 EXB EZ17 EXB X200 FALCON 1530 FALCON 1560 FASTSTOR FILE HP19 LTO HP660 LTO HP660 HPC1191 HPDAT6 Arkeia command line interface Manual 114 144 Harrier8150 Harrier8 amp 30 Harrier850 IBM7336 IBM7337 ITL2225 ITL4115 ITL7115 LIBRA16 LIBRA18 LIBRA8 LP1117 MAGSTAR_L12 MAGSTAR_L18 MAGSTAR_L24 MAGSTAR_L32 SONY_DMSB9 STD4586NP 12 STD4586NP STK7430 STK9710 STK9714 SUN L1000 SUN L700 9840 SUN L700 DLT SUN L9 TSL A300 TSL S7000 TWINLIBRA16 TWINLIBRA18 You
137. llow shared file sys tems for instance NFS while saving the tree For more information please refer to the follow_fs parameter in Savepack creation on page 20 tree_inc_filter Optional The parameter tree_inc_filter determines an include filter for the tree backup For more information please refer to the inc_f ilter parameter in Savepack creation on page 20 tree_exc_filter Optional The parameter tree_inc_f ilter determines an exclusion filter for the tree backup For more information please refer to the exc_f ilter parameter on page 22 6 4 Drivepack modification To modify a Drivepack using the modify command of arkc the following syntax should be respected arkc drivepack modify D name name_of_drivepack lt parameters gt It is highly recommended to use an input file with the option 1 to modify a Drive pack Each item to be added to a Drivepack should be contained within an lt ITEM gt lt ITEM gt statement The parameters that can be added to such an input file are the following ones drvname Optional The parameter drvname contains the name of the drive to be added to the Drivepack Arkeia command line interface Manual 45 144 You can obtain a list of drives installed on the Arkeia server by entering the following com mand arkc drive list To add a drive to a Drivepack the following syntax should therefore be used
138. mand arkc library list D name name_of_the_library more Therefore the following start command is correct assuming 3af012b1 is the correct ID for the library HP SureStore 1 9 DISTE arkc library start D Libid 3af012b1 e Stopping a library It is possible to stop a library manually by using the stop command of arkc For instance arkc library stop D I lt input file gt lt parameters gt Arkeia command line interface Manual 70 144 This command accepts the same parameters as the start command For instance the following commands are valid arkc Library stop D name CHP SureStore 1 9 DLTI arkc Library stop D libid 3af012b1 Arkeia command line interface Manual 71 144 9 Miscellaneous commands This chapter of the arkc manual contains commands that could not easily be grouped with others These commands will be introduced in no special order 9 1 Tape recycling the recycle command The recycle command of arkc allows the manual recycling of a tape If applied to a pool the recycle command will recycle all the tapes contained in the pool It is important to understand the distinction between the recycle command and the delete command Deleting a tape means removing its entry in the Arkeia database The data contained on the tape is therefore unavailable to Arkeia and cannot be accessed unless the tape data is re imported into the Arkeia dat
139. meter is the ID assigned to the tape drive when it was created by Arkeia This ID value can be used instead of the name parameter described above For instance the two commands below are equivalent assuming that 3bc419cd is the correct ID of the tape drive named DLTO2 arkc pool delete D name DLTO2 arkc pool delete D plid 3bc419cd 13 3 Drive modification To modify a tape drive characteristics the syntax of arkc is the following arkc drive modify D I lt input file gt lt parameters gt To modify a tape drive it is necessary to supply to arkc its name or its drv id For more information on this parameter please refer to The create command of arkc on page 14 To obtain a list of the names of the available tape drives it is always possible to enter the following command arkc drive list To obtain a detailed list of the existing characteristics of a specific tape drive including the drv id parameter it is possible to enter the command arkc drive list D name name_of_drive For instance the following command will return all relevant information on the tape drive named Sony AIT2 arkc drive list D name Sony AIT2 PID 19533 DRVID 3bc1d31b COMMENT Sony AIT 2 drive plugged on Zeus NODE zeus OWNER jsmith DRV_NUM 0 LIBID 0 DRV_DENY 0 STATUS E TIME_BEFORE_CLEAN 32767 USAGE_TIME 14924 NB_LOADS 0 CONTROL_DEV dev st0O NONREWIND_DEV dev nulLl REW
140. n tax for this parameter is for example name John If a name must contain spaces it should be enclosed between square brackets E 1 For instance name LJohn Smith node Required The parameter node contains the name of the Arkeia client the user will interact with This parameter has the following syntax node stormbringer In the example above the name of the Arkeia client which is to be used is s torm bringer A node should always be assigned to a newly created user email Optional The ema i L parameter is used to define an email address that Arkeia can use to warn the user of the completion of an operation The email address should be a standard address that can be reached by the Arkeia server For instance email john smithafoobar com e passwd Optional The passwd parameter defines the password used by the user to connect to the Arkeia server defined by the node parameter It is highly recommended to use secure UNIX passwords to avoid security problems For instance Arkeia command line interface Manual 26 144 passwd DF56AX82VV08 vpasswd DF56AX82VV08 Please note the password defined by the passwd parameter should always be confirmed with the vpasswd parameter as in the example above 4 7 Library creation Arkeia is able to manage complex backup hardware such as large tape libraries This type of hardware should be defined within A
141. nal help on the create com mand it is possible to enter arkc usage tape create e Help options getinfo If a command requires several parameters it is possible to obtain an online help on these by entering the following arkc getinfo object command parameterJ To obtain all the parameters that will be accepted by the command modify and the object tape we can therefore enter arkc getinfo tape modify Please note that the information returned by the getinfo option is much more terse than the information returned by the usage option When in doubt always use usage first Testing and debugging options validate If youd like to test the syntax of a command without executing the arke command itself it is possible to enter arkc validate object command options Arkeia command line interface Manual 8 144 For instance if youd like to test a tape creation without really creating a tape on your Arkeia server it is possible to enter arkc validate tape create D type CDLT 8000 name Test The command above would test the syntax of the create command without creating a tape Testing and debugging options moreinfo If a command fails it is possible to obtain a detailed explanation by entering the follow ing arkc object command moreinfo Testing and debugging options verbose If need be all the transactions between ar
142. name indicates either a the drive that contains the new tape if exec has the value SETTAPE or b the drive that should be used for the restoration if exec has the value SETDRIVE This parameter is required if the exec parameter has the value SETTAPE or SETDRIVE Please refer to the exec parameter above for more information For instance arkc restore connect D rstsid 35a6 29dc exec SETDRIVE drvname ecrix_2 The command above indicates to the restoration with an ID of 3a6729dc that the drive to be used for the operation is the ec r i x_2 drive Please note that this command should be placed all on one line Arkeia command line interface Manual 134 144 17 3 Displaying the list of restorations with running The running command can be used to display the list restoration that are in progress on the Arkeia server Further information about a specific job can then be queried using the status command see below The standard syntax for the running command is the following arkc restore running For instance to display a list of all backup operations currently in progress it is possible to enter the above command and it will then display the IDs of all the backup in progress on the Arkeia server To obtain more information on a specific job please refer to the status command below 17 4 Displaying the state of a restoration with stat
143. nformation about a specific job can then be queried using the status command see below The standard syntax for the running command is the following arkc Cbackup restore running For instance to display a list of all backup operations currently in progress it is possible to enter arkc backup running This command will then display the IDs of all the backup in progress on the Arkeia server To obtain more information on a specific job please refer to the status com mand below 16 5 Displaying information on a running backup with status To obtain detailed information on a running backup the status command should be used This command has the following syntax arkc backup status LCD I lt input file gt lt parameters gt This command accepts only one parameter which is detailed below bksid Required The bksid parameter contains the ID of the backup whose detailed status should be dis played This ID is displayed when a backup is started with the start command For more information please refer to the next chapter of this manual The start and the stop commands of arke on page 64 For instance the following command Arkeia command line interface Manual 130 144 arkc backup status D bksid 3bcc2793 will return the possible values 0 The backup job is running cs The backup needs a new tape Sor The backup is now finish
144. nstance arkc drive delete D name DLTO2 A list of all the tape drives available on a given Arkeia server can be obtained with the com mand arkc drive list drvid Optional The drv id parameter is the ID assigned to the tape drive when it was created by Arkeia This ID value can be used instead of the name parameter described above For instance the two commands below are equivalent assuming that 3bc419cd is the correct ID of the tape drive named DLTO2 arkc pool delete D name DLTO2 arkc pool delete D plid 3bc419cd 5 4 Savepack deletion The correct syntax to delete a Savepack is the following one arkc savepack delete D I lt parameters gt Where the parameters can be the following ones name Required The name parameter should contain the name of the Savepack to be deleted For instance arkc savepack delete D name WebDesign A list of all the savepacks available on a given Arkeia server can be obtained with the com mand arkc savepack list skid Optional The skid parameter is the ID assigned to the Savepack when it was created by Arkeia This ID value can be used instead of the name parameter described above For instance the two commands below are equivalent assuming that 3a64332e is the correct ID of the Savepack named WebDesign Arkeia command line interface Manual 35 144 arkc savepack delete D name WebDesign
145. ntered exactly as shown as it is case sensitive For instance this is a valid filter option Fbksid On the other hand the following filters options are not valid and will produce an ar kc error message if entered on a command line F bksid F BKSID FBksid In the following chapters a special filters section will indicate which command can accept filters and detail the usage and syntax of said filters Arkeia command line interface Manual 12 144 3 5 Path syntax and Plugin syntax When arkc requires a path to be entered anywhere in the options or commands the path and file name entered have to respect a special syntax This syntax is required by the Arkeia server since it is able to backup different client machines through a local area network The following is the standard Arkeia syntax FQDN_machine_nameL pLlugin_nameJ path0O1 pathxX filename Here is a detailed explanation for all the parts of this syntax FQDN_machine_name This is the Fully Qualified Domain Name FQDN machine name This means that ar kc version 5 accepts names such as zap foo com where zap is the name of the client and f o0 com the name of the domain which con tains the machine named zap Please note that an exclamation point also called a bang in the UNIX world should separate the F DN_machine_name from the plug in name see below Iplug in_name This i
146. ntil the end of the restoration to return which means the user will not be able to enter any new command until the completion of the operation If the value NO is used ar kc will return immediately and allow the user to enter other commands on the command line drvname Optional The parameter drvname contains the name of the drive to be used for the restoration in a single drive environment This name is assigned during the creation of the drive For instance drvname SonyDLT On a single drive system the parameter above indicates that the drive named Sony DLT should be used for the restoration operation Please note It is possible to replace the drvname parameter by the drvid parameter The drvid should then contain the ID of the drive to be used for the restoration in the case of a single drive configu ration This ID is assigned to the drive during its creation and can be obtained by entering the following command arke drive list D name name_of_the_drive rstopt Optional The rstopt parameter determines the different options that should be applied to the files that will be managed by the restoration This parameter accepts the following values that will influence the restoration REST_TIMES Restore the time information of the files RST_PERMS Restore the access rights of the files RST_BYID Restore by user identifier RST_BYNAME Restore by user name RST_CHKTIME Check if th
147. o this command skname Required The skname parameter contains the name of the Savepack to be saved by the backup This name is assigned to the Savepack during its creation For instance arkc backup start D skname JackHome The command above would start the backup of the Savepack named JackHome plname Required The plname parameter contains the name of the tape pool to be used by the backup This name is assigned to the tape pool during its creation For instance arkc backup start D skname JackHome plname Poo0o 01 The command above would start the backup of the Savepack named JackHome on the tape pool named Pool01 dkname Required The dkname parameter contains the name of the Drivepack to be used for the backup This name is assigned to the Drivepack during its creation For instance arkc backup start D skname JackHome plname Pool01 dkname DSK_01 Arkeia command line interface Manual 64 144 The command above would start the backup of J ackHome on the tape pool Pool01 and on the Drivepack named DSK_01 Please note that these options should all be con tained on the same line Please note The parameters skname p Lname and dkna me while they must be entered on the command line to start a backup can be replaced by the parameters skid plid and dkid These parameters are respectively the IDs for the Savepa
148. oTape name DAT_Database Arkeia command line interface Manual 14 144 type Required The type parameter indicates the type of the tape being created This parameter is required by the create command Please note that the names should be entered pre cisely as shown below and that whenever a name contain spaces it should be enclosed with square brackets E I after the type function For instance type EXB 85001 is a valid syntax while type exb 8500 or type Exb8500 are not The available tape types are listed below AIT 1 AIT 1XL AIT 2 DAT DDS4 DAT DDS3 DAT 120 DAT 60 DAT 90 D3 10GB D3 25GB D3 50GB EXB 8500 EXB 8505XL EXB MAMMOTH EXB MAMMOTH 2 NULL FILE 20MB FILE 50MB FILE 100MB FILE 500MB DLT 2000 DLT 2000XT DLT 4000 DLT 7000 DLT 8000 DLT1 SDLT MAGSTAR MP MAGSTAR MP C MAGSTAR MP CXL DTF GW 730L QIC 50GB QIC 25GB QIC 16GB QIC 13GB QIC 4GB QIC 2GB 3590 CART 9840 CART LTO Ultrium VXA V17 VXA V6 Please_note It is possible to obtain this list of available tape types by entering the following command arkc tape type For more information about the type command please refer to the chapter named The informational commands and objects of arkc on page 48 of this manual Arkeia command line interface Manual 15 144 comment Optional The comment parameter can be used to insert a short string to offer more information to th
149. ome jack files bin arkc 4 1 17 1 11801200 mkplinstall Installing arkc Version 4 1 17 1 C Arkeia Command Line Mode 11801210 mkplinstall OS Linux Version 2 2 5 15 Q1801002 Enter main KNOX directory LC usr knox q to quit 2 2 Installation using rpm packages Most Linux based operating systems use rpm Red Hat Package Manager packages The main advantage of rpm packages is to provide automated installation and pack age tracking through several command line or graphical utilities To install an rpm package please follow the instructions detailed below Login as the root user This is usually achieved through the su command su root Please note that with several X GUT utilities this step may be unnecessary as the util ity itself will prompt you for the root password when launched and perform the root login itself Check the presence of the arke package with ts command The package name usu ally contains a version number as indicated below Ls arkeia arkc 4 1 16 1 i1386 rpm Please note that the version number and architecture information indicated could be different from the one indicated above Enter the command rpm Uvh arkeia arkc 4 1 16 1 i1386 rpm The RPM utility will then proceed with the installation of the software Please note that the u option of the RPM utility will only install a newer version of the software Fo
150. on determines the duration of the data retention of the backup This parameter must be completed by the retunit parameter see below and can accept values starting at 1 For instance retention 6 retunit Optional The parameter re tun it determines the type of unit used by the retention param eter It can accept the following values DAY WEEK MONTH and YEAR For instance to take back the example above retention 6 retunit MONTH This defines a retention period of 6 months for the data of the backup being started with arkc parallelism Optional The parameter parallelism determines the number of concurrent data flows that will be used for the backup This parameter can accept numerical values from 1 to 128 By default Arkeia uses the maximum number of flows available for its backups type Optional The parameter t ype determines the type of backup that will be performed by Arkeia This parameter can accept three values TOTAL INCREMENTAL and ARCHIVE By default the value of type is TOTAL For more information about the different type of backup available under Arkeia please refer to the Arkeia User Manual Arkeia command line interface Manual 66 144 based_on_bksid Optional The based_on_bksid parameter is valid only if the type parameter is set to INCREMENTAL In this case the based_on_
151. ot allow the header of a tape to be written if the tape already has an existing header To force the header to be written to the tape using the wr i te command use the overwrite parameter see below overwrite Optional Using the overwrite parameter it is possible to delete the existing header of a tape and replace it with the new header For instance arke drive write D name LCDLT 8000 tpname JackTape overwrite Please note that the command above should be entered all on one line This replaces the existing header of the tape introduced in the drive DLT 8000 by the header Ja ck Tape 9 4 Checking the label on a tape with the read command The read command checks if a tape is present in a given tape drive If this is the case it will then display the tape header The syntax for this command is the following arkc drive read D I lt input file gt lt parameters gt This command accepts only one parameter drvname or drvid which is detailed below drvname drvid Required The parameter drvname contains the name of the drive that should be checked for the presence of a tape For instance arke drive read D drvname ecrix_2 The command above indicates that the drive to be checked for the presence of a tape is Arkeia command line interface Manual 74 144 ecrix_2 If drvid should be used the following command would be equiv
152. pe to complete the backup operation If the value NO is used then Arkeia will not send an email The default value of email is YES Please_note In order to receive an email the parameter email defined for a user must contain a valid email address Even if the email parameter of a backup is defined it will not send any informa tion if the user ema i L parameter does not contain any information mode Optional The parameter mode controls the operational mode of Arkeia for a backup Two modes and values of mode are available CONTINUOUS and STANDARD When the STANDARD mode of operation is chosen the backup will stop once it is completed and will be considered as terminated by the Arkeia server When the CONTINUOUS mode is selected the backup task will not be considered as finished once it has saved all the files in the Savepack and more Savepacks can be added to the backup task By default the value of Arkeia command line interface Manual 126 144 mode is STANDARD if you are unsure which mode is best suited to your need please use the default comment Optional The parameter comment is used to add a more descriptive comment to a backup For instance comment CLComplete user data backup including email dir Please note that as seen above comments that contain spaces should be enclosed within square brackets E I
153. pping a library The start and stop commands can be used to manage the tape libraries e Starting a library In order to use a given library Arkeia has to start a specialized module that allows it to drive meaning use all the functions of a library This module is usually launched automatically for instance when a backup is started However it is sometimes necessary to start a library manually To do this the following syntax should be respected arkc library start LCD I lt input file gt lt parameters gt This command accepts only one parameter which is name Required The name parameter contains the name of the tape library to be started This name is assigned to the tape library during its creation For instance arke library start D name CHP SureStore 1 9 DLT The command above would start the tape library named HP SureStore 1 9 DLT Please note the use of the square brackets around the name of the library Arkeia command line interface Manual 118 144 Please_note it is possible to replace the name parameter by the Libid parameter The Ll ibid parameter is the ID of the library that should be started It can be obtained by entering the command arkc library List D name name_of_the_library more Therefore the following start command is correct assuming 3af012b1 is the correct ID for the library HP SureStore 1 9 DLT arkc library
154. r Arkeia command line interface Manual 5 144 more information on the RPM utility please refer to the man pages of your system with the command man r pm 2 3 Standard arkc configuration If your Arkeia configuration is simple the easiest way to configure arkc is to edit the file named arkc param and enter the relevant information For instance here is the default arkc param file This file is the preferences file for the Arkeia Command Line Interface You have to comment out or uncomment any field which requires modification Those information are used by ARKC during an arkc session The syntax of this file must always be KEYWORD QUOTED_EXPRESSION tE The NODE is your Arkeia backup server The backup server name is a part of the requested information to realize a remote connection NODE MyBackupServer This field sets the login of the Arkeia user who executes some commands on the backup server The first time you log in you must use root Login LOGIN MyLogin This field sets the password of the Arkeia user set above through LOGIN parameter The first time you log in as root you must set an empty password PASSWORD MyPassword Arkeia and Knox Software are registered trademarks all rights reserved ALL other company or product names mentioned are used for identification only and trademarks of their respective owners The content of this file should be self explanatory Th
155. r to the second part of this manual It is possible to filter the output of file list command with the following filter e file Displays only the files present on the tape 18 2 Finding a file with the where command Finding a file that should be restored can be a time consuming process The where command can help in this process This command only applies to the f i Le object The correct syntax for this command is the following arkc file where LD I lt input file gt lt parameters gt The command where searches the internal Arkeia database and tries to find a match to the search criteria that were given This command accepts the following parameter file Required The file parameter contains the name of the file or directory that should be searched for The search criteria should be in the following format machine directory directory file For instance arke file where D file pluto home Arkeia command line interface Manual 137 144 The command above will start a search in the Arkeia database for the directory home that was backed up from the machine named pluto The output of the where command can be modified with the following filters tpname Displays only the name of the tape s where the files are found tpid Displays only the ID of the tape s where the files are found Arkeia command line interface Manual 138 144 19 The
156. re detail the modification of the Arkeia Savepacks through the use of the modi fy com mand of arkc Arkeia command line interface Manual 97 144 The information regarding a specific tree have to entered in a configuration file and each item should be separated by a pair of lt ITEM gt lt ITEM gt statements For instance the following lines are valid tree information lt ITEM gt tree_name station0O1 home jack mail lt ITEM gt lt ITEM gt tree_name station0O1 home jack CADfiles lt ITEM gt lt ITEM gt tree_name station0O1 home jack project documentation lt ITEM gt These lines inserted in a configuration file would indicate that on the computer named station01 the following directories and their contents should be backed up by Arkeia home jack mail home jack CADfiles and home jack project documentation The following parameters can be added to the lt I TEM gt lt ITEM gt statements tree_name Optional The tree_name parameter defines the new tree that will be added to a Savepack This parameter has the following format name_of_machine directory1 directory2 For instance tree_name station01 home jack project programming C_files Please note that to delete a specific tree from within a Savepack you need to use the param eter dt ree_name on the command line The parameter t ree_name and its output FULLNAME see
157. rity Optional The parameter priority assigns a priority to a drive contained in a Drivepack This allows an administrator to define precisely which drive will receive first the data from a back up operation For instance if drive A has a priority of 1 and drive B has a priority of 5 the A drive will be used first for a backup operation If this operation requires more drives then drive B will be used followed by any other drives in the order of their priority This parameter can accept values from 1 to 128 with a value of 1 highest priority being assigned by default Combining the priority parameter with the nbdr ive offers a high level of flexibil ity for the operation of a group of drives Please refer to the above information for more examples on how to add this parameter to a Drivepack input file 14 2 Drivepack deletion The correct syntax to delete a Drivepack is the following one arkc drivepack delete D I lt parameters gt Where the parameters can be the following ones name Required The name parameter should contain the name of the Drivepack to be deleted For instance arkc drivepack delete D name DLT_drivepack A list of all the Drivepacks available on a given Arkeia server can be obtained with the com mand arkc drivepack list dkid Optional The dk id parameter is the ID assigned to the Drivepack when it
158. rive creation The creation of a tape drive with arkc through the create command uses the fol lowing syntax arkc drive create D I lt parameters gt Arkeia command line interface Manual 18 144 The parameters that can be used while creating a tape drive are the following ones name Required The name parameter indicates the name which is going to be used by Arkeia to refer to the new tape drive This parameter is required by the create command The correct syntax for this parameter is name XXXXX where XXXXX is the name string to assign to the new drive For instance name Accounting The parameter above creates a drive named Accounting type Required The type parameter indicates which type of tape drive is going to be created by arkc Please note that this parameter is required by the create command Here is a list of available types of tape drive that are valid for this parameter NULL FILE STD_AIT STD_DAT STD_EXABYTE STD_DLT STD_DTF DAT_SONY_7000 AIT_AUTOLOADER STD_QIC STD_CARTRIDGE REDWOOD_SD3 LTO MAGSTAR_MP ECRIX_VXA 9840 For instance to create a DLT tape drive a correct command syntax would be the following one arkc drive create D name DLTO2 type STD_DLT rewind_dev dev st0 Please note that this command should be entered all on one line You can also refer to the parameter rewind_dev below rewind_dev Required The parameter
159. rkeia in order to be used for back up and restore operations The standard syntax to create a library with arkc is the following arkc library create D I lt parameters gt The parameters that can be accepted by arkc while creating a library are the following ones name Required The parameter name assigns a descriptive name to the library being created This parame ter is mandatory For instance name DLT_Lib04 or name LAccounting DLT Library type Required The parameter type defines the type of library being created Please note that the value of type must be entered precisely as shown Some possible values for this parameter are ADIC100 LTO ATL L200 AUTOPAK BLACKJACK_X_21 DLT4700 DLT7 DLTSTOR114 EXB 17D7 EXB 60 EXB EZ17 EXB X200 FALCON 1530 FALCON 1560 FASTSTOR Arkeia command line interface Manual 27 144 FILE HP19 LTO HP660 LTO HP660 HPC1191 HPDAT6 Harrier8150 Harrier8 amp 30 Harrier850 IBM7336 IBM7337 ITL2225 ITL4115 ITL7115 LIBRA16 LIBRA18 LIBRA8 amp LP1117 MAGSTAR_L12 MAGSTAR_L18 MAGSTAR_L24 MAGSTAR_L32 SONY_DMSB9 STD4586NP 12 STD4586NP STK7430 STK9710 STK9714 SUN L1000 SUN L700 9840 SUN L700 DLT SUN L9 TSL A300 TSL S7000 TWINLIBRA16 TWINLIBRA18 You can obtain a complete list of all the hardware supported by Arkeia by typing the com mand arkc library type onacommand line For more information please see chapter 6 The in
160. rocess The where command can help in this process This command only applies to the f i Le object Arkeia command line interface Manual 77 144 The correct syntax for this command is the following arkc file where LD I lt input file gt lt parameters gt The command where searches the internal Arkeia database and tries to find a match to the search criteria that were given This command accepts the following parameter file Required The f i Le parameter contains the name of the file or directory that should be searched for The search criteria should be in the following format machine directory directory file For instance arke file where D file pluto home The command above will start a search in the Arkeia database for the directory home that was backed up from the machine named p luto The output of the where command can be modified with the following filters tpname Displays only the name of the tape s where the files are found tpid Displays only the ID of the tape s where the files are found The rest of this manual will describe the a rkc commands divided among the different objects Arkeia command line interface Manual 78 144 10 The tape object This chapter of the arke manual will detail all the possible commands that can be applied to the tape object As such it contains all the tape related commands such as create
161. running The running command can be used to display the list of backups or restoration that are in progress on the Arkeia server Further information about a specific job can then be queried using the s tatus command see below The standard syntax for the running command is the following arkc Cbackup restore running For instance to display a list of all backup operations currently in progress it is possible to enter arkc backup running This command will then display the IDs of all the backup in progress on the Arkeia server To obtain more information on a specific job please refer to the status com mand below 7 8 Displaying information on a job in progress with status The status command can be used to display information on either backups or on restorations This will detailed in the next two sections e Status of a running backup To obtain detailed information on a running backup the status command should be used This command has the following syntax arkc backup status LCD I lt input file gt lt parameters gt This command accepts only one parameter which is detailed below bksid Required The bks id parameter contains the ID of the backup whose detailed status should be dis played This ID is displayed when a backup is started with the start command For more information please refer to the next chapter of this manual The start
162. s gt The following parameters can be applied to this command skname Required The skname parameter contains the name of the Savepack to be saved by the backup This name is assigned to the Savepack during its creation For instance arkc backup start D skname JackHome The command above would start the backup of the Savepack named JackHome plname Required The plname parameter contains the name of the tape pool to be used by the backup This name is assigned to the tape pool during its creation For instance arkc backup start D skname JackHome plname PoolLl01 The command above would start the backup of the Savepack named JackHome on the tape pool named Poo L01 dkname Required The dkname parameter contains the name of the Drivepack to be used for the backup This name is assigned to the Drivepack during its creation For instance arkc backup start D skname JackHome plname Pool01 dkname DSK_01 The command above would start the backup of Ja ckHome on the tape pool Poo t01 and on the Drivepack named DSK_01 Please note that these options should all be con tained on the same line Arkeia command line interface Manual 125 144 Please note The parameters skname plname and dkname while they must be entered on the command line to start a backup can be replaced by the parameters skid plid and dkid T
163. s the name of the plug in which is used by the Arkeia server to perform the backup and restoration operation In the example screen above the plug in name is the default plug in f i Le which is used for all normal file system opera tions Future plug ins may be named for instance oracle mysql for plug ins spe cialized in database backup and restoration Please note that the plug in name should be separated from the path by a character path filename This is the path and the name of the file on which the operation should be performed Here are a few examples of correct paths file names that will be accepted by arkc as valid zap foo com file home jack cad files DCCF_0124122589 dat zip foo com file home tina docs pdf arkeia man_arkc pdf email01 neon com file etc mail statistics Please note The syntax descrived above applies only to arke version 5 or above This syntax is valid whether the machine is a Windows or a UNIX machine Arkeia uses slash characters for paths on all operat ing systems The only difference in syntax between the Windows and the UNIX Arkeia client is that Windows machines require the volume letter to be inserted before the path and file name Therefore the following paths are correct only for Windows machines bilbo shire org file c files docs lLinux pdf LinuxFromScratch pdf gandalf mordor com file d patrick meeting Conference2002 ppt Arkeia comm
164. sidered valid and will be accepted by arkc for a tape duplication com mand dst_lib_name RD_LTO dst_libid 3a530bcf As can be seen above the ds t_lib_name may be easier to remember but both these values are valid and accepted by arkc To display a list of available libraries enter the com mand arke library List without the quotes Please note that defining dst_lib_name or dst_libid means that dst_slot see below must be defined as well dst_slot Required This parameter is required when using a r k c but only if duplicating in a library This parameter should contain the number of the slot that contains the destination tape This parameter must be defined if duplicating to a library For instance the following is con sidered as valid value and will be accepted by ar kc for a tape duplication command dst_slot 6 Arkeia command line interface Manual 143 144 This slot must contain the tape that will be used as a target by the duplication operation Please note that when duplicating from to a library it is not necessary to define a source slot for the source tape as Arkeia is able to retrieve the correct tape based on its ID and or name Also please note that defining dst_slot means that dst_lib_name or dst_libid see above must be defined as well Arkeia command line interface Manual 144 144
165. stance taking back the example above arkc restore start Ireports txt Content of reports txt Example of restoration file AnnualReport_2000 ps Arkeia command line interface Manual 67 144 from babylon home jack files Reports to babylon home jack tmp arkeia temporary In the example above the file Annual Report_2000 ps whose original directory was fhome jack files Reports on the workstation babylon from line will be restored instead to the directory home jack tmp arkeia temporary to line This allows the user to check the content of the restored file before moving it back to its original position Please note A from parameter should always be followed and com pleted with a to parameter If this is not the case the restoration will be rejected by arkc with an error message wait Optional The parameter wait determines the behavior of arkc once a restoration is launched with arke restore start This parameter can accept two values YES or NO If the value YES is used arkc will wait until the end of the restoration to return which means the user will not be able to enter any new command until the completion of the operation If the value NO is used ar kc will return immediately and allow the user to enter other commands on the command line drvname Optional The parameter drvname contains the name of
166. start D Libid 3af012b1 e Stopping a library It is possible to stop a library manually by using the stop command of arkc For instance arke library stop LCD I lt input file gt lt parameters gt This command accepts the same parameters as the start command For instance the following commands are valid arkc Library stop D name CHP SureStore 1 9 DLTI arkc library stop D Libid 3af012b1 15 8 Additional tape related commands for tape libraries There are four arke tape related commands that are specifically designed for tape libraries These commands are settape Library slots and tapes configuration and assignement unsettape Modification of the configuration of the library slots tape load Load a tape from a pre defined slot unload unload a tape from a pre defined slot The rest of this section is going to detail these commands and their usage e Assigning logical tapes to library slot with settape For a library to function properly under Arkeia it is necessary to assign existing tapes to the different slots present in the library This is done through the settape command The syntax of this command is the following arkc library settape LD I lt input file gt lt parameters gt The possible parameters for this command are the following Arkeia command line interface Manual 119 144 name Libid Required The name and lL ibid parameters contain th
167. t syntax to use for this is the following arkc journal command D lt parameters gt The different commands that can be used with the journa L object are the following journal all Displays all log information journal jtape Displays only tape related information journal jdrive Displays only drive related information journal jbackup Displays only backup related information journal jrestore Displays only restoration related information The rest of this section will detail the j tape command listed above Since all the commands accept the same parameters these will be detailed at the end of the section Displaying the tape related information The syntax to display only the tape related information contained in the Arkeia log is the following arkc journal jtape D lt parameters gt For more information about the parameters that can be accepted by this command please refer to the section below Possible parameters for the journal object and commands The parameters that can be accepted by the journal object are detailed below Please note that these parameters apply to all the commands that were detailed above D all jtape jdrive and jrestore gt and that they are all optional month Optional The parameter month limits the display of the journal object to a specific month The value of month can go from 1 J
168. t parameters gt The command jbackup accepts all the parameters detailed above month Level and filter and adds the following required parameter bksid Required Using the parameter bksid which contains the ID of a completed backup will display only the information related to this backup For instance you will find below a typical journal jbackup command and its output please note the usage of the filter parameter arke journal jbackup D bksid 3b5316a0 filter ZLZS wO80006 pak Pool wO80006 1080003 1080010 wO80006 Start of backup Savepack dragon Drivepack Ecrix Auto VXA Owner is root Adding savepack dragon Loading tape VXA_03 in drive ECRIX_2 Job has been aborted by root Arkeia command line interface Manual 63 144 8 The start and the stop commands of arkc The start and the stop commands of arkc are used only for the following Arkeia objects backup start only restore start only duplication start only Library start and stop The rest of this chapter will detail the different possibilities offered by these commands 8 1 Starting a backup The start command can be used to launch a backup with arkc The standard syn tax for this command is the following one arkc backup start D I lt parameters gt The following parameters can be applied t
169. t with unload Once a tape has transferred to a tape drive it is possible to unload transfer the tape back to its slot from one of the tape drives of the library This is done with the unload command of arkc The syntax of this command is the following arke library unload LD I lt input file gt lt parameters gt The parameters that can accepted by the unload command are the following ones name Libid Required The name and lL ibid parameters contain the name and the ID of the library respec tively This parameter is required to indicate which library is going to be affected by the unload command For instance the following parameters are equivalent assuming 3b614c30 is the correct ID of the library named Aut opack30 name Autopack30 lLibid 3b614c30 Or for a complete command arke library unload D name Autopack30 slot Required The slot parameter contain the number of the slot that should receive the unloaded tape This parameter only accepts numerical values ranging from 1 first slot to the last slot available in the library For more information on the number of slots available please refer to the documentation supplied with the library hardware For instance the following parameter would unload the tape back to slot number 8 slot 8 drvnum Optional The drvnum is the logical number of the drive that should eject t
170. tape delete D plid 3a78354e In the example above all the tapes contained within the tape pool ID 3a78354e will be deleted with one command Arkeia command line interface Manual 83 144 Please note Caution is advised when using the pl id parameter while deleting several tapes as the de Le te command will delete all the tapes contained in the tape pool For more information on tape pool deletion please see below 10 3 Tape modification To modify a tape s characteristics the syntax of ar kc is the following arkc tape modify LD I lt input file gt lt parameters gt To modify a tape it is necessary to supply to arkc its name or its tpid For more information on these parameters please refer to The create command of arkc on page 14 To obtain a list of the names of the available tapes it is always possible to enter the following command arkc tape list The following tape parameters can be changed using the modify command plname plid Tape Pool name and ID recycle_in recycle_mode Recycling functions access Access rights of the tape comment These parameters are described in more detail in the chapter The create command of arkc on page 14 of this manual 10 4 Listing files present on a tape with the list command The object f i Le is used to obtain a list of files contained on a given tape When using the command arke file l
171. tape in a given directory 10 2 Tape deletion To delete a date with arkc use the following syntax arkc tape delete D lt parameters gt Please note Deleting an Arkeia tape does not affect the physical tape itself it means that the entry of the tape in the Arkeia database will be deleted The tape data won t be accessible anymore since the Arkeia data base will not have a record of the tape The only way to access the tape data again is to import the tape informa tion back in the Arkeia database with the arkrstb utility an opera tion which can be complex and time consuming if several tapes have been deleted For more information on this operation and the utilities provided to perform it please refer to the Arkeia User s Manual The following parameters can be used to delete a tape name Required The name parameter indicates which tape should be deleted by arkc For instance the following command will delete the tape named Test_Tape_01 arkc tape delete D name Test_Tape_01 To delete several tapes you can either a Enter several names on the command line Arkeia command line interface Manual 82 144 arkc tape delete D name Test_Tape_01 name Test_Tape_02 b Delete all the tapes contained in a pool of tape if all the tapes to be deleted are assigned to the same pool arkc tape delete D plid 3a78354e For more information on tape pool deletion please see the parameter
172. the drive to be used for the restoration in a single drive environment This name is assigned during the creation of the drive For instance drvname SonyDLtT On a single drive system the parameter above indicates that the drive named SonyDLT should be used for the restoration operation Please note It is possible to replace the drvname parameter by the drvid parameter The drvid should then contain the ID of the drive to be used for the restoration in the case of a single drive configu ration This ID is assigned to the drive during its creation and can be obtained by entering the following command arkc drive list D name name_of_the_drive rstopt Optional The rstopt parameter determines the different options that should be applied to the files that will be managed by the restoration This parameter accepts the following values Arkeia command line interface Manual 68 144 that will influence the restoration REST_TIMES Restore the time information of the files RST_PERMS Restore the access rights of the files RST_BYID Restore by user identifier RST_BYNAME Restore by user name RST_CHKTIME Check if the existing file if any is newer 8 3 Starting a tape duplication operation Like other arke objects a tape duplication operation must be first created Please refer to The create command of arkc on page 14 for more information and can then be started To this the proper
173. tion on the connect command and its uses please refer to Modifying a job with the connect command on page 75 17 5 Displaying restoration related log information To display restoration related information contained in the Arkeia log the journal object should be used The correct syntax for this object is the following arkc journal jrestore LD I lt input file gt lt parameters gt For more information on the journal object and its parameters please refer to the section named Displaying log information with the journal object on page 60 in the chapter named The informational commands and objects of arkc on page 48 of this manual Arkeia command line interface Manual 136 144 18 The file object This chapter of the arke manual will explain the different commands that can be applied to the f i Le object 18 1 Listing files present on a tape with the list command The object f i Le is used to obtain a list of files contained on a given tape When using the command arke file list it is therefore necessary to supply the name of the tape to be listed with the t pname parameter The standard syntax is therefore arkc file list D tpname name_of_tape For instance arkc file list D tpname DLT_140 The command above will list all the files contained on the tape named DLT_140 For more information on the file object please refe
174. tional The parameter tree_cmd_before describes a command that should be executed before the tree is backed up For more information please refer to the cmd_before parameter in Savepack creation on page 20 tree_do_cmd_before Optional The parameter tree_do_cmd_be fore describes the behavior of Arkeia in the case of a failure of the command described in tree_cmd_before For more information please refer to the do_cmd_be fore parameter in Savepack creation on page 20 tree_cmd_after Optional The parameter tree_cmd_after assigns a command to be executed after the back up Arkeia command line interface Manual 44 144 of the tree by Arkeia For more information please refer to the cmd_af ter parameter in Savepack creation on page 20 tree_do_cmd_after Optional The parameter tree_do_cmd_a f ter describes the behavior of the command entered in tree_cmd_after in the case of a failure of the tree backup For more information please refer to the do_cmd_af ter parameter in Savepack creation on page 20 tree_allowed_fs Optional The parameter tree_allowed_fs determines the behavior of the Arkeia backup in case the tree contains NFS links For more information please refer to the al Lowed_fs parameter in Savepack creation on page 20 tree_follow_fs Optional The parameter tree_follow_fs determines if Arkeia should fo
175. us To obtain detailed information on a running restoration the status command should be used This command has the following syntax arkc restore status LD I lt input file gt lt parameters gt This command accepts only one parameter which is detailed below rstid Required The rstid parameter contains the ID of the restoration whose detailed status should be displayed This ID is displayed when a restoration is started with the start command For more information please refer to the The start and the stop commands of arkc on page 64 For instance the following command arke restore status D rstid 3bcc4545 will return the possible values 0 The restoration is in progress 1 The restoration needs a new tape 2 The restoration is now completed 3 The restoration requires a new drive If the value returned is 1 the status command also displays two values which are drvname Name of the drive to be used for the new tape tpname Name of the new tape to be inserted in the drive P If the value returned is 3 the only value displayed will be drvname as the restora tion only requires a new drive and not a new drive and a new tape Arkeia command line interface Manual 135 144 Please note that it is possible to modify the behavior of a restoration in progress by using the connect command to modify its parameters For more informa
176. used instead of the name parameter described above For instance the two commands below are equivalent assuming that 3a64332e is the correct ID of the Savepack named WebDesign arkc savepack delete D name WebDesign arkc savepack delete D plid 3a64332e 12 3 Savepack modification To modify a Savepack with arkc the following syntax should be used arkc savepack modify D I lt input file gt lt parameters gt Please note that when modifying a Savepack with arkc it is necessary to supply the parameter name or the parameter skid name or ID of the Savepack to be modi fied The following Savepack parameters can be changed through the modi fy command allowed_fs file systems allowed retry number of allowed retries compress compression scheme to be used for back up crypt cryptographic function to be used symb_Link follow through of symbolic links follow_fs follow through of file systems inc_filter inclusion filter exc_filter exclusion filters cmd_before do_cmd_before pre backup command cmd_after and do_cmd_af ter post backup commands behavior bd comment For more information on these parameters please refer to The create command of arkc on page 14 The main use of the modify command when it applies to Savepack is to add or remove trees files and their relevant parameters The rest of this section will therefo
177. user object This chapter will detail the different arkc commands that can be applied to the user object 19 1 User creation Creating a user can be accomplished with the create command with the following syntax arkc user create LD IJ lt parameters gt The parameters that can be used to create a user are the following ones name Required The parameter name assigns a descriptive name to the user being created The correct syn tax for this parameter is for example name John If a name must contain spaces it should be enclosed between square brackets E 1 For instance name LJohn Smith node Required The parameter node contains the name of the Arkeia client the user will interact with This parameter has the following syntax node stormbringer In the example above the name of the Arkeia client which is to be used is s torm bringer A node should always be assigned to a newly created user email Optional The ema i L parameter is used to define an email address that Arkeia can use to warn the user of the completion of an operation The email address should be a standard address that can be reached by the Arkeia server For instance email john smithafoobar com passwd Optional The passwd parameter defines the password used by the user to connect to the Arkeia server defined by the node parameter It is highly recommended to use s
178. uses the follow ing syntax arkc pool create D I lt parameters gt Please refer to arkc options general on page 8 for more information on the different options that can be used with ar kc The parameters that can be accepted by the c r e ate command when it is used to create a new tape pool are the following name Required The name parameter indicates the name which is going to be used by Arkeia to refer to the new tape pool This parameter is required by the c r ea t e command The correct syn tax for this parameter is name XXXXX where XXXXX is the name string to assign to the new pool For instance name Safe_Pool creates a tape pool named Sa fe_PooL Please note that it is possible to assign a name that contains space if this name is entered between square brackets E 1 For instance name LR amp D tape pool The parameter above will create a Tape Pool named R amp D tape pool owner Optional The owner parameter indicates which Arkeia user is the owner of the tape pool By default the value of owner is set to the user who opened the session It is possible to spec ify a different user than the user currently logged in to the session For instance if the com mand arkc user list returns the following list of users name jsmith John Smith name tchang Tina Chang name root The owner value can be either jsmit
179. ut file with the I option on the command Line You can try to use debug to analyze your input file For instance arkc debug input lIinputfile MLC_ERROR_INPUTFILE_CLOSE arkc could not close the file specified as the input file with the I option on the command Line MLC_ERROR_INPUTFILE_NEEDED An input file is needed MLC_ERROR_INPUTSTD arkc could not parse the standard input with the option MLC_ERROR_OUTPUT_WRITE arkc could not write to the output file specified wit the 0 option MLC_ERROR_OUTPUTFILE_OPEN arkc could not open the file specified as the output file with the 0O option in the command Line MLC_ERROR_OUTPUTFILE_WRITING arkc could not wtite to the output file specified with the 0 option on the command Line MLC_ERROR_OUTPUTFILE_CLOSE arkc could not close the file specified as the output file with the 0O option on the command Line MLC_ERROR_FUNCTION_AFFECTATION Internal error MLC_ERROR_INIT_PREFS arkc could not use the preference file see FAQ MLC_ERROR_CONNECTION arkc could not establish a connection to the backup server Please refer to the arkc FAQ for more information Arkeia command line interface Manual 59 144 on the possible connection problems MLC_ERROR_EXECUTING FUNCTION arkc could not execute a request Please note that the arkc configuration and command syntax are correct MLC_ERROR_ARGUMENT_FUNCTION Internal error MLC_ERROR_RETURNING_FU
180. ve is the number of drives that are contained in the Drivepack If nbdr ive has a lower value this means a group of drives within the Drivepack will be used for the first task while some drives will be reserved for other tasks For instance if a Drive pack contains 5 drives it is possible to reserve three of these nbdrive 3 for backup and keep 2 drives for restoration operations Combining this parameter with the priority parameter see below for more information offers a great flexibility to system administrators in deciding which drive will be used for what purpose Arkeia command line interface Manual 110 144 Please refer to the information below drvname and drvid parameters for more details on adding new drives to a Drivepack drvname Optional To add drives to a Drivepack it is possible to use either the drvname or the drv id parameters Both these parameters should be contained in an input file with each drive to be added to the Drivepack contained in a pair of lt ITEM gt lt ITEM gt statements For instance the following lines of an input file would add the drive named DLTO1 in a Drivepack Comment First DLT drive of drivepack lt ITEM gt drvname DLT01 priority 1 lt ITEM gt Adding several drives to a Drivepack is therefore a question of adding several lt ITEM gt lt ITEM gt statements into the same input file each statement containing di
181. ven tape by entering the command arkc tape list D name name_of_tape Since the tpid parameter is equivalent to the name parameter the two commands below are equivalent provided that 3a7834d7 is the correct tp id value of the tape Test_Tape_01 arkc tape delete D name Test_tape_01 arkc tape delete D tpid 3a7834d7 plid Optional The p Llid parameter is one way to delete several tapes in one operation as long as all the tapes to be deleted are included in the same tape pool The p Llid of a given tape can be obtained by entering the following command arkc tape list D name name_of_the_tape Once obtained it is possible to delete all the tapes contained in a given pool tape by entering the command arkc tape delete D plid 3a78354e In the example above all the tapes contained within the tape pool ID 3a78354e will be deleted with one command Please note Caution is advised when using the p l id parameter while deleting several tapes as the de Le te command will delete all the tapes contained in the tape pool For more information on tape pool deletion please see below Arkeia command line interface Manual 33 144 5 2 Tape pool deletion Deleting a tape pool is almost the same as deleting a single tape The correct syntax to delete a tape pool with arkc is the following one arkc pool tape D Ename plidJ lt value gt The parameters that c

arkc: arkeia command

Contents

Download Pdf Manuals

Related Search

Related Contents