atFilev2CopyBegin
AT-FILEv2-MIB ·
.1.3.6.1.4.1.207.8.4.4.4.600.3.7
Object
scalar
r/w
OctetString
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.
Context
- MIB
- AT-FILEv2-MIB
- OID
.1.3.6.1.4.1.207.8.4.4.4.600.3.7- Type
- scalar
- Access
- readwrite
- Status
- current
- Parent
- atFilev2FileOperation
- Siblings
- 14
Syntax
OctetString
Values & Constraints
No enumerated values or constraints recorded.
Related Objects
Sibling Objects
| Object | Type | Syntax | OID |
|---|---|---|---|
| atFilev2SourceStackID Set an integer corresponding to the stack ID of the stack
member to use as the source. This value is ignored if the
source device is set to TFTP.
If running a stand-al… | scalar | SNMPv2-SMIInteger32 | .1.3.6.1.4.1.207.8.4.4.4.600.3.1 |
| atFilev2Flash1 | node | - | .1.3.6.1.4.1.207.8.4.4.4.600.3.10 |
| atFilev2Card2 | node | - | .1.3.6.1.4.1.207.8.4.4.4.600.3.11 |
| atFilev2Nvs3 | node | - | .1.3.6.1.4.1.207.8.4.4.4.600.3.12 |
| atFilev2Tftp4 | node | - | .1.3.6.1.4.1.207.8.4.4.4.600.3.13 |
| atFilev2DirOperation | node | - | .1.3.6.1.4.1.207.8.4.4.4.600.3.14 |
| atFilev2Usb5 | node | - | .1.3.6.1.4.1.207.8.4.4.4.600.3.15 |
| atFilev2SourceDevice Set an integer that corresponds with a device found below:
0. Unconfigured (not settable)
1. Flash
2. Card
3. NVS
4. TFTP
For copying, you may use any combin… | scalar | Integer32 | .1.3.6.1.4.1.207.8.4.4.4.600.3.2 |
| atFilev2SourceFilename The filename of the source file to copy, move or delete.
Include any path as required, but the storage type is not
necessary. Setting a null string will return an error.
… | scalar | SNMPv2-TCDisplayString | .1.3.6.1.4.1.207.8.4.4.4.600.3.3 |
| atFilev2DestinationStackID Set an integer corresponding to the stack ID of the stack
member to use as the destination. This value is ignored if the
destination device is set to TFTP, or if a deletion operat… | scalar | SNMPv2-SMIInteger32 | .1.3.6.1.4.1.207.8.4.4.4.600.3.4 |
| atFilev2DestinationDevice Set an integer that corresponds with a device found below:
0. Unconfigured (not settable)
1. Flash
2. Card
3. NVS
4. TFTP
For copying, you may use any combin… | scalar | Integer32 | .1.3.6.1.4.1.207.8.4.4.4.600.3.5 |
| atFilev2DestinationFilename The destination filename of the file to copy or move. Include
any path as required, but the storage type is not necessary.
For any operation other than a file deletion, setting a … | scalar | SNMPv2-TCDisplayString | .1.3.6.1.4.1.207.8.4.4.4.600.3.6 |
| atFilev2MoveBegin 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 … | scalar | OctetString | .1.3.6.1.4.1.207.8.4.4.4.600.3.8 |
| atFilev2DeleteBegin 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 … | scalar | OctetString | .1.3.6.1.4.1.207.8.4.4.4.600.3.9 |