RBN-CONFIG-FILE-MIB: View SNMP OID List / Download MIB

Defines the objects necessary to support loading Redback system configuration files and saving the contents of the current system configuration. For security reasons, all mib objects defined in this module are only accessible via SNMP community strings (v1/v2c) or SNMP contextNames (v3) that map to the system's 'local' context. Note well: due to these security reasons, it is highly encouraged to only allow access to this MIB via the more secure protocols supported by SNMPv3.

A notification indicating that a configuration job has completed.

An advisory lock used to allow several cooperating Command Generator Applications to coordinate their use of facilities to create/modify entries in the rcfJobTable.

The next available index which can be used to create a rcfJobEntry.

A table which is used to start and monitor a process which loads a configuration file, or saves the current configuration out to a file. The suggested method to create a new entry is: 1. GET(rcfJobSpinLock.0, rcfJobNextIndex.0) and save in slValue, niValue respectively 2. SET(rcfJobSpinLock.0 = slValue, rcfJobXxx.niValue = ... rcfJobYyy.niValue = ... ... rcfJobRowStatus.niValue = 'createAndGo') Entries whose state is 'completed' may be automatically deleted by the system after some system dependant time.

An entry created by a Command Generator application which starts and monitors a process which loads a system configuration file or saves the current system configuration out to a file. When rcfJobRowStatus becomes active, rcfJobState is set to 'pending' and is queued for processing. Only one job may be processed at a time. When the job reaches the head of the queue, rcfJobState is set to 'inProgress' and the configuration operation will be performed. When the operation completes, rcfJobState will be set to 'completed'. Also at this time the objects rcfJobResult and rcfJobErrorMsgs will be instantiated and will provide the success/failure status of the operation. A job in the 'pending' state may be aborted by setting rcfJobRowStatus to 'notInService' or 'destroy'. An entry for a job which has completed (rcfJobState is 'completed') may be reset to the 'pending' state by setting rcfRowStatus to 'notInService' and then back to 'active' to initiate another configuration operation. Note: while rcfRowStatus equals 'active', the only object instance that can be modified in the entry is rcfRowStatus. To alter any other object instance, rcfRowStatus must be set to 'notInService'.

A unique identifier for an entry in this table.

The configuration operation to perform. If 'load', the file specified in rcfJobFilename is retrieved, parsed and loaded into the system configuration. If 'save', the current system configuration is written to the file specified in rcfJobFilename. Enumeration: 'load': 0, 'save': 1.

The file transfer protocol to use. If 'local', the filename specified in rcfJobFilename exists locally on the Redback system (eg in /flash). If 'tftp', the filename specified in rcfJobFilename will be read/written from/to the system identified by rcfJobIpAddress via the TFTP file transfer protocol. If 'ftp', the filename specified in rcfJobFilename will be read/written from/to the system identified by rcfJobIpAddress via the FTP file transfer protocol. The values in rcfJobUsername and rcfJobPassword will be used for authentication. rcfJobPassiveMode can be used to enable/disable FTP's passive mode. Enumeration: 'ftp': 2, 'tftp': 1, 'local': 0.

The name of the source file (loads) or destination file (saves).

The address type for rcfJobIpAddress. This object is only relevant for non-local filenames. If rcfJobProtocol equals 'local', any value for this object will effectively be ignored.

The IP address for the file server which contains the source file (loads) or destination file (saves). This object is only relevant for non-local filenames. If rcfJobProtocol equals 'local', any value for this object will effectively be ignored.

The username to use for authentication with the file server. This object is only relevant for the FTP protocol. If rcfJobProtocol does not equal 'ftp', any value for this object will effectively be ignored. For security reasons, all SNMP gets on this object will return a zero-length string.

The password to use for authentication with the file server. A zero-length string value would be used for usernames that do not require a password. This object is only relevant for the FTP protocol. If rcfJobProtocol does not equal 'ftp', any value for this object will effectively be ignored. For security reasons, all SNMP gets on this object will return a zero-length string.

Enables/disables passive mode on FTP connections. This object is only relevant for the FTP protocol. If rcfJobProtocol does not equal 'ftp', any value for this object will effectively be ignored.

If this object instance has a non-zero value, parsing and loading of the configuration file will terminate after the specified line number. This object is only relevant for 'load' operations. If rcfJobOp does not equal 'load', any value for this object will effectively be ignored.

If 'true', default values for all configuration values are saved. If 'false', only the values which have been explicitly configured are saved. This object is only relevant for 'save' operations. If rcfJobOp does not equal 'save', any value for this object will effectively be ignored.

The current state of the configuration job. pending -- The initial state of all jobs. Jobs are queued and processed in order of creation. inProgress -- The job is actively being performed. completed -- The job has completed. Enumeration: 'inProgress': 1, 'completed': 2, 'pending': 0.

A generic result code. This object is instantiated only when rcfJobStatus equals 'completed'. success -- The job completed successfully. other -- An error that doesn't fall into one of the categories below. noMemory -- Insufficient system resources to perform the operation. parse -- A parse failure occurred. ie- there was a syntax error in the source configuration file. io -- An i/o error occurred. access -- A file access error occurred. This could be caused by a non-existant source file, or insufficient access/permission to create/modify the destination file. More detailed error descriptions can be found in the rcfJobErrorMsgs object. Enumeration: 'noMemory': 2, 'access': 5, 'success': 0, 'parse': 3, 'other': 1, 'io': 4.

Detailed error messages generated during the configuration operation. This object is instantiated only when rcfJobState equals 'completed'. Note: the amount of error messages produced by a configuration operation may exceed the max size of this object (255 bytes). If this happens, the last character in the rcfJobErrorMsgs value will be '$' to indicate that a truncation occurred. Note: there may be some types of messages that one will see when performing a configuration operation via the CLI. However these messages will not be seen in the values for this object. A specific example on the SMS platform is the messages the CLI will display when there is a parse failure. These messages will not be captured in this object.

The value of sysUpTime when this job entry was created.

The value of sysUpTime when rcfJobState moved from 'pending' to 'inProgress'. This object will not be instantiated until rcfJobState moves to 'inProgress'. The object will be un-instantiated if rcfJobRowStatus is set to 'notInService'.

The value of sysUpTime when the job completed. This object will not be instantiated until rcfJobState moves to 'completed'. The object will be un-instantiated if rcfJobRowStatus is set to 'notInService'.

If 'true', an rcfJobCompleted notification will be generated when the job completes.

This object can be used to identify who/what/where created this job entry.

The row status for creating, modifying, or deleting an entry in the table. Note that 'active' entries cannot be modified. Any attempt to modify an object in this entry while rcfJobRowStatus equals 'active' will result in an inconsistentValue error. To modify objects in an active entry, rcfJobRowStatus must first be set to 'notInService'. All entries will be automatically deleted by the agent after some system dependent time.

The compliance statement for SNMP entities which implement the Redback Configuration File MIB.

The collection of objects which represent a configuration job.

The collection of notifications related to configuration jobs.