a3ComBackupAction OBJECT-TYPE
SYNTAX INTEGER {
notActive (1),
abortAction (2),
cliSave (3),
cliVerify (4),
binarySave (5),
binaryVerify (6),
restoreConfig (7),
restoreIgnoringErrors (8),
loadDescriptionOnly (9),
takeSnapshot (10)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This object actually starts the operation. The users
parameters MUST have been entered into the preceeding objects
before a command is started. The objects SHOULD all be set using
a single SNMP packet. This reduces the liklihood of one user
altering another users parameters inadvertantly.
This object shall return notActive(1) when no operations are in
progress. While an operation is in progress, it will return the
enumeration for the operation that is in progress. When that
operation finishes, this object shall return to notActive(1).
The user may set this object to abortAction(2) at any time. This
will abort any operation that is currently in progress. While
the operation is being aborted, this object shall return
abortAction(2). When the abort is complete, this value shall
return to notActive(1). The a3ComBackupStatus shall be set to
backupAbortedByUser(23) to indicate that the command was aborted.
The user may only start any of the other operations when the state
is notActive(1). Once an operation is in progress, this object
shall return the enumeration for the operation until it completes.
The outcome of the operation may be read from a3ComBackupStatus
below.
A device may refuse to carry out an operation if it is currently
unable to carry out the operation or if the operation is not
supported. In this case a bad value response shall be returned.
The cliSave(3) operation saves the configuration as a list of CLI
commands. If these commands are played back to the device, then
the resultant configuration of the device would be that of the
device when the backup was taken. The cliVerify(4) operation
checks that a backup file contains the commands that the current
configuration of the device would generate.
The binarySave(5) and binaryVerify(6) operations are similar to
the CLI operations. The difference being that the configuration
is stored in a binary format rather than the CLI command format.
The restoreConfig(7) operation will read the configuration from
the specified file and apply it to the current device. It is
assumed that the configuration file will have been generated by
this device or by a device of identical configuration. If this
is not the case, then the operation shall be aborted and the
a3ComBackupStatus shall be set to backupWrongHardwareType. If
any of the commands fail to execute, then the operation is
aborted and a3ComBackupStatus is set to backupBadCommand or
backupCommandFailed. The details of the failed command shall be
stored in a3ComBackupFailedCommand and a3ComBackupFailureReason.
The preceeding is a deliberate protection mechanism. It ensures
that a user does not accidentally restore the wrong configuration
to a device. However, there may be times when a user wants to
copy the configuration from one type of device to another. The
user may edit the file to remove commands that the new device
does not understand. This could be a time consuming process.
We therefore also allow the user the restoreIgnoringErrors(8)
operation. This is similar to the restoreConfig(7) operation
above with the exception that all errors are ignored and the
restore passes onto the next configuration item in the backup
file. The objects a3ComBackupFailedCommand and
a3ComBackupFailureReason will contain details of the last error
which occurred.
As an additional protection mechanism, the user may also load
just the comment fields from the backup file. These can then be
displayed to the user so that they can confirm that they have
selected the correct operation. In this case the user would
select the loadDescriptionOnly(9) operation; wait for it to
complete; display the comments to the user and ask for
confiirmation; if the user is happy that it is the correct file
it is then loaded using the restoreConfig(7) operation.
Note: It is possible for another user to overwrite the parameters
while the confirmation is awaited. The user SHOULD therefore
set the parameters to the same values as were used for the
loadDescriptionOnly(9) operation in the same SNMP packet as the
setting of the restoreConfig(7) operation.
The final operation is takeSnapshot(10). A snapshot creates a
file which contains the current status of the device. This
includes dynamic details such as what addresses have been
learned on a port as well as the configuration details. This
file is intended for human reading and contains the detail in
a tabular format. A snapshot is similar to the output that
would be created by running all of the display and summary
commands on the device."
View at oid-info.com
This object actually starts the operation. The user's
parameters MUST have been entered into the preceeding objects
before a command is started. The objects SHOULD all be set using
a single SNMP packet. This reduces the liklihood of one user
altering another user's parameters inadvertantly.
This object shall return notActive(1) when no operations are in
progress. While an operation is in progress, it will return the
enumeration for the operation that is in progress. When that
operation finishes, this object shall return to notActive(1).
The user may set this object to abortAction(2) at any time. This
will abort any operation that is currently in progress. While
the operation is being aborted, this object shall return
abortAction(2). When the abort is complete, this value shall
return to notActive(1). The a3ComBackupStatus shall be set to
backupAbortedByUser(23) to indicate that the command was aborted.
The user may only start any of the other operations when the state
is notActive(1). Once an operation is in progress, this object
shall return the enumeration for the operation until it completes.
The outcome of the operation may be read from a3ComBackupStatus
below.
A device may refuse to carry out an operation if it is currently
unable to carry out the operation or if the operation is not
supported. In this case a bad value response shall be returned.
The cliSave(3) operation saves the configuration as a list of CLI
commands. If these commands are played back to the device, then
the resultant configuration of the device would be that of the
device when the backup was taken. The cliVerify(4) operation
checks that a backup file contains the commands that the current
configuration of the device would generate.
The binarySave(5) and binaryVerify(6) operations are similar to
the CLI operations. The difference being that the configuration
is stored in a binary format rather than the CLI command format.
The restoreConfig(7) operation will read the configuration from
the specified file and apply it to the current device. It is
assumed that the configuration file will have been generated by
this device or by a device of identical configuration. If this
is not the case, then the operation shall be aborted and the
a3ComBackupStatus shall be set to backupWrongHardwareType. If
any of the commands fail to execute, then the operation is
aborted and a3ComBackupStatus is set to backupBadCommand or
backupCommandFailed. The details of the failed command shall be
stored in a3ComBackupFailedCommand and a3ComBackupFailureReason.
The preceeding is a deliberate protection mechanism. It ensures
that a user does not accidentally restore the wrong configuration
to a device. However, there may be times when a user wants to
copy the configuration from one type of device to another. The
user may edit the file to remove commands that the new device
does not understand. This could be a time consuming process.
We therefore also allow the user the restoreIgnoringErrors(8)
operation. This is similar to the restoreConfig(7) operation
above with the exception that all errors are ignored and the
restore passes onto the next configuration item in the backup
file. The objects a3ComBackupFailedCommand and
a3ComBackupFailureReason will contain details of the last error
which occurred.
As an additional protection mechanism, the user may also load
just the comment fields from the backup file. These can then be
displayed to the user so that they can confirm that they have
selected the correct operation. In this case the user would
select the loadDescriptionOnly(9) operation; wait for it to
complete; display the comments to the user and ask for
confiirmation; if the user is happy that it is the correct file
it is then loaded using the restoreConfig(7) operation.
Note: It is possible for another user to overwrite the parameters
while the confirmation is awaited. The user SHOULD therefore
set the parameters to the same values as were used for the
loadDescriptionOnly(9) operation in the same SNMP packet as the
setting of the restoreConfig(7) operation.
The final operation is takeSnapshot(10). A snapshot creates a
file which contains the current status of the device. This
includes dynamic details such as what addresses have been
learned on a port as well as the configuration details. This
file is intended for human reading and contains the detail in
a tabular format. A snapshot is similar to the output that
would be created by running all of the display and summary
commands on the device.
Parsed from file 3COM0469.MIB.txt
Company: a3com
Module: A3COM0469-BACKUP-AND-RESTORE
Automatically extracted from a file named S3M_AGENT
a3ComBackupAction OBJECT-TYPE SYNTAX INTEGER { notActive (1), abortAction (2), cliSave (3), cliVerify (4), binarySave (5), binaryVerify (6), restoreConfig (7), restoreIgnoringErrors (8), loadDescriptionOnly (9), takeSnapshot (10) } ACCESS read-write STATUS mandatory DESCRIPTION "This object actually starts the operation. The user's parameters MUST have been entered into the preceeding objects before a command is started. The objects SHOULD all be set using a single SNMP packet. This reduces the liklihood of one user altering another user's parameters inadvertantly. This object shall return notActive(1) when no operations are in progress. While an operation is in progress, it will return the enumeration for the operation that is in progress. When that operation finishes, this object shall return to notActive(1). The user may set this object to abortAction(2) at any time. This will abort any operation that is currently in progress. While the operation is being aborted, this object shall return abortAction(2). When the abort is complete, this value shall return to notActive(1). The a3ComBackupStatus shall be set to backupAbortedByUser(23) to indicate that the command was aborted. The user may only start any of the other operations when the state is notActive(1). Once an operation is in progress, this object shall return the enumeration for the operation until it completes. The outcome of the operation may be read from a3ComBackupStatus below. A device may refuse to carry out an operation if it is currently unable to carry out the operation or if the operation is not supported. In this case a bad value response shall be returned. The cliSave(3) operation saves the configuration as a list of CLI commands. If these commands are played back to the device, then the resultant configuration of the device would be that of the device when the backup was taken. The cliVerify(4) operation checks that a backup file contains the commands that the current configuration of the device would generate. The binarySave(5) and binaryVerify(6) operations are similar to the CLI operations. The difference being that the configuration is stored in a binary format rather than the CLI command format. The restoreConfig(7) operation will read the configuration from the specified file and apply it to the current device. It is assumed that the configuration file will have been generated by this device or by a device of identical configuration. If this is not the case, then the operation shall be aborted and the a3ComBackupStatus shall be set to backupWrongHardwareType. If any of the commands fail to execute, then the operation is aborted and a3ComBackupStatus is set to backupBadCommand or backupCommandFailed. The details of the failed command shall be stored in a3ComBackupFailedCommand and a3ComBackupFailureReason. The preceeding is a deliberate protection mechanism. It ensures that a user does not accidentally restore the wrong configuration to a device. However, there may be times when a user wants to copy the configuration from one type of device to another. The user may edit the file to remove commands that the new device does not understand. This could be a time consuming process. We therefore also allow the user the restoreIgnoringErrors(8) operation. This is similar to the restoreConfig(7) operation above with the exception that all errors are ignored and the restore passes onto the next configuration item in the backup file. The objects a3ComBackupFailedCommand and a3ComBackupFailureReason will contain details of the last error which occurred. As an additional protection mechanism, the user may also load just the comment fields from the backup file. These can then be displayed to the user so that they can confirm that they have selected the correct operation. In this case the user would select the loadDescriptionOnly(9) operation; wait for it to complete; display the comments to the user and ask for confiirmation; if the user is happy that it is the correct file it is then loaded using the restoreConfig(7) operation. Note: It is possible for another user to overwrite the parameters while the confirmation is awaited. The user SHOULD therefore set the parameters to the same values as were used for the loadDescriptionOnly(9) operation in the same SNMP packet as the setting of the restoreConfig(7) operation. The final operation is takeSnapshot(10). A snapshot creates a file which contains the current status of the device. This includes dynamic details such as what addresses have been learned on a port as well as the configuration details. This file is intended for human reading and contains the detail in a tabular format. A snapshot is similar to the output that would be created by running all of the display and summary commands on the device." ::= {a3ComBackup-mib 6}
| OID | Name | Sub children | Sub Nodes Total | Description |
|---|---|---|---|---|
| 1.3.6.1.4.1.43.10.43.6.0 | a3ComBackupAction | 0 | 0 | None |
| OID | Name | Sub children | Sub Nodes Total | Description |
|---|---|---|---|---|
| 1.3.6.1.4.1.43.10.43.1 | a3ComBackupNecessary | 1 | 1 | This object is used to warn the user that any previous backup that they have taken may no longer be used to restore the configura… |
| 1.3.6.1.4.1.43.10.43.2 | a3ComBackupTftpServer | 1 | 1 | This object is used to store the IP address of the TFTP Server which is being used to hold the backup and snapshot files. Before… |
| 1.3.6.1.4.1.43.10.43.3 | a3ComBackupFilename | 1 | 1 | The name of the backup or snapshot file on the TFTP Server. This may include directory information as appropriate to the TFTP Se… |
| 1.3.6.1.4.1.43.10.43.4 | a3ComBackupAgentComment | 1 | 1 | This object contains the header comment that the agent prepends to the backup and snapshot files. By default, it will contain a … |
| 1.3.6.1.4.1.43.10.43.5 | a3ComBackupUserComment | 1 | 1 | This object is similar to the agent comment object above but it allows the user to add their own notes to the backup or snapshot … |
| 1.3.6.1.4.1.43.10.43.7 | a3ComBackupStatus | 1 | 1 | This returns the status of the current or the previous operation. See the top of this MIB for a list of all of the possible valu… |
| 1.3.6.1.4.1.43.10.43.8 | a3ComBackupBytes | 1 | 1 | The number of bytes of the configuration data that have been transferred between the device and the TFTP Server. This may be used… |
| 1.3.6.1.4.1.43.10.43.9 | a3ComBackupFailedCommand | 1 | 1 | If any restore command fails, then this object shall contain the command line that caused the failure. It shall be cleared when … |
| 1.3.6.1.4.1.43.10.43.10 | a3ComBackupFailureReason | 1 | 1 | If a3ComBackupFailedCommand contains a failed command, then this object contains the error message that the failed command produc… |
| 1.3.6.1.4.1.43.10.43.11 | a3ComBackupResetNecessary | 1 | 1 | This object is used to inform management stations such as 3NS that the device must be reset to factory defaults before a backup f… |
| 1.3.6.1.4.1.43.10.43.12 | a3ComBackupLastAction | 1 | 1 | This object returns the last operation that was performed by the user. This is used for display purposes so that a suitable mess… |