CONFIG-COPY-MIB: View SNMP OID List / Download MIB

A table of config-copy requests.

A config-copy request. A management station wishing to create an entry should first generate a random serial number to be used as the index to this sparse table. The station should then create the associated instance of the row status and row index objects. It __MUST__ in the same PDUs, create an instance of copySourceFileType and copyDestFileType. At least one of the FileTypes must be an agent-config file type (i.e. startupConfig or runningConfig). If one of the file types is a networkFile, a valid copyServerAddress and copyFileName must be created as well. For a file type of localFile, only a valid fileName needs to be created as an extra parameter. It should also modify the default values for the other configuration objects if the defaults are not appropriate. Once the appropriate instance of all the configuration objects have been created, the row status will automatically be set to active to initiate the request. Note that this entire procedure __MUST__ be initiated via a single set request which specifies a row status of createAndGo as well as specifies valid values for the non-defaulted configuration objects. Once the config-copy request has been created (i.e. the copyEntryRowStatus has been made active), the entry cannot be modified - the only operation possible after this is to delete the row. Once the request completes, the management station should retrieve the values of the status objects of interest, and should then delete the entry. In order to prevent old entries from clogging the table, entries will be aged out, but an entry will never be deleted within 5 minutes of completing.

Object which specifies a unique entry in the copyTable. A management station wishing to initiate a config-copy operation should use a random value for this object when creating or modifying an instance of a copyEntry. The RowStatus semantics of the copyEntryRowStatus object will prevent access conflicts.

The protocol to be used for any copy. Will default to ftp if not specified. If the copy operation occurs locally on the SNMP agent (e.g. runningConfigToStartupConfig), this object may be ignored by the implementation.

specifies the type of file to copy from. Either the copySourceFileType or the copyDestFileType (or both) must be of type runningConfig or startupConfig. Also, the copySourceFileType must be different from the copyDestFileType. If the copySourceFileType has the value of networkFile, the copyServerAddress and copyFileName must also be created, and these 3 objects together (copySourceFileType, copyServerAddress, copyFileName) will uniquely identify the source file. If the copySourceFileType is localFile, the copyFileName must also be created, and the 2 objects together (copySourceFileType, copyFileName) will uniquely identify the source file.

specifies the type of file to copy to. Either the copySourceFileType or the copyDestFileType (or both) must be of type runningConfig or startupConfig. Also, the copySourceFileType must be different from the copyDestFileType. If the copyDestFileType has the value of networkFile, the copyServerAddress and copyFileName must also be created, and these 3 objects together (copyDestFileType, copyServerAddress, copyFileName) will uniquely identify the destination file. If the copyDestFileType is localFile, the copyFileName must also be created, and the 2 objects together (copyDestFileType, copyFileName) will uniquely identify the destination file.

The ip address of the tftp server from (or to) which to copy the configuration file. This object must be created when either the copySourceFileType or copyDestFileType has the value networkFile. Values of 0.0.0.0 or FF.FF.FF.FF for copyServerAddress are not allowed.

The source file name (including the path, if applicable) of the file. This object must be created when either the copySourceFileType or copyDestFileType has the value networkFile or localFile.

The destination file name (including the path, if applicable) of the file. This object must be created when either the copySourceFileType or copyDestFileType has the value networkFile or localFile.

Remote user name for copy via ftp, rcp, sftp or scp protocol. This object must be created when the copyProtocol is rcp, scp, ftp or sftp. If the protocol is rcp, it will override the remote user-name configured through the rcmd remote-username <username> configuration command. The remote user-name is sent as the server user-name in an rcp command request sent by the system to a remote rcp server.

Password used by ftp, sftp or scp for copying a file to/from an ftp/sftp/scp server. This object must be created when the copyProtocol is ftp or scp. Reading it returns a zero-length string for security reasons.

Specifies whether or not a copyCompletion notification should be issued on completion of the tftp transfer. If such a notification is desired, it is the responsibility of the management entity to ensure that the SNMP administrative model is configured in such a way as to allow the notification to be delivered.

Specifies the state of this config-copy request. This value of this object is instantiated only after the row has been instantiated, i.e. after the copyEntryRowStatus has been made active.

Specifies the time the copyState last transitioned to running, or 0 if the state has never transitioned to running (for e.g., stuck in waiting state). This object is instantiated only after the row has been instantiated.

Specifies the time the copyState last transitioned from running to successful or failed states. This object is instantiated only after the row has been instantiated. Its value will remain 0 until he request has completed.

The reason why the config-copy operation failed. This object is instantiated only when the copyState for this entry is in the failed state.

The status of this table entry. Once the entry status is set to active, the associated entry cannot be modified until the request completes (copyState transitions to successful or failed state).

A copyCompletion trap is sent at the completion of a config-copy request. The copyFailCause is not instantiated, and hence not included in a trap, when the copyState is success.