file commands

See “File management” in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Basic System Configuration Guide for more information.

file 
   —  change-directory 
      —  [url] (sat-url | cflash-url | string-not-all-spaces | ftp-url)
   —  checksum 
      —  [type] keyword
      —  [url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url)
   —  copy 
      —  client-tls-profile string
      —  [destination-url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url | http-url-loose)
      —  direct-http 
      —  force 
      —  proxy string
      —  recursive 
      —  [source-url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url | http-url-loose)
   —  disable 
      —  active 
      —  cflash-id string
      —  standby 
   —  enable 
      —  active 
      —  cflash-id string
      —  standby 
   —  format 
      —  [cflash-id] string
   —  list 
      —  reverse 
      —  [sort-order] keyword
      —  [url] (sat-url | cflash-url | string-not-all-spaces | ftp-url)
   —  make-directory 
      —  [url] (sat-url | cflash-url | string-not-all-spaces | ftp-url)
   —  move 
      —  client-tls-profile string
      —  [destination-url] (sat-url | cflash-url | string-not-all-spaces | ftp-url | http-url-loose)
      —  direct-http 
      —  force 
      —  proxy string
      —  [source-url] (sat-url | cflash-url | string-not-all-spaces | ftp-url | http-url-loose)
   —  permission 
      —  [attribute] keyword
      —  [url] (sat-url | cflash-url | string-not-all-spaces)
   —  remove 
      —  client-tls-profile string
      —  direct-http 
      —  force 
      —  proxy string
      —  [url] (sat-url | cflash-url | string-not-all-spaces | ftp-url | http-url-loose)
   —  remove-directory 
      —  force 
      —  recursive 
      —  [url] (sat-url | cflash-url | string-not-all-spaces | ftp-url)
   —  repair 
      —  [cflash-id] string
   —  show 
      —  client-tls-profile string
      —  direct-http 
      —  proxy string
      —  [url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url | http-url-loose)
   —  unzip 
      —  create-destination 
      —  [destination-url] (sat-url | cflash-url | string-not-all-spaces)
      —  force 
      —  list 
      —  [source-url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url | http-url-loose)
   —  version 
      —  [url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url)
Parent topic: Operational commands

file command descriptions

file

  Synopsis Perform file operations
  Context file
  Tree file
 

Description

Commands in this context execute file management operations.
  Introduced 20.10.R1
 

Platforms

All

change-directory

  Synopsis Change the working directory
  Context file change-directory
  Tree change-directory
  Introduced 20.10.R1
 

Platforms

All
[url] (sat-url | cflash-url | string-not-all-spaces | ftp-url)
  Synopsis New working directory URL
  Context file change-directory [url] (sat-url | cflash-url | string-not-all-spaces | ftp-url)
  Tree [url]
  String Length 1 to 200
  Default .
  Introduced 20.10.R1
 

Platforms

All

checksum

  Synopsis Compute and display checksums
  Context file checksum
  Tree checksum
 

Description

This command computes and displays an image file or a checksum for a file.
  Introduced 20.10.R1
 

Platforms

All
[type] keyword
  Synopsis Checksum option type
  Context file checksum [type] keyword
  Tree [type]
  Options image, md5, sha256
 

Notes

This element is mandatory.
  Introduced 20.10.R1
 

Platforms

All
[url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url)
  Synopsis File URL
  Context file checksum [url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url)
  Tree [url]
  String Length 1 to 200
 

Notes

This element is mandatory.
  Introduced 20.10.R1
 

Platforms

All

copy

  Synopsis Copy files
  Context file copy
  Tree copy
  Introduced 20.10.R1
 

Platforms

All
client-tls-profile string
  Synopsis Connect over HTTP with a client TLS profile
  Context file copy client-tls-profile string
  Tree client-tls-profile
  String Length 1 to 32
  Introduced 20.10.R1
 

Platforms

All
[destination-url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url | http-url-loose)
  Synopsis Destination URL or '.' for the working directory
  Context file copy [destination-url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url | http-url-loose)
  Tree [destination-url]
  String Length 1 to 200
 

Notes

This element is mandatory.
  Introduced 20.10.R1
 

Platforms

All
direct-http
  Synopsis Allow direct HTTP connection, do not follow redirects
  Context file copy direct-http
  Tree direct-http
  Introduced 20.10.R1
 

Platforms

All
force
  Synopsis Force copy without prompting before overwriting
  Context file copy force
  Tree force
  Introduced 20.10.R1
 

Platforms

All
proxy string
  Synopsis Connect over HTTP with a proxy
  Context file copy proxy string
  Tree proxy
  String Length 1 to 255
  Introduced 20.10.R1
 

Platforms

All
recursive
  Synopsis Copy sub-directories encountered at the source URL
  Context file copy recursive
  Tree recursive
 

Description

This command recursively copies files and directories. If files or directories already exist, the operator is prompted to overwrite them. When the force command is enabled, a positive response to the overwrite prompts is assumed, and the operator is not prompted for confirmation. The existing files or directories are overwritten.
  Introduced 21.10.R1
 

Platforms

All
[source-url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url | http-url-loose)
  Synopsis Source URL
  Context file copy [source-url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url | http-url-loose)
  Tree [source-url]
  String Length 1 to 200
 

Notes

This element is mandatory.
  Introduced 20.10.R1
 

Platforms

All

disable

  Synopsis Disable compact flash devices
  Context file disable
  Tree disable
  Introduced 20.10.R1
 

Platforms

All
active
  Synopsis Disable all devices on the active CPM
  Context file disable active
  Tree active
 

Notes

The following elements are part of a choice: active, cflash-id, or standby.
  Introduced 20.10.R1
 

Platforms

All
cflash-id string
  Synopsis Disable the compact flash device
  Context file disable cflash-id string
  Tree cflash-id
  String Length 4 to 6
 

Notes

The following elements are part of a choice: active, cflash-id, or standby.
  Introduced 20.10.R1
 

Platforms

All
standby
  Synopsis Disable all devices on the standby CPM
  Context file disable standby
  Tree standby
 

Notes

The following elements are part of a choice: active, cflash-id, or standby.
  Introduced 20.10.R1
 

Platforms

All

enable

  Synopsis Enable compact flash devices
  Context file enable
  Tree enable
  Introduced 20.10.R1
 

Platforms

All
active
  Synopsis Enable all devices on the active CPM
  Context file enable active
  Tree active
 

Notes

The following elements are part of a choice: active, cflash-id, or standby.
  Introduced 20.10.R1
 

Platforms

All
cflash-id string
  Synopsis Enable the compact flash device
  Context file enable cflash-id string
  Tree cflash-id
  String Length 4 to 6
 

Notes

The following elements are part of a choice: active, cflash-id, or standby.
  Introduced 20.10.R1
 

Platforms

All
standby
  Synopsis Enable all devices on the standby CPM
  Context file enable standby
  Tree standby
 

Notes

The following elements are part of a choice: active, cflash-id, or standby.
  Introduced 20.10.R1
 

Platforms

All

format

  Synopsis Format a compact flash device
  Context file format
  Tree format
  Introduced 20.10.R1
 

Platforms

All
[cflash-id] string
  Synopsis Compact flash ID
  Context file format [cflash-id] string
  Tree [cflash-id]
  String Length 4 to 6
  Introduced 20.10.R1
 

Platforms

All

list

  Synopsis List directory contents
  Context file list
  Tree list
  Introduced 20.10.R1
 

Platforms

All
reverse
  Synopsis List files in reverse sort order
  Context file list reverse
  Tree reverse
  Introduced 20.10.R1
 

Platforms

All
[sort-order] keyword
  Synopsis Sort order for the directory
  Context file list [sort-order] keyword
  Tree [sort-order]
  Options date, name, size
  Introduced 20.10.R1
 

Platforms

All
[url] (sat-url | cflash-url | string-not-all-spaces | ftp-url)
  Synopsis Location of the directory to be listed
  Context file list [url] (sat-url | cflash-url | string-not-all-spaces | ftp-url)
  Tree [url]
  String Length 1 to 200
  Default .
  Introduced 20.10.R1
 

Platforms

All

make-directory

  Synopsis Make a directory
  Context file make-directory
  Tree make-directory
  Introduced 20.10.R1
 

Platforms

All
[url] (sat-url | cflash-url | string-not-all-spaces | ftp-url)
  Synopsis Directory location
  Context file make-directory [url] (sat-url | cflash-url | string-not-all-spaces | ftp-url)
  Tree [url]
  String Length 1 to 200
 

Notes

This element is mandatory.
  Introduced 20.10.R1
 

Platforms

All

move

  Synopsis Move or rename files or directories
  Context file move
  Tree move
  Introduced 20.10.R1
 

Platforms

All
client-tls-profile string
  Synopsis Connect over HTTP with a client TLS profile
  Context file move client-tls-profile string
  Tree client-tls-profile
  String Length 1 to 32
  Introduced 20.10.R1
 

Platforms

All
[destination-url] (sat-url | cflash-url | string-not-all-spaces | ftp-url | http-url-loose)
  Synopsis Destination URL or '.' for the working directory
  Context file move [destination-url] (sat-url | cflash-url | string-not-all-spaces | ftp-url | http-url-loose)
  Tree [destination-url]
  String Length 1 to 200
 

Notes

This element is mandatory.
  Introduced 20.10.R1
 

Platforms

All
direct-http
  Synopsis Allow direct HTTP connection, do not follow redirects
  Context file move direct-http
  Tree direct-http
  Introduced 20.10.R1
 

Platforms

All
force
  Synopsis Force move without prompting before overwriting
  Context file move force
  Tree force
  Introduced 20.10.R1
 

Platforms

All
proxy string
  Synopsis Connect over HTTP with a proxy
  Context file move proxy string
  Tree proxy
  String Length 1 to 255
  Introduced 20.10.R1
 

Platforms

All
[source-url] (sat-url | cflash-url | string-not-all-spaces | ftp-url | http-url-loose)
  Synopsis Source URL
  Context file move [source-url] (sat-url | cflash-url | string-not-all-spaces | ftp-url | http-url-loose)
  Tree [source-url]
  String Length 1 to 200
 

Notes

This element is mandatory.
  Introduced 20.10.R1
 

Platforms

All

permission

  Synopsis Show or set file permissions
  Context file permission
  Tree permission
  Introduced 20.10.R1
 

Platforms

All
[attribute] keyword
  Synopsis File permission
  Context file permission [attribute] keyword
  Tree [attribute]
  Options read-only, read-write
  Introduced 20.10.R1
 

Platforms

All
[url] (sat-url | cflash-url | string-not-all-spaces)
  Synopsis File URL to set permissions
  Context file permission [url] (sat-url | cflash-url | string-not-all-spaces)
  Tree [url]
  String Length 1 to 200
  Introduced 20.10.R1
 

Platforms

All

remove

  Synopsis Remove files
  Context file remove
  Tree remove
  Introduced 20.10.R1
 

Platforms

All
client-tls-profile string
  Synopsis Connect over HTTP with a client TLS profile
  Context file remove client-tls-profile string
  Tree client-tls-profile
  String Length 1 to 32
  Introduced 20.10.R1
 

Platforms

All
direct-http
  Synopsis Allow direct HTTP connection, do not follow redirects
  Context file remove direct-http
  Tree direct-http
  Introduced 20.10.R1
 

Platforms

All
force
  Synopsis Force removal without prompting
  Context file remove force
  Tree force
  Introduced 20.10.R1
 

Platforms

All
proxy string
  Synopsis Connect over HTTP with a proxy
  Context file remove proxy string
  Tree proxy
  String Length 1 to 255
  Introduced 20.10.R1
 

Platforms

All
[url] (sat-url | cflash-url | string-not-all-spaces | ftp-url | http-url-loose)
  Synopsis File URL
  Context file remove [url] (sat-url | cflash-url | string-not-all-spaces | ftp-url | http-url-loose)
  Tree [url]
  String Length 1 to 200
 

Notes

This element is mandatory.
  Introduced 20.10.R1
 

Platforms

All

remove-directory

  Synopsis Remove directories
  Context file remove-directory
  Tree remove-directory
  Introduced 20.10.R1
 

Platforms

All
force
  Synopsis Force removal without prompting
  Context file remove-directory force
  Tree force
  Introduced 20.10.R1
 

Platforms

All
recursive
  Synopsis Remove directory and contents recursively
  Context file remove-directory recursive
  Tree recursive
  Introduced 20.10.R1
 

Platforms

All
[url] (sat-url | cflash-url | string-not-all-spaces | ftp-url)
  Synopsis Directory URL
  Context file remove-directory [url] (sat-url | cflash-url | string-not-all-spaces | ftp-url)
  Tree [url]
  String Length 1 to 200
 

Notes

This element is mandatory.
  Introduced 20.10.R1
 

Platforms

All

repair

  Synopsis Repair a compact flash file system
  Context file repair
  Tree repair
  Introduced 20.10.R1
 

Platforms

All
[cflash-id] string
  Synopsis Compact flash ID
  Context file repair [cflash-id] string
  Tree [cflash-id]
  String Length 4 to 6
  Introduced 20.10.R1
 

Platforms

All

show

  Synopsis Display the contents of a file
  Context file show
  Tree show
  Introduced 20.10.R1
 

Platforms

All
client-tls-profile string
  Synopsis Connect over HTTP with a client TLS profile
  Context file show client-tls-profile string
  Tree client-tls-profile
  String Length 1 to 32
  Introduced 20.10.R1
 

Platforms

All
direct-http
  Synopsis Allow direct HTTP connection, do not follow redirects
  Context file show direct-http
  Tree direct-http
  Introduced 20.10.R1
 

Platforms

All
proxy string
  Synopsis Connect over HTTP with a proxy
  Context file show proxy string
  Tree proxy
  String Length 1 to 255
  Introduced 20.10.R1
 

Platforms

All
[url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url | http-url-loose)
  Synopsis File URL
  Context file show [url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url | http-url-loose)
  Tree [url]
  String Length 1 to 200
 

Notes

This element is mandatory.
  Introduced 20.10.R1
 

Platforms

All

unzip

  Synopsis Unzip files
  Context file unzip
  Tree unzip
  Introduced 20.10.R1
 

Platforms

All
create-destination
  Synopsis Create destination directory if it does not exist
  Context file unzip create-destination
  Tree create-destination
  Introduced 20.10.R1
 

Platforms

All
[destination-url] (sat-url | cflash-url | string-not-all-spaces)
  Synopsis Destination URL or '.' for the working directory
  Context file unzip [destination-url] (sat-url | cflash-url | string-not-all-spaces)
  Tree [destination-url]
  String Length 1 to 200
  Introduced 20.10.R1
 

Platforms

All
force
  Synopsis Force the unzip operation without prompting
  Context file unzip force
  Tree force
 

Description

When configured, files and directories that already exist in the destination URL are overwritten without prompting. 

The system does not automatically create directories explicitly specified by the destination URL. To allow the system to create new directories, use the create-destination command.

When unconfigured, the system prompts the user before overwriting a file or directory.
 

Notes

The following elements are part of a choice: force or list.
  Introduced 20.10.R1
 

Platforms

All
list
  Synopsis List the file contents without the unzip operation
  Context file unzip list
  Tree list
 

Notes

The following elements are part of a choice: force or list.
  Introduced 20.10.R1
 

Platforms

All
[source-url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url | http-url-loose)
  Synopsis Source URL
  Context file unzip [source-url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url | http-url-loose)
  Tree [source-url]
  String Length 1 to 200
 

Notes

This element is mandatory.
  Introduced 20.10.R1
 

Platforms

All

version

  Synopsis Display the version of an SR OS image file
  Context file version
  Tree version
  Introduced 20.10.R1
 

Platforms

All
[url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url)
  Synopsis File URL
  Context file version [url] (sat-url | cflash-url | string-not-all-spaces | ftp-tftp-url)
  Tree [url]
  String Length 1 to 200
 

Notes

This element is mandatory.
  Introduced 20.10.R1
 

Platforms

All