Operation: Add Hotspot / Update Hotspot
Description:  

Sample Configuration
<Hotspot> <Name>text</Name> <Description>description</Description> <AutoFirewallRule>Enable/Disable</AutoFirewallRule> <Interfaces> <Interface>interface name</Interface> : </Interfaces> <Users> <User>user name</User> : </Users> <ApplicationFilterPolicy>app filter policy names</ApplicationFilterPolicy> <WebFilterPolicy>web filter policy names</WebFilterPolicy> <IPSPolicy>ips policy names</IPSPolicy> <QoSPolicy>qos policy names</QoSPolicy> <RedirectHTTPS>Enable/Disable</RedirectHTTPS> <HostnameType>None (IP Address)/Custom hostname</HostnameType> <!-- If HostnameType is Custom hostname --> <Hostname>text</Hostname> <HotspotType>TermsOfUseAcceptance/PasswordofTheDay/Voucher</HotspotType> <!-- If HotspotType is TermsOfUseAcceptance --> <SessionExpiry>After2hours/After6hours/After12hours/After24hours/After1week</SessionExpiry> <TermsOfUse>text</TermsOfUse> <!-- If HotspotType is PasswordofTheDay --> <PasswordCreationTime>time in dropdown</PasswordCreationTime> <Email>email id</Email> <SynchronizePSK>Enable/Disable</SynchronizePSK> <!-- If HotspotType is Voucher --> <Vouchers> <Voucher>voucher name</Voucher> : </Vouchers> <DevicePerVoucher>unlimited/1/2/3/4/5</DevicePerVoucher> <!-- If HotspotType is PasswordofTheDay or Voucher --> <TermsAcceptance>Enable/Disable</TermsAcceptance> <!-- If TermsAcceptance is Enabled --> <TermsOfUse>text</TermsOfUse> <RedirectURL>Enable/Disable</RedirectURL> <!-- If RedirectURL is Enabled --> <URL>url</URL> <RestoreDefault>Enable/Disable</RestoreDefault> <!-- If RestoreDefault is Enabled --> <CustomizationType>Basic/Full</CustomizationType> <!-- If CustomizationType is Basic --> <Logo>logo filename</Logo> <ScaleLogo>Enable/Disable</ScaleLogo> <Title /> <CustomText /> <!-- If CustomizationType is Full --> <LoginPageTemplate>login filename</LoginPageTemplate> <ImagesStylesheet>image filename</ImagesStylesheet> <!-- If RestoreDefault is Enabled AND HotspotType is Voucher --> <VoucherTemplate>voucher filename</VoucherTemplate> </Hotspot>



Parameter Mandatory Default Description
NameYes  
Enter a descriptive name for hotspot.
Name confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 40.
DescriptionNo  
Enter a description.
Description confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
InterfaceYes  
Select or add the interfaces which are to be restricted by the hotspot.
Interface confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Multiple values are allowed.
ApplicationFilterPolicyNo  
Select or add an application filter policy for the hotspot.
ApplicationFilterPolicy confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
WebFilterPolicyNo  
Select or add a web filter policy for the hotspot.
WebFilterPolicy confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
IPSPolicyNo  
Select or add IPS policies for the hotspot.
IPSPolicy confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
QoSPolicyNo  
Select or add a traffic shaping policy for the hotspot.
QoSPolicy confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
RedirectHTTPSNo  
Enable to redirect users to HTTPS.
RedirectHTTPS confines to:
  • Type is 'SCALAR'.
  • Only 'Enable', 'Disable' are allowed.
HostnameTypeNo  
Select the hostname type for the hotspot.
HostnameType confines to:
  • Type is 'SCALAR'.
  • Only 'None (IP Address)', 'Custom hostname' are allowed.
HostnameNo  
Enter a hostname.
Hostname confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
HotspotTypeYes  
Select a hotspot type for the selected interfaces.
HotspotType confines to:
  • Type is 'SCALAR'.
  • Only 'TermsOfUseAcceptance', 'PasswordofTheDay', 'Voucher' are allowed.
SessionExpiryYes  
Select the time span after which the access will expire.
SessionExpiry confines to:
  • Type is 'SCALAR'.
  • Only 'After2hours', 'After6hours', 'After12hours', 'After24hours', 'After1week' are allowed.
TermsOfUseYes  
Add the text to be displayed as terms of use.
TermsOfUse confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 8192.
RedirectURLNo  
Enable to redirect users automatically to a particular URL after entering password or voucher data.
RedirectURL confines to:
  • Type is 'SCALAR'.
  • Only 'Enable', 'Disable' are allowed.
URLNo  
Enter URL to which the user will be redirected to.
URL confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
PasswordCreationTimeYes  
The assigned time of the day at which the new password will be created. At this time the former password will immediately get invalid and current sessions will be cut off.
PasswordCreationTime confines to:
  • Type is 'SCALAR'.
  • Only '00:00', '01:00', '02:00', '03:00', '04:00', '05:00', '06:00', '07:00', '08:00', '09:00', '10:00', '11:00', '12:00', '13:00', '14:00', '15:00', '16:00', '17:00', '18:00', '19:00', '20:00', '21:00', '22:00', '23:00' are allowed.
EmailNo  
Add email addresses to which the password shall be sent.
Email confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
SynchronizePSKNo  
Enable to synchronize the new generated/saved password with wireless PSK.
SynchronizePSK confines to:
  • Type is 'SCALAR'.
  • Only 'Enable', 'Disable' are allowed.
UserYes  
Select or add users for administrative settings.
User confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Multiple values are allowed.
AutoFirewallRuleNo  
Turn on to create a firewall rule automatically.
AutoFirewallRule confines to:
  • Type is 'SCALAR'.
  • Only 'Enable', 'Disable' are allowed.
VoucherTemplateNo  
Select and upload a PDF file with the voucher layout.
VoucherTemplate confines to:
  • Type is 'SCALAR'.
  • Datatype is 'FILE'.
  • Maximum characters allowed are 255.
  • File formats 'pdf' are allowed.
DevicePerVoucherNo  
Enter the number of devices which are allowed to log in with one voucher during its lifetime.
DevicePerVoucher confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
TermsAcceptanceNo  
Enable to make hotspot users accept terms of use before accessing the Internet.
TermsAcceptance confines to:
  • Type is 'SCALAR'.
  • Only 'Enable', 'Disable' are allowed.
RestoreDefaultNo  
Enable to use a customized HTML file.
RestoreDefault confines to:
  • Type is 'SCALAR'.
  • Only 'Enable', 'Disable' are allowed.
CustomizationTypeYes  
Select the customization type.
CustomizationType confines to:
  • Type is 'SCALAR'.
  • Only 'Basic', 'Full' are allowed.
LogoNo  
Upload a logo for the login page.
Logo confines to:
  • Type is 'SCALAR'.
  • Datatype is 'FILE'.
  • Maximum characters allowed are 255.
  • File formats 'jpg', 'jpeg', 'png', 'gif' are allowed.
ScaleLogoNo  
Enable to scale logo to recommended size.
ScaleLogo confines to:
  • Type is 'SCALAR'.
  • Only 'Enable', 'Disable' are allowed.
TitleNo  
Add a title for the login page.
Title confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
CustomTextNo  
Add an additional text for the login page.
CustomText confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
Login Page TemplateYes  
Select the HTML template you want to use for your individual login page.
Login Page Template confines to:
  • Type is 'SCALAR'.
  • Datatype is 'FILE'.
  • Maximum characters allowed are 255.
  • File formats 'html' are allowed.
Images Style SheetNo  
Add files that are referenced in your login page template.
Images Style Sheet confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 255.
  • Multiple values are allowed.
VoucherYes  
Add or select the voucher definitions you want to use for the hotspot.
Voucher confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Multiple values are allowed.



Operation   Status   Message
Add Hotspot200
Add Hotspot500
Add Hotspot502
Add Hotspot541
Add Hotspot542
Add Hotspot543
Update Hotspot200
Update Hotspot500
Update Hotspot541
Update Hotspot542
Update Hotspot543

© Copyright 2019 Sophos Firewall Limited. All rights reserved.
Sophos Firewall is registered trademarks of Sophos Firewall Limited and Sophos Firewall Group. All other product and company names mentioned are trademarks or registered trademarks of their respective owners.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording or otherwise unless you are either a valid licensee where the documentation can be reproduced in accordance with the license terms or you otherwise have the prior permission in writing of the copyright owner.