Chapter 6 Command Line Management Utility Manual

PacketiX VPN comes with a command line management utility called "vpncmd". You can use vpncmd to perform management operations from the command line with Windows-based GUI software, such as PacketiX VPN Server Manager or PacketiX VPN Client Manager. This chapter describes how to use vpncmd and serves as a reference for all vpncmd commands.

	6.1 Overview of vpncmd
		6.1.1 vpncmd
		6.1.2 vpncmd Management Mode
	6.2 General Usage of vpncmd
		6.2.1 Command Input Rules
		6.2.2 Command Help Display
		6.2.3 Command Line Parameters When Starting a vpncmd Command
		6.2.4 Batch Processing Mode
		6.2.5 Saving a Log
		6.2.6 vpncmd Process Return Values
		6.2.7 Character Encoding
		6.2.8 Calling vpncmd in Windows
		6.2.9 Stand-Alone Installation of vpncmd
	6.3 VPN Server / VPN Bridge Management Command Reference (For Entire Server)
		6.3.1 About - Display the version information
		6.3.2 ServerInfoGet - Get server information
		6.3.3 ServerStatusGet - Get Current Server Status
		6.3.4 ListenerCreate - Create New TCP Listener
		6.3.5 ListenerDelete - Delete TCP Listener
		6.3.6 ListenerList - Get List of TCP Listeners
		6.3.7 ListenerEnable - Begin TCP Listener Operation
		6.3.8 ListenerDisable - Stop TCP Listener Operation
		6.3.9 ServerPasswordSet - Set VPN Server Administrator Password
		6.3.10 ClusterSettingGet - Get Clustering Configuration of Current VPN Server
		6.3.11 ClusterSettingStandalone - Set VPN Server Type as Standalone
		6.3.12 ClusterSettingController - Set VPN Server Type as Cluster Controller
		6.3.13 ClusterSettingMember - Set VPN Server Type as Cluster Member
		6.3.14 ClusterMemberList - Get List of Cluster Members
		6.3.15 ClusterMemberInfoGet - Get Cluster Member Information
		6.3.16 ClusterMemberCertGet - Get Cluster Member Certificate
		6.3.17 ClusterConnectionStatusGet - Get Connection Status to Cluster Controller
		6.3.18 ServerCertGet - Get SSL Certificate of VPN Server
		6.3.19 ServerKeyGet - Get SSL Certificate Private Key of VPN Server
		6.3.20 ServerCertSet - Set SSL Certificate and Private Key of VPN Server
		6.3.21 ServerCipherGet - Get the Encrypted Algorithm Used for VPN Communication.
		6.3.22 ServerCipherSet - Set the Encrypted Algorithm Used for VPN Communication.
		6.3.23 KeepEnable - Enable the Keep Alive Internet Connection Function
		6.3.24 KeepDisable - Disable the Keep Alive Internet Connection Function
		6.3.25 KeepSet - Set the Keep Alive Internet Connection Function
		6.3.26 KeepGet - Get the Keep Alive Internet Connection Function
		6.3.27 SyslogEnable - Set syslog Send Function
		6.3.28 SyslogDisable - Disable syslog Send Function
		6.3.29 SyslogGet - Get syslog Send Function
		6.3.30 ConnectionList - Get List of TCP Connections Connecting to the VPN Server
		6.3.31 ConnectionGet - Get Information of TCP Connections Connecting to the VPN Server
		6.3.32 ConnectionDisconnect - Disconnect TCP Connections Connecting to the VPN Server
		6.3.33 BridgeDeviceList - Get List of Network Adapters Usable as Local Bridge
		6.3.34 BridgeList - Get List of Local Bridge Connection
		6.3.35 BridgeCreate - Create Local Bridge Connection
		6.3.36 BridgeDelete - Delete Local Bridge Connection
		6.3.37 Caps - Get List of Server Functions/Capability
		6.3.38 Reboot - Reboot VPN Server Service
		6.3.39 ConfigGet - Get the current configuration of the VPN Server
		6.3.40 ConfigSet - Write Configuration File to VPN Server
		6.3.41 RouterList - Get List of Virtual Layer 3 Switches
		6.3.42 RouterAdd - Define New Virtual Layer 3 Switch
		6.3.43 RouterDelete - Delete Virtual Layer 3 Switch
		6.3.44 RouterStart - Start Virtual Layer 3 Switch Operation
		6.3.45 RouterStop - Stop Virtual Layer 3 Switch Operation
		6.3.46 RouterIfList - Get List of Interfaces Registered on the Virtual Layer 3 Switch
		6.3.47 RouterIfAdd - Add Virtual Interface to Virtual Layer 3 Switch
		6.3.48 RouterIfDel - Delete Virtual Interface of Virtual Layer 3 Switch
		6.3.49 RouterTableList - Get List of Routing Tables of Virtual Layer 3 Switch
		6.3.50 RouterTableAdd - Add Routing Table Entry for Virtual Layer 3 Switch
		6.3.51 RouterTableDel - Delete Routing Table Entry of Virtual Layer 3 Switch
		6.3.52 LogFileList - Get List of Log Files
		6.3.53 LogFileGet - Download Log file
		6.3.54 HubCreate - Create New Virtual HUB
		6.3.55 HubCreateDynamic - Create New Dynamic Virtual HUB (For Clustering)
		6.3.56 HubCreateStatic - Create New Static Virtual HUB (For Clustering)
		6.3.57 HubDelete - Delete Virtual HUB
		6.3.58 HubSetStatic - Change Virtual HUB Type to Static Virtual HUB
		6.3.59 HubSetDynamic - Change Virtual HUB Type to Dynamic Virtual HUB
		6.3.60 HubList - Get List of Virtual HUBs
		6.3.61 Hub - Select Virtual HUB to Manage
		6.3.62 LicenseAdd - Add License Key Registration
		6.3.63 LicenseDel - Delete Registered License
		6.3.64 LicenseList - Get List of Registered Licenses
		6.3.65 LicenseStatus - Get License Status of Current VPN Server
		6.3.66 MakeCert - Create New X.509 Certificate and Private Key
		6.3.67 TrafficClient - Execute Communication Throughput Measurement Tool Client
		6.3.68 TrafficServer - Execute Communication Throughput Measurement Tool Server
		6.3.69 Check - Check if PacketiX VPN Operation is Possible
	6.4 VPN Server / VPN Bridge Management Command Reference (For Virtual HUB)
		6.4.1 Online - Switch Virtual HUB to Online
		6.4.2 Offline - Switch Virtual HUB to Offline
		6.4.3 SetMaxSession - Set the Max Number of Concurrently Connected Sessions for Virtual HUB
		6.4.4 SetHubPassword - Set Virtual HUB Administrator Password
		6.4.5 SetEnumAllow - Allow Enumeration by Virtual HUB Anonymous Users
		6.4.6 SetEnumDeny - Deny Enumeration by Virtual HUB Anonymous Users
		6.4.7 OptionsGet - Get Options Setting of Virtual HUBs
		6.4.8 RadiusServerSet - Set RADIUS Server to use for User Authentication
		6.4.9 RadiusServerDelete - Delete Setting to Use RADIUS Server for User Authentication
		6.4.10 RadiusServerGet - Get Setting of RADIUS Server Used for User Authentication
		6.4.11 StatusGet - Get Current Status of Virtual HUB
		6.4.12 LogGet - Get Log Save Setting of Virtual HUB
		6.4.13 LogEnable - Enable Security Log or Packet Log
		6.4.14 LogDisable - Disable Security Log or Packet Log
		6.4.15 LogSwitchSet - Set Log File Switch Cycle
		6.4.16 LogPacketSaveType - Set Save Contents and Type of Packet to Save to Packet Log
		6.4.17 CAList - Get List of Trusted CA Certificates
		6.4.18 CAAdd - Add Trusted CA Certificate
		6.4.19 CADelete - Delete Trusted CA Certificate
		6.4.20 CAGet - Get Trusted CA Certificate
		6.4.21 CascadeList - Get List of Cascade Connections
		6.4.22 CascadeCreate - Create New Cascade Connection
		6.4.23 CascadeSet - Set the Destination for Cascade Connection
		6.4.24 CascadeGet - Get the Cascade Connection Setting
		6.4.25 CascadeDelete - Delete Cascade Connection Setting
		6.4.26 CascadeUsernameSet - Set User Name to Use Connection of Cascade Connection
		6.4.27 CascadeAnonymousSet - Set User Authentication Type of Cascade Connection to Anonymous Authentication
		6.4.28 CascadePasswordSet - Set User Authentication Type of Cascade Connection to Password Authentication
		6.4.29 CascadeCertSet - Set User Authentication Type of Cascade Connection to Client Certificate Authentication
		6.4.30 CascadeCertGet - Get Client Certificate to Use for Cascade Connection
		6.4.31 CascadeEncryptEnable - Enable Encryption when Communicating by Cascade Connection
		6.4.32 CascadeEncryptDisable - Disable Encryption when Communicating by Cascade Connection
		6.4.33 CascadeCompressEnable - Enable Data Compression when Communicating by Cascade Connection
		6.4.34 CascadeCompressDisable - Disable Data Compression when Communicating by Cascade Connection
		6.4.35 CascadeProxyNone - Specify Direct TCP/IP Connection as the Connection Method of Cascade Connection
		6.4.36 CascadeProxyHttp - Set Connection Method of Cascade Connection to be via an HTTP Proxy Server
		6.4.37 CascadeProxySocks - Set Connection Method of Cascade Connection to be via an SOCKS Proxy Server
		6.4.38 CascadeServerCertEnable - Enable Cascade Connection Server Certificate Verification Option
		6.4.39 CascadeServerCertDisable - Disable Cascade Connection Server Certificate Verification Option
		6.4.40 CascadeServerCertSet - Set the Server Individual Certificate for Cascade Connection
		6.4.41 CascadeServerCertDelete - Delete the Server Individual Certificate for Cascade Connection
		6.4.42 CascadeServerCertGet - Get the Server Individual Certificate for Cascade Connection
		6.4.43 CascadeDetailSet - Set Advanced Settings for Cascade Connection
		6.4.44 CascadePolicySet - Set Cascade Connection Session Security Policy
		6.4.45 PolicyList - Display List of Security Policy Types and Settable Values
		6.4.46 CascadeStatusGet - Get Current Cascade Connection Status
		6.4.47 CascadeRename - Change Name of Cascade Connection
		6.4.48 CascadeOnline - Switch Cascade Connection to Online Status
		6.4.49 CascadeOffline - Switch Cascade Connection to Offline Status
		6.4.50 AccessAdd - Add Access List Rules
		6.4.51 AccessList - Get Access List Rule List
		6.4.52 AccessDelete - Delete Rule from Access List
		6.4.53 AccessEnable - Enable Access List Rule
		6.4.54 AccessDisable - Disable Access List Rule
		6.4.55 UserList - Get List of Users
		6.4.56 UserCreate - Create User
		6.4.57 UserSet - Change User Information
		6.4.58 UserDelete - Delete User
		6.4.59 UserGet - Get User Information
		6.4.60 UserAnonymousSet - Set Anonymous Authentication for User Auth Type
		6.4.61 UserPasswordSet - Set Password Authentication for User Auth Type and Set Password
		6.4.62 UserCertSet - Set Individual Certificate Authentication for User Auth Type and Set Certificate
		6.4.63 UserCertGet - Get Certificate Registered for Individual Certificate Authentication User
		6.4.64 UserSignedSet - Set Signed Certificate Authentication for User Auth Type
		6.4.65 UserRadiusSet - Set RADIUS Authentication for User Auth Type
		6.4.66 UserNTLMSet - Set NT Domain Authentication for User Auth Type
		6.4.67 UserPolicyRemove - Delete User Security Policy
		6.4.68 UserPolicySet - Set User Security Policy
		6.4.69 UserExpiresSet - Set User's Expiration Date
		6.4.70 GroupList - Get List of Groups
		6.4.71 GroupCreate - Create Group
		6.4.72 GroupSet - Set Group Information
		6.4.73 GroupDelete - Delete Group
		6.4.74 GroupGet - Get Group Information and List of Assigned Users
		6.4.75 GroupJoin - Add User to Group
		6.4.76 GroupUnjoin - Delete User from Group
		6.4.77 GroupPolicyRemove - Delete Group Security Policy
		6.4.78 GroupPolicySet - Set Group Security Policy
		6.4.79 SessionList - Get List of Connected Sessions
		6.4.80 SessionGet - Get Session Information
		6.4.81 SessionDisconnect - Disconnect Session
		6.4.82 MacTable - Get the MAC Address Table Database
		6.4.83 MacDelete - Delete MAC Address Table Entry
		6.4.84 IpTable - Get the IP Address Table Database
		6.4.85 IpDelete - Delete IP Address Table Entry
		6.4.86 SecureNatEnable - Enable the Virtual NAT and DHCP Server Function (SecureNat Function)
		6.4.87 SecureNatDisable - Disable the Virtual NAT and DHCP Server Function (SecureNat Function)
		6.4.88 SecureNatStatusGet - Get the Operating Status of the Virtual NAT and DHCP Server Function (SecureNat Function)
		6.4.89 SecureNatHostGet - Get Network Interface Setting of Virtual Host of SecureNAT Function
		6.4.90 SecureNatHostSet - Change Network Interface Setting of Virtual Host of SecureNAT Function
		6.4.91 NatGet - Get Virtual NAT Function Setting of SecureNAT Function
		6.4.92 NatEnable - Enable Virtual NAT Function of SecureNAT Function
		6.4.93 NatDisable - Disable Virtual NAT Function of SecureNAT Function
		6.4.94 NatSet - Change Virtual NAT Function Setting of SecureNAT Function
		6.4.95 NatTable - Get Virtual NAT Function Session Table of SecureNAT Function
		6.4.96 DhcpGet - Get Virtual DHCP Server Function Setting of SecureNAT Function
		6.4.97 DhcpEnable - Enable Virtual DHCP Server Function of SecureNAT Function
		6.4.98 DhcpDisable - Disable Virtual DHCP Server Function of SecureNAT Function
		6.4.99 DhcpSet - Change Virtual DHCP Server Function Setting of SecureNAT Function
		6.4.100 DhcpTable - Get Virtual DHCP Server Function Lease Table of SecureNAT Function
		6.4.101 AdminOptionList - Get List of Virtual HUB Administration Options
		6.4.102 AdminOptionSet - Set Values of Virtual HUB Administration Options
		6.4.103 CrlList - Get List of Certificates Revocation List
		6.4.104 CrlAdd - Add a Revoked Certificate
		6.4.105 CrlDel - Delete a Revoked Certificate
		6.4.106 CrlGet - Get a Revoked Certificate
		6.4.107 AcList - Get List of Rule Items of IP Access Control List
		6.4.108 AcAdd - Add Rule to IP Access Control List
		6.4.109 AcDel - Delete Rule from IP Access Control List
	6.5 VPN Client Management Command Reference
		6.5.1 About - Display the version information
		6.5.2 VersionGet - Get Version Information of VPN Client Service
		6.5.3 PasswordSet - Set the password to connect to the VPN Client service.
		6.5.4 PasswordGet - Get Password Setting to Connect to VPN Client Service
		6.5.5 CertList - Get List of Trusted CA Certificates
		6.5.6 CertAdd - Add Trusted CA Certificate
		6.5.7 CertDelete - Delete Trusted CA Certificate
		6.5.8 CertGet - Get Trusted CA Certificate
		6.5.9 SecureList - Get List of Usable Smart Card Types
		6.5.10 SecureSelect - Select the Smart Card Type to Use
		6.5.11 SecureGet - Get ID of Smart Card Type to Use
		6.5.12 NicCreate - Create New Virtual Network Adapter
		6.5.13 NicDelete - Delete Virtual Network Adapter
		6.5.14 NicUpgrade - Upgrade Virtual Network Adapter Device Driver
		6.5.15 NicGetSetting - Get Virtual Network Adapter Setting
		6.5.16 NicSetSetting - Change Virtual Network Adapter Setting
		6.5.17 NicEnable - Enable Virtual Network Adapter
		6.5.18 NicDisable - Disable Virtual Network Adapter
		6.5.19 NicList - Get List of Virtual Network Adapters
		6.5.20 AccountList - Get List of VPN Connection Settings
		6.5.21 AccountCreate - Create New VPN Connection Setting
		6.5.22 AccountSet - Set the VPN Connection Setting Connection Destination
		6.5.23 AccountGet - Get Setting of VPN Connection Setting
		6.5.24 AccountDelete - Delete VPN Connection Setting
		6.5.25 AccountUsernameSet - Set User Name of User to Use Connection of VPN Connection Setting
		6.5.26 AccountAnonymousSet - Set User Authentication Type of VPN Connection Setting to Anonymous Authentication
		6.5.27 AccountPasswordSet - Set User Authentication Type of VPN Connection Setting to Password Authentication
		6.5.28 AccountCertSet - Set User Authentication Type of VPN Connection Setting to Client Certificate Authentication
		6.5.29 AccountCertGet - Get Client Certificate to Use for Cascade Connection
		6.5.30 AccountEncryptDisable - Disable Encryption when Communicating by VPN Connection Setting
		6.5.31 AccountEncryptEnable - Enable Encryption when Communicating by VPN Connection Setting
		6.5.32 AccountCompressEnable - Enable Data Compression when Communicating by VPN Connection Setting
		6.5.33 AccountCompressDisable - Disable Data Compression when Communicating by VPN Connection Setting
		6.5.34 AccountProxyNone - Specify Direct TCP/IP Connection as the Connection Method of VPN Connection Setting
		6.5.35 AccountProxyHttp - Set Connection Method of VPN Connection Setting to be via an HTTP Proxy Server
		6.5.36 AccountProxySocks - Set Connection Method of VPN Connection Setting to be via an SOCKS Proxy Server
		6.5.37 AccountServerCertEnable - Enable VPN Connection Setting Server Certificate Verification Option
		6.5.38 AccountServerCertDisable - Disable VPN Connection Setting Server Certificate Verification Option
		6.5.39 AccountServerCertSet - Set Server Individual Certificate for VPN Connection Setting
		6.5.40 AccountServerCertDelete - Delete Server Individual Certificate for VPN Connection Setting
		6.5.41 AccountServerCertGet - Get Server Individual Certificate for VPN Connection Setting
		6.5.42 AccountDetailSet - Set Advanced Settings for VPN Connection Setting
		6.5.43 AccountRename - Change VPN Connection Setting Name
		6.5.44 AccountConnect - Start Connection to VPN Server using VPN Connection Setting
		6.5.45 AccountDisconnect - Disconnect VPN Connection Setting During Connection
		6.5.46 AccountStatusGet - Get Current VPN Connection Setting Status
		6.5.47 AccountNicSet - Set Virtual Network Adapter for VPN Connection Setting to Use
		6.5.48 AccountStatusShow - Set Connection Status and Error Screen to Display when Connecting to VPN Server
		6.5.49 AccountStatusHide - Set Connection Status and Error Screen to be Hidden when Connecting to VPN Server
		6.5.50 AccountSecureCertSet - Set User Authentication Type of VPN Connection Setting to Smart Card Authentication
		6.5.51 AccountRetrySet - Set Interval between Connection Retries for Connection Failures or Disconnections of VPN Connection Setting
		6.5.52 AccountStartupSet - Set VPN Connection Setting as Startup Connection
		6.5.53 AccountStartupRemove - Remove Startup Connection of VPN Connection Setting
		6.5.54 AccountExport - Export VPN Connection Setting
		6.5.55 AccountImport - Import VPN Connection Setting
		6.5.56 RemoteEnable - Allow Remote Management of VPN Client Service
		6.5.57 RemoteDisable - Deny Remote Management of VPN Client Service
		6.5.58 KeepEnable - Enable the Keep Alive Internet Connection Function
		6.5.59 KeepDisable - Disable the Keep Alive Internet Connection Function
		6.5.60 KeepSet - Set the Keep Alive Internet Connection Function
		6.5.61 KeepGet - Get the Keep Alive Internet Connection Function
		6.5.62 MakeCert - Create New X.509 Certificate and Private Key
		6.5.63 TrafficClient - Execute Communication Throughput Measurement Tool Client
		6.5.64 TrafficServer - Execute Communication Throughput Measurement Tool Server
		6.5.65 Check - Check if PacketiX VPN Operation is Possible
	6.6 VPN Tools Command Reference
		6.6.1 About - Display the version information
		6.6.2 MakeCert - Create New X.509 Certificate and Private Key
		6.6.3 TrafficClient - Execute Communication Throughput Measurement Tool Client
		6.6.4 TrafficServer - Execute Communication Throughput Measurement Tool Server
		6.6.5 Check - Check if PacketiX VPN Operation is Possible

PacketiX VPN 2.0 Online Manual 2.20.5320
Copyright © 2004-2007 SoftEther Corporation. All Rights Reserved.
 Contact Plat'Home for inquiries. | Support | Notes