Reserved OIDs

Parameter OIDs in the set 0xFF00 to 0xFFFF are reserved for future protocol messages.  Apart from these, there are several other OIDs that have special significance in DashBoard.

 

Name

OID

Type

Constraint

Function

SUPPLIER_NAME*

0x0102

String

N/A

Name of the card manufacturer or OEM supplier (i.e. who customer should call for support).  Reported as a generic card parameter by SNMP.

PRODUCT_NAME**

0x0105

String

(32-bytes max)

N/A

The product name used to identify the card in DashBoard.  This name should not change.  For display purposes, an alternate name can be provided via OID 0xFF01.
Reported as a generic card parameter by SNMP.

SERIAL_NUMBER

0x0106

String

N/A

Unique serial number.

SOFTWARE_REV*+

0x010B

String

(20-bytes max)

N/A

This value is used by a card to report information about its software load.  The value should be meaningful to the people supporting the card.
Reported as a generic card parameter by SNMP.

FPGA_REV+

0x010C

String

N/A

This value is used by DashBoard compare software versions when uploading the Main Board FPGA Type (upload type 1).

OPTION_SOFTWARE_REV+

0x010D

String

N/A

This value is used by DashBoard compare software versions when uploading the Option Board Software Type (upload type 2).

OPTION_FPGA_REV+

0x010E

String

N/A

This value is used by DashBoard compare software versions when uploading the Option Board FPGA Type (upload type 3).

SMPTE_STATUS

0x0201

Int16

N/A

Card status to be reported via frame fault LEDs.

Value of 0 indicates no error.

Non-zero values indicate error state.

CURRENT_MILLIS

0x0205

Int16

N/A

Current consumption in milliamps at 12 V.

This may be used by the fan controller to adjust fan speed for high-current cards.

EDIT_PERMISSION

0x0601

Int16

Choice

 

Tells DashBoard that the card is editable.  If this OID is used, parameters on the card will be editable only if the parameter value is 0.  If the parameter value is non-zero, the card will display as read-only.

NAME_OVERRIDE

0xFF01

String

N/A

With a widget hint of 0, the value in this String will be appended to the device name (0x0105) when displayed in the DashBoard tree and tabs.  With a widget hint of 1, the value in this String will be displayed instead of the value in 0x0105 in the DashBoard tree and tabs.

CONNECT_VERIFY

0xFF03

Mixed

N/A

This parameter is used for communicating DashBoard’s connection handshake and response.  See the Connection Management section for more details.

UPLOAD_URL

0xFF02

String

N/A

Alternate file upload target.  This overrides the behavior of the DashBoard upload button.

If this value is “disable”, DashBoard will disable the upload button on the device page.

If this value is a valid URL, DashBoard will upload files to this location via HTTP POST.

FRAME_ID

0xFF04

String

N/A

Reserved for use by an openGear frame’s Network Interface Card.  If this parameter is provided, its value MUST match the unique ID provided by SLP and manual SLP attribute queries.  If it does not, DashBoard will close its connection to the frame.

BACKWARDS_COMPATIBILE

0xFF05

String

(20-bytes max)

N/A

Specifies the lowest software version to maintain OID-compatibility with this software version.  If this OID is not supplied, the lowest software version is assumed to be the version specified in the SOFTWARE_REV OID (0x010B).

 

The card guarantees that all software versions bounded by the version numbers specified between 0xFF05 and 0x010B can be restored using the same stored set of parameter values.

RESTORE_SET_DELAY

0xFF06

Int16

N/A

Specifies the delay to use between each parameter set request during a card restore.  The restore set messages will not be sent any faster than the specified delay.  This number must be between 0 and 1000 milliseconds.

 

If this value is not specified, a default of 0 is used.  Parameters will be restored as quickly as the card can process the PARAM_SET commands.

 

If the value is -1, DataSafe is disabled for this card.  Other negative values are not valid at this time and should not be used.

RESTORE_START

0xFF07

Int16

N/A

A parameter set request with a value of 1 will be sent to this parameter before the card data is restored (the equivalent of a button press in DashBoard).

 

If this parameter is provided, its position in the list of OIDs returned by the OGP_GET_PARAM_OIDS Response defines where the range of saved parameter values should start.  No parameters whose OID was returned before this OID will be restored by DataSafe.

 

RESTORE_STOP

0xFF08

Int16

N/A

A parameter set request with a value of 1 will be sent to this parameter after the card data is restore is complete (the equivalent of a button press in DashBoard).

 

If this parameter is provided, its position in the list of OIDs returned by the OGP_GET_PARAM_OIDS Response defines where the range of saved parameter values should stop.  No parameters whose OID was returned after this OID will be restored by DataSafe.

DATASAFE_NAME

0xFF09

String

N/A

Alternative card name for determining DataSafe compatibility.  See DataSafe section for more details.

UPLOAD_NAME

0xFF0A

Int16

Choice

Alternative card name for file upload purposes.

See DataSafe section for more details.

DISPLAY_OPTIONS

0xFF0B

Int16

ARRAY

 

Each array element is used to define a different display option.

 

Element 0 controls display of the card:

0 (Default) = Display the card in the tree view

1 = Hide the card in the tree view

 

Element 1 controls the display of the slot name before the card name:

0 (Default) = Display the slot name  (e.g. Slot 1: UDC-8225-W)

1 = Hide the slot name (e.g. UDC-8225-W)

 

All other array elements are reserved for future use.

DEVICE_ICON

0xFF0C

Int16

N/A

Contains an external object ID for an encapsulated icon.  See table 3.15 for encoding information.

DEVICE_INDEX_URL

0xFF0D

String

N/A

URL for a DashBoard Connect XML Definition.

OGLML_DESCRIPTOR

0xFF0E

String

N/A

Provides an OGLML URL that describes a layout to use in place of the standard configuration screen in DashBoard.

DEDICATED_CONNECTION

0xFF0F

Binary

N/A

Allows a card that has its own Ethernet port to communicate directly with DashBoard, bypassing the CAN bus and MFC card.  This allows traffic offloading from the CAN bus, and also allows messages to be sent to specific DashBoards rather than all of them.

 

When connected, DashBoard will use this connection to send all messages to the card.  DashBoard will continue to receive updates from both the dedicated OGP connection and the CAN Bus connection.

 

UTF-8 String for the hostname

UINT16 for the port

UINT8 for the use

0 = Do not use

1 = Connect when UI is visible

DEVICE_IP_ADDRESS

0xFF10

Int32

IP_ADDRESS

Cards that have their own Ethernet port should use this OID to report their current IPv4 address.

FAN_SPEED_REQUEST

0xFF11

Int16

N/A

Used by cards in OG3-FR high power frame to request additional fan cooling. Card must send OGP_REPORT_PARAM for this OID periodically (not to exceed once per minute). Value of the parameter varies depending on the cooling capabilities of the frame.

OCCUPIED_SLOTS

0xFF12

Int16

N/A

Report the number of slots this card occupies.

Value consists of two 8-bit fields, representing the number of additional slots to the left and right.

Value = (left << 8) | (right)

UPLOAD_FILE_EXTENSIONS

0xFF13

String Array

N/A

Extensions of file types allowed to be sent to the device.  Arrau elements have the format: “[Description]<ext:[extension without dot]>”

RESERVED

0xFF14

to 0xFFFF

Reserved for future use

RESERVED

0xFF14

to 0xFFFF

Reserved for future use

 

** Required by DashBoard and SNMP.

*  Required for SNMP.

+  Version numbers are important for software uploads and DataSafe.  Please review section 5-9 for recommended version number encodings.

SMPTE_STATUS, CURRENT_MILLIS, and EDIT_PERMISSION are optional, but to avoid misinterpretation, these OIDs should not be used for other parameters.