VIPNETCLIENT(8)

NAME
vipnetclient - ViPNet Client for Linux

SYNOPSIS
vipnetclient [COMMAND] [OPTION]...

DESCRIPTION
ViPNet Client for Linux by JSC InfoTeCS is a VPN client to connect to ViPNet-protected networks. ViPNet Client allows you to access the corporate resources seamlessly for the applications and the operating system over an encrypted channel powered by the ViPNet technology. Due to the symmetric encryption and sessionless communication protocol, the ViPNet technology ensures access to the corporate resources even for poor or unstable connections. At any time necessary, you can access your corporate mailbox, secure portals, document flow system, and other resources. The ViPNet technology supports simultaneous connections to multiple geographically distributed segments of the ViPNet network at once without any additional configuring. See more ViPNet products at www.vipnet.ru https://www.vipnet.ru

COMMANDS

start
    Start ViPNet Client

stop
    Stop ViPNet Client

installkeys <DST file>
    Install DST file

deletekeys
    Remove the installed DST file

reconfigure
    Create the configuration files anew

report
    Create a report archive

info
    Show the ViPNet Client details

list
    Show the requested information (see OPTIONS for details)

debug
    Configure ViPNet Client (see OPTIONS for details)

iplirdiag
    Show the requested run-time information (see OPTIONS for details)

dbviewer
    Show the events registered in the database within the last week

eventlog
    Export the event log

firewall or fw
    Control the built-in firewall

OPTIONS
global options

    --help
        Describes commands and options

    --version
        Software version

    --no-background
        Turn off operation in background (requires superuser permissions)

start options

    --no-failprotect
        Turn off the fault tolerance

    --psw <password>
        ViPNet™ user password

    --pin <pin-code>
        Logon device PIN

    --token-select <module/slot>
        Logon device selection string

installkeys options

    --no-autostart
        Turn off ViPNet™ autostart

    --no-start
        Turn off VPN start on keys installation

    --no-failprotect
        Turn off the fault tolerance

    --psw <password>
        ViPNet™ user password

    --pin <pin-code>
        Logon device PIN

    --token-select <module/slot>
        Logon device selection string

deletekeys options

    --skip-accept
        Skip confirmation

report options

    --output|-o <path>
        Outputs a path or a file

info options

    --regulations
        Turn on the routine testing instead of the regular diagnostics

    --psw <password>
        ViPNet™ administrator password

list options

    --nodes
        List ViPNet™ hosts your host has links with

    --users
        List ViPNet™ users your host has links with

    --tokens
        List the connected logon devices

debug options

    --loglevel <level>
        Log verbosity level 0(critical)...5(deep)

    --mftp-reconnect
        Reconnect MFTP

    --autostart --no-autostart
        Turn ViPNet™ autostart on/off

    --ping [<node_id>]
        Check connection to <node_id> or to the active server if omitted

    --tokens
        List the configured logon devices

    --change-logon-type
        Change the logon mode from Password to Device (requires VPN)

    --mdns-crypt <mode>
        Change crypt mode for mdns

    --pin <pin-code>
        Logon device PIN (requires --change-logon-type)

    --token-select <module/slot>
        Logon device selection string (requires --change-logon-type)

    --tcp-tunnel-mode <mode>
        Change the TCP tunnel mode (on, off, auto)

    --user-vpnconfig [<*.vpnconfig>|none]
        Apply customized VPN settings from a file or reset to default ones (if 'none')

iplirdiag options

    --help
        Describes commands and options for iplirdiag

    -s adapters ...
        Information about adapters

    options of subsystem 'adapters'

        --stats
            Subsystem statistics

        --info
            Information about adapters

        --dumper arg
            List event records for adapter, <num> <filename>

    -s cipher ...
        Information about cryptography

    options of subsystem 'cipher'

        --info
            Cryptography information

    -s dnsproxy ...
        DNS proxy information

    options of subsystem 'dnsproxy'

        --info
            DNS proxy information

        --query-logging arg
            Turn on/off verbose DNS query logging

    -s firewall ...
        Firewall info

    options of subsystem 'firewall'

        --stats
            Subsystem statistics

        --static
            Static firewall rules

        --ip
            Dynamic IP rules

        --tcp
            Dynamic TCP rules

        --udp
            Dynamic UDP rules

        --udp-bcast
            Dynamic UDP rules for broadcast requests

        --icmp
            Dynamic ICMP rules

        --icmp-bcast
            Dynamic ICMP rules for broadcast requests

        --icmp-tcp
            Dynamic ICMP TCP rules

        --icmp-udp
            Dynamic ICMP UDP rules

        --icmp-icmp
            Dynamic ICMP ICMP rules

        --wait-rule
            Pending rules

        --natal-bindings
            Mappings for ports and protocols to be processed by the ALG module

        --bcast-id
            Firewall broadcast-to-ID table

        --params
            Firewall parameters

        --counters
            Firewall connection counters

        --used-ports
            Port usage

        --store arg
            Save current settings

        --dnsnamedump
            List ViPNet hosts' DNS names

        --unknownips arg
            List new IP addresses obtained while resolving ViPNet hosts' DNS names

        --drv-alg-trace arg
            Turn on/off the ALG module logging (bitmask required)

    -s ipsettings ...
        IP settings

    options of subsystem 'ipsettings'

        --stats
            Subsystem statistics

        --v-table
            Visibility table

        --v-tun-table
            Tunnel visibility table

        --node-info arg
            Host details

eventlog options

    --output|-o <path>
        Output a path or a file

    --delete <path>
        Output a path or a file and deletes log after execution

    --psw <password>
        ViPNet™ administrator password
firewall|fw options

    --help
        The built-in firewall commands and options

    info
        The built-in firewall status and settings

    public ...
        Public network settings

    options of the public domain

        --(no)--block
            Apply or turn off the traffic block policy for all unencrypted (non-ViPNet™) packets (except DHCP, DNS, and NTP)

        --psw <password>
            ViPNet™ administrator password

    protected ...
        ViPNet™ network settings

    options of the private domain

        --(no)--policy
            Apply the policy settings from the management software to encrypted traffic and ignore custom settings, or vice versa

        --user-xml <xml-file>
            Replace the custom private network filters (from xml file)

        --save-user-xml <path-to-xml>
            Export the custom private network filters

        --erase-user-xml
            Clear the custom private network filters

        --psw <password>
            ViPNet™ administrator password

USAGE

  > vipnetclient installkeys ~/path/to/dst/file.dst --psw password
Install DST file from ~/path/to/dst/file.dst using password "password"

  > vipnetclient start --no-failprotect
Start VPN without fault tolerance

  > vipnetclient deletekeys
Remove the installed DST file. Confirmation required

  > vipnetclient report -o ~/Public

  > vipnetclient report -o ~/Public/issue8913_report.zip
Create a report archive at ~/Public for the first case and as the file ~/Public/issue8913_report.zip for the second case

  > vipnetclient debug --loglevel 5
Set log verbosity level to deep

  > vipnetclient list --nodes
List all hosts

  > vipnetclient iplirdiag -s ipsettings --node-info 432100ec
Request and show run-time information about host with id 432100ec (if known). Turn on VPN by executing vipnetclient start beforehand

  > vipnetclient dbviewer
Show events registered in the database within the last week

  > vipnetclient --version
Show the ViPNet Client software version

Logon device commands

  > vipnetclient list --tokens
Show devices connected and supported

  > vipnetclient installkeys ~/path/to/dst/file.dst --pin 1234 --token-select "slot:0"
Install the DST file from ~/path/to/dst/file.dst using device on "slot:0" and PIN "1234"

  > vipnetclient debug --tokens
Show the PKCS#11 plug-ins configured

  > vipnetclient debug --change-logon-type
Move the personal key to the logon device

Built-in firewall commands

  > vipnetclient fw info
Show the firewall status

  > vipnetclient fw public --block
Block all unencrypted traffic (except DHCP, DNS, and NTP) using the built-in firewall (requires ViPNet™ administrator permissions)

  > vipnetclient fw protected --no-policy
Prioritize the custom settings over the policy settings from the management software (requires ViPNet™ administrator permissions)

  > vipnetclient fw protected --user-xml /path/to/user/rules.xml
Replace the custom settings with the specified ones (requires ViPNet™ administrator permissions)

HOMEPAGE
https://www.vipnet.ru