Louis Erickson
and 2 contributors

NAME

Samba::Smbstatus - Read active Samba server data from smbstatus

VERSION

Version 0.01

SYNOPSIS

Provides information about current connections to the local Samba server.

    use Samba::Smbstatus;

    my $smbstats = Samba::Smbstatus->new;
    my $services = $smbstats->services;
    my $users = $smbstats->users;
    my $locks = $smbstats->locks;

DESCRIPTION

This module reads data from the local Samba server and returns information about the current users, connections, and resources those users are using.

This information is currently gathered from

METHODS

new()

Create the Samba::Smbstatus object. Can be called with parameters to configure the object.

Configuration parameters are:

smbstatus_binary

Provide a path to the smbstatus binary to use to query the status of the running server. Defaults to searching the path for an smbstatus, which some may consider insecure.

smbstatus_binary()

Fetch the name of the smbstatus binary used to query the running Samba server. Returns the default value, or the value set at init time.

services()

Returns information about what services are in use by what users.

Returns an array reference of hash references, each of which should have the following keys:

service

Name of the service being described by this entry. Usually a share name, but can also be printers, named pipes, or other Samba objects.

pid

Process ID of the process serving the data. A client will be connected to the socket this process has open.

machine

Name of the machine or service connected to this resource. Usually a host name, but sometimes a synthetic client name.

connected

Time the client connected to this service.

users()

Returns information about what users are connected to the server.

Returns an array reference of hash references, each of which should have the following keys:

pid

Process ID of the process serving the data. A client will be connected to the socket this process has open.

username

Name of the account used by this connection.

group

Name of the group used by this connection.

machine

Name of the machine or service connected to this resource. Usually a host name, but sometimes a synthetic client name.

ip

IP address this connection is from.

locks()

Returns information about what files are locked by the clients on this Samba server..

Returns an array reference of hash references, each of which should have the following keys:

pid

Process ID of the process serving the data. A client will be connected to the socket this process has open.

uid

User ID used by this connection. (Not a user name - names can be correlated by pid from the users data.)

deny_mode

Read/write lock requested by this client. Symbolic names from Samba. Common values are:

DENY_NONE
DENY_ALL
DENY_READ
DENY_WRITE
DENY_DOS
DENY_FCB

See Using Samba, chapter 5 for more description of what those mean.

access

Numeric access code requested for this item. Displayed as a hexidecimal value.

readwrite

Symbolic value describing how this file is being used by the client. Values are from Samba. Known values are:

RDONLY
RDWR
oplock

Symbolic values from Samba representing the operational locking mode for this file.

Known values are:

NONE
EXCLUSIVE+BATCH
share

Name of the shared path opened by the client. This is the path on the local system.

name

Name of the item being used by the system. It represents a file or directory on the local sysetm in the share location.

time

Time the lock was made by this client.

AUTHOR

Louis Erickson, <laufeyjarson at laufeyjarson.com>

BUGS

Please report any bugs or feature requests to bug-samba-smbstatus at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Samba-Smbstatus. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Samba::Smbstatus

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2014 Louis Erickson.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.