CISCO-CONFIG-COPY-MIB

TEXTUAL-CONVENTION

The reason a config-copy request failed. unknown: very descriptive. badFileName: check your file name/path/permissions. timeout: the network may be overloaded, or the remote file server may not be responding. noMem: the Agent wasn't able to allocate memory for the config-copy operation. noConfig: the agent-config selected as the source was non-existent. unsupportedProtocol: the protocol is not supported by the agent. someConfigApplyFailed: applying of some of the configuration commands failed. systemNotReady: system is not ready to copy. requestAborted: config copy operation aborted.

TEXTUAL-CONVENTION

The protocol file transfer protocol that should be used to copy the configuration file over the network. If the config file transfer is to occur locally on the SNMP agent, the method of transfer is left up to the implementation, and is not restricted to the protocols below. tftp: Transfer File Transfer Protocol ftp: File Transfer protocol rcp: Remote Copy Protocol scp: Secure Copy Protocol sftp: Secure File Transfer Protocol

TEXTUAL-CONVENTION

The state of a TFTP config-copy operation. The description of each state is given below: waiting: only one config-copy request can run at any time. A newly activated config-copy request is placed in this state if another request has already been activated. running: this state signifies that the config-copy request is running. successful: the state when a config-copy request is successfully completed. failed: the config-copy request was unsuccessful.

TEXTUAL-CONVENTION

The various types of files on which a config-copy operation can be performed. networkFile: file on another network device, e.g. a file-server on the network. iosFile: a file on the local agent, other than startup or running config. startupConfig: a startup config file. runningConfig: a running config file. terminal: a terminal (e.g. the console window) on which the config is to be displayed. fabricStartupConfig: a file type which can be used for a destination file; when a running-config is to copied to a destination of this type, the file is copied to the startup config on all devices in the fabric. Such a fabric could, for example, be a Fibre Channel fabric, or even a MAC-based fabric.

OBJECT-IDENTITY

OBJECT-IDENTITY

OBJECT-TYPE

A table of config-copy requests.

OBJECT-TYPE

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 also, either in the same or in successive PDUs, create an instance of ccCopySourceFileType and ccCopyDestFileType. At least one of the file types defined in ConfigFileType TC must be an agent-config file type (i.e. 'startupConfig' or 'runningConfig'). If one of the file types is a 'networkFile', a valid ccCopyFileName and ccCopyServerAddressType and ccCopyServerAddressRev1 or just ccCopyServerAddress must be created as well. If ccCopyServerAddress is created then ccCopyServerAddressRev1 will store the same IP address and ccCopyServerAddressType will take the value 'ipv4'. For a file type of 'iosFile', only a valid ccCopyFileName 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, either by an explicit SNMP set request or by default, the row status should be set to active to initiate the request. Note that this entire procedure may 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 ccCopyEntryRowStatus 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 ever be deleted within 5 minutes of completing.

OBJECT-TYPE

Object which specifies a unique entry in the ccCopyTable. 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 ccCopyEntry. The RowStatus semantics of the ccCopyEntryRowStatus object will prevent access conflicts.

OBJECT-TYPE

The protocol to be used for any copy. If the copy operation occurs locally on the SNMP agent (e.g. 'runningConfig' to 'startupConfig'), this object may be ignored by the implementation.

OBJECT-TYPE

Specifies the type of file to copy from. Either the ccCopySourceFileType or the ccCopyDestFileType (or both) must be of type 'runningConfig' or 'startupConfig'. Also, the ccCopySourceFileType must be different from the ccCopyDestFileType. If the ccCopySourceFileType has the value of 'networkFile', the ccCopyServerAddress/ ccCopyServerAddressRev1 and ccCopyServerAddressType and ccCopyFileName must also be created, and 3 objects together (ccCopySourceFileType, ccCopyServerAddressRev1, ccCopyFileName) will uniquely identify the source file. If ccCopyServerAddress is created then ccCopyServerAddressRev1 will store the same IP address and ccCopyServerAddressType will take the value 'ipv4'. If the ccCopySourceFileType is 'iosFile', the ccCopyFileName must also be created, and the 2 objects together (ccCopySourceFileType, ccCopyFileName) will uniquely identify the source file.

OBJECT-TYPE

specifies the type of file to copy to. Either the ccCopySourceFileType or the ccCopyDestFileType (or both) must be of type 'runningConfig' or 'startupConfig'. Also, the ccCopySourceFileType must be different from the ccCopyDestFileType. If the ccCopyDestFileType has the value of 'networkFile', the ccCopyServerAddress/ccCopyServerAddressType and ccCopyServerAddressRev1 and ccCopyFileName must also be created, and 3 objects together (ccCopyDestFileType, ccCopyServerAddressRev1, ccCopyFileName) will uniquely identify the destination file. If ccCopyServerAddress is created then ccCopyServerAddressRev1 will store the same IP address and ccCopyServerAddressType will take the value 'ipv4'. If the ccCopyDestFileType is 'iosFile', the ccCopyFileName must also be created, and the 2 objects together (ccCopyDestFileType, ccCopyFileName) will uniquely identify the destination file.

OBJECT-TYPE

The IP address of the TFTP server from (or to) which to copy the configuration file. This object must be created when either the ccCopySourceFileType or ccCopyDestFileType has the value 'networkFile'. Values of 0.0.0.0 or FF.FF.FF.FF for ccCopyServerAddress are not allowed. Since this object can just hold only IPv4 Transport type, it is deprecated and replaced by ccCopyServerAddressRev1.

OBJECT-TYPE

The file name (including the path, if applicable) of the file. This object must be created when either the ccCopySourceFileType or ccCopyDestFileType has the value 'networkFile' or 'iosFile'.

OBJECT-TYPE

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

OBJECT-TYPE

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 ccCopyProtocol is FTP or SCP. Reading it returns a zero-length string for security reasons.

OBJECT-TYPE

Specifies whether or not a ccCopyCompletion 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.

OBJECT-TYPE

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 ccCopyEntryRowStatus has been made active.

OBJECT-TYPE

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

OBJECT-TYPE

Specifies the time the ccCopyState 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 the request has completed.

OBJECT-TYPE

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

OBJECT-TYPE

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

OBJECT-TYPE

This object indicates the transport type of the address contained in ccCopyServerAddressRev1 object. This must be created when either the ccCopySourceFileType or ccCopyDestFileType has the value 'networkFile'.

OBJECT-TYPE

The IP address of the TFTP server from (or to) which to copy the configuration file. This object must be created when either the ccCopySourceFileType or ccCopyDestFileType has the value 'networkFile'. All bits as 0s or 1s for ccCopyServerAddressRev1 are not allowed. The format of this address depends on the value of the ccCopyServerAddressType object.

OBJECT-TYPE

A table containing information about the failure cause of the config copy operation. An entry is created only when the value of ccCopyState changes to 'failed' for a config copy operation. Not all combinations of ccCopySourceFileType and ccCopyDestFileType need to be supported. For example, an implementation may choose to support only the following combination: ccCopySourceFileType = 'runningConfig' ccCopyDestFileType = 'fabricStartupConfig'. In the case where a fabric wide config copy operation is being performed, for example by selecting ccCopyDestFileType value to be 'fabricStartupConfig', it is possible that the fabric could have more than one device. In such cases this table would have one entry for each device in the fabric. In this case even if the operation succeeded in one device and failed in another, the operation as such has failed, so the global state represented by ccCopyState 'failed', but for the device on which it was success, ccCopyErrorDescription would have the distinguished value, 'success'. Once the config copy operation completes and if an entry gets instantiated, the management station should retrieve the values of the status objects of interest. Once an entry in ccCopyTable is deleted by management station, all the corresponding entries with the same ccCopyIndex in this table are also deleted. In order to prevent old entries from clogging the table, entries age out at the same time as the corresponding entry with same ccCopyIndex in ccCopyTable ages out.

OBJECT-TYPE

An entry containing information about the outcome at one destination of a failed config copy operation.

OBJECT-TYPE

A monotonically increasing integer for the sole purpose of indexing entries in this table. When a config copy operation has multiple destinations, then this index value is used to distinguish between those multiple destinations.

OBJECT-TYPE

The type of Internet address for this destination device on which config copy operation is performed.

OBJECT-TYPE

The IP address of this destination device on which config copy operation is performed. The object value has to be consistent with the type specified in ccCopyErrorDeviceIpAddressType.

OBJECT-TYPE

The World Wide Name (WWN) of this destination device on which config copy operation is performed. The value of this object is zero-length string if WWN is unassigned or unknown. For example, devices which do not support fibre channel would not have WWN.

OBJECT-TYPE

The error description for the error happened for this destination of this config copy operation.

OBJECT-IDENTITY

OBJECT-IDENTITY

OBJECT-IDENTITY

OBJECT-IDENTITY

OBJECT-IDENTITY