Table of Contents

options attribute

Specifies a number of options separated by semicolons (;).

Content Type

string

Parent

Type

Remarks

In the options attribute, you can specify a combination of the following options, separated by semicolons (;).

columnTypes

Column type definitions. Only for parameters of type array or write and measurement type matrix.

Each column type has the following format: Parameterid:column indexes

  • First part: ID of the parameter containing the column type
  • Second part: columns identified by their 0-based column index

If you specify multiple column types, separate them by means of pipe characters (|).

If you specify multiple column indexes, separate them by commas.

You can also specify ranges of column indexes. In the example below, columns 0 to 20 and 35 have a column type as defined in parameter 2, and columns 21 to 34 and 36 have a column type as defined in parameter 3:

options="columnTypes=2:0-20,35|3:21-34,36"

connection=[x]

If there are several connections, then you can use this option to specify the connection to use.

Expected value: a number within the range [0, 32 767] or -1.

Default: value: -1 (meaning it applies to all relevant connections)

Example:

<Param id="1">
    <Name>STX</Name>
    <Type options="connection=0">header</Type>
    <Interprete>
        <RawType>other</RawType>
        <Type>string</Type>
        <LengthType>fixed</LengthType>
        <Length>3</Length>
        <Value>0x000x000x00</Value>
    </Interprete>
</Param>

dimensions=[rows,columns]

The dimensions of the parameter. Only for parameters of type array or write.

In the following example, the parameter has 128 rows and 1 column:

options="dimensions=128,1"

dynamic ip

In a protocol, you can dynamically assign an IP address and an IP port to an advanced port of a serial device.

In the example below, the IP address/port combination specified in parameter 400 is assigned to advanced port 1. To overrule the default connection, specify "dynamic ip" or "dynamic ip 0". To overrule a specific connection, you can for example specify "dynamic ip 2".

<Param id="400" trending="false" save="true">
    <Name>DynamicPollingIP</Name>
    ...
    <Type options="dynamic ip 1">read</Type>
    <Interprete>
        <RawType>other</RawType>
        <Type>string</Type>
        <LengthType>next param</LengthType>
    </Interprete>
    ...
</Param>

Parameter syntax: IP:PORT

If, in the parameter, you specify the value "10.12.0.63:4000", all communication will go via port 4000 of address 10.12.0.63.

If you do not specify a port, then the last port set will be used. If no port has been set yet, the port configured during element creation will be used.

Only applicable for parameters of type read.

Note
  • For smart-serial connections, dynamic polling is supported from DataMiner 10.3.11/10.4.0 onwards.
  • For HTTP connections, to poll an HTTPS server on a different port than 443, the "https://" prefix needs to be specified before the IP address as parameter value. The prefix that was configured during element creation will not be taken into account.

dynamic snmp get

With this option, an SNMP Get can be triggered dynamically when a parameter value changes.

Concept: A certain parameter contains an OID. When it changes, DataMiner looks for the closest match to determine the parameter to get. If a match is found, a get is executed on that parameter. If the parameter is an instance of a table, then the entire table is retrieved.

Protocol logic: When the value of the parameter has changed, a dynamic group containing a Get is added to the queue behind all other QActions and triggers associated with that same parameter.

Example:

In an SNMP protocol, you define the following two parameters:

  • Parameter 1, identified with OID 1.3.6.2
  • Parameter 2, defined as "dynamic snmp get"

When the value of parameter 2 changes to "1.3.6.2", a group like the following one is created in memory:

<Group id="1">
    <Type>poll</Type>
    <Content>
        <Param>1</Param>
    </Content>
</Group>

When, later on, the value of parameter 2 changes to "1.3.6.", that same group is triggered again.

In the communication stream, you will notice the following entry:

Dynamic group for parameter 1 [triggered by 1.3.6.]
Note
  • Only applicable for parameters of type read.
  • This option is rendered obsolete by the dedicated dynamicSnmpGet attribute.

This option is only applicable for smart-serial connections. It defines a link between a header and a trailer parameter (see Data forwarding from SLPort to SLProtocol).

With this option, it is also possible to only specify a trailer (i.e. where no corresponding header has the same value specified for the headerTrailerLink option).

The value specified must be an unsigned integer number.

Example:

<Type options="headerTrailerLink=1">header</Type>
<Type options="headerTrailerLink=1">trailer</Type>
Important

Headers and trailers are by default applicable to all connections. We strongly recommend always using the headerTrailerLink option in combination with a specified connection. This will make sure those headers and trailers only apply to the specified defined smart-serial connection, because otherwise this can quickly cause unintended bugs and behavior.

<Type options="headerTrailerLink=1;connection=0">header</Type>"

linkAlarmValue=TRUE

With this option you can link externally generated alarms based on the alarm value. When there is an exact value match the alarms are linked, whether or not a root key has been specified.

Example:

options="LinkAlarmValue=TRUE"

linkAlarmValue=[xx]

With this option you can link alarms based on the value between the two specified characters.

Examples:

If you want alarms to be linked if the values between two brackets match:

options="LinkAlarmValue=()"

If you want alarms to be linked if the values between two dots match:

options="LinkAlarmValue=.."

loadOID

Used with multi-threaded timers to perform SNMP polling.

For more information, refer to Multi-threaded timers SNMP.

ssh pwd

Caution

Using this option is not recommended. It only supports connectors with a single SSH connection using the fixed port 22. Instead, link this parameter via the Password element.

This option specifies that this parameter holds the password for setting up SSH communication based on user credentials. When this option is used, there should also be another parameter that uses the "ssh username" option. The SSH connection is established by DataMiner itself, if the parameters are filled in correctly.

Only applicable for parameters of type read.

Important

Use the password option when this parameter is displayed. Using this option ensures greater security.

ssh username

Caution

Using this option is not recommended. It only supports connectors with a single SSH connection using the fixed port 22. Instead, link this via the Username element.

This option specifies that this parameter holds the username for setting up SSH communication based on user credentials. When this option is used, there should also be another parameter that uses the "ssh pwd" option. The SSH connection is established by DataMiner itself, if the parameters are filled in correctly.

Only applicable for parameters of type read.

ssh options

Caution

Using this option is not recommended. It only supports connectors with a single SSH connection using the fixed port 22. Instead, link this via the Identity element.

This option specifies that this parameter holds the path to the private key for setting up SSH communication based on public key authentication. This is an alternative way to set up an SSH connection (instead of user credentials).

The content of the "ssh options" parameter is as follows: key=C:\Users\User\.ssh\my_key_rsa;pass=passphrase

Only applicable for parameters of type read.

Propose changes