CISCO-CONFIG-COPY-MIB

File: CISCO-CONFIG-COPY-MIB.mib (31617 bytes)

Imported modules

SNMPv2-SMI SNMPv2-TC SNMPv2-CONF
SNMP-FRAMEWORK-MIB CISCO-SMI INET-ADDRESS-MIB
CISCO-ST-TC

Imported symbols

MODULE-IDENTITY OBJECT-TYPE NOTIFICATION-TYPE
IpAddress Unsigned32 TEXTUAL-CONVENTION
DisplayString TimeStamp RowStatus
TruthValue MODULE-COMPLIANCE OBJECT-GROUP
NOTIFICATION-GROUP SnmpAdminString ciscoMgmt
InetAddressType InetAddress FcNameIdOrZero

Defined Types

ConfigCopyProtocol  
TEXTUAL-CONVENTION    
  current INTEGER tftp(1), ftp(2), rcp(3), scp(4), sftp(5)

ConfigCopyState  
TEXTUAL-CONVENTION    
  current INTEGER waiting(1), running(2), successful(3), failed(4)

ConfigCopyFailCause  
TEXTUAL-CONVENTION    
  current INTEGER unknown(1), badFileName(2), timeout(3), noMem(4), noConfig(5), unsupportedProtocol(6), someConfigApplyFailed(7), systemNotReady(8), requestAborted(9)

ConfigFileType  
TEXTUAL-CONVENTION    
  current INTEGER networkFile(1), iosFile(2), startupConfig(3), runningConfig(4), terminal(5), fabricStartupConfig(6)

CcCopyEntry  
SEQUENCE    
  ccCopyIndex Unsigned32
  ccCopyProtocol ConfigCopyProtocol
  ccCopySourceFileType ConfigFileType
  ccCopyDestFileType ConfigFileType
  ccCopyServerAddress IpAddress
  ccCopyFileName DisplayString
  ccCopyUserName DisplayString
  ccCopyUserPassword DisplayString
  ccCopyNotificationOnCompletion TruthValue
  ccCopyState ConfigCopyState
  ccCopyTimeStarted TimeStamp
  ccCopyTimeCompleted TimeStamp
  ccCopyFailCause ConfigCopyFailCause
  ccCopyEntryRowStatus RowStatus
  ccCopyServerAddressType InetAddressType
  ccCopyServerAddressRev1 InetAddress

CcCopyErrorEntry  
SEQUENCE    
  ccCopyErrorIndex Unsigned32
  ccCopyErrorDeviceIpAddressType InetAddressType
  ccCopyErrorDeviceIpAddress InetAddress
  ccCopyErrorDeviceWWN FcNameIdOrZero
  ccCopyErrorDescription SnmpAdminString

Defined Values

ciscoConfigCopyMIB 1.3.6.1.4.1.9.9.96
This MIB facilitates writing of configuration files of an SNMP Agent running Cisco's IOS in the following ways: to and from the net, copying running configurations to startup configurations and vice-versa, and copying a configuration (running or startup) to and from the local IOS file system.
MODULE-IDENTITY    

ciscoConfigCopyMIBObjects 1.3.6.1.4.1.9.9.96.1
OBJECT IDENTIFIER    

ccCopy 1.3.6.1.4.1.9.9.96.1.1
OBJECT IDENTIFIER    

ccCopyTable 1.3.6.1.4.1.9.9.96.1.1.1
A table of config-copy requests.
OBJECT-TYPE    
  SEQUENCE OF  
    CcCopyEntry

ccCopyEntry 1.3.6.1.4.1.9.9.96.1.1.1.1
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    
  CcCopyEntry  

ccCopyIndex 1.3.6.1.4.1.9.9.96.1.1.1.1.1
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    
  Unsigned32 1..2147483647  

ccCopyProtocol 1.3.6.1.4.1.9.9.96.1.1.1.1.2
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    
  ConfigCopyProtocol  

ccCopySourceFileType 1.3.6.1.4.1.9.9.96.1.1.1.1.3
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    
  ConfigFileType  

ccCopyDestFileType 1.3.6.1.4.1.9.9.96.1.1.1.1.4
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    
  ConfigFileType  

ccCopyServerAddress 1.3.6.1.4.1.9.9.96.1.1.1.1.5
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    
  IpAddress  

ccCopyFileName 1.3.6.1.4.1.9.9.96.1.1.1.1.6
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    
  DisplayString  

ccCopyUserName 1.3.6.1.4.1.9.9.96.1.1.1.1.7
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 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    
  DisplayString Size(1..40)  

ccCopyUserPassword 1.3.6.1.4.1.9.9.96.1.1.1.1.8
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    
  DisplayString Size(1..40)  

ccCopyNotificationOnCompletion 1.3.6.1.4.1.9.9.96.1.1.1.1.9
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    
  TruthValue  

ccCopyState 1.3.6.1.4.1.9.9.96.1.1.1.1.10
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    
  ConfigCopyState  

ccCopyTimeStarted 1.3.6.1.4.1.9.9.96.1.1.1.1.11
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    
  TimeStamp  

ccCopyTimeCompleted 1.3.6.1.4.1.9.9.96.1.1.1.1.12
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    
  TimeStamp  

ccCopyFailCause 1.3.6.1.4.1.9.9.96.1.1.1.1.13
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    
  ConfigCopyFailCause  

ccCopyEntryRowStatus 1.3.6.1.4.1.9.9.96.1.1.1.1.14
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    
  RowStatus  

ccCopyServerAddressType 1.3.6.1.4.1.9.9.96.1.1.1.1.15
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    
  InetAddressType  

ccCopyServerAddressRev1 1.3.6.1.4.1.9.9.96.1.1.1.1.16
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    
  InetAddress  

ccCopyErrorTable 1.3.6.1.4.1.9.9.96.1.1.2
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    
  SEQUENCE OF  
    CcCopyErrorEntry

ccCopyErrorEntry 1.3.6.1.4.1.9.9.96.1.1.2.1
An entry containing information about the outcome at one destination of a failed config copy operation.
OBJECT-TYPE    
  CcCopyErrorEntry  

ccCopyErrorIndex 1.3.6.1.4.1.9.9.96.1.1.2.1.1
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    
  Unsigned32  

ccCopyErrorDeviceIpAddressType 1.3.6.1.4.1.9.9.96.1.1.2.1.2
The type of Internet address for this destination device on which config copy operation is performed.
OBJECT-TYPE    
  InetAddressType  

ccCopyErrorDeviceIpAddress 1.3.6.1.4.1.9.9.96.1.1.2.1.3
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    
  InetAddress  

ccCopyErrorDeviceWWN 1.3.6.1.4.1.9.9.96.1.1.2.1.4
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    
  FcNameIdOrZero  

ccCopyErrorDescription 1.3.6.1.4.1.9.9.96.1.1.2.1.5
The error description for the error happened for this destination of this config copy operation.
OBJECT-TYPE    
  SnmpAdminString  

ciscoConfigCopyMIBTrapPrefix 1.3.6.1.4.1.9.9.96.2
OBJECT IDENTIFIER    

ccCopyMIBTraps 1.3.6.1.4.1.9.9.96.2.1
OBJECT IDENTIFIER    

ccCopyCompletion 1.3.6.1.4.1.9.9.96.2.1.1
A ccCopyCompletion trap is sent at the completion of a config-copy request. The ccCopyFailCause is not instantiated, and hence not included in a trap, when the ccCopyState is success.
NOTIFICATION-TYPE    

ciscoConfigCopyMIBConformance 1.3.6.1.4.1.9.9.96.3
OBJECT IDENTIFIER    

ccCopyMIBCompliances 1.3.6.1.4.1.9.9.96.3.1
OBJECT IDENTIFIER    

ccCopyMIBGroups 1.3.6.1.4.1.9.9.96.3.2
OBJECT IDENTIFIER    

ccCopyMIBCompliance 1.3.6.1.4.1.9.9.96.3.1.1
The compliance statement for Cisco agents which implement the Cisco ConfigCopy MIB. This MIB should be implemented on all Cisco agents that support copying of configs via the CLI. This compliance is deprecated and new compliance ccCopyMIBComplianceRev1 is defined.
MODULE-COMPLIANCE    

ccCopyMIBComplianceRev1 1.3.6.1.4.1.9.9.96.3.1.2
The compliance statement for Cisco agents which implement the Cisco ConfigCopy MIB. This MIB should be implemented on all Cisco agents that support copying of configs via the CLI. This compliance module deprecates ccCopyMIBCompliance.
MODULE-COMPLIANCE    

ccCopyMIBComplianceRev2 1.3.6.1.4.1.9.9.96.3.1.3
Implementation of this group is optional.
MODULE-COMPLIANCE    

ccCopyGroup 1.3.6.1.4.1.9.9.96.3.2.1
A collection of objects providing the ability to copy an agent-configuration file. This Group is deprecated and new group is defined.
OBJECT-GROUP    

ccCopyNotificationsGroup 1.3.6.1.4.1.9.9.96.3.2.2
The notification used to indicate that a config-copy operation to or from the agent has been completed.
NOTIFICATION-GROUP    

ccCopyGroupRev1 1.3.6.1.4.1.9.9.96.3.2.3
A collection of objects providing the ability to copy an agent-configuration file. This group deprecates the old group ccCopyGroup.
OBJECT-GROUP    

ccCopyErrorGroup 1.3.6.1.4.1.9.9.96.3.2.4
A collection of objects providing the result of a config copy operation when the value of ccCopyDestFileType is 'fabricStartupConfig' and value of ccCopyState is 'failed'.
OBJECT-GROUP