NAME
App::NetworkUtils - Command-line utilities related to networking
VERSION
This document describes version 0.005 of App::NetworkUtils (from Perl
distribution App-NetworkUtils), released on 2019-10-07.
DESCRIPTION
This distribution includes the following command-line utilities related
to networking:
* netoff
* neton
* networking-is-on
* turn-networking-off
* turn-networking-on
* turn-off-networking
* turn-off-wireless
* turn-on-networking
* turn-on-wireless
* turn-wireless-off
* turn-wireless-on
* wloff
* wlon
FUNCTIONS
networking_is_on
Usage:
networking_is_on() -> [status, msg, payload, meta]
Return true when networking is on, or 0 otherwise.
Will try: - nmcli
This function is not exported by default, but exportable.
No arguments.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200
means OK, 4xx caller error, 5xx function error). Second element (msg) is
a string containing error message, or 'OK' if status is 200. Third
element (payload) is optional, the actual result. Fourth element (meta)
is called result metadata and is optional, a hash that contains extra
information.
Return value: (any)
turn_off_networking
Usage:
turn_off_networking() -> [status, msg, payload, meta]
Turn off networking.
Will try: - nmcli
This function is not exported by default, but exportable.
No arguments.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200
means OK, 4xx caller error, 5xx function error). Second element (msg) is
a string containing error message, or 'OK' if status is 200. Third
element (payload) is optional, the actual result. Fourth element (meta)
is called result metadata and is optional, a hash that contains extra
information.
Return value: (any)
turn_off_wireless
Usage:
turn_off_wireless() -> [status, msg, payload, meta]
Turn off wireless networking.
Will try: - nmcli
This function is not exported by default, but exportable.
No arguments.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200
means OK, 4xx caller error, 5xx function error). Second element (msg) is
a string containing error message, or 'OK' if status is 200. Third
element (payload) is optional, the actual result. Fourth element (meta)
is called result metadata and is optional, a hash that contains extra
information.
Return value: (any)
turn_on_networking
Usage:
turn_on_networking() -> [status, msg, payload, meta]
Turn on networking.
Will try: - nmcli
This function is not exported by default, but exportable.
No arguments.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200
means OK, 4xx caller error, 5xx function error). Second element (msg) is
a string containing error message, or 'OK' if status is 200. Third
element (payload) is optional, the actual result. Fourth element (meta)
is called result metadata and is optional, a hash that contains extra
information.
Return value: (any)
turn_on_wireless
Usage:
turn_on_wireless() -> [status, msg, payload, meta]
Turn on wireless networking.
Will try: - nmcli
This function is not exported by default, but exportable.
No arguments.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200
means OK, 4xx caller error, 5xx function error). Second element (msg) is
a string containing error message, or 'OK' if status is 200. Third
element (payload) is optional, the actual result. Fourth element (meta)
is called result metadata and is optional, a hash that contains extra
information.
Return value: (any)
HOMEPAGE
Please visit the project's homepage at
<https://metacpan.org/release/App-NetworkUtils>.
SOURCE
Source repository is at
<https://github.com/perlancar/perl-App-NetworUtils>.
BUGS
Please report any bugs or feature requests on the bugtracker website
<https://rt.cpan.org/Public/Dist/Display.html?Name=App-NetworkUtils>
When submitting a bug or request, please include a test-file or a patch
to an existing test-file that illustrates the bug or desired feature.
SEE ALSO
App::BluetoothUtils
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2019, 2018 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.