AT-FILEv2-MIB: View SNMP OID List / Download MIB

The AT File v2 MIB, for listing file contents of flash, nvs and sd-cards on local and stacked devices, and copying, moving and deleting files from local, stacked and remote sources.

Set a value of '1' to enable recursive listing of directories in the atFilev2Table listing. NOTE: atFilev2Table and associated objects have been replaced by atFilev2FileViewer.

Set a value of '1' to enable listing of all files (including hidden etc) in the atFilev2Table listing. NOTE: atFilev2Table and associated objects have been replaced by atFilev2FileViewer.

Set a value that corresponds with the various devices listed below: 1. Flash (default) 2. Card 3. NVS Subsequent SNMP queries to the atFilev2Table will use this as the device to generate a file listing from. NOTE: atFilev2Table and associated objects have been replaced by atFilev2FileViewer.

Set an integer to correspond to the stack ID of a stack member. For devices that are not capable of being stacked, set with the value 1. For a chassis switch, it corresponds to the card ID. Subsequent SNMP queries to the atFilev2Table will use this as the stack member to generate a file listing from. NOTE: atFilev2Table and associated objects have been replaced by atFilev2FileViewer.

A list of files present on the device and stack-member specified by the atFilev2Device and atFilev2StackID objects. NOTE: atFilev2Table and associated objects have been replaced by atFilev2FileViewer.

An entry in the list of files containing information about a single file. NOTE: atFilev2Table and associated objects have been replaced by atFilev2FileViewer.

The name of the file. Files are sorted in alphabetical order. Directory names end with / and have a 'd' present in the atFilev2FileAttribs object. The filename is truncated at 112 characters due to SNMP OID length limitations. If two files are not uniquely distinguishable within the first 112 characters, the listing will halt after the first file. NOTE: atFilev2Table and associated objects have been replaced by atFilev2FileViewer.

The size of the file in bytes. NOTE: atFilev2Table and associated objects have been replaced by atFilev2FileViewer.

File creation time in the form . Eg: Sep 7 2008 06:07:54. NOTE: atFilev2Table and associated objects have been replaced by atFilev2FileViewer.

The standard file accessibility attributes in the form . d - directory r - readable w - writeable x - executable If a file does not have a particular attribute set, the respective position will contain a -. For example, <-r-x> indicates a readable and executable file that is not a directory or writeable. NOTE: atFilev2Table and associated objects have been replaced by atFilev2FileViewer.

Set to the stack ID of the source device to be used for the file operation. For devices that are not capable of being stacked, set with the value 1. For a chassis switch, it corresponds to the card ID. This value is ignored if the source device is set to TFTP.

Set to the value representing the source file system to be used for the file operation: 1. Flash 2. Card 3. NVS 4. TFTP 5. USB For copying files, any combination of source and destination file system types may be selected, with the exception of TFTP to TFTP, which is not supported. For moving files, TFTP may not be selected as the source or destination file system type. For deleting files, the source file system type cannot be TFTP. All required parameters must be fully configured before an operation can commence. Where a TFTP operation is configured, an IP address must also be set via atFilev2TftpIPAddr. Enumeration: 'tftp': 4, 'flash': 1, 'nvs': 3, 'usb': 5, 'card': 2.

The filename of the source file to be copied, moved or deleted. Include any path as required, but the file system type is not necessary. For example, to copy the file latest.cfg from the backupconfigs/routers directory on the TFTP server, this object should be set to: backupconfigs/routers/latest.cfg

Set to the stack ID of the destination device to be used for the file operation. For devices that are not capable of being stacked, set with the value 1. For a chassis switch, it corresponds to the card ID. This value is ignored if the destination device is set to TFTP, or if a deletion operation is carried out.

Set to the value representing the destination file system to be used for the file operation: 1. Flash 2. Card 3. NVS 4. TFTP 5. USB For copying files, any combination of source and destination file system types may be selected, with the exception of TFTP to TFTP, which is not supported. For moving files, TFTP may not be selected as the source or destination file system type. For deleting files, this object is ignored. All required parameters must be fully configured before an operation can commence. Where a TFTP operation is configured, an IP address must also be set via atFilev2TftpIPAddr. Enumeration: 'tftp': 4, 'flash': 1, 'nvs': 3, 'usb': 5, 'card': 2.

The destination filename for the copy or move operation. Include any path as required, but the file system type is not necessary. The destination filename does not need to be the same as the source filename, and this object is ignored for file deletion operations. For example, to copy a release file from a TFTP server to the backuprelease directory on the flash file system, this object should be set to: backuprelease/latest.rel Note: Any file at the destination that shares the destination filename will be overwritten by a move or copy operation.

A read on this object can return several possible values, depending on the current status of the system and the various file operation objects: idle There is no file operation in progress and all required objects have been set correctly. Setting a '1' to this object will begin the file copy. Error codes: [1-7] A copy operation cannot be started until these errors are resolved. See below for key. [action]ing x [--> y] A file operation is currently in progress. You cannot start another operation while the object is returning this value. [action] x [--> y] success The last copy, move or delete operation was successfully completed. [action] x [--> y] failure: [err] The last copy, move or delete operation failed, with the error message attached. Common failures include lack of space on the destination file system, incorrect source file names or communication errors with remote services. Upon reading a success or failure message, the message will be cleared and the next read will result in either an 'idle' message or an 'Error codes' message if not all required objects have been correctly set. If a read returns 'idle', a new file operation can be started. Error codes for file copy: 1 - atFilev2SourceDevice has not been set 2 - atFilev2SourceFilename has not been set 3 - atFilev2DestinationDevice has not been set 4 - atFilev2DestinationFilename has not been set 5 - atFilev2SourceDevice and atFilev2DestinationDevice are both set to TFTP 6 - the combination of source device, stackID and filename is the same as the destination device, stackID and filename (i.e. it is not valid to copy a file onto itself. 7 - TFTP IP address has not been set and TFTP has been set for one of the devices Note that if the above requirements are met and the operation would result in a system file being modified, then an SNMP set to this object will be disallowed. For valid operations, immediately upon executing the SNMP set operation on this object, the file copy will begin and will continue on the device until either it has completed, or a failure occurs. For large files, operations can take several minutes to complete. Subsequent reads of the object will return one of the messages shown above, to track the progress of the copy operation.

A read on this object can return several possible values, depending on the current status of the system and the various file operation objects: idle There is no file operation in progress and all required objects have been set correctly. Setting a '1' to this object will begin the file move. Error codes: [1-6] A move operation cannot be started until these errors are resolved. See below for key. [action]ing x [--> y] A file operation is currently in progress. You cannot start another operation while the object is returning this value. [action] x [--> y] success The last copy, move or delete operation was successfully completed. [action] x [--> y] failure: [err] The last copy, move or delete operation failed, with the error message attached. Common failures include lack of space on the destination file system, incorrect source file names or communication errors with remote services. Upon reading a success or failure message, the message will be cleared and the next read will result in either an 'idle' message or an 'Error codes' message if not all required objects have been correctly set. If a read returns 'idle', a new file operation can be started. Error codes for file move: 1 - atFilev2SourceDevice has not been set 2 - atFilev2SourceFilename has not been set 3 - atFilev2DestinationDevice has not been set 4 - atFilev2DestinationFilename has not been set 5 - either atFilev2SourceDevice or atFilev2DestinationDevice are set to TFTP 6 - the combination of source device, stackID and filename is the same as the destination device, stackID and filename (i.e. it is not valid to move a file onto itself. Note that if the above requirements are met and the operation would result in a system file being modified or deleted, then an SNMP set to this object will be disallowed. For valid operations, immediately upon executing the SNMP set operation on this object, the file move will begin and will continue on the device until either it has completed, or a failure occurs. For large files, operations can take several minutes to complete. Subsequent reads of the object will return one of the messages shown above, to track the progress of the move operation.

A read on this object can return several possible values, depending on the current status of the system and the various file operation objects: idle There is no file operation in progress and all required objects have been set correctly. Setting a '1' to this object will begin the file deletion. Error codes: [1-3] A delete operation cannot be started until these errors are resolved. See below for key. [action]ing x [--> y] A file operation is currently in progress. You cannot start another operation while the object is returning this value. [action] x [--> y] success The last copy, move or delete operation was successfully completed. [action] x [--> y] failure: [err] The last copy, move or delete operation failed, with the error message attached. Common failures include lack of space on the destination file system, incorrect source file names or communication errors with remote services. Upon reading a success or failure message, the message will be cleared and the next read will result in either an 'idle' message or an 'Error codes' message if not all required objects have been correctly set. If a read returns 'idle', a new file operation can be started. File deletion operations ignore the values set in the atFilev2DestinationStackID, atFilev2DestinationDevice and atFilev2DestinationFilename objects. Error codes for file deletion: 1 - atFilev2SourceDevice has not been set 2 - atFilev2SourceFilename has not been set 3 - atFilev2SourceDevice has been set to TFTP Note that if the above requirements are met and the operation would result in a system file being deleted, then an SNMP set to this object will be disallowed. For valid operations, immediately upon executing the SNMP set operation on this object, the file deletion will begin and will continue on the device until either it has completed, or a failure occurs. For large files, operations can take several minutes to complete. Subsequent reads of the object will return one of the messages shown above, to track the progress of the deletion operation.

The IP address of the TFTP server that is to be used for the file copy process. This IP address needs to be reachable from the device or the file copy will fail.

Set to the stack ID of the device containing the directory to be renamed or deleted, or to the stack ID of the device on which to create a new directory. For devices that are not capable of being stacked, set with the value 1. For a chassis switch, it corresponds to the card ID.

Set to the value representing the file system on which the existing directory resides, or on which a new directory should be created: 1. Flash 2. Card 3. NVS 5. USB Enumeration: 'flash': 1, 'nvs': 3, 'usb': 5, 'card': 2.

This object should be set to the path of the directory to be created/deleted/renamed, but should not include the name of the directory itself, or the file system on which it resides. For example, to delete directory 'backupconfigs/old' from the flash filesystem, this object should be set to 'backupconfigs'.

This object is required for directory deletion or rename operations only. It should be set to the name of the directory to be deleted/renamed, but should not include any path data. Operations on hidden directories are not supported. For example, to delete directory 'backupconfigs/old' from the flash filesystem, this object should be set to 'old'.

This object is required for directory creation or rename operations only. It should be set to the name of the directory to be created, or the destination directory name for a rename operation. It should not include any path data and operations on hidden directories are not supported. For example, to create directory 'backupconfigs/old' on the flash filesystem, this object should be set to 'old'.

A read of this object will always return 'idle' (1). All applicable objects above must have been set correctly in order to commence an operation. The following values may be set to perform the operations described: createDir (2) : This will create a new directory with a name equating to atFilev2DestDirName, on the device indicated by atFilev2DirStackID, and the file system indicated by atFilev2DirFileSystem, with the path to the directory being indicated by atFilev2DirPath. The given path structure must already exist. renameDir (3) : This will rename an existing directory with a name equating to atFilev2SourceDirName, to a name equating to atFilev2DestDirName on the device indicated by atFilev2DirStackID, and the file system indicated by atFilev2DirFileSystem, with the path to the directory being indicated by atFilev2DirPath. The given path structure and source directory must already exist, and a rename operation cannot change the path where the directory currently resides. deleteEmptyDir (4) : This will delete an existing directory with a name equating to atFilev2SourceDirName, on the device indicated by atFilev2DirStackID, and the file system indicated by atFilev2DirFileSystem, with the path to the directory being indicated by atFilev2DirPath. However, the operation will fail if the specified directory is not empty. Only sub-directories within the specified file system can be deleted. deleteForceDir (5) : This will delete an existing directory with a name equating to atFilev2SourceDirName, on the device indicated by atFilev2DirStackID, and the file system indicated by atFilev2DirFileSystem, with the path to the directory being indicated by atFilev2DirPath. The operation will also automatically delete any contents within the specified directory. Only sub- directories within the specified file system can be deleted. Enumeration: 'createDir': 2, 'deleteForceDir': 5, 'idle': 1, 'deleteEmptyDir': 4, 'renameDir': 3.

Gives an indication of the result of the last completed SNMP directory operation.

A table of information about SD cards.

Data pertaining to an SD card instance.

The index of the stack member hosting this SD card. For devices that are not capable of being stacked, this object will always return the value 1.

This object indicates whether or not an SD card is inserted in a slot. Enumeration: 'notPresent': 1, 'present': 2.

A list of all files, including pathnames, that are present on the device. Hidden system files are not displayed. NOTE: atFilev2InfoTable and associated objects have been replaced by atFilev2FileViewer.

An entry in the list of files, containing information about a single file. NOTE: atFilev2Table and associated objects have been replaced by atFilev2FileViewer.

The full path and name of the file. Files are sorted in alphabetical order, and any filepath that is longer than 112 characters will not be displayed due to SNMP OID length limitations. NOTE: atFilev2InfoTable and associated objects have been replaced by atFilev2FileViewer.

The size of the file in bytes. NOTE: atFilev2InfoTable and associated objects have been replaced by atFilev2FileViewer.

File creation time in the form . Eg: Sep 7 2008 06:07:54. NOTE: atFilev2InfoTable and associated objects have been replaced by atFilev2FileViewer.

Returns TRUE if the entry is a directory, FALSE otherwise. NOTE: atFilev2InfoTable and associated objects have been replaced by atFilev2FileViewer.

Returns TRUE if the file is readable, FALSE otherwise. NOTE: atFilev2InfoTable and associated objects have been replaced by atFilev2FileViewer.

Returns TRUE if the file is writeable, FALSE otherwise. NOTE: atFilev2InfoTable and associated objects have been replaced by atFilev2FileViewer.

Returns TRUE if the file is executable, FALSE otherwise. NOTE: atFilev2InfoTable and associated objects have been replaced by atFilev2FileViewer.

A table of information about USB media.

Data pertaining to an USB media instance.

The index of the stack member hosting this USB media. For devices that are not capable of being stacked, this object will always return the value 1. For a chassis switch, it corresponds to the card ID.

This object indicates whether or not an USB media is inserted in a slot. Enumeration: 'notPresent': 1, 'present': 2.

The stack ID of the stack member for which files will be displayed in the FileViewer table. For devices that are not capable of being stacked, this variable will always read as 1, and will cause an error on being written to with any value other than 1. Write this variable with the stack ID of the stack member for which a view of files is required. If the stack member doesn't exist, an error will be returned. For a chassis switch, it corresponds to the card ID. Note that the other variables specifying the files to view will not be altered by changing the stack ID, which means that the file view table could be empty if a non-existant device or path has been referenced previously.

The file system device for which files will be displayed in the FileViewer table. The values supported for this variable are identical to the values for other variables in the MIB, although not all values will actually result in the display of files. The different devices and whether they will result in the display of files are: 1. Flash - Onboard Flash - supported 2. Card - Removable SD card - supported 3. NVS - Onboard battery backed RAM - supported 4. TFTP - not supported 5. USB - Removable USB media - supported Setting this variable to an unsupported value will result in an error, but setting to a value that is supported but on a device that doesn't contain that type of device will not. However, no files will be displayed in the File Viewer table in this case. Enumeration: 'tftp': 4, 'flash': 1, 'nvs': 3, 'usb': 5, 'card': 2.

The file system path for which files will be displayed in the FileViewer table. This path will always read as a full pathname starting with the '/' character. Setting this variable will specify a new directory for which files will be displayed. The path specified must be the full path, relative setting of path does not work. Only paths with invalid characters in them will cause an error, paths specifying non-existant directories will be accepted, but no files will be displayed in the File Viewer table in this case.

A list of all files, not including pathnames, that are present on the device specified by atFilev2FileViewerStackId and atFilev2FileViewerDevice, in the path specified by atFilev2FileViewerCurrentPath. Hidden and system files are not displayed. If the Stack ID, device and path are invalid (the path is for a non-existant directory), the table will be empty. This will allow a MIB walk through the table even though the setup parameters are incorrect.

An entry in the list of files, containing information about a single file.

The name of the file. Files are sorted in alphabetical order, and any name that is longer than 112 characters will not be displayed due to SNMP OID length limitations.

The size of the file in bytes.

File creation time in the form . Eg: Sep 7 2008 06:07:54.

Returns TRUE if the entry is a directory, FALSE otherwise.

Returns TRUE if the file is readable, FALSE otherwise.

Returns TRUE if the file is writeable, FALSE otherwise.

Returns TRUE if the file is executable, FALSE otherwise.