The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Setup-Unix-User-0.13
River stage one • 1 direct dependent • 1 total dependent
++
/ Setup::Unix::Group

NAME

Setup::Unix::Group - Setup Unix group (existence)

VERSION

This document describes version 0.13 of Setup::Unix::Group (from Perl distribution Setup-Unix-User), released on 2015-09-04.

FAQ

SEE ALSO

Setup

Setup::Unix::User

FUNCTIONS

addgroup(%args) -> [status, msg, result, meta]

Add group.

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.

    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.

    Passed to Unix::Passwd::File's max_new_gid.

  • min_gid => int (default: 1000)

    Specify range for new GID.

    If a free GID between min_gid and max_gid is not available, an error is returned.

    Passed to Unix::Passwd::File's min_new_gid.

Special 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 (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.

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.

  • group => str

    Group name.

Special 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 (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)

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.

On undo, will delete Unix group previously created.

On redo, will recreate the Unix group with the same GID.

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.

  • group => str

    Group name.

  • max_new_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.

    Passed to Unix::Passwd::File's max_new_gid.

  • min_new_gid => int (default: 1000)

    Specify range for new GID.

    If a free GID between min_gid and max_gid is not available, an error is returned.

    Passed to Unix::Passwd::File's min_new_gid.

  • new_gid => int

    Add with specified GID.

    If not specified, will search an unused GID from min_new_gid to max_new_gid.

    If specified, will accept non-unique GID (that which has been used by other group).

  • should_already_exist => bool

    Whether group should already exist.

  • should_exist => bool (default: 1)

    Whether group should exist.

Special 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 (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)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Setup-Unix-User.

SOURCE

Source repository is at https://github.com/perlancar/perl-Setup-Unix-User.

BUGS

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 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.