Class PiaCtl

Namespace

Cmpnnt.Pia.Ctl

Assembly

Cmpnnt.Pia.Ctl.dll

A convenience class to call the commands available in the piactl command line application. The methods are all asynchronous despite not using the async suffix.

public class PiaCtl

Inheritance

object

PiaCtl

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PiaCtl()

The default constructor.

public PiaCtl()

PiaCtl(ICommandLineWrapper)

Allows a CommandLineWrapper implementation to be set during construction.

public PiaCtl(ICommandLineWrapper commandLineWrapper)

Parameters

commandLineWrapper ICommandLineWrapper

PiaCtl(PiaCtlOptions)

Allows options to be set during construction.

public PiaCtl(PiaCtlOptions piaCtlOptions)

Parameters

piaCtlOptions PiaCtlOptions

PiaCtl(PiaCtlOptions, ICommandLineWrapper)

Allows options and a a CommandLineWrapper implementation to be set during construction.

public PiaCtl(PiaCtlOptions piaCtlOptions, ICommandLineWrapper commandLineWrapper)

Parameters

piaCtlOptions PiaCtlOptions

The options to configure

commandLineWrapper ICommandLineWrapper

A wrapper around the system's command line interface. The methods defined in this interface match ExecuteDelegate and ExecuteTimedDelegate

Methods

AddDedicatedIp(string, bool)

Adds a dedicated IP address to your VPN. The dedicated IP token must be in a text file by itself. This is an async method.

public Task<PiaResults> AddDedicatedIp(string tokenFilePath, bool debug = false)

Parameters

tokenFilePath string

The path to the text file containing your dedicated IP token.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

BackgroundDisable(bool)

Foregrounds a backgrounded PIA daemon. This is an async method.

public Task<PiaResults> BackgroundDisable(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

BackgroundEnable(bool)

Allow the killswitch and/or VPN connection to remain active in the background when the GUI client is not running. When enabled, the PIA daemon will stay active even if the GUI client is closed or has not been started. This allows Connection.Connect() to be used even if the GUI client is not running. Disabling background activation will disconnect the VPN and deactivate killswitch if the GUI client is not running. This is an async method.

public Task<PiaResults> BackgroundEnable(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

Connect(bool)

Connects to the VPN, or reconnects to apply new settings. To use this command, the PIA GUI client must be running, or background mode must be enabled with piactl background enable. By default, the PIA daemon is inactive when the GUI client is not running. This is an async method.

public Task<PiaResults> Connect(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

Disconnect(bool)

Disconnects from the VPN. This is an async method.

public Task<PiaResults> Disconnect(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

GetAllowLan(bool)

Gets whether allows LAN traffic. This is an async method.

public Task<PiaResults> GetAllowLan(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

GetConnectionState(bool)

Gets the current VPN connection state. This is an async method.

public Task<PiaResults> GetConnectionState(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

GetDebugLogging(bool)

Gets the current state of the debug logging setting. This is an async method.

public Task<PiaResults> GetDebugLogging(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

GetPortForward(bool)

Gets the forward port number, if available, or the status of the request to forward a port. This is an async method.

public Task<PiaResults> GetPortForward(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

GetProtocol(bool)

Gets the current VPN connection protocol. This is an async method.

public Task<PiaResults> GetProtocol(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

GetPubIp(bool)

Gets the current public IP address. This is an async method.

public Task<PiaResults> GetPubIp(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

GetRegion(bool)

Gets the currently selected region (or "auto"). This is an async method.

public Task<PiaResults> GetRegion(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

GetRegions(bool)

Lists all available regions. This is an async method.

public Task<PiaResults> GetRegions(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

GetRequestPortForward(bool)

Gets whether a forwarded port will be requested on the next connection attempt. This is an async method.

public Task<PiaResults> GetRequestPortForward(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

GetVpnIp(bool)

Gets the current VPN IP address. This is an async method.

public Task<PiaResults> GetVpnIp(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

Login(string, bool)

Logs into Private Internet Access using a login file. This is an async method.

public Task<PiaResults> Login(string loginFilePath, bool debug = false)

Parameters

loginFilePath string

The path to the text file containing your login information as specified by piactl.exe --help.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

Logout(bool)

Log out your PIA account on this computer. This is an async method.

public Task<PiaResults> Logout(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

MonitorAllowLan(uint, bool)

Monitors whether LAN traffic is being allowed. This is an async method.

public Task<PiaResults> MonitorAllowLan(uint timeout, bool debug = false)

Parameters

timeout uint

A (non-negative) integer number of seconds to run the monitor operation.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

MonitorConnectionState(uint, bool)

Monitors the VPN connection state. This is an async method.

public Task<PiaResults> MonitorConnectionState(uint timeout, bool debug = false)

Parameters

timeout uint

A (non-negative) integer number of seconds to run the monitor operation.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

MonitorDebugLogging(uint, bool)

Monitors the state of the debug logging setting. This is an async method.

public Task<PiaResults> MonitorDebugLogging(uint timeout, bool debug = false)

Parameters

timeout uint

A (non-negative) integer number of seconds to run the monitor operation.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

MonitorPortForward(uint, bool)

Monitors the forwarded port number, if available, or the status of the request to forward a port. This is an async method.

public Task<PiaResults> MonitorPortForward(uint timeout, bool debug = false)

Parameters

timeout uint

A (non-negative) integer number of seconds to run the monitor operation.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

MonitorProtocol(uint, bool)

Monitors the VPN connection protocol. This is an async method.

public Task<PiaResults> MonitorProtocol(uint timeout, bool debug = false)

Parameters

timeout uint

A (non-negative) integer number of seconds to run the monitor operation.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

MonitorPubIp(uint, bool)

Monitors the public IP address. This is an async method.

public Task<PiaResults> MonitorPubIp(uint timeout, bool debug = false)

Parameters

timeout uint

A (non-negative) integer number of seconds to run the monitor operation.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

MonitorRegion(uint, bool)

Monitors the currently selected region. This is an async method.

public Task<PiaResults> MonitorRegion(uint timeout, bool debug = false)

Parameters

timeout uint

A (non-negative) integer number of seconds to run the monitor operation.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

MonitorRequestPortForward(uint, bool)

Monitors whether a forwarded port will be requested on the next connection attempt. This is an async method.

public Task<PiaResults> MonitorRequestPortForward(uint timeout, bool debug = false)

Parameters

timeout uint

A (non-negative) integer number of seconds to run the monitor operation.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

MonitorVpnIp(uint, bool)

Monitors the VPN IP address. This is an async method.

public Task<PiaResults> MonitorVpnIp(uint timeout, bool debug = false)

Parameters

timeout uint

A (non-negative) integer number of seconds to run the monitor operation.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

RemoveDedicatedIp(string, bool)

Removes a dedicated IP address from your VPN. This is an async method.

public Task<PiaResults> RemoveDedicatedIp(string regionId, bool debug = false)

Parameters

regionId string

The region associated with the dedicated IP as shown by the method GetRegions() or piactl.exe get regions

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

ResetSettings(bool)

Resets daemon settings to the defaults (ports/protocols/etc). This affects the PIA daemon itself, not this instance of the CLI wrapper. This is an async method.

public Task<PiaResults> ResetSettings(bool debug = false)

Parameters

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

SetAllowLan(bool, bool)

Sets whether to allow LAN traffic. This is an async method.

public Task<PiaResults> SetAllowLan(bool value, bool debug = false)

Parameters

value bool

Whether or not to allow LAN traffic.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

SetDebugLogging(bool, bool)

Sets whether to enable or disable debug logging. This is an async method.

public Task<PiaResults> SetDebugLogging(bool value, bool debug = false)

Parameters

value bool

Whether or not to enable debug logging.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

SetProtocol(string, bool)

Sets the VPN protocol. This is an async method.

public Task<PiaResults> SetProtocol(string value, bool debug = false)

Parameters

value string

The VPN protocol to use. Must be one of "openvpn" or "wireguard".

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

SetRegion(string, bool)

Sets the VPN region. This is an async method.

public Task<PiaResults> SetRegion(string value, bool debug = false)

Parameters

value string

A valid region or "auto". Run the method GetRegions() for a list of regions.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.

SetRequestPortForward(bool, bool)

Sets whether to request a forwarded port on the next connection attempt. This is an async method.

public Task<PiaResults> SetRequestPortForward(bool value, bool debug = false)

Parameters

value bool

Whether or not to request port forwarding.

debug bool

Prints debug logs to stderr.

Returns

Task<PiaResults>

A Task<PiaResults> containing standard output and standard error results.