Badge Property Reference

This section contains an alphabetical list of the most common badge properties. These property names appear in the badge.properties file. The list contains cross-references to the fields and pages you can use to set these properties in the Badge Properties Editor (BPE).

The properties for different types of Vocera badges have different names. In the badge.properties file, properties have the following prefixes:

Badge type Prefix

B3000n

B3N

B3000

B3

B2000

B2

Important: Badges have many properties that are for internal use only. Setting the wrong value or the wrong property can cause unrecoverable damage to a badge. Use the Badge Properties Editor to set property values unless you are working with Vocera Technical Support. Otherwise, do not set any properties other than the ones listed in this chapter.
Table 1. List of Badge Properties
Property Name Default Value Description
  • B2000:

    B2.AuthenticationType

  • B3000:

    B3.AuthenticationType

  • B3000n:

    B3N.AuthenticationType

Open

Specifies the type of authentication required by your wireless network:

  • Open specifies that your wireless network does not require authentication.

  • LEAP specifies that your wireless network implements the Cisco LEAP protocol for authentication.

  • WPA-PEAP specifies that your wireless network uses the WiFi Protected Access Protected Extensible Authentication Protocol for authentication.

  • WPA-PSK specifies that your wireless network uses the WiFi Protected Access Pre-Shared Key protocol for authentication.

  • EAP-FAST specifies that your wireless network uses Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling for authentication.

  • EAP-TLS specifies that your wireless network uses Extensible Authentication Protocol-Transport Layer Security for authentication.

Use the Authentication field on the Security tab of the Badge Properties Editor to set this value.

  • B2000:

    B2.BadgeIPAddr

  • B3000:

    B3.BadgeIPAddr

  • B3000n:

    B3N.BadgeIPAddr

Blank

Specifies a static IP address for the badge using standard dotted notation (such as 192.168.3.7). Leave this value blank if a DHCP server is assigning IP addresses.

If you are setting up badges for a production Vocera environment, allow a DHCP server to assign IP addresses to the badges. Static IP addresses are feasible only for small evaluation systems.

  • B2000:

    Not available

  • B3000:

    Not available

  • B3000n:

    B3N.DisplayBluetooth

FALSE

Specifies whether the Bluetooth configuration menu is displayed on the badge.

  • B2000:

    B2.BroadcastUsesIGMP

  • B3000:

    B3.BroadcastUsesIGMP

  • B3000n:

    Not available

FALSE

Vocera broadcast is implemented as IP Multicast. If broadcast commands need to cross a subnet, IGMP must be supported in the switch or router, and this property must be set to TRUE.

The B3000n badge auto-detects IGMP and changes its mode dynamically if IGMP is enabled in the infrastructure. Consequently, this property is deprecated in the B3000n badge.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.ChannelsToScan

  • B3000:

    B3.ChannelsToScan

  • B3000n:

    B3N.ChannelsToScan

Blank

Allows B3000n (on 2.4 GHz networks), B3000, and B2000 badges to scan up to four arbitrary channels when the signal quality drops. By default, badges scan only channels 1, 6, and 11 unless this property is set. To set this property, enter the specific channel numbers in a comma-separated list.

For optimal performance of the badge and other wireless clients, Vocera recommends that the access points on your network are set only to the three non-overlapping channels of 1, 6, and 11.

Use the Specify Channels field in the 2.4 GHz Channels section of the Wireless tab in the Badge Properties Editor to set this value.

  • B2000:

    Not available

  • B3000:

    Not available

  • B3000n:

    B3N.ChannelsToScan5G

Blank

Allows B3000n badges on 5 GHz networks to scan an arbitrary set of channels when the signal quality drops. By default, B3000n badges scan all available channels unless this property is set. To set this property, enter the specific channel numbers in a comma-separated list.

Use the Specify Channels field in the 5 GHz Channels section of the Wireless tab in the Badge Properties Editor to set this value.

  • B2000:

    B2.ClientKeyPassword

  • B3000:

    B3.ClientKeyPassword

  • B3000n:

    B3N.ClientKeyPassword

Blank

Specifies the password for the client private key. This is only needed if you are using external EAP-TLS certificates. The maximum length of the password supported by Vocera badges is 32 alphanumeric characters.

  • B2000:

    B2.ClosedMenus

  • B3000:

    B3.ClosedMenus

  • B3000n:

    B3N.ClosedMenus

FALSE

Specifies whether the badge configuration menus are hidden, or if they can be easily accessed through the DND button:

  • FALSE specifies that you can access the configuration menus by pressing the DND button within three seconds of the B3000, or B2000 badge displaying the boot countdown timer.

  • For B3000 and B2000 badges, TRUE specifies that you must use the special sequence of button presses to display the configuration menus.

  • To display the configuration menus on B3000n badges, press and hold the DND and Call buttons together while the countdown timer is displayed, regardless of the setting of this property.

With B3000 and B2000 badges, set this value to TRUE to prevent users from displaying the configuration menus and inadvertently causing configuration problems in a badge.

Use the Hide Boot Menus field on the General tab of the Badge Properties Editor to set this value.

  • B2000:

    B2.ConfigStaticIP

  • B3000:

    B3.ConfigStaticIP

  • B3000n:

    B3N.ConfigStaticIP

FALSE

Specifies whether your badge has a static IP address, or whether it receives its address from a DHCP server.

If a DHCP server is assigning IP addresses, leave this field blank. This value is necessary only if you are using static IP addresses.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.DNS1IPAddr

  • B3000:

    B3.DNS1IPAddr

  • B3000n:

    B3N.DNS1IPAddr

Blank

Specifies the IP address of the DNS server that your site uses to resolve DNS queries, in standard dotted notation.

If a DHCP server is assigning IP addresses, leave this field blank. This value is necessary only if you are using static IP addresses and the value of ServerIPAddr is specified as a DNS style name.

Note: This badge property is not available in the Badge Properties Editor.

  • B3000n/B3000/B2000:

    Not available

Blank

Specifies the IP address of the secondary DNS server that is used if the primary server is not available, in standard dotted notation.

If a DHCP server is assigning IP addresses, leave this field blank. This value is necessary only if you are using static IP addresses and the value of ServerIPAddr is specified as a DNS style name.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.EAPTLSUseExtCert

  • B3000:

    B3.EAPTLSUseExtCert

  • B3000n:

    B3N.EAPTLSUseExtCert

FALSE

Specifies whether to use external certificates instead of the Vocera Manufacturer Certificates. External certificates can be self-signed or signed by a trusted Certificate Authority (CA).

  • FALSE specifies that you are using the Vocera Manufacturer Certificates.

  • TRUE specifies that you are using external certificates. Additional configuration is required.

  • B2000:

    B2.EFAutoPACProvRetryCount

  • B3000:

    B3.EFAutoPACProvRetryCount

  • B3000n:

    B3N.EFAutoPACProvRetryCount

0

Limits the number of times a badge attempts to retry retrieving a PAC from the Cisco ACS after the first attempt failed (for example, due to wireless network problems). Enter a number from 0 to 5.

By default, this property is set to 0 (meaning no retries). In order to take advantage of this feature, you must also select EAP-FAST authentication.

  • B2000:

    B2.Enable80211d

  • B3000:

    B3.Enable80211d

  • B3000n:

    B3N.Enable80211d

FALSE

Specifies whether the badge will take advantage of the region-based channel selection capabilities of 802.11d.

  • FALSE specifies that region-based channel selection is disabled.

  • TRUE specifies that region-based channel selection is enabled.

In order to take advantage of this standard, your access points must also support it.

  • B2000:

    B2.EnableAPSD

  • B3000:

    B3.EnableAPSD

  • B3000n:

    Not available

FALSE

Specifies whether the badge will take advantage of the Unscheduled Automatic Power Save Delivery Subset (U-APSD) of 802.11e. U-APSD improves power management and potentially increases the talk time of 802.11 clients.

  • FALSE specifies that U-APSD is disabled.

  • TRUE specifies that U-APSD is enabled.

In order to take advantage of this standard, your access points must also support it.

Important: The B2.EnableAPSD, B3.EnableAPSD, B2.EnableWMM, and B3.EnableWMM properties should all be set to the same value.

The firmware and chip set changes in the B3000n badge make this property unnecessary. Consequently, this property is deprecated in the B3000n badge.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.EnableCCKM

  • B3000:

    B3.EnableCCKM

  • B3000n:

    B3N.EnableCCKM

FALSE

Specifies whether Cisco Certified Key Management is enabled for Vocera devices.

CCKM is a form of fast roaming supported on Cisco access points and on various routers. Using CCKM, Vocera devices can roam from one access point to another without any noticeable delay during reassociation. After a Vocera device is initially authenticated by the RADIUS authentication server, each access point on your network acts as a wireless domain service (WDS) and caches security credentials for CCKM-enabled client devices. When a Vocera device roams to a new access point, the WDS cache reduces the time it needs to reassociate.

  • FALSE specifies that CCKM is disabled.

  • TRUE specifies that CCKM is enabled.

In order to take advantage of this feature, your access points must also support it, and you must use either LEAP, WPA-PEAP, EAP-FAST, or EAP-TLS authentication.

  • B2000:

    B2.EnableEFAutoPACProv

  • B3000:

    B3.EnableEFAutoPACProv

  • B3000n:

    B3N.EnableEFAutoPACProv

FALSE

Enables automatic provisioning of the Protected Access Credential (PAC) for EAP-FAST authentication. This replaces the manual method of creating a new PAC on the Cisco ACS when it expires and then copying it to the Vocera Server and the Vocera configuration computer.

In order to take advantage of this feature, you must also select EAP-FAST authentication.

  • B2000:

    B2.EnableEFAutoPACProvOnExpiry

  • B3000:

    B3.EnableEFAutoPACProvOnExpiry

  • B3000n:

    B3N.EnableEFAutoPACProvOnExpiry

FALSE

Enables the automatic provisioning of a new PAC when it expires. If this property is unchecked, a badge whose PAC has completely expired will display the following message: "Expired or invalid PAC credentials."

In order to take advantage of this feature, you must also select EAP-FAST authentication.

  • B2000:

    B2.EnableFIPSMode

  • B3000:

    B3.EnableFIPSMode

  • B3000n:

    Not available

FALSE

When set to TRUE, this property causes the cryptographic security module to run in a secure mode that conforms with Federal Information Processing Standard (FIPS) 140-2.

  • B2000:

    B2.EnableWMM

  • B3000:

    B3.EnableWMM

  • B3000n:

    B3N.EnableWMM

FALSE

Specifies whether the badge will take advantage of the WiFi Multimedia (WMM) subset of 802.11e. 802.11e QoS provides standards-based QoS to prioritize voice over data traffic and ensure high level voice quality.

  • FALSE specifies that 802.11e QoS is disabled.

  • TRUE specifies that 802.11e QoS is enabled.

In order to take advantage of this standard, your access points must also support it, switches and routers must be configured to honor DSCP markings, and the Vocera QoS Manager service must be enabled on the Vocera Server.

Important: The B2.EnableAPSD, B3.EnableAPSD, B2.EnableWMM, and B3.EnableWMM properties should all be set to the same value.

If 802.11n is enabled on both the network and the B3000n badge (through the B3N.WirelessBand property), the B3000n takes advantage of WMM and ignores this property. In legacy 802.11n environments, you can continue to use this property for the B3000n badge. This property is not tied to the use of APSD for the B3000n.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.EncryptionType

  • B3000:

    B3.EncryptionType

  • B3000n:

    B3N.EncryptionType

None

Specifies the type of data encryption your wireless network requires.

  • None specifies your wireless network does not require encryption.

  • WEP64 specifies your network uses 64-bit (sometimes called 40-bit) WEP keys.

  • WEP128 specifies your network uses 128-bit (sometimes called 104-bit) WEP keys.

  • TKIP-Cisco specifies your network uses Cisco's proprietary TKIP encryption technique.

  • TKIP-WPA specifies your network uses TKIP as defined by WPA.

  • AES-CCMP specifies your network uses AES-CCMP as defined by WPA2.

Use the Encryption field on the Security tab of the Badge Properties Editor to set this value.

  • B2000:

    B2.GatewayIPAddr

  • B3000:

    B3.GatewayIPAddr

  • B3000n:

    B3N.GatewayIPAddr

Blank

Specifies the address of your gateway, if your LAN uses one, in standard dotted notation.

Make sure you specify a default DHCP gateway by manually editing this property in the badge.properties file (this property is not currently exposed in the Badge Properties Editor. Vocera uses this property for multicast sessions even when badges and the Vocera Voice Server are in the same VLAN.

  • B2000:

    Not available

  • B3000:

    B3.GroupModeState

  • B3000n:

    B3N.GroupModeState

1

Specifies whether Group Mode is turned on when users are on a call. Group Mode widens the speech zone, allowing other people to speak into the badge's primary microphone.

  • 1 specifies that Group Mode is enabled only while on a call.

  • 2 specifies that Group Mode is disabled to eliminate background noise when users are on a call. This setting is appropriate for noisy environments.

Note: B3000n and B3000 badge users can change the Group Mode setting on their badges.
  • For B3000: Group Mode is always off during Genie interactions and broadcasts.
  • For B3000n: Group Mode is automatically enabled when the badge is turned to a 105 degree angle to improve voice recognition when the badge is not placed in an optimal position.
  • B2000:

    Not available

  • B3000:

    B3.HeadsetButtonSupport

  • B3000n:

    B3N.HeadsetButtonSupport

FALSE

Specifies whether the in-line button on a wired headset is able to initiate or accept badge calls.

  • If this property is set to TRUE, a user can accept or initiate a call with either the headset button or the badge's Call button.
  • If this property is set to FALSE, a user must accept a call with the badge's Call button.

This property is not available for the B2000 badge. The B2000 supports wired headsets, but does not support the use of the headset buttons.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.InstallDone

  • B3000:

    B3.InstallDone

  • B3000n:

    B3N.InstallDone

FALSE

Specifies whether the Badge Configuration Utility has performed the initial configuration for a badge:

  • If this property is TRUE, the badge boots the normal Vocera application when it powers up.

  • If this property is FALSE, the badge attempts to connect to a machine at IP address 10.0.0.1 running the Badge Configuration Utility when it powers up. If successful, the badge downloads properties and firmware from the Badge Configuration Utility.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.ListenInterval

  • B3000:

    B3.ListenInterval

  • B3000n:

    B3N.ListenInterval

5

An access point broadcasts a management frame called a beacon at a fixed interval (required to be set to 100 ms by Vocera). The B2.ListenInterval property specifies the frequency with which badges "wake up" and listen for a beacon. When the beacon interval is 100 ms and B2.ListenInterval is 5, the default listen interval is 500 ms.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.Password

  • B3000:

    B3.Password

  • B3000n:

    B3N.Password

Blank

If AuthenticationType is set to LEAP, WPA-PEAP, or EAP-FAST, specifies the password the badge supplies for authentication.

Use the Password field on the Security tab of the Badge Properties Editor to set this value.

  • B2000:

    B2.PreSharedKey

  • B3000:

    B3.PreSharedKey

  • B3000n:

    B3N.PreSharedKey

Blank

If AuthenticationType is set to WPA-PSK, specifies the 64-character, hexadecimal pre-shared key the badge supplies for authentication. Use the PreShared Key field on the Security tab of the Badge Properties Editor to set this value.

The WPA-PSK standard uses a hexadecimal key to encrypt the association handshake. For B3000n and B3000 badges, you can enter the ASCII passphrase used by your wireless network. For other badges, enter a 64-character, hexadecimal value for the pre-shared key.

  • B2000:

    B2.ResetVolumeToDefault

  • B3000:

    B3.ResetVolumeToDefault

  • B3000n:

    B3N.ResetVolumeToDefault

FALSE

Specifies whether the badge resets the volume to the default at boot-up.

  • FALSE specifies that the badge maintains the previous volume setting at boot-up.

  • TRUE specifies that the badge resets the volume to the default at boot-up.

  • B2000:

    B2.RoamingPolicy

  • B3000:

    B3.RoamingPolicy

  • B3000n:

    B3N.RoamingPolicy

2

Specifies how quickly a badge searches for another access point when signal quality drops. Higher values cause a badge to search sooner, and may correct problems with choppy audio. However, a badge cannot send or receive audio packets while searching for an access point, so communication may be interrupted. Lower values allow a badge to tolerate lower signal quality before searching. The optimal threshold value varies from one 802.11 network to another, depending on how the network is configured.

Use the Roaming Policy field on the Wireless tab of the Badge Properties Editor to set this value.

  • B2000:

    B2.ServerIPAddr

  • B3000:

    B3.ServerIPAddr

  • B3000n:

    B3N.ServerIPAddr

Blank

Specifies the IP address of the machine which is running the Vocera server. Use dotted notation (such as 192.168.3.7) to specify this value. For a Vocera Server cluster, enter multiple IP addresses and separate them with commas. You must specify a value for this property.

Use the Vocera Server IP Address field on the General tab of the Badge Properties Editor to set this value.

  • B2000:

    B2.SSID

  • B3000:

    B3.SSID

  • B3000n:

    B3N.SSID

vocera

Specifies the SSID of the wireless network or subnet the Vocera badges will use. This value is case sensitive. You must specify a value for this property.

Use the SSID field on the General tab of the Badge Properties Editor to set this value.

  • B2000:

    B2.SubnetMask

  • B3000:

    B3.SubnetMask

  • B3000n:

    B3N.SubnetMask

Blank

Specifies a subnet mask that indicates which bits in the IP address correspond to the subnet, using standard dotted notation (such as 255.255.255.0). You must specify this property if you are using static IP addresses. Leave this value blank if a DHCP server is assigning IP addresses.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.SubnetRoaming

  • B3000:

    B3.SubnetRoaming

  • B3000n:

    B3N.SubnetRoaming

FALSE

 

FALSE

 

FALSE

Specifies whether users can roam across subnet boundaries while using badges.

If subnet roaming is enabled, a badge automatically obtains a new IP address as a badge user makes the transition to an access point on a different subnet. If you enable subnet roaming, you must use a DHCP server to supply your IP addresses.

Set this property to TRUE only if the access points on your wireless LAN are divided into multiple subnets, and if you want to allow users to roam across subnet boundaries.

If all the access points on your wireless LAN are within a single subnet, set this property to FALSE to minimize DHCP traffic and reduce the chance of a momentary loss of audio when roaming between access points.

The subnet where the Vocera server is located is not relevant to this property.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.UserName

  • B3000:

    B3.UserName

  • B3000n:

    B3N.UserName

Blank

If AuthenticationType is set to LEAP, WPA-PEAP, or EAP-FAST, specifies the user name the badge supplies for authentication.

Use the User Name field on the Security tab of the Badge Properties Editor to set this value.

  • B2000:

    B2.WEPKey1

  • B3000:

    B3.WEPKey1

  • B3000n:

    B3N.WEPKey1

Blank

Specifies a WEP key the badge can use to transmit or receive data, if EncryptionType is set to WEP64 or WEP128. Enter the value in the following format:

  • If EncryptionType is set to WEP64, specify a key with 10 hexadecimal digits.

  • If EncryptionType is set to WEP128, specify a key with 26 hexadecimal digits.

If either the access points or the badges are using the first WEP key to transmit data, the value you specify here must match the first WEP key in the access point.

Use the WEP Key field on the Security tab of the Badge Properties Editor to set this value.

  • B2000:

    B2.WEPKey2

  • B3000:

    B3.WEPKey2

  • B3000n:

    B3N.WEPKey2

Blank

Specifies a WEP key the badge can use to transmit or receive data, if EncryptionType is set to WEP64 or WEP128. Enter the value in the following format:

  • If EncryptionType is set to WEP64, specify a key with 10 hexadecimal digits.

  • If EncryptionType is set to WEP128, specify a key with 26 hexadecimal digits.

If either the access points or the badges are using the second WEP key to transmit data, the value you specify here must match the second WEP key in the access point.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.WEPKey3

  • B3000:

    B3.WEPKey3

  • B3000n:

    B3N.WEPKey3

Blank

Specifies a WEP key the badge can use to transmit or receive data, if EncryptionType is set to WEP64 or WEP128. Enter the value in the following format:

  • If EncryptionType is set to WEP64, specify a key with 10 hexadecimal digits.

  • If EncryptionType is set to WEP128, specify a key with 26 hexadecimal digits.

If either the access points or the badges are using the third WEP key to transmit data, the value you specify here must match the third WEP key in the access point.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.WEPKey4

  • B3000:

    B3.WEPKey4

  • B3000n:

    B3N.WEPKey4

Blank

Specifies a WEP key the badge can use to transmit or receive data, if EncryptionType is set to WEP64 or WEP128. Enter the value in the following format:

  • If EncryptionType is set to WEP64, specify a key with 10 hexadecimal digits.

  • If EncryptionType is set to WEP128, specify a key with 26 hexadecimal digits.

If either the access points or the badges are using the fourth WEP key to transmit data, the value you specify here must match the fourth WEP key in the access point.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    B2.WEPKeySlot

  • B3000:

    B3.WEPKeySlot

  • B3000n:

    B3N.WEPKeySlot

Blank

If Encryption is set to WEP64 or WEP128, specifies which of the four WEP keys the badge uses to transmit data. Valid values are 1-4.

Note: This badge property is not available in the Badge Properties Editor.

  • B2000:

    Not available

  • B3000:

    Not available

  • B3000n:

    B3N.WirelessBand

ABGN

Select the wireless bands used by the B3000n badge:

  • ABGN uses all 802.11 wireless bands (a, b, g, and n) at 2.4 GHz and 5 GHz. This is the default setting.

  • AN uses 802.11a and 802.11n wireless bands at 5 GHz.

  • BGN uses the the 802.11b, 802.11g, and 802.11n wireless bands at 2.4 GHz.

  • A uses the 802.11a wireless band at 5 GHz.

  • BG uses the 802.11b and 802.11g wireless bands at 2.4 GHz.

  • B2000:

    Not available

  • B3000:

    DefaultHandsetVolume

  • B3000n:

    DefaultHandsetVolume

1 Lists the default volume level of Privacy Mode when no users are logged on.
  • B2000:

    Not available

  • B3000:

    DisplayHandsetMode

  • B3000n:

    DisplayHandsetMode

True Displays Privacy Mode in on the badge menu under Settings.
  • B2000:

    Not available

  • B3000:

    EnableHandsetQuickEntry

  • B3000n:

    EnableHandsetQuickEntry

True Enables Easy Access entry to Privacy mode.
  • B2000:

    Not available

  • B3000:

    HandsetMode

  • B3000n:

    HandsetMode

False Enables or disables Privacy mode using Easy Access.
  • B2000:

    Not available

  • B3000:

    HandsetQuickEntryPromptPlay

  • B3000n:

    HandsetQuickEntryPromptPlay

True Plays an audible alert, “Entering Handset Mode” while switching to Privacy Mode using Easy Access.