NAME

Win32::Netsh::Wlan - Provide functions in that correlate to the Microsoft Windows netsh utility's wlan context

VERSION

Version 0.01

SYNOPSIS

use Win32::Netsh::Wlan qw(wlan_interface_info_all);

my @wireless_if = wlan_interface_info_all();

FUNCTIONS

wlan_debug($level)

Description: Set the debug level for the module
Parameters: $level - Debug level
Return: SCALAR - Current debug level

wlan_interface_info_all()

Description

Return a reference to a list of hashes that describe the wireless interfaces available

Parameters

NONE

Return

ARRAY reference of hash references whose keys are as follows:

name: Name of the interface
description: Description of the interface
guid: GUID associated with the interface
mac_address: IEEE MAC address of the interfaces as a string with the format "xx:xx:xx:xx:xx:xx" where xx is a hexadecimal number between 00 and ff
state: Disconnected, discovering, or connected
ssid: SSID of connected wireless network
bssid: IEEE MAC address of the associated accees point as a string with the format "xx:xx:xx:xx:xx:xx" where xx is a hexadecimal number between 00 and ff
net_type: String indicating "Infrastructure" or "Ad hoc" mode for the connection
radio: String indicating if connection is 802.11b 802.11n etc.
auth: String indicating the type of authentication for the connection
cipher: String indicating the cypher type
mode: String indicating connection mode
channel: RF channel used for connection
rx_rate: Receive rate in Mbps
tx_rate: Receive rate in Mbps
signal: Signal strength as a percentage

wlan_interface_info($name)

Description

Return a reference to a hash that describes the wireless interface

Parameters

$name: Name of the interface such as "Wireless Network Connection"

Return

UNDEF

Indicates the named interface could not be found

HASH reference

Hash reference whose keys are as follows:

name: Name of the interface
description: Description of the interface
guid: GUID associated with the interface
mac_address: IEEE MAC address of the interfaces as a string with the format "xx:xx:xx:xx:xx:xx" where xx is a hexadecimal number between 00 and ff
state: Disconnected, discovering, or connected
ssid: SSID of connected wireless network
bssid: IEEE MAC address of the associated accees point as a string with the format "xx:xx:xx:xx:xx:xx" where xx is a hexadecimal number between 00 and ff
net_type: String indicating "Infrastructure" or "Ad hoc" mode for the connection
radio: String indicating if connection is 802.11b 802.11n etc.
auth: String indicating the type of authentication for the connection
cipher: String indicating the cypher type
mode: String indicating connection mode
channel: RF channel used for connection
rx_rate: Receive rate in Mbps
tx_rate: Receive rate in Mbps
signal: Signal strength as a percentage

wlan_profile_info($name)

Description

Return a hash reference with details of the given profile name

Parameters

$name: Name of the profile

Return

UNDEF

Indicates profile not found

HASH Reference

Hash reference whose keys are as follows:

name: Name of the profile
interface: Name of the interface
ssid: SSID of the wireless network
net_type: String indicating "Infrastructure" or "Ad hoc" mode for the connection
radio: String indicating if connection is 802.11b 802.11n etc.
auth: String indicating the type of authentication for the connection
cipher String indicating the cypher type
mode String indicating connection mode

wlan_profile_info_all()

Description

Return an array reference of hash references with details of the profiles

Parameters

NONE

Return

ARRAY reference of hash references corresponding to each profile. Each hash reference has the following keys:

name: Name of the profile
interface: Name of the interface
ssid: SSID of the wireless network
net_type: String indicating "Infrastructure" or "Ad hoc" mode for the connection
radio: String indicating if connection is 802.11b 802.11n etc.
auth: String indicating the type of authentication for the connection
cipher String indicating the cypher type
mode String indicating connection mode

wlan_profile_add($filename, $options)

Description

Add the given profile with the specified options. If no options are provided then the profile will be added for all interfaces and all users

Parameters

$filename

Filename of the XML file containing the wireless profiles

$options

Optional hash reference with the following keys:

interface: Name of the interface for the profile
user: User scope (all or current)

Return

UNDEF on error, or 1 for success

wlan_profile_delete($name)

Description

Delete the specified profile if it exists

Parameters

$name: Name of the profile to delete

Return

UNDEF on error, or 1 for success

wlan_last_error()

Description: Return the error string associated with the last command
Parameters: NONE
Return: SCALAR - Error string

AUTHOR

Paul Durden <alabamapaul AT gmail.com>

COPYRIGHT & LICENSE

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

To install Win32::Netsh, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Win32::Netsh

CPAN shell

perl -MCPAN -e shell
install Win32::Netsh

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

FUNCTIONS

wlan_debug($level)

wlan_interface_info_all()

wlan_interface_info($name)

wlan_profile_info($name)

wlan_profile_info_all()

wlan_profile_add($filename, $options)

wlan_profile_delete($name)

wlan_last_error()

AUTHOR

COPYRIGHT & LICENSE

Module Install Instructions