Netsh commands for Interface HTTPSTunnel

  • Article

This section contains the following commands.

  • add interface

  • delete interface

  • reset

  • set interface

  • show interfaces

  • show statistics

Interface HTTPSTunnel commands

The following entries provide details for each command.

add interface

Creates an IPHTTPS client or server interface and configures the properties.

Syntax

add interface [[ type= ] ( server | client )] [[ name= ] ( Name )] [[ state= ] ( enabled | disabled | default )] [[authmode= ] ( none | certificates )]

  • type
    Optional. Specifies either client or server.
  • url
    Optional. Specifies the URL on which the server interface listens for HTTP(S) requests.

  • state
    Optional. Specifies one of the following values:

    • default:

      • server interface – always configured.

      • client interface – configured on demand based on other connectivity options available. (Client interfaces are created with this setting by default.)

    • enabled:

      • always configured (server interfaces are created with this setting by default).

    • disabled:

      • interface will be disabled.

  • authmode
    One of the following values:

    • none: no client authentication will be performed during the SSL handshake (default).

    • certificates: client certificates will be used to authenticate clients (applies only to a server interface on a computer running Windows).

Examples

Following are examples of the add interface command.

add interface server https://*:443/IPHTTPS enabled certificates

add interface client https://myserver/IPHTTPS default

The first command adds an IPHTTPS server interface and configures it to listen on the specified URL and to use client certificates for client authentication.(Port numbers are required in the url specified for the server). The interface is always created at the boot time.

The second command adds an IPHTTPS client interface and configures the specified URL to establish a HTTP(S) session with the IPHTTPS server. It is configured to be activated when no other connectivity options are available.

delete interface

Deletes an IPHTTPS client or server interface.

Syntax

delete interface

Parameters

  • none
     

Examples

Following is an example of the delete interface command.

delete interface

reset

Deletes all locally configured IPHTTPS interfaces.

Syntax

reset

Parameters

  • none

Examples

Following is an example of the reset command.

reset

set interface

Sets the properties of an IPHTTPS client or server interface.

Syntax

set interface [[ url= ] ( url )] [[ state= ] ( enabled | disabled | default )] [[authmode= ] ( none | certificates )]

Parameters

  • url
    Optional. Specifies the URL on which the server interface listens for HTTP(S) requests.

  • state
    Optional. Specifies one of the following values:

    • default:

      • server interface – always configured.

      • client interface – configured on demand based on other connectivity options available. (Client interfaces are created with this setting by default.)

    • enabled:

      • always configured (server interfaces are created with this setting by default.)

    • disabled:

      • interface will be disabled.

  • authmode
    One of the following values:

    • none: no client authentication will be performed during the SSL handshake (default).

    • certificates: client certificates will be used to authenticate clients (applies only to a server interface on a computer running Windows).

Examples

Following is an example of the set interface command.

set interface https://*:443/IPHTTPS1 none

This command modifies a previously configured IPHTTPS server interface to use the URL https://*:443/IPHTTPS1 and to not use any client authentication. Modifying an interface may cause disruption in connectivity on the IPHTTPS interface.

show interfaces

Shows IPHTTPS interface parameters

Syntax

show interfaces [ [ store= ] ( active | persistent )

  • store
    Optional. One of the following values:

    • active: show active interfaces only (default).

    • persistent: show all interfaces.

Examples

Following is an example of the show interfaces command.

show interfaces persistent

show statistics

Shows IPHTTPS interface statistics

Syntax

show statistics [[ interface= ] ( interface )]

Parameters

  • interface
    Optional. Interface name for which statistics are displayed.

Examples

Following is an example of the show statistics command.

show statistics connection1