Skip to content
The XG Series hardware appliances will reach end-of-life (EOL) on March 31, 2025. Click here to see the XG to XGS migration documentation.

Page permalink

Always use the following permalink when referencing this page. It will remain unchanged in future help versions.

https://docs.sophos.com/nsg/sophos-firewall/21.0/Help/en-us/webhelp/onlinehelp/index.html?contextId=wireless-hotspot-voucher-template

Voucher template

You can create a voucher template using your preferred page layout or word processor and save it as a PDF. A voucher template contains information such as time and usage allocations. Vouchers provide users access to your network when you set your hotspot type to voucher.

Variables

Templates support variables that the firewall replaces with specific values during voucher generation. Refer to the voucher template in Wireless > Hotspot settings > Download templates for usage examples. You can use the following variables in your template:

  • <?ssid#?>: The wireless network SSID defined in Wireless networks.
  • <?psk#?>: The wireless network passphrase or PSKs defined in Wireless networks.
  • <?code?>: The voucher code.
  • <?validity?>: The voucher's validity period defined in Hotspot voucher definition.
  • <?datalimit?>: The voucher's data volume defined in Hotspot voucher definition.
  • <?timelimit?>: The voucher's time quota defined in Hotspot voucher definition.
  • <?comment?>: The description defined in Hotspot voucher definition.
  • <?qr0?>: A QR code with the hotspot access data encoded.

Requirements

When creating custom voucher templates, you must adhere to the following requirements:

  • Place each variable on a separate line.
  • Use only standard system fonts without additional formatting. Bold, italic, or similarly altered fonts can cause rendering issues when creating vouchers.
  • Define the character set on the last line of your PDF file. This string doesn't appear on the voucher. For more information, see the example template.