hotspot
-------

.. osdx:cfgcmd:: service hotspot <id>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>


    :arg id:
        Hotspot configuration


    :instances: Multiple

    :ref Required: service hotspot * aaa
    :ref Required: service hotspot * downstream-interfaces *
    :ref Required: service hotspot * redirection
    :ref Required: service hotspot * traffic
    :ref Required: service hotspot * uam-server


.. osdx:cfgcmd:: service hotspot <id> aaa

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    AAA parameters




    :ref Required: service hotspot * aaa authentication


.. osdx:cfgcmd:: service hotspot <id> aaa accounting

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Accounting parameters






.. osdx:cfgcmd:: service hotspot <id> aaa accounting interim-interval <u32>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Interval to send periodic interim accounting messages

    :arg u32:
        Interval in seconds (5-86400)





.. osdx:cfgcmd:: service hotspot <id> aaa accounting list <id>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Accounting list



    :ref Reference: system aaa list *



.. osdx:cfgcmd:: service hotspot <id> aaa authentication

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Authentication parameters






.. osdx:cfgcmd:: service hotspot <id> aaa authentication list <id>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Authentication list



    :ref Reference: system aaa list *



.. osdx:cfgcmd:: service hotspot <id> downstream-interfaces <ifc>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>


    :arg ifc:
        Interface where Hotspot clients are located





.. osdx:cfgcmd:: service hotspot <id> local-vrf <id>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    VRF to run the hotspot service on



    :ref Reference: system vrf *



.. osdx:cfgcmd:: service hotspot <id> log-level <txt>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Service log level

    :arg err:
        Error messages
    :arg info:
        Informational messages
    :arg debug:
        Debug messages





.. osdx:cfgcmd:: service hotspot <id> redirection

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Redirection parameters




    :ref Required: service hotspot * redirection captive-portal


.. osdx:cfgcmd:: service hotspot <id> redirection captive-portal

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Captive portal to which a client is being redirected to initialize authentication






.. osdx:cfgcmd:: service hotspot <id> redirection captive-portal url <txt>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Captive portal URL

    :arg txt:
        URL





.. osdx:cfgcmd:: service hotspot <id> redirection fail-page

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Destination to which a client is redirected to after a failed authentication






.. osdx:cfgcmd:: service hotspot <id> redirection fail-page url <txt>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Destination URL

    :arg txt:
        URL





.. osdx:cfgcmd:: service hotspot <id> redirection success-page

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Destination to which a client is redirected to after successful authentication






.. osdx:cfgcmd:: service hotspot <id> redirection success-page url <txt>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Destination URL

    :arg txt:
        URL





.. osdx:cfgcmd:: service hotspot <id> session

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Session parameters






.. osdx:cfgcmd:: service hotspot <id> session authorized-macs <anymacaddr>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    List of MAC addresses always authorized by the service

    :arg anymacaddr:
        MAC address


    :instances: Multiple



.. osdx:cfgcmd:: service hotspot <id> session hard-timeout <u32>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Timeout to deauthenticate a session regardless of the subscriber activity

    :arg u32:
        Timeout in seconds (60-86400)





.. osdx:cfgcmd:: service hotspot <id> session max-authorized-clients <u32>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Maximum number of authorized clients

    :arg u32:
        Number (1-21474836)





.. osdx:cfgcmd:: service hotspot <id> traffic

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Traffic parameters configuration




    :ref Required: traffic policy *


.. osdx:cfgcmd:: service hotspot <id> traffic bandwidth

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Bandwidth limitation per authenticated subscriber






.. osdx:cfgcmd:: service hotspot <id> traffic bandwidth download <float>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Drop traffic if download bandwidth exceeds a limit

    :arg float:
        Rate in Mbit/s (0.000001-100000)





.. osdx:cfgcmd:: service hotspot <id> traffic bandwidth upload <float>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Drop traffic if upload bandwidth exceeds a limit

    :arg float:
        Rate in Mbit/s (0.000001-100000)





.. osdx:cfgcmd:: service hotspot <id> traffic policy <txt>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Traffic policy ruleset for this service



    :ref Reference: traffic policy *



.. osdx:cfgcmd:: service hotspot <id> traffic quota

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Quota limitation per authenticated subscriber






.. osdx:cfgcmd:: service hotspot <id> traffic quota download <float>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Drop traffic if download quota exceeds a limit

    :arg float:
        Limit in MB (0.000001-1000000000)





.. osdx:cfgcmd:: service hotspot <id> traffic quota upload <float>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Drop traffic if upload quota exceeds a limit

    :arg float:
        Limit in MB (0.000001-1000000000)





.. osdx:cfgcmd:: service hotspot <id> uam-server

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    UAM server parameters




    :ref Required: service hotspot * uam-server address *


.. osdx:cfgcmd:: service hotspot <id> uam-server address <ipv4>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    IP address used by the UAM server

    :arg ipv4:
        IPv4 address





.. osdx:cfgcmd:: service hotspot <id> uam-server authentication

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Authentication options for the UAM server






.. osdx:cfgcmd:: service hotspot <id> uam-server authentication chap

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Enables CHAP authentication






.. osdx:cfgcmd:: service hotspot <id> uam-server authentication encrypted-secret <password>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Encrypted shared secret between the UAM server and the captive portal

    :arg password:
        Encrypted secret





.. osdx:cfgcmd:: service hotspot <id> uam-server authentication plaintext-secret <txt>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Plaintext shared secret between the UAM server and the captive portal

    :arg txt:
        Secret (1-64)





.. osdx:cfgcmd:: service hotspot <id> uam-server port <u32>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Port used by the UAM HTTP server

    :arg u32:
        Port number (0-65535)





.. osdx:cfgcmd:: service hotspot <id> uam-server secure-port <u32>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    Port used by the UAM HTTPs server

    :arg u32:
        Port number (0-65535)





.. osdx:cfgcmd:: service hotspot <id> x509

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>

    X.509 configuration parameters




    :ref Required: service hotspot * x509 certificate *
    :ref Required: service hotspot * x509 private-key *


.. osdx:cfgcmd:: service hotspot <id> x509 certificate <file>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>


    :arg file:
        Server certificate exchanged when HTTPs is enabled





.. osdx:cfgcmd:: service hotspot <id> x509 private-key <file>

    .. raw:: html

        <span class="badge devices-badge" title="AresC640, Atlas840, H5-Auto, H5-Rail, M10-Plus, M10-Smart, M2, M20, RS420, RXL15000, SDE, SDE-11k">Devices</span>


    :arg file:
        Certificate private key