CISCO-DEVICE-LOCATION-MIB: View SNMP OID List / Download MIB

This MIB is used for managing location information of end point devices(Telepresence, IP Camera, Digital media player etc) connected to switches/routers. This location information is then carried from the switch/router to the end point via Cisco Discovery protocol (CDP) or Link Layer Discovery protocol (LLDP). The location information can be used by applications such as Cisco Video Surveillance Manager, digital media manager. Civic location information as described in RFC 4676, identifies the exact location information like state, city, building, floor that helps identify the exact location of the devices. Definitions: ============ LocationTarget: This is identified by a target type (interface, IP session) and target identifier (ifIndex, IP address). MIB Table Overview: =================== This MIB consists of five tables: 1) cdlLocationTable 2) cdlCivicAddrLocationTable 3) cdlCustomLocationTable 4) cdlGeoLocationTable 5) cdlLocationPreferWeightTable The cdlLocationTable provides information about location information of LocationTarget. cdlCivicAddrLocationTable provides the details about the civic address types like state, county, city for a given LocationTarget. cdlCustomLocationTable provides the ability to associate arbitrary name/value pairs with a LocationTarget. This allows for specification of information which is not currently included into the standard definition of Civic address types. cdlGeoLocationTable provides Geolocation (GPS) coordinate information for a LocationType. cdlLocationPreferWeightTable provides information about, and a method for configuring, the order in which the system makes use of location information which is provided by different sources. The following provides a sample view of the contents of the table and the relationship between them. cdlLocationTable ------------------------------------------------ Location Sub Country Target Target Index TypeCap Code Type Identifier ------------------------------------------------- - 1 Civic Addr 01 Interface 1 | 2 Civic Addr 01 Interface 2 | | | cdlCivicAddrLocationTable | ---------------------------------------- | Location Location Location | Index Type Index Value | ----------------------------------------- |_ _ _ _ 1 1 - State Karnataka |_ _ _ _ 1 2 - County Bangalore District |_ _ _ _ 1 3 - city Bangalore 2 1 - State Kerala 2 2 - County Waynad District 2 3 - city Waynad

A proprietary key to validate the application requiring access to the rest of the objects in this MIB. A read operation on this object would return NULL string.

This table lists different LocationTargets and associated location attributes (such as country code). The information in this table MUST be stored in non-volatile-memory and persist over restart and reboot sequences.

An entry describes the location attributes required to be configured for every LocationTarget in a device. An entry is created in this table when an interface is detected in this devices or an IP session is established. An entry is removed in this table when an interface is removed or an IP session is terminated.

Identifies the unique index assigned to a given LocationTarget. A LocationTarget is defined by cdlLocationTargetType and cdlLocationTargetIdentifier.

This object specifies the location subtypes that can be supported by a given LocationTarget. Following is the list of subtypes: noSubtypesConfigured(0) 0x0 - No location types configured geoLocation(1) 0x1 - GeoSpatial location information civic(2) 0x2 - Civic address location information. When this sub type is set then cdlCivicAddrLocationTable could have zero or more rows created. elin(3) 0x4 - ELIN location information custom(4) 0x8 - Custom location information For Example: If both 'civic' and 'elin' are supported on a given LocationTarget then the value of this object would be 0x110. Bits: 'geoLocation': 1, 'elin': 3, 'custom': 4, 'noSubtypesConfigured': 0, 'civic': 2.

Country code information applicable to a given LocationTarget

This object specifies the target type. The following are the possible values. interface(1) - The interface could be a physical interface or a virtual/logical interface. ipv4Addr(2) - An ipv4 address of a given session. Enumeration: 'interface': 1, 'ipv4Addr': 2.

This object specifies a unique identifier for a given cdlLocationTargetType in a given device. If the cdlLocationTargetType is set to 'interface', then the identifier would be the ifIndex. If the cdlLocationTargetType is set to 'ipv4Addr', then the identifier would the IP address.

This table lists civic address information of end point devices. This table has a sparse dependant relationship with cdlLocationTable. The information in this table MUST be stored in non-volatile-memory and persist across restart, reboot and switch-over sequences.

An entry in this table specifies civic address location information. One or more entries could be created for every entry in cdlLocationEntry with cdlLocationSubTypeCapability set to 'civic' type. If an entry in cdlLocationEntry is deleted then all all corresponding entries would be deleted in this table.

This object specifies the location types that can be configured/unconfigured on a LocationTarget. The following are all the possible types and a brief explanation for the same. state(1) - National subdivision (state) county(2) - County city(3) - City cityDivision(4) - City division neighborhood(5) - Neighborhood streetGroup(6) - Group of streets leadingStreetDirection(16) - Leading street direction trailingStreetDirection(17) - Trailing street direction streetSuffix(18) - Street suffix house(19) - House number streetNumber(20) - House number suffix landmark(21) - Landmark additionalLoc(22) - Additional location - information name(23) - Name of the resident zipcode(24) - Postal/Zip Code building(25) - Building name unit(26) - Unit floor(27) - Floor number room(28) - Room number place(29) - Place type postalCommunityName(30) - Postal community name postOffiiceBox(31) - PO Box additionalCode(32) - Additional code information seat(33) - Seat number primaryRoad(34) - primary road or street name roadSection(35) - Road section name roadBranch(36) - Road branch name roadSubBranch(37) - Road sub-branch name streetNamePreMod(38) - Street pre modifier name streetNamePostMod(39) - Street post modifier name Enumeration: 'roadSection': 35, 'postalCommunityName': 30, 'neighborhood': 5, 'streetNamePreMod': 38, 'house': 19, 'cityDivision': 4, 'seat': 33, 'county': 2, 'roadSubBranch': 37, 'postOffiiceBox': 31, 'leadingStreetDirection': 16, 'unit': 26, 'city': 3, 'floor': 27, 'trailingStreetDirection': 17, 'zipcode': 24, 'streetSuffix': 18, 'streetGroup': 6, 'roadBranch': 36, 'state': 1, 'room': 28, 'building': 25, 'name': 23, 'additionalLoc': 22, 'primaryRoad': 34, 'place': 29, 'streetNumber': 20, 'landmark': 21, 'additionalCode': 32, 'streetNamePostMod': 39.

This object specifies the civic address value for a given cdlCivicAddrLocationType. For Example: If cdlCivicAddrLocationType is of type 'building' then the string value representing this type would be the name of the building, like 'Building 23'.

This object specifies the storage type for this conceptual row.

This object will follow RowStatus Textual convention to create/destroy entries. The following columnar object is mandatory to make the entry 'active': cdlCivicAddrLocationValue

This table lists 'Custom' address information of end point devices, giving 'name' and 'value' pairs. This table has a sparse dependent relationship with cdlLocationTable. The information in this table MUST be stored in non-volatile-memory and persist across restart, reboot and switch-over sequences.

An entry in this table specifies 'Custom' address location information consisting of 'Name' and associated 'Value' pairs. One or more entries could be created for every entry in cdlLocationEntry with cdlLocationSubTypeCapability set to 'custom' type. If an entry in cdlLocationEntry is deleted then all corresponding entries would be deleted in this table.

This object specifies the 'Custom' address 'Name' for a given cdlCustomLocationEntry. The character string may contain space characters. Examples would be 'Department', 'Class room', etc.

This object specifies the 'Custom' address 'Value' for a given cdlCustomLocationEntry. For Example: If the cdlCustomLocationName were 'Department' then the 'Value' string may be 'Photography'.

This object specifies the storage type for this conceptual row.

This object will follow RowStatus Textual convention to create/destroy entries. The following columnar objects are mandatory to make the entry 'active': cdlCustomLocationValue cdlCustomLocationValue may be modified at any time (even while the row is active).

This table lists Geographic address information of end point devices. This table has a sparse dependent relationship with cdlLocationTable. The information in this table MUST be stored in non-volatile-memory and persist across restart, reboot and switch-over sequences.

An entry in this table specifies Geographic location information. An entry in this table is appropriate for any LocationEntry which has the cdlLocationSubTypeCapability bit presenting the 'geo' type set. If an entry in cdlLocationEntry is deleted then the corresponding entry would be deleted in this table.

This object specifies latitude of the end point device in degrees. An empty string means that latitude is not configured for this row.

This object specifies latitude resolution of the end point device in meters. This allows for specification of latitude resolution separately from other dimensions. If this resolution is non-empty, then it has precedence over cdlGeoResolution as the resolution attributed to cdlGeoLatitude.

This object specifies longitude of the end point device in degrees. An empty string means that longitude is not configured for this row.

This object specifies longitude resolution of the end point device in meters. This allows for specification of longitude resolution separately from other dimensions. If this resolution is non-empty, then it has precedence over cdlGeoResolution as the resolution attributed to cdlGeoLongitude.

This object specifies altitude of the end point device in units, as specified in cdlGeoAltitudeType. An empty string means that altitude is not configured for this row.

This object specifies the Geographic Location Altitude types which may be configured on a LocationTarget. The following are all the possible types as specified in the referenced RFC. meters(1) floors(2) Note that if the type is specified in 'feet' by other means of configuration for information denoted by this object, it will be reported in units of 'meters' here, in order to agree with the referenced RFC. Enumeration: 'floors': 2, 'meters': 1.

This object specifies altitude resolution of the end point device in the same units as that which cdlGeoAltitudeType specifies. This allows for specification of altitude resolution separately from other dimensions. If this resolution is non-empty, then it has precedence over cdlGeoResolution as the resolution attributed to cdlGeoAltitude.

This object specifies resolution of the end point device in meters. A resolution specified here will apply to latitude and longitude.

This object specifies the storage type for this conceptual row.

This object will follow RowStatus Textual convention to create/destroy entries. The following columnar objects are mandatory to make the entry 'active': cdlGeoLatitude cdlGeoLongitude All columnar objects may be modified at any time (even while the row is active).

This table lists the preference weights which are to be given to location information according the source of the information. Each possible source for location information has an assigned cdlLocationPreferWeightEntry with a unique cdlLocationPreferWeightType number. Each source has an entry in the table with an associated weight (cdlLocationPreferWeightValue). When information is retrieved for internal use, via SNMP, via CLI, etc., the information source associated with the lowest weight, and which contains the type of information requested, will be utilized.

An entry in this table specifies the Weight which is assigned to a particular source of Location information. All weight 'Value' fields need not add to 100. Location source priorities are simply sorted according to the values entered, with a lower number indicating a 'better' priority.

This object specifies the Location source weight type. The following source types are represented: static(1) - Statically configured via CLI or SNMP locp(2) - Location Control Protocol dhcp(3) - Dynamic Host Configuration Protocol lldp(4) - Link Layer Discovery Protocol cdp(5) - Cisco Discovery Protocol Enumeration: 'lldp': 4, 'dhcp': 3, 'locp': 2, 'static': 1, 'cdp': 5.

This object specifies the Weight to assign to a particular source of Location information. All weight 'Value' fields need not add to 100. Location information from sources are used according to the priority weight values entered, with a lower number indicating a 'better' priority.

The compliance statement for entities which implement the CISCO-DEVICE-LOCATION-MIB.

The compliance statement for entities which implement the CISCO-DEVICE-LOCATION-MIB.

A collection of location objects.

A collection of civic address location objects.

A collection of Custom location information objects.

A collection of Geographic location information objects.

A collection of location source preference objects.