Page MenuHomeFreeBSD
Differential D8691 Diff 24369 head/usr.sbin/wpa/wpa_cli/wpa_cli.8

Changeset View

Standalone View

View Options

head/usr.sbin/wpa/wpa_cli/wpa_cli.8

Show All 18 Lines
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd June 16, 2005 .Dd January 24, 2017
.Dt WPA_CLI 8 .Dt WPA_CLI 8
.Os .Os
.Sh NAME .Sh NAME
.Nm wpa_cli .Nm wpa_cli
.Nd "text-based frontend program for interacting with wpa_supplicant" .Nd "text-based frontend program for interacting with wpa_supplicant"
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm wpa_cli
.Op Ar commands .Op Fl p Ar path_to_ctrl_sockets
.Op Fl i Ar ifname
.Op Fl hvB
.Op Fl a Ar action_file
.Op Fl P Ar pid_file
.Op Fl g Ar global_ctrl
.Op Fl G Ar ping_interval
.Ar command ...
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
utility utility
is a text-based frontend program for interacting with is a text-based frontend program for interacting with
.Xr wpa_supplicant 8 . .Xr wpa_supplicant 8 .
It is used to query current status, It is used to query current status,
change configuration, change configuration,
▲ Show 20 Lines • Show All 95 Lines • ▼ Show 20 Lines
CTRL-REQ-PASSWORD-1:Password needed for SSID foobar CTRL-REQ-PASSWORD-1:Password needed for SSID foobar
> password 1 mysecretpassword > password 1 mysecretpassword
Example request for generic token card challenge-response: Example request for generic token card challenge-response:
CTRL-REQ-OTP-2:Challenge 1235663 needed for SSID foobar CTRL-REQ-OTP-2:Challenge 1235663 needed for SSID foobar
> otp 2 9876 > otp 2 9876
.Ed .Ed
.Sh OPTIONS
These options are available:
.Bl -tag -width indent
.It Fl p Ar path
Control sockets path.
This should match the
.Ic ctrl_interface
in
.Xr wpa_supplicant.conf 5 .
The default path is
.Pa /var/run/wpa_supplicant .
.It Fl i Ar ifname
Interface to be configured.
By default, the first interface found in the socket path is used.
.It Fl h
Show help.
.It Fl v
Show version information.
.It Fl B
Run the daemon in the background.
.It Fl a Ar action_file
Run in daemon mode, executing the action file based on events from
.Xr wpa_supplicant 8 .
.It Fl P Ar pid_file
PID file location.
.It Fl g Ar global_ctrl
Use a global control interface to
.Xr wpa_supplicant 8
rather than the default Unix domain sockets.
.It Fl G Ar ping_interval
Wait
.Dq ping_interval
seconds before sending each ping to
.Xr wpa_supplicant 8 .
See the
.Ic ping
command.
.It command
See available commands in the next section.
.El
.Sh COMMANDS .Sh COMMANDS
The following commands may be supplied on the command line These commands can be supplied on the command line
or at a prompt when operating interactively. or at a prompt when operating interactively.
.Bl -tag -width indent .Bl -tag -width indent
.It Ic status .It Ic status
Report the current WPA/EAPOL/EAP status for the current interface. Report the current WPA/EAPOL/EAP status for the current interface.
.It Ic ifname
Show the current interface name.
The default interface is the first interface found in the socket path.
.It Ic ping
Ping the
.Xr wpa_supplicant 8
utility.
This command can be used to test the status of the
.Xr wpa_supplicant 8
daemon.
.It Ic mib .It Ic mib
Report MIB variables (dot1x, dot11) for the current interface. Report MIB variables (dot1x, dot11) for the current interface.
.It Ic help .It Ic help
Show usage help. Show usage help.
.It Ic interface Op Ar ifname .It Ic interface Op Ar ifname
Show available interfaces and/or set the current interface Show available interfaces and/or set the current interface
when multiple are available. when multiple interfaces are available.
.It Ic level Ar debug_level .It Ic level Ar debug_level
Change the debugging level in Change the debugging level in
.Xr wpa_supplicant 8 . .Xr wpa_supplicant 8 .
Larger numbers generate more messages. Larger numbers generate more messages.
.It Ic license .It Ic license
Display the full Display the full license for
license for
.Nm . .Nm .
.It Ic logoff .It Ic logoff
Send the IEEE 802.1X EAPOL state machine into the Send the IEEE 802.1X EAPOL state machine into the
.Dq logoff .Dq logoff
state. state.
.It Ic logon .It Ic logon
Send the IEEE 802.1X EAPOL state machine into the Send the IEEE 802.1X EAPOL state machine into the
.Dq logon .Dq logon
Show All 12 Lines
to re-read its configuration file. to re-read its configuration file.
.It Ic preauthenticate Ar BSSID .It Ic preauthenticate Ar BSSID
Force preauthentication of the specified Force preauthentication of the specified
.Ar BSSID . .Ar BSSID .
.It Ic identity Ar network_id identity .It Ic identity Ar network_id identity
Configure an identity for an SSID. Configure an identity for an SSID.
.It Ic password Ar network_id password .It Ic password Ar network_id password
Configure a password for an SSID. Configure a password for an SSID.
.It Ic new_password Ar network_id password
Change the password for an SSID.
.It Ic PIN Ar network_id pin
Configure a PIN for an SSID.
.It Ic passphrase Ar network_id passphrase
Configure a private key passphrase for an SSID.
.It Ic bssid Ar network_id bssid
Set a preferred BSSID for an SSID
.It Ic blacklist Op Ar bssid | clear
Add a BSSID to the blacklist.
When invoked without any extra arguments, display the blacklist.
Specifying
.Ar clear
causes
.Nm
to clear the blacklist.
.It Ic list_networks
List configured networks.
.It Ic select_network Ar network_id
Select a network and disable others.
.It Ic enable_network Ar network_id
Enable a network.
.It Ic disable_network Ar network_id
Disable a network.
.It Ic add_network
Add a network.
.It Ic remove_network Ar network_id
Remove a network.
.It Ic set_network Op Ar network_id variable value
Set network variables.
Shows a list of variables when run without arguments.
.It Ic get_network Ar network_id variable
Get network variables.
.It Ic disconnect
Disconnect and wait for reassociate/reconnect command before connecting.
.It Ic reconnect
Similar to
.Ic reassociate ,
but only takes effect if already disconnected.
.It Ic scan
Request new BSS scan.
.It Ic scan_results
Get the latest BSS scan results.
This command can be invoked after running a BSS scan with
.Ic scan .
.It Ic bss Op Ar idx | bssid
Get a detailed BSS scan result for the network identified by
.Dq bssid
or
.Dq idx .
.It Ic otp Ar network_id password .It Ic otp Ar network_id password
Configure a one-time password for an SSID. Configure a one-time password for an SSID.
.It Ic terminate .It Ic terminate
Force Force
.Xr wpa_supplicant 8 .Xr wpa_supplicant 8
to terminate. to terminate.
.It Ic interface_add Ar ifname Op Ar confname driver ctrl_interface driver_param bridge_name
Add a new interface with the given parameters.
.It Ic interface_remove Ar ifname
Remove the interface.
.It Ic interface_list
List available interfaces.
.It Ic quit .It Ic quit
Exit Exit
.Nm . .Nm .
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr wpa_supplicant.conf 5 , .Xr wpa_supplicant.conf 5 ,
.Xr wpa_supplicant 8 .Xr wpa_supplicant 8
.Sh HISTORY .Sh HISTORY
The The
.Nm .Nm
utility first appeared in utility first appeared in
.Fx 6.0 . .Fx 6.0 .
.Sh AUTHORS .Sh AUTHORS
The The
.Nm .Nm
utility was written by utility was written by
.An Jouni Malinen Aq Mt j@w1.fi . .An Jouni Malinen Aq Mt j@w1.fi .
This manual page is derived from the This manual page is derived from the
.Pa README .Pa README
file included in the and
.Pa wpa_cli.c
files included in the
.Nm wpa_supplicant .Nm wpa_supplicant
distribution. distribution.