1. ACLI Reference Guide
  2. ACLI Commands A-M
  3. archives

archives

The archives command is used for creating, moving, and manipulating archived log files. All archive files are created in .tar.gz format in SD Software versions 2.0 and above. All commands are executed from within the archives menu.

Log files contain a record of system events. Log files are stored in the /code/logs directory. The CFG archive type is no longer supported in C6.2.0. When an archive command is entered with the CFG type, the Oracle Communications Session Border Controllerresponds with an error message.

Path

Type archives at the topmost prompt before executing any of the below commands to enter the archives shell.

Syntax

archives > create

create LOGS <logfile-name>

Arguments

<logfile-name> Enter the name of archive file that contains all logs To create an archive file of a log, type create LOGS and enter a logfile name. Archives are created in .tar.gz (tarred and gzipped) format.

Example

ORACLE(archives)# create LOGS jun_30.gz

Syntax

archives > delete

delete LOGS <logfile-name>

Arguments

<filename> Enter the filename of the log archive to delete The archives > delete command deletes the specified archive file from the Oracle Communications Session Border Controller. You must append “.tar.gz” to the filename when using this command. Use the archives > display command to list the available log archives to delete.

Example

ORACLE(archives)# delete LOGS july_16.gz

Syntax

archives > display

display LOGS

Arguments

This command lists the log archives currently saved on the Oracle Communications Session Border Controller’s file system.

Example

ORACLE(archives)# display LOGS

Syntax

archives > exit

exit

Example

ORACLE(archives)# exit

Note:

This command exits from the archives session and returns you to the ACLI Superuser system prompt.

Syntax

archives > extract

This command is no longer supported in release C6.2.0.

Syntax

archives > get

get LOGS <archive-name> <remote-host> <user-name> <password>

Arguments

<remote-name> Enter the full path and filename to retrieve

<host> Enter the IP address of the remote host

<user-name> Enter the user name on remote host

<password> Enter the password on remote host

Example

ORACLE(archives)# get LOGS may_31.gz

Note:

This command retrieves an archived log. If you do not include all the necessary arguments, the get command will prompt you for the arguments you omitted. The get command writes the retrieved file to the /code/logs/<archive-name> path.

Syntax

archives > rename

rename LOGS <old-archive> <new-archive>

Arguments

<current_name> Enter the old archive name

<new_name> Enter the new archive name

Example

ORACLE(archives)# rename LOGS june sept

Note:

Renames an archived log. You do not need to append “.tar.gz” to the filename when using this command.

Syntax

archives > send

send LOGS <archive-name> <host-ip-address> <username>

Arguments

<archive-name> Enter the name of archive file to send

<host-ip-address> Enter the IP address of FTP server

<username> Enter the FTP username on server

Example

ORACLE(archives)# send LOGS Oct_24.gz 1.0.100.7 user1

Note:

This command sends an archived log file to a remote host using FTP. If you do not include all the necessary arguments, the send command will prompt you for the arguments you omitted.

archives create

Syntax

create LOGS <logfile-name>

Arguments

  • <logfile-name> Enter the name of archive file that contains all logs

To create an archive file of a log, type create LOGS and enter a logfile name. Archives are created in .tar.gz (tarred and gzipped) format.

Example

ORACLE(archives)# create LOGS jun_30.gz

archives delete

Syntax

delete LOGS <logfile-name>

Arguments

<filename> Enter the filename of the log archive to delete

The archives > delete command deletes the specified archive file from the Oracle Communications Session Border Controller. You must append “.tar.gz” to the filename when using this command. Use the archives > display command to list the available log archives to delete.

Example

ORACLE(archives)# delete LOGS july_16.gz

archives display

Syntax

display LOGS

This command lists the log archives currently saved on the Oracle Communications Session Border Controller file system.

Example

ORACLE(archives)# display LOGS

archives exit

Syntax

exit

Note:

This command exits from the archives session and returns you to the ACLI Superuser system prompt.

Example

ORACLE(archives)# exit

archives extract

This command is unsupported.

archives get

Syntax

get LOGS <archive-name> <remote-host> <user-name> <password>

Arguments

  • <remote-name> Enter the full path and filename to retrieve
  • <host> Enter the IP address of the remote host
  • <user-name> Enter the user name on remote host
  • <password> Enter the password on remote host

Note:

This command retrieves an archived log. If you do not include all the necessary arguments, the get command will prompt you for the arguments you omitted.

The get command writes the retrieved file to the /code/logs/<archive-name> path.

Example

ORACLE(archives)# get LOGS may_31.gz

archives rename

Syntax

rename LOGS <old-archive> <new-archive>

Arguments

  • <current_name> Enter the old archive name
  • <new_name> Enter the new archive name



Note:

Renames an archived log. You do not need to append “.tar.gz” to the filename when using this command.

Example

ORACLE(archives)# rename LOGS june sept

archives send

Syntax

send LOGS <archive-name> <host-ip-address> <username>

Arguments

  • <archive-name> Enter the name of archive file to send
  • <host-ip-address> Enter the IP address of FTP server
  • <username> Enter the FTP username on server


Note:

This command sends an archived log file to a remote host using FTP. If you do not include all the necessary arguments, the send command will prompt you for the arguments you omitted.

Example

ORACLE(archives)# send LOGS Oct_24.gz 1.0.100.7 user1