NAME

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

VERSION

version 0.10

FAQ

SEE ALSO

Setup

Setup::Unix::User

DESCRIPTION

This module has Rinci metadata.

FUNCTIONS

None are exported by default, but they are exportable.

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:

• -tx_action => str

  For more information on transaction, see Rinci::Transaction.

• -tx_action_id => str

  For more information on transaction, see Rinci::Transaction.

• -tx_recovery => str

  For more information on transaction, see Rinci::Transaction.

• -tx_rollback => str

  For more information on transaction, see Rinci::Transaction.

• -tx_v => str

  For more information on transaction, see Rinci::Transaction.

Return value:

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.

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:

• -tx_action => str

  For more information on transaction, see Rinci::Transaction.

• -tx_action_id => str

  For more information on transaction, see Rinci::Transaction.

• -tx_recovery => str

  For more information on transaction, see Rinci::Transaction.

• -tx_rollback => str

  For more information on transaction, see Rinci::Transaction.

• -tx_v => str

  For more information on transaction, see Rinci::Transaction.

Return value:

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.

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_exit => bool (default: 1)

  Whether group should exist.

Special arguments:

• -tx_action => str

  For more information on transaction, see Rinci::Transaction.

• -tx_action_id => str

  For more information on transaction, see Rinci::Transaction.

• -tx_recovery => str

  For more information on transaction, see Rinci::Transaction.

• -tx_rollback => str

  For more information on transaction, see Rinci::Transaction.

• -tx_v => str

  For more information on transaction, see Rinci::Transaction.

Return value:

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.

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Steven Haryanto.

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

cpanm Setup::Unix::User

perl -MCPAN -e shell
install Setup::Unix::User