4.3. File System Command Reference

4.3.1. Command Hierarchy

4.3.1.1. Configuration Commands

attrib [+r | -r] file-url
attrib
cd [file-url]
copy source-file-url dest-file-url [force]
delete file-url [force]
dir [file-url] [sort-order {d | n | s}] [reverse]
format [flash-id] [reliable]
md file-url
move old-file-url new-file-url [force]
rd file-url rf
rd file-url [force]
repair [flash-id]
scp local-file-url destination-file-url [router router-instance] [force]
scp local-file-url destination-file-url [service service-name] [force]
[no] shutdown [active] [standby]
[no] shutdown flash-id
type file-url
version file-url [check]

4.3.2. Command Descriptions

4.3.2.1. Configuration Commands

file

Syntax 
file
Context 
root
Description 

This command enters the context to perform file system operations.

When entering the file context, the prompt changes to reflect the present working directory. Navigating the file system with the cd .. command results in a changed prompt.

The exit all command leaves the file system/file operation context and returns to the <ROOT> CLI context. The state of the present working directory is maintained for the CLI session. Entering the file command returns the cursor to the working directory where the exit command was issued.

attrib

Syntax 
attrib [+r | -r] file-url
attrib
Context 
file
Description 

This command sets or clears/resets the read-only attribute for a file in the local file system.

To list all files and their current attributes, enter attrib or attrib x where x is either the filename or a wildcard (*).

When an attrib command is entered to list a specific file or all files in a directory, the file’s attributes are displayed with or without an “R” preceding the filename. The “R” implies that the +r is set and that the file is read-only. Files without the “R” designation imply that the -r is set and that the file is read-write-all. For example:

     ALU-1>file cf3:\ # attrib
               cf3:\bootlog.txt
               cf3:\bof.cfg
               cf3:\boot.ldr
               cf3:\sr1.cfg
               cf3:\test
               cf3:\bootlog_prev.txt
          R    cf3:\BOF.SAV
Parameters 
file-url—
the URL for the local file (see Table 16 for parameter descriptions)
+r—
sets the read-only attribute on the specified file
-r—
clears/resets the read-only attribute on the specified file

cd

Syntax 
cd [file-url]
Context 
file
Description 

This command displays or changes the current working directory in the local file system.

Parameters 
file-url—
the URL for the local file (see Table 16 for parameter descriptions)
<none>—
displays the current working directory
..—
signifies the parent directory. This can be used in place of an actual directory name in a directory-url.
directory-url—
the destination directory

copy

Syntax 
copy source-file-url dest-file-url [force]
Context 
file
Description 

This command copies a file or all files in a directory from a source URL to a destination URL. At least one of the specified URLs should be a local URL. The optional wildcard (*) can be used to copy multiple files that share a common (partial) prefix and/or (partial) suffix.

When a file is copied to a destination with the same filename, the original file is overwritten by the new file specified in the operation. The following prompt appears if the destination file already exists:

“Overwrite destination file (y/n)?”

For example:

To copy a file named srcfile in a directory called test on cf3: in slot CSM B to a file called destfile in a directory called production on cf3: in slot CSM A, the syntax is:

file cf3:\ # copy cf3-B:/test/srcfile cf3-A:/production/destfile

To FTP a file named 121201.cfg in directory mydir stored on cf3: in slot CSM A to a network FTP server with IP address 192.0.2.255 in a directory called backup with a destination filename of 121201.cfg, the FTP syntax is:

copy cf3-A:/mydir/121201.cfg 192.0.2.255.79/backup/121201.cfg
Parameters 
source-file-url—
the location of the source file or directory to be copied (see file-url)
dest-file-url—
the destination of the copied file or directory (see file-url)
force—
forces an immediate copy of the files without displaying a user prompt message
file-url—
the local or remote URL (see Table 16 for parameter descriptions)

delete

Syntax 
delete file-url [force]
Context 
file
Description 

This command deletes the specified file.

The optional wildcard “*” can be used to delete multiple files that share a common (partial) prefix and/or (partial) suffix. When the wildcard is entered, the following prompt displays for each file that matches the wildcard:

“Delete file <filename> (y/n)?”

Parameters 
file-url—
the filename to delete (see Table 16 for parameter descriptions)
force—
forces an immediate deletion of the specified files

       file delete * force deletes all the wildcard matching files without displaying a user prompt message

dir

Syntax 
dir [file-url] [sort-order {d | n | s}] [reverse]
Context 
file
Description 

This command displays a list of files and subdirectories in a directory. The sort-order keyword sorts the files by date, name, or size. The default is to list in ascending order (oldest to newest, A to Z, or smallest to largest); to list the files in descending order, use the reverse keyword.

Parameters 
file-url—
the path or directory name (see Table 16 for parameter descriptions)

Use file-url with the optional wildcard (*) to reduce the number of files to list.

Default—
lists all files in the present working directory, sorted by name (in ascending order)
sort-order—
specifies the order by which the files are sorted
Values—
d – sorts by date
n – sorts by filename
s – sorts by file size

 

reverse—
sorts the files in descending order

format

Syntax 
format [flash-id] [reliable]
Context 
file
Description 

This command formats the compact flash. The compact flash must be shut down before formatting.

Parameters 
cflash-id—
the compact flash type (see Table 16 for parameter descriptions and values)
reliable—
enables the reliance file system and disables the default DOS file system. This option is valid only on compact flashes 1 and 2.

md

Syntax 
md file-url
Context 
file
Description 

This command creates a new directory in a file system.

Directories can only be created one level at a time.

Parameters 
file-url—
the directory name to be created (see Table 16 for parameter descriptions)

move

Syntax 
move old-file-url new-file-url [force]
Context 
file
Description 

This command moves a local file, system file, or a directory. If the target already exists, the command fails and an error message displays.

The following prompt appears if the destination file already exists:

“Overwrite destination file (y/n)?”

Parameters 
old-file-url—
the file or directory to be moved (see Table 16 for parameter descriptions)
new-file-url—
the new destination to place the old-file-url (see Table 16 for parameter descriptions)
force—
forces an immediate move of the specified files

       file move force executes the command without displaying a user prompt message

rd

Syntax 
rd file-url rf
rd file-url [force]
Context 
file
Description 

This command removes (deletes) a directory in a file system.

If the directory is empty, the rd command is used to remove it. The force option executes the command without prompting the user to confirm the action.

If the directory contains files and/or subdirectories, the rf parameter must be used to remove the directory.

Parameters 
file-url—
the directory to be removed (see Table 16 for parameter descriptions)
rf—
forces a recursive delete (directory and its subdirectories/files)
force—
forces an immediate deletion of the specified directory; no user prompt is displayed

repair

Syntax 
repair [flash-id]
Context 
file
Description 

This command checks a compact flash device for errors and repairs any errors found.

Parameters 
cflash-id—
the compact flash slot ID to be shut down or enabled. When a specific cflash-id is specified, then that drive is shut down. If no cflash-id is specified, the drive referred to by the current working directory is assumed. If a slot number is not specified, then the active CSM is assumed.
Values—
see Table 16 for parameter descriptions and values

 

Default—
the current compact flash device

scp

Syntax 
scp local-file-url destination-file-url [router router-instance] [force]
scp local-file-url destination-file-url [service service-name] [force]
Context 
file
Description 

This command copies a local file to a remote host file system. It uses ssh for data transfer, and uses the same authentication and provides the same security as ssh. When the command is entered, the following prompt appears:

“Are you sure (y/n)?”

The destination must specify a user and a host.

Parameters 
local-file-url—
the local source file or directory (see Table 16 for parameter descriptions)
destination-file-url—
the destination file:
Values—

user@hostname:file-path

255 characters maximum

user:

the SSH user, 32 characters maximum

hostname:

dns-name | ipv4-address | “[”ipv6-address “]” (IPv6 address must be enclosed in square brackets)

   dns-name: 

128 characters maximum

   ipv4-address: 

a.b.c.d

   ipv6-address:

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x:  [0..FFFF]H

d:  [0..255]D

interface:  the interface name, 32 characters maximum, mandatory for link local addresses

 file-path:

the destination file path, 200 characters maximum, directory length is 99 characters maximum each

 

router-instance—
specifies the router name or service ID
Values—
router-name:     Base, management
service-id:         1 to 2147483647

 

Default—
Base
service-name
specifies the service name, 64 characters maximum
force—
forces an immediate copy of the specified file

file scp local-file-url destination-file-url [router router-instance | service-name service-name] force executes the command without displaying a user prompt message

shutdown

Syntax 
[no] shutdown [active] [standby]
[no] shutdown flash-id
Context 
file
Description 

This command shuts down (unmounts) the specified CSMs.

Use the no shutdown [active] [standby] command to enable one or both CSMs.

Use the no shutdown flash-id command to enable a compact flash (cf3: on all platforms; cf1: or cf2: on the 7705 SAR-18) on the CSM. The no shutdown command can be issued for a specific slot when no compact flash is present. When a compact flash is installed in the slot, the device will be activated upon detection.

In redundant systems, use the no shutdown command on cf3: on both CSMs in order to facilitate synchronization. See the synchronize command in the config>redundancy context.

The shutdown command must be issued prior to removing a compact flash. If no parameters are specified, the drive referred to by the current working directory will be shut down.

LED status indicators — the following states are possible for the compact flash:

Operational: If a compact flash is present in a drive and operational (no shutdown), the respective LED is lit green. The LED flickers when the compact flash is accessed. Do not remove the compact flash during a read/write operation.

State:                        admin = up, operational = up, equipped

Flash defective: If a compact flash is defective, the respective LED blinks amber to reflect the error condition and a trap is raised.

State:                        admin = up/down, operational = faulty, equipped = no

Flash drive shut down: When the compact flash drive is shut down and a compact flash is present, the LED is lit amber. In this state, the compact flash can be ejected.

State:                        admin = down, operational = down, equipped = yes

No compact flash present, drive shut down: If no compact flash is present and the drive is shut down, the LED is unlit.

State:                        admin = down, operational = down, equipped = no

No compact flash present, drive enabled: If no compact flash is present and the drive is not shut down, the LED is unlit.

State:                        admin = up, operational = down, equipped = no

Ejecting a compact flash: The compact flash drive should be shut down before ejecting a compact flash. The LED should turn to solid (not blinking) amber. This is the only way to safely remove the compact flash. If a compact flash drive is not shut down before a compact flash is ejected, the LED blinks amber for approximately 5 s before shutting off.

State:                        admin = down, operational = down, equipped = yes

The shutdown or no shutdown state is not saved in the configuration file. Following a reboot, all compact flash drives are in their default state.

Default 

no shutdown — compact flash device is administratively enabled

Parameters 
cflash-id—
the compact flash slot ID to be shut down or enabled. If a cflash-id is specified, the drive is shut down or enabled. If no cflash-id is specified, the drive referred to by the current working directory is assumed. If a slot number is not specified, the active CSM is assumed.
Values—
see Table 16 for parameter descriptions and values

 

active—
all drives on the active CSM are shut down or enabled
standby—
all drives on the standby CSM are shut down or enabled

If both active and standby keywords are specified, all drives on both CSMs are shut down or enabled.

type

Syntax 
type file-url
Context 
file
Description 

This command displays the contents of a text file.

Parameters 
file-url—
the file contents to display (see Table 16 for parameter descriptions)

version

Syntax 
version file-url [check]
Context 
file
Description 

This command displays the version of a -TiMOS both.tim file.

Parameters 
file-url—
the filename of the target file (see Table 16 for parameter descriptions)
check—
validates the .tim file
Output 

The following example shows the version of a -TiMOS both.tim file.

Output Example
A:ALU-1# file version cf3:/both.tim
TiMOS-B-0.0.R1 for NOKIA SAR 7705
A:ALU-1# file version ftp://timos:timos@xxx.xxx.xx.xx/./both.tim check
Validation successful
TiMOS-I-0.0.R1 for NOKIA SAR 7705
B:Performance#