Setup::Unix::Group - Setup Unix group (existence)
This document describes version 0.14 of Setup::Unix::Group (from Perl distribution Setup-Unix-User), released on 2017-07-10.
Usage:
addgroup(%args) -> [status, msg, result, meta]
Add group.
This function is not exported.
This function is idempotent (repeated invocations with same arguments has the same effect as single invocation). This function supports transactions.
Arguments ('*' denotes required arguments):
etc_dir => str (default: "/etc")
Location of passwd files.
gid => int
Add with specified GID.
If not specified, will search an unused GID from min_new_gid to max_new_gid.
min_new_gid
max_new_gid
If specified, will accept non-unique GID (that which has been used by other group).
group => str
Group name.
max_gid => int (default: 65534)
Specify range for new GID.
If a free GID between min_gid and max_gid is not available, an error is returned.
min_gid
max_gid
Passed to Unix::Passwd::File's max_new_gid.
min_gid => int (default: 1000)
Passed to Unix::Passwd::File's min_new_gid.
Special arguments:
-tx_action => str
For more information on transaction, see Rinci::Transaction.
-tx_action_id => str
-tx_recovery => str
-tx_rollback => str
-tx_v => str
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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
delgroup(%args) -> [status, msg, result, meta]
Delete group.
Fixed state: group does not exist.
Fixable state: group exists.
setup_unix_group(%args) -> [status, msg, result, meta]
Setup Unix group (existence).
On do, will create Unix group if not already exists. The created GID will be returned in the result ({gid => GID}). If should_already_exist is set to true, won't create but only require that group already exists. If should_exist is set to false, will delete existing group instead of creating it.
{gid => GID}
should_already_exist
should_exist
On undo, will delete Unix group previously created.
On redo, will recreate the Unix group with the same GID.
This function is not exported by default, but exportable.
max_new_gid => int (default: 65534)
min_new_gid => int (default: 1000)
new_gid => int
should_already_exist => bool
Whether group should already exist.
should_exist => bool (default: 1)
Whether group should exist.
Please visit the project's homepage at https://metacpan.org/release/Setup-Unix-User.
Source repository is at https://github.com/perlancar/perl-Setup-Unix-User.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Setup-Unix-User
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.
Setup
Setup::Unix::User
perlancar <perlancar@cpan.org>
This software is copyright (c) 2017, 2015, 2014, 2012, 2011 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.
To install Setup::Unix::User, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Setup::Unix::User
CPAN shell
perl -MCPAN -e shell install Setup::Unix::User
For more information on module installation, please visit the detailed CPAN module installation guide.