web
---

.. osdx:cfgcmd:: service web

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>

    OSDX Web API Server configuration






.. osdx:cfgcmd:: service web http

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>

    Enable HTTP protocol






.. osdx:cfgcmd:: service web http host <ipv4>

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>


    :arg ipv4:
        HTTP server bind address





.. osdx:cfgcmd:: service web http port <u32>

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>

    HTTP server port

    :arg u32:
        Port number (1-65535)





.. osdx:cfgcmd:: service web https

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>

    Enable HTTPS protocol




    :ref Required: 


.. osdx:cfgcmd:: service web https host <ipv4>

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>


    :arg ipv4:
        HTTPS server bind address





.. osdx:cfgcmd:: service web https port <u32>

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>

    HTTPS server port

    :arg u32:
        Port number (1-65535)





.. osdx:cfgcmd:: service web https ssl-ciphers <txt>

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>


    :arg txt:
        Allowed SSL cipher suites (OpenSSL cipher string format)





.. osdx:cfgcmd:: service web https ssl-protocol <id>

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>

    Allowed SSL/TLS protocol version

    :arg TLSv1.2:
        TLS version 1.2
    :arg TLSv1.3:
        TLS version 1.3 (recommended)


    :instances: List of values



.. osdx:cfgcmd:: service web https x509

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>

    X.509 certificate configuration




    :ref Required: 
    :ref Required: 


.. osdx:cfgcmd:: service web https x509 ca-certificate <file>

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>


    :arg file:
        CA certificate for mTLS - when set, client certificates are required and verified





.. osdx:cfgcmd:: service web https x509 certificate <file>

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>


    :arg file:
        Server certificate file (PEM format)





.. osdx:cfgcmd:: service web https x509 certificate-key <file>

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>


    :arg file:
        Server private key file (PEM format)





.. osdx:cfgcmd:: service web log-level <txt>

    .. raw:: html

        <span class="badge" style="background-color: rosybrown">AresC640</span>
        <span class="badge" style="background-color: darkolivegreen">Atlas840</span>
        <span class="badge" style="background-color: darkviolet">H5-Rail</span>
        <span class="badge" style="background-color: steelblue">M10-Smart</span>
        <span class="badge" style="background-color: goldenrod">M2</span>
        <span class="badge" style="background-color: mediumseagreen">M20</span>
        <span class="badge" style="background-color: firebrick">RS420</span>
        <span class="badge" style="background-color: darkkhaki">RXL15000</span>
        <span class="badge" style="background-color: lightslategray">SDE</span>
        <span class="badge" style="background-color: dodgerblue">SDE-11k</span>

    Web service log-level

    :arg emerg:
        Emergency messages
    :arg alert:
        Urgent messages
    :arg crit:
        Critical messages
    :arg err:
        Error messages
    :arg warning:
        Warning messages
    :arg notice:
        Messages for further investigation
    :arg info:
        Informational messages
    :arg debug:
        Debug messages