CISCO-SMART-INSTALL-MIB

        This MIB module defines managed objects that facilitate
the management of Smart Install feature.  Smart Install is a
plug-and-play image and configuration management feature which
enables zero-touch deployment of Cisco network devices in an
enterprise branch network.
        
Following is the terminology associated with Smart Install
feature:
        
Director
   A router or switch selected as the single management point
   for images and configuration of network devices in a Smart
   Install network.  When a device is first installed into the
   network, the director detects the new device and facilitates
   the correct Cisco IOS image and configuration file for the
   device based on user defined profiles.  With the automated
   process, a single or a group of devices are deployed without
   user intervention.
        
   The managed device includes, but not limited to, Cisco 2K/3K
   switches and EtherSwitch service modules.  Director learns
   about them through CDP or Smart Install protocol.
        
Smart Install Capable Client
   A client device running Smart Install capable image.
        
Group
   Devices are placed into Groups where they can be manipulated
   together rather than individually.
        
Profile
   Profile is the configuration file, image, etc. that a user
   programs for each group.
        
Backup
   The feature to archive/backup client device's configuration
   file upon 'write memory' on client.
        
Join-Window
   A join window is a time window during which the device is
   allowed to upgrade image or configuration files.  Only
   during this window can the director provide information
   about the image and configuration to the device.  A device
   attempting to join the network outside of the join window
   will not be allowed to do so, and cannot upgrade their image
   and configuration files.
        
This MIB module is supported on the director but not on the
client devices.  It is designed to:
        
   - Allow operators to make configurations for client devices
     before and after they connect to the director's network.
        
   - Support monitoring of client devices discovered by the
     director.
        
   - Provide status of the deployed client image and
     configuration as a result of operator defined profiles.
        
   - Provide notifications for notable events such as new
     device joined or upgrade failure if there is any.
        
        
Please note that, in most cases a working DHCP pool is
configured for the subnet(s) on which the client devices
are located.  The DHCP server could be the director,
another Cisco device running Cisco IOS, or a non-Cisco
third-party server.
        
        
CISCO-SMART-INSTALL-MIB Module usage:
        
1) Create profile for a group of devices
        
   Profile is used to pre-configure image and configuration
   files for a group of devices.
        
   In csiProfileTable
   {
    csiProfileIndex          = 8, 
    csiProfileGroupName      = '3750E_24', 
    csiProfileImageUrl       = 'tftp://10.0.0.1/3750e.tar',
    csiProfileImageTwoUrl    = '',
    csiProfileConfigUrl      = 'flash:/default_config.txt',
    <snip>
   } 
        
2) Define a group of devices
        
   For example, to define a group matching on Catalyst 2960
   24 8 Poe switches:
        
   In csiMatchTable
   {
    csiMatchIndex     = 1, 
    csiMatchGroupType = 'product',
    csiMatchProductId = 'WS-C2960-24LT-L',
    csiProfileIndex   = 6, 
    <snip>
   }
        
3) Enable Smart Install feature on the director
        
   The operator enables the Smart Install feature by setting
        
        csiOperationMode = basic(2)
        
4) Display device information
        
   Director is aware of Smart Install capable devices and others
   connected to a Smart Install capable device.  This MIB table
   displays information about the devices, such as the running
   image, the MAC address, etc.
        
        csiDeviceTable
        
5) Further refine the running environment
        
   Objects in csiGlobalConfig enable the Operator to tailor
   the director operation, such as:
        
   . Backup client device's configuration file.
   . Set up Join Window to monitor newly installed devices.
    
Source file
CISCO-SMART-INSTALL-MIB
Last revised
Identity
ciscoSmartInstallMIB
Base OID
1.3.6.1.4.1.9.9.725
Imported Objects
CISCO-SMI ciscoMgmt
CISCO-TC Cisco2KVlanList CiscoURLStringOrEmpty TimeIntervalMin
INET-ADDRESS-MIB InetAddress InetAddressType
SNMP-FRAMEWORK-MIB SnmpAdminString
SNMPv2-CONF MODULE-COMPLIANCE (no object page) NOTIFICATION-GROUP (no object page) OBJECT-GROUP (no object page)
SNMPv2-SMI MODULE-IDENTITY (no object page) NOTIFICATION-TYPE (no object page) OBJECT-TYPE (no object page) Unsigned32
SNMPv2-TC DateAndTime MacAddress RowStatus StorageType TruthValue
Net-SNMP examples using the cisco MIB directory Show commands

These commands use the standard Observium installation path and load the selected MIB variant before the RFC and Net-SNMP directories.

Translate the module identity
/usr/bin/snmptranslate -Pud -Ir -On -m 'CISCO-SMART-INSTALL-MIB' -M '/opt/observium/mibs/cisco:/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'CISCO-SMART-INSTALL-MIB::ciscoSmartInstallMIB'
Walk the MIB subtree
/usr/bin/snmpbulkwalk -v2c -c '<community>' -Pud -Ir -OQUs -m 'CISCO-SMART-INSTALL-MIB' -M '/opt/observium/mibs/cisco:/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'udp:<hostname>:161' 'CISCO-SMART-INSTALL-MIB::ciscoSmartInstallMIB'
How SNMP, Net-SNMP, MIB paths, and variants work
Objects (72)
.1.3.6.1.4.1.9.9.725
.1.3.6.1.4.1.9.9.725.0
.1.3.6.1.4.1.9.9.725.1
.1.3.6.1.4.1.9.9.725.1.1
Enumeration
.1.3.6.1.4.1.9.9.725.1.1.1
.1.3.6.1.4.1.9.9.725.1.1.2
.1.3.6.1.4.1.9.9.725.1.1.3
.1.3.6.1.4.1.9.9.725.1.1.4
.1.3.6.1.4.1.9.9.725.1.1.5
.1.3.6.1.4.1.9.9.725.1.1.6
.1.3.6.1.4.1.9.9.725.1.1.7
.1.3.6.1.4.1.9.9.725.1.1.7.1
.1.3.6.1.4.1.9.9.725.1.1.7.2
.1.3.6.1.4.1.9.9.725.1.1.8
Enumeration
.1.3.6.1.4.1.9.9.725.1.1.8.1
Unsigned32
.1.3.6.1.4.1.9.9.725.1.1.8.2
.1.3.6.1.4.1.9.9.725.1.1.8.3
.1.3.6.1.4.1.9.9.725.1.1.8.3.1
.1.3.6.1.4.1.9.9.725.1.1.8.3.1.1
.1.3.6.1.4.1.9.9.725.1.1.8.3.1.2
.1.3.6.1.4.1.9.9.725.1.1.8.3.1.3
Enumeration
.1.3.6.1.4.1.9.9.725.1.1.8.3.1.4
.1.3.6.1.4.1.9.9.725.1.1.8.3.1.5
.1.3.6.1.4.1.9.9.725.1.1.8.3.1.6
.1.3.6.1.4.1.9.9.725.1.1.8.3.1.7
.1.3.6.1.4.1.9.9.725.1.2
.1.3.6.1.4.1.9.9.725.1.2.1
.1.3.6.1.4.1.9.9.725.1.2.2
OctetString
.1.3.6.1.4.1.9.9.725.1.2.3
Unsigned32
.1.3.6.1.4.1.9.9.725.1.2.4
.1.3.6.1.4.1.9.9.725.1.2.5
.1.3.6.1.4.1.9.9.725.1.2.5.1
.1.3.6.1.4.1.9.9.725.1.2.5.1.1
OctetString
.1.3.6.1.4.1.9.9.725.1.2.5.1.2
.1.3.6.1.4.1.9.9.725.1.2.5.1.3
.1.3.6.1.4.1.9.9.725.1.2.5.1.4
.1.3.6.1.4.1.9.9.725.1.2.5.1.5
.1.3.6.1.4.1.9.9.725.1.2.5.1.6
.1.3.6.1.4.1.9.9.725.1.2.5.1.7
.1.3.6.1.4.1.9.9.725.1.2.6
.1.3.6.1.4.1.9.9.725.1.2.6.1
.1.3.6.1.4.1.9.9.725.1.2.6.1.1
.1.3.6.1.4.1.9.9.725.1.2.6.1.10
.1.3.6.1.4.1.9.9.725.1.2.6.1.11
Enumeration
.1.3.6.1.4.1.9.9.725.1.2.6.1.2
.1.3.6.1.4.1.9.9.725.1.2.6.1.3
.1.3.6.1.4.1.9.9.725.1.2.6.1.4
.1.3.6.1.4.1.9.9.725.1.2.6.1.5
.1.3.6.1.4.1.9.9.725.1.2.6.1.6
.1.3.6.1.4.1.9.9.725.1.2.6.1.7
.1.3.6.1.4.1.9.9.725.1.2.6.1.8
.1.3.6.1.4.1.9.9.725.1.2.6.1.9
.1.3.6.1.4.1.9.9.725.1.3
.1.3.6.1.4.1.9.9.725.1.3.1
.1.3.6.1.4.1.9.9.725.1.3.1.1
.1.3.6.1.4.1.9.9.725.1.3.1.1.1
.1.3.6.1.4.1.9.9.725.1.3.1.1.10
.1.3.6.1.4.1.9.9.725.1.3.1.1.2
.1.3.6.1.4.1.9.9.725.1.3.1.1.3
.1.3.6.1.4.1.9.9.725.1.3.1.1.4
.1.3.6.1.4.1.9.9.725.1.3.1.1.5
.1.3.6.1.4.1.9.9.725.1.3.1.1.6
.1.3.6.1.4.1.9.9.725.1.3.1.1.7
.1.3.6.1.4.1.9.9.725.1.3.1.1.8
.1.3.6.1.4.1.9.9.725.1.3.1.1.9
.1.3.6.1.4.1.9.9.725.1.4
Bits
.1.3.6.1.4.1.9.9.725.1.4.1
Enumeration
.1.3.6.1.4.1.9.9.725.1.4.2
.1.3.6.1.4.1.9.9.725.1.4.3
.1.3.6.1.4.1.9.9.725.2
.1.3.6.1.4.1.9.9.725.2.1
.1.3.6.1.4.1.9.9.725.2.2
Dependencies (7) 7 direct Show tree and compile order Hide dependency details

Each imported module is resolved in the importing module's source directory first, then through the normal default-variant rules.

Dependency tree
Dependency-first compile order
  1. SNMPv2-SMIrfc
  2. CISCO-SMIcisco
  3. SNMPv2-TCrfc
  4. CISCO-TCcisco
  5. INET-ADDRESS-MIBrfc
  6. SNMPv2-CONFrfc
  7. SNMP-FRAMEWORK-MIBrfc
  8. CISCO-SMART-INSTALL-MIBciscoselected
Conformance Groups (8)
A collection of objects used for director configurations.
.1.3.6.1.4.1.9.9.725.2.2.1
A collection of objects related to configuration file backup
feature.
.1.3.6.1.4.1.9.9.725.2.2.2
A collection of objects related to the Join Window.
.1.3.6.1.4.1.9.9.725.2.2.3
A collection of objects which are used to configure the profile
for clients.
.1.3.6.1.4.1.9.9.725.2.2.4
A collection of objects that provide information about devices
in a Smart Install network.
.1.3.6.1.4.1.9.9.725.2.2.5
A collection of objects for controlling (enabling/disabling)
notifications to a management application.
.1.3.6.1.4.1.9.9.725.2.2.6
A collection of notifications in this MIB module.
.1.3.6.1.4.1.9.9.725.2.2.7
A collection of objects used for notifications.
.1.3.6.1.4.1.9.9.725.2.2.8
Compliance Statements (1)

OID .1.3.6.1.4.1.9.9.725.2.1.1
Describes the requirements for conformance to the
CISCO-SMART-INSTALL-MIB module.
Required groups
mandatory ciscoSmartInstallGlobalConfigGroup
mandatory ciscoSmartInstallDeviceInformationGroup
optional ciscoSmartInstallConfigBackupGroup The ciscoSmartInstallConfigBackupGroup is optional.
optional ciscoSmartInstallJoinWindowGroup The ciscoSmartInstallJoinWindowGroup is optional.
optional ciscoSmartInstallProfileGroup The ciscoSmartInstallProfileGroup is optional.
optional ciscoSmartInstallNotificationEnableGroup The ciscoSmartInstallNotificationEnableGroup is optional.
optional ciscoSmartInstallNotificationsGroup The ciscoSmartInstallNotificationsGroup is optional.
optional ciscoSmartInstallNotifyVarsGroup The ciscoSmartInstallNotifyVarsGroup is optional. if
ciscoSmartInstallNotificationsGroup is supported, this group
must be implemented.
Object refinements
ObjectAccessSyntaxDescription
csiOperationMode readonly
Write access is not required.
csiDirectorIpAddressType readonly
Write access is not required.
csiDirectorIpAddress readonly
Write access is not required.
csiManagementVlansFirst2K readonly
Write access is not required.
csiManagementVlansSecond2K readonly
Write access is not required.
csiBackupHostUrl readonly
Write access is not required.
csiBackupEnable readonly
Write access is not required.
csiJoinWindowConfigOperationMode readonly
Write access is not required.
csiJoinWindowPeriodStartTime readonly
Create/Write access is not required.
csiJoinWindowPeriodInterval readonly
Create/Write access is not required.
csiJoinWindowPeriodRecurrencePattern readonly
Create/Write access is not required.
csiJoinWindowPeriodExpirationDate readonly
Create/Write access is not required.
csiJoinWindowPeriodStorageType readonly
Support for read-create access is not required.
csiJoinWindowPeriodRowStatus readonly
active(1)
Support for 'createAndWait' is not required.
csiImageFileUrl readonly
Write access is not required.
csiConfigFileUrl readonly
Write access is not required.
csiHostnamePrefix readonly
Write access is not required.
csiProfileGroupName readonly
Create/Write access is not required.
csiProfileImageUrl readonly
Create/Write access is not required.
csiProfileImageTwoUrl readonly
Create/Write access is not required.
csiProfileConfigUrl readonly
Create/Write access is not required.
csiProfileStorageType readonly
Support for read-create access is not required.
csiProfileRowStatus readonly
active(1)
Support for 'createAndWait' is not required.
csiMatchGroupType readonly
Create/Write access is not required.
csiMatchProductId readonly
Create/Write access is not required.
csiMatchSwitchNum readonly
Create/Write access is not required.
csiMatchSwitchProductId readonly
Create/Write access is not required.
csiMatchHostAddressType readonly
Create/Write access is not required.
csiMatchHostAddress readonly
Create/Write access is not required.
csiMatchHostInterface readonly
Create/Write access is not required.
csiMatchMacAddress readonly
Create/Write access is not required.
csiMatchStorageType readonly
Support for read-create access is not required.
csiMatchRowStatus readonly
active(1)
Support for 'createAndWait' is not required.
csiNotifEnable readonly
Write access is not required.
Notifications / Traps (4)
NameOIDDescription
.1.3.6.1.4.1.9.9.725.0.1
This notification is generated when the director operation
mode changes. csiOperationMode indicates the director
operation mode.
.1.3.6.1.4.1.9.9.725.0.2
This notification is generated when a network device joins the
Smart Install network.

csiDeviceName indicates the device host name.
csiDeviceAddressType indicates the device Internet address
type.
csiDeviceAddress indicates the device Internet address.
csiDeviceMacAddress indicates the device MAC address.
.1.3.6.1.4.1.9.9.725.0.3
This notification is generated when director loses connectivity
to a device.

csiDeviceName indicates the device host name.
csiDeviceAddressType indicates the device Internet address
type.
csiDeviceAddress indicates the device Internet address.
csiDeviceMacAddress indicates the device MAC address.
.1.3.6.1.4.1.9.9.725.0.4
This notification is generated when a file upload or download
operation has failed.

csiDeviceName indicates the device host name.
csiDeviceAddressType indicates the device Internet address
type.
csiDeviceAddress indicates the device Internet address.
csiDeviceMacAddress indicates the device MAC address.
csiNotifOperationType indicates the file operation type.
csiNotifOperationResult indicates the file operation result.