CISCO-CONFIG-COPY-MIB
AI MIB Summary
The CISCO-CONFIG-COPY-MIB enables SNMP-based programmatic transfer and synchronization of Cisco IOS configuration files between the running and startup configurations, the local file system, and remote network destinations. This module specifically manages the execution of copy operations to persist, migrate, or backup device configurations without requiring interactive CLI access.
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.
29
Objects
Active
Status
5
Dependencies
Imported Objects
Objects
29 total| Object Name |
|---|
ciscoConfigCopyMIB OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.96 |
RFC1155-SMI Unknown .1.3.6.1.4.1.9.9.96 |
ciscoConfigCopyMIBObjects OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.96.1 |
ccCopy OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.96.1.1 |
ccCopyTableA table of config-copy requests. SEQUENCE OF CcCopyEntry .1.3.6.1.4.1.9.9.96.1.1.1 |
ccCopyEntryA 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 FileTypes must be an agent-config
file type (i.e. startupConfig or runningConfig).
If one of the file types is a networkFile, a valid
ccCopyServerAddress and ccCopyFileName must be
created as well. For a file type of iosFile, 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, 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 never be
deleted within 5 minutes of completing. CcCopyEntry .1.3.6.1.4.1.9.9.96.1.1.1.1 |
ccCopyIndexObject 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. Gauge .1.3.6.1.4.1.9.9.96.1.1.1.1.1 |
ccCopyProtocolThe protocol to be used for any copy.
Will default to tftp if not specified.
If the copy operation occurs locally on the SNMP agent
(e.g. runningCOnfigToStartupConfig), this object may
be ignored by the implementation.rw ConfigCopyProtocol -- Rsyntax INTEGER { -- tftp(1), -- ftp(2), -- rcp(3), -- scp(4), -- sftp(5) -- } .1.3.6.1.4.1.9.9.96.1.1.1.1.2 |
ccCopySourceFileTypespecifies 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 and
ccCopyFileName must also be created, and these 3
objects together (ccCopySourceFileType,
ccCopyServerAddress, ccCopyFileName) will uniquely
identify the source file.
If the ccCopySourceFileType is iosFile, the
ccCopyFileName must also be created, and the
2 objects together (ccCopySourceFileType,
ccCopyFileName) will uniquely identify the source
file.rw ConfigFileType -- Rsyntax INTEGER { -- networkFile(1), -- iosFile(2), -- startupConfig(3), -- runningConfig(4), -- terminal(5) -- } .1.3.6.1.4.1.9.9.96.1.1.1.1.3 |
ccCopyDestFileTypespecifies 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 and
ccCopyFileName must also be created, and these
3 objects together
(ccCopyDestFileType, ccCopyServerAddress,
ccCopyFileName) will uniquely identify the
destination file.
If the ccCopyDestFileType is iosFile, the ccCopyFileName
must also be created, and the 2 objects together
(ccCopyDestFileType, ccCopyFileName) will uniquely
identify the destination file.rw ConfigFileType -- Rsyntax INTEGER { -- networkFile(1), -- iosFile(2), -- startupConfig(3), -- runningConfig(4), -- terminal(5) -- } .1.3.6.1.4.1.9.9.96.1.1.1.1.4 |
ccCopyServerAddressThe 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.rw IpAddress .1.3.6.1.4.1.9.9.96.1.1.1.1.5 |
ccCopyFileNameThe 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.rw DisplayString -- Rsyntax OCTET STRING .1.3.6.1.4.1.9.9.96.1.1.1.1.6 |
ccCopyUserNameRemote user name 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
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.rw DisplayString .1.3.6.1.4.1.9.9.96.1.1.1.1.7 |
ccCopyUserPasswordPassword 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.rw DisplayString .1.3.6.1.4.1.9.9.96.1.1.1.1.8 |
ccCopyNotificationOnCompletionSpecifies 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.rw TruthValue -- Rsyntax INTEGER { -- true(1), -- false(2) -- } .1.3.6.1.4.1.9.9.96.1.1.1.1.9 |
ccCopyStateSpecifies 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.ro ConfigCopyState -- Rsyntax INTEGER { -- waiting(1), -- running(2), -- successful(3), -- failed(4) -- } .1.3.6.1.4.1.9.9.96.1.1.1.1.10 |
ccCopyTimeStartedSpecifies the time the ccCopyState 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.ro TimeStamp -- Rsyntax TimeTicks .1.3.6.1.4.1.9.9.96.1.1.1.1.11 |
ccCopyTimeCompletedSpecifies 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 he request has completed.ro TimeStamp -- Rsyntax TimeTicks .1.3.6.1.4.1.9.9.96.1.1.1.1.12 |
ccCopyFailCauseThe reason why the config-copy operation failed.
This object is instantiated only when the ccCopyState
for this entry is in the failed state.ro ConfigCopyFailCause -- Rsyntax INTEGER { -- unknown(1), -- badFileName(2), -- timeout(3), -- noMem(4), -- noConfig(5), -- unsupportedProtocol(6), -- someConfigApplyFailed(7) -- } .1.3.6.1.4.1.9.9.96.1.1.1.1.13 |
ccCopyEntryRowStatusThe 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).rw RowStatus -- Rsyntax INTEGER { -- active(1), -- notInService(2), -- notReady(3), -- createAndGo(4), -- createAndWait(5), -- destroy(6) -- } .1.3.6.1.4.1.9.9.96.1.1.1.1.14 |
ciscoConfigCopyMIBTrapPrefix OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.96.2 |
ccCopyMIBTraps OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.96.2.1 |
ccCopyCompletionA 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. TRAP-TYPE .1.3.6.1.4.1.9.9.96.2.1.0.1 |
ciscoConfigCopyMIBConformance OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.96.3 |
ccCopyMIBCompliances OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.96.3.1 |
ccCopyMIBCompliance OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.96.3.1.1 |
ccCopyMIBGroups OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.96.3.2 |
ccCopyGroup OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.96.3.2.1 |
ccCopyNotificationsGroup OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.96.3.2.2 |