System variables for the iSTAR driver

System variables for the iSTAR driver lists system variables used to define various settings for the iSTAR driver.

Note: If an iSTAR driver variable requires a driver restart for changes to take effect, that is documented in its description in the System Variables list.
Table 1. System variables for the iSTAR driver
System Variable Name Description Value Type Default Value

iSTAR Host Port

iSTAR host TCP/IP port number

The value must be between 1024 and 49151.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

2800

Queue Priority Threshold

Determines that stored messages are designated as high priority when the iSTAR is offline. When the iSTAR resumes service, messages assigned a high priority are sent to the host before low priority messages. The larger the threshold value, the higher the message priority.

The value must be between 0 and 210.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

100

Escort Count The value must be between 0 and 999. Numeric 200

Message Encryption

For iSTAR Classic and iSTAR Pro, indicates if iSTAR messages are encrypted, as follows:

0 Not encrypted

2 Encrypted.

iSTAR Classic and iSTAR Pro use 128 bit RC4 encryption. You can employ AES 256 bit encryption when you use Software House specified routers.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

0

Auto Sign Certificate non FIPS

Determines if the host automatically approves an encryption certificate on request. If True, the host digitally signs the certificate.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Boolean

False

Signed Certificate Expiring Days

Determines the amount of time, in days, until a signed encryption certificate expires.

The value must be between 1 and 10000. The default value (3653 days) is equivalent to 10 years.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

3653

Controller Certificate Signature Timeout

Determines the amount of time, in minutes, the certificate request is valid.

The value must be between 1 and 10000.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

8

Personnel Fast Download Port

Designates the port used for fast data downloads.

The value must be between 1024 and 2147483147.

Change to this value is applied only to iSTAR Pro/Classic. iSTAR EX and iSTAR Edge always use port 2801 for personnel fast download.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

2801

Firmware Fast Download Port

Designates the port used for fast download of firmware.

The value must be between 1024 and 2147483147.

Change to this value is applied only to iSTAR Pro/Classic. iSTAR EX and iSTAR Edge always use port 2802 for personnel fast download.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

2802

Enable Personnel Fast Download

Enables the Personnel Fast Download feature.

If True, Personnel Fast Download is enabled.

If False, Personnel Fast Download is not enabled.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Boolean

True

Specified Host IPV4 Address

(Formerly Vinca IP)

When using a multi-homed 9000 standalone server with multiple network adapters on multiple networks, use the Specified Host IP address of the adapter selected for IP communication. This ensures consistent communication with the iSTAR fast personnel download. Also, set the Specified Host IP address as the host address for the iSTAR controllers.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

IP address

0.0.0.0

Controller waits for connection

Designates the amount of time, in minutes, before the driver signals communication failure during startup, or when enabling the controller.

The value must be between 0 and 10000.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

60

Minutes between sending date and time

Designates the amount of time, in seconds, between the transmissions of the current date and time from the server to the iSTAR to ensure they are in sync.

The value must be between 1 and 1000.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

60

Number of iSTAR Regular Personnel Downloading Simultaneously

Number of iSTAR controllers that can have personnel downloaded to them at the same time. This variable is related to ordinary personnel downloads, not fast download.

The value must be between 1 and 50.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

10

iSTAR APB maximum ping round trip

Number of milliseconds ping response must arrive after ping sent for APB link to be declared “fast” again. Must be larger than minimum time required for a round trip message over link during normal utilization of network, otherwise communication cannot be restored. Must be larger than 250.

The value must be between 250 and 1800000.

Note: Change this value only in consultation with the Software House Customer Support Center. Incorrect settings can cause APB comm fail.

Numeric

500

iSTAR APB ping interval

Number of milliseconds iSTAR and host wait before sending APB ping on “slow” APB link (to master or host). This is also the minimum amount of time the iSTAR and host waits before attempting to re-establish APB comm over a link that has timed out.

The value must be between 1000 and 600000.

Note: Change this value only in consultation with the Software House Customer Support Center. Incorrect settings can cause APB comm fail.

Numeric

10000

iSTAR APB response timeout

Number of milliseconds iSTAR member waits for APB response from master. This is the amount of time a person sees Please Wait displayed at the reader. You must ensure that the time required for 3 round-trip messages over the link during normal utilization of the network is larger than the minimum time. Otherwise, communication cannot be restored. Must be larger than 1000.

The value must be between 1000 and 600000.

Note: Change this value only in consultation with the Software House Customer Support Center. Incorrect settings can cause APB comm fail.

Numeric

5000

Length of Reader Lockout after bad PIN retries reached

Number of seconds that door or elevator is disabled after the bad PIN retries value (set in the following system variable) has been reached.

The value must be between 0 and 99999.

Numeric

300

Number of bad PIN tries allowed before the door/elevator is disabled

Number of bad PIN tries allowed before the door or elevator is disabled. -1 (minus 1) disables the bad PIN try feature.

The value must be between -1 and 20.

Numeric

5

Maximum length of Command Code in keypad entry

Note: For further information about Keypad Commands, refer to the Keypad Commands chapter in the C•CURE 9000 Areas and Zones Guide.

The number of digits used for the “Command Code” part of the keypad entry.

The value must be between 1 and 9.

Numeric

9

Maximum length of Prompt 1 Code in keypad entry

Note: For further information about Keypad Commands, refer to the Keypad Commands chapter in the C•CURE 9000 Areas and Zones Guide.

The number of digits used for the “Prompt 1 Code” part of the keypad entry.

The value must be between 0 and 8.

Numeric

0

Maximum length of Prompt 2 Code in keypad entry

Note: For further information about Keypad Commands, refer to the Keypad Commands chapter in the C•CURE 9000 Areas and Zones Guide.

The number of digits used for the “Prompt 2 Code” part of the keypad entry.

The value must be between 0 and 8.

Numeric

0

Disable the Intrusion Zone Cabinet Tamper

If True, the Intrusion Zone Cabinet Tamper is disabled.

If False, the Intrusion Zone Cabinet Tamper is enabled.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Boolean

False

iSTAR Always Honor Event Delay

If set to 1, the iSTAR always honors the Event Activation Delay. Otherwise the Activation Delay is only honored the first time the event is activated. This affects when iSTAR re-executes the target actions of the event.

The value must be between 0 and 2147483147.

Numeric

0

iSTAR Unlock Clears Alarms

Changing the iSTAR door mode to “unlocked” clears the door forced or door held alarms even if the door is still open.

If set to 0 (the default), the door going into unlock mode does not clear these alarms, only closing the door clears the alarms.

If set to 1, the door going into unlock mode clears these alarms even if the door is open.

The value must be between 0 and 2147483147.

Numeric

0

Single EOL state input

If the Input is flagged on the Input Editor as activation = supervision and:

  • This switch is set to 1. Whenever the input is in an open loop state, it reports as an alarm.

  • This switch is set to 2. Whenever the input is in an open loop or line fault state, it also reports as an alarm.

This allows certain types of Input configurations to work better with Intrusion Zones without causing false Intrusion Zone violations.

The value must be between 0 and 2147483147.

Numeric

0

MDI type input

If this switch is set to 1 and the Input is flagged on the Input Editor as activation = supervision, input activation reports as a fault.

If the Input is configured as normally open and it is open loop, it reports as active. If the Input is configured as normally closed and it is shorted loop, it reports as active. Activate on supervision and normally open is otherwise ignored. Instead they only select that Inputs follow the above translations. All other states report untranslated.

The value must be between 0 and 2147483147.

Numeric

0

Software Switch 5

Reserved, do not change unless instructed to by the Software House Customer Support Center.

The value must be between 0 and 2147483147.

Numeric

0

Shunt Expire for RTE

If true, and the door is configured for "Always use shunt expire output" then the shunt expire relay activates for RTE (Request to Exit), momentary unlock and card accesses.

The value must be between 0 and 2147483147.

Numeric

0

RM reader reset on communication error

Whether or not the iSTAR causes an RM reader that loses communications to reset by not communicating to it for a period of time (about 16 seconds).

If set to 0 (the default), the iSTAR does not cause the RM reader to reset.

If set to 1, the iSTAR causes the RM reader to reset by not polling it for about 16 seconds

The value must be between 0 and 2147483147.

Numeric

0

iSTAR Activity Flags

If the value is set to 1, then disarmed inputs does not report hardware state changes from active to inactive or inactive to active, reducing the load on the system. If the value is set to 3, disarmed inputs in Intrusion Zones reports such hardware state changes.

Numeric

0

Software Switch 11 - Intrusion Zones: Disarm within Intrusion Zone and on exit card swipe

Reserved, do not change unless instructed to by the Software House Customer Support Center.

The value must be between 0 and 2147483147.

Numeric

0

Software Switch 12 - APB ‘pending card’ clear time

Reserved, do not change unless instructed to by the Software House Customer Support Center.

The value must be between 0 and 2147483147.

Numeric

0

Software Switch 13 - Soft Occupancy

Reserved, do not change unless instructed to by the Software House Customer Support Center.

The value must be between 0 and 2147483147.

Numeric

0

Software Switch 14 - Ultra firmware downgrade

Reserved, do not change unless instructed to do so by the Software House Customer Support Center.

The value must be between 0 and 2147483147.

Numeric

0

Software Switch 15

Reserved, do not change unless instructed to by the Software House Customer Support Center.

The value must be between 0 and 2147483147.

Numeric

0

Software Switch 16

Reserved, do not change unless instructed to by the Software House Customer Support Center.

The value must be between 0 and 2147483147.

Numeric

0

Software Switch 17

Reserved, do not change unless instructed to by the Software House Customer Support Center.

The value must be between 0 and 2147483147.

Numeric

0

Software Switch 18

Reserved, do not change unless instructed to by the Software House Customer Support Center.

The value must be between 0 and 2147483147.

Numeric

0

Software Switch 19

Reserved, do not change unless instructed to by the Software House Customer Support Center.

The value must be between 0 and 2147483147.

Numeric

0

Software Switch 20

Reserved, do not change unless instructed to by the Software House Customer Support Center.

The value must be between 0 and 2147483147.

Numeric

0

Multiple Flashing Reader LEDs Rotate

Enables a Reader that needs to flash more than one color of LED at a time (for a door in alert, for example) to flash them in sequence: first red, yellow, then green. This supports bi-color or tri-color LEDs when all colors cannot be flashed at once.

If True, the reader flashes the LEDs in the sequence described above.

If False, the reader does not flash the LEDs in the described sequence.

Boolean

False

Use Auto ACM Reset

Enables the iSTAR Controller to use the ‘Auto ACM Reset’ setting instead of the jumper on the ACM board.

If True, the iSTAR controller uses the ‘Auto ACM Reset’ setting.

If False, the iSTAR controller uses the jumper on the ACM board.

Boolean

False

Auto ACM Reset

Enables the iSTAR controller, if it has determined that communication is lost with all readers on an ACM, to re-set the ACM hardware to try to clear any error.

If True, the iSTAR controller re-sets the ACM hardware to try to clear any error.

If False, the iSTAR controller does not re-set the ACM hardware to try to clear any error.

Boolean

False

Clean up idle socket

Time out value in seconds for defining socket in idle state.

If set to 0 (the default), the iSTAR driver does not clean up the idle socket.

If set to 1 or greater, the iSTAR driver cleans up the idle socket.

The value must be between 0 and 1000.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

0

iSTAR Reader LED Beep Patterns

Set 1 for standard patterns. Set 2 for standard patterns with audible indications. Set 3 for alternate LED patterns with audible indications.

The value must be between 1 and 3.

Note: The reader controls the timing of the LED and beeps for the RM 4000 only.

Issues

  • HID readers have only one-bi-color LED. It is controlled by two active leads, one for red and one for green. But, by turning on both red and green, an amber light of sorts is achieved. The RM/RM4E has 3 independent LEDS, and can present more options than the HID reader. The above is standard behavior and is currently available by appropriate configuration of reader and ACM Board.

  • Most of the conditions have 2 possible LED pattens, configurable by the user, the idle pattern is set by one configuration choice, and the alternate access grant or deny patterns by another, and the alarm patterns by a third configuration choice. In the table the default pattern comes first.

  • The iSTAR ACM board can control the beeper inside the readers but the ACM board cannot do the LED patterns correctly.

  • The RM4e board can control the LEDs correctly but it cannot control the beeper.

See Software House readers for beeper & LED patterns.

Numeric

1

Always Track Personnel

If True, the Area location of personnel is always tracked at the controller or panel.

If False, the Area location of personnel is not tracked at the controller or panel, unless anti-passback is configured.

Boolean

True

iSTAR Activity Message Queue Size

Specifies the size of the queue for storing off-line host activity messages. The greater the number, the less iSTAR memory and object storage available for normal use. If the number is greater than 50000, the iSTAR must have a 64M-memory configuration.

The value must be between 10,000 and 500,000.

Note: You must stop and restart both the host driver and iSTAR driver to have any changes you make to this variable take effect.

Numeric

10000

Minimum Occupancy Exit Option

Enables personnel to exit an Area configured for restricted Minimum Occupancy if the iSTAR resets, that resets the Area count to 0 (zero).

If True, the iSTAR permits the personnel inside the area to exit.

If False, the iSTAR does not permit the personnel inside the area to exit, unless the area count is reset correctly.

Note: In either case, the area may have an incorrect count that should be reset manually

Boolean

True

Journal Occurrence Difference Range

For a journal message, if the iSTAR driver-received time and the activity-occurred time differ less than the entered value (in seconds), only iSTAR driver-received time displays in the Monitoring Station and journal view.

The value must be between 0 and 60.

Numeric

0

Maximum Visitor Count

You can use the Maximum Visitor Count to indicate the maximum number of escorted visitors that a single designated escort can escort through a door.

The value must be between 0 and 100. If this value is set to zero [0], Escorted Access functionality is disabled in the system. Anyone can go anywhere, subject to the regular access control checks.

Numeric

10

iSTAR Global Antipassback Communication Failure Mode

Global anti-passback operation when the controllers are in communication failure mode.

The value must be between 0 and 2.

  • No Access Mode = 0 – Non-owner iSTAR controllers do not admit unless they can communicate with the iSTAR owner controller.

  • Local Mode = 1 – iSTAR controllers make a decision based on locally available information or admit if that information is insufficient.

Numeric

0

Host Global Antipassback Response Timeout

Number of milliseconds host waits for global anti-passback response from iSTAR.

  • Must be less than 'iSTAR Global Antipassback response timeout'.

  • Must be larger than minimum time required for a round trip message over link during normal utilization of network. Otherwise, communications cannot be restored.

  • Must be larger than 1000.

The value must be between 1000 and 60, 000.

Note: Change this value only in consultation with the Software House Customer Support Center. Incorrect settings can cause APB comm fail.

Numeric

2000

iSTAR Global Antipassback Response Timeout

Number of milliseconds iSTAR master waits for Global Antipassback response from host.

  • Must be less than 'iSTAR APB response timeout'.

  • Must be larger than minimum time required for 2 round trip messages over link during normal utilization of network. Otherwise, communications cannot be restored.

  • Must be larger than 1000.

The value must be between 1000 and 60, 000.

Note: Change this value only in consultation with the Software House Customer Support Center. Incorrect settings can cause APB comm fail.

Numeric

4000

Display person in admitted access messages only when PIN used after card swipe.

Select this option to specify that personnel information is not logged in the journal message for valid access without a PIN for all iSTAR doors. If an access does not require a PIN, the access is logged without the personnel Information.

Boolean

False

Allow Web Server for Ultra Firmware Download

Ultra controller firmware downloads using the web server.

If True, the firmware is downloaded using the web server.

If False, the firmware is not downloaded using the web server.

Boolean

False

After-Hours Antipassback Exempt

If True, the Antipassback Exempt flag for personnel also exempts the person from After Hours Restriction.

If False, the person is not exempt.

The default for this feature is False. Restart the iSTAR driver for a change to take effect.

Boolean

False

Number of Consecutive Rejects Cause Event

Set this variable to specify the number of consecutive rejects. This causes a message to appear on the Monitoring Station and trigger an optional event. The value must be between 0 and 100. If set at zero, the feature is disabled. Restart the iSTAR driver for a change to take effect.

Numeric

0

Reader Consecutive Rejects Timer

Number in seconds before the consecutive rejects timer resets automatically. The value must be between 0 and 86400. If set at zero, the feature is disabled. Restart the iSTAR driver for a change to take effect.

Numeric

0

Number of iSTAR Ultra Controllers fast personnel downloading simultaneously

Sets the number of iSTAR Ultra controllers that can simultaneously download personnel.

Numeric

5

Specified Host IPV6 Address

Host IPV6 TCP/IP address used to communicate with iSTAR controller. iSTAR driver restart required before modified setting takes effect.

Numeric

Specified Host IPV6 Address

You can use this variable to specify the TCP/IP address used to communicate with the iSTAR when you install the iSTAR and the host controller on different networks isolated by a firewall.

If you do not enter a value for the variable, C•CURE 9000 attempts to identify the IPv6 address. If it does not identify the correct address, you must type a valid format for this variable. IPv6 addresses are 128 bits, and typically have the following format: 2001:0db8:0000:0000:0000:ff00:0042:8329

You can also enter an abbreviated version of the IPV6 address.

For more information about IPv6 supported controllers, refer to the C•CURE 9000 Hardware Configuration Guide.

Note: You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

IP address

:::0

Area Timed Passthrough Grace Time

Duration of Grace from a Timed Area Passthrough lock-in. Value in minutes.

Numeric

60

Auto Sign Certificate (TLS 1.3)

When this value is set to True, the iSTAR driver automatically signs TLS 1.3 certificates that are requested from the controller.

You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Boolean

True

Signed Certificate (TLS 1.3) Expiring Days

Signed certificate expiring in days for controller supporting TS 1.3 . The minimum value is 1 day, and the maximum value is 10,000.

You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

3653

Controller Certificate (TLS 1.3) Signature Timeout

Controller Certificate Signature Timeout in minutes for controller supporting TLS 1.3. The minimum value is 1, and the maximum value is 10.

You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

8

High activity input detection period

High activity input detection time window size (minutes). For a given iSTAR input, the iSTAR driver uses this time window to detect high activity input. The minimum value is 0, and the maximum value is 60.

Numeric

5

High activity input threshold

High activity input threshold. For a given iSTAR input, if the total number of its activities is greater than the threshold, the input will be declared as a high activity input. The minimum value is 10, and the maximum value is 10,000.

Numeric

500

Number of days before certificate expired

If the controller's expiration date is within this value, iSTAR driver will create a journal record to remind the user. The minimum value is 1, and the maximum value is 1000.

You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

14

Intrusion Zone Debounce

The length of time in seconds for an intrusion zone debounce. The minimum value is 0, and the maximum value is 120.

You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

4

Number of iSTAR controllers in a Pod doing simultaneous fast personnel download

Note: This variable is used only in a Data Center environment.

The number of iSTAR Controllers in each Pod performing simultaneous fast personnel downloads. The minimum value is 1, and the maximum number is 50. The system-wide total number of simultaneous fast downloads is the value of this variable multiplied by the number of Pods in your system.

You must stop and restart the iSTAR driver to have any changes you make to this variable take effect.

Numeric

5

Maximum iSTAR panel connections per pod

Note: This variable is used only in a Data Center environment.

This variable controls the maximum number of panel connections that are allowed in a single iSTAR driver pod. The exact number of panels running in each pod can vary slightly from this value.

You must restart the pod for the new value to take effect.

Numeric

500

CPNI Timeout

For any iSTAR panel in the TLS 1.3 channel, the iSTAR Driver uses this variable to check the duration of a timeout in seconds and detect if the panel is offline.

The default value is 0. If the value is set to 0, the feature is disabled.

The TimeoutCPNI variable is linked to the controller waits for connection variable. For example, if controller waits for connection is set to 1 second and TimeoutCPNI is set to 8 seconds, iSTAR driver detects if the panel is offline after 9 seconds.

Numeric

0

Disable Person Pin Failure

If a personnel enters multiple incorrect PINs for a card, this variable automatically disables the personnel after a specific number of incorrect PIN attempts. It also sends an iSTAR Controller Security Activity message to the Journal and disables the personnel.

To re-enable the personnel, locate the personnel record on the Administration Station and, on the General tab, clear the Disabled check box.

Note: The iSTAR panel must be online to disable a personnel and send the journal message. The default value is three PIN attempts. If you set the variable to 0, the variable does not disable personnel after incorrect PIN attempts.

Numeric

3

PIN failure period Duration of time, in seconds, that PIN failures are monitored for.

Numeric

300