CIPUX_CAT_WEB_MODULE(1p) User Contributed Perl Documentation CIPUX_CAT_WEB_MODULE(1p)NAME
Program to register, deregister and list a CAT modules.
SYNOPSIS(1) cipux_cat_web_module [OPTIONS] --register --object <NAME>| --all(2) cipux_cat_web_module [OPTIONS] --deregister --object <NAME>| --all(3) cipux_cat_web_module [OPTIONS] --list-registered(4) cipux_cat_web_module [OPTIONS] --list-deregistered
OPTIONS
Options for all commands:
-D | --debug : print debug messages for developers
-h | --help : print help (this message + options)
-l | --login ID : uses ID as UID to authenticate
-V | --version : print only version
--verbose : print more messages
-w | --password CRED : uses CRED as credential to authenticate
Additional options for registering and deregistering:
-a | --all : (de)register all pending objects
Additional options for registering:
-e | --enable : enable module(s)
-m | --add-member : add object (user or group) to ACL
USAGE SPECIFIC OPTIONS(1) register
--add-member <NAME> : do add object to the ACL, so that this object
can access the modules. An object could be a
group or a user.
-e | --enable : do enable the module during registration; module is
disabled by default
-a | --all : register all modules
or
-o | --object <NAME> : or register only one module(2) deregister
-a | --all : deregister all modules
or
-o | --object <NAME> : or deregister only one module
The URL of the CipUX XML-RPC server is taken from cipux-cat-web.ini file. The default location for CipUX-CAT-Web. If you would like to use
a different URL change catweb_rpc_server in the base section.
DESCRIPTION OF OPTIONS -a Same as option --all
-add-member NAME
Adds NAME to the ACL of that module(s).
-all
Register all CAT modules.
-D Same as option --debug.
--debug
To see more output, what the internals is doing, you can enable the --debug option and see more message printed to STDOUT.
-e Same as option --enable.
--enable
Enable the object during registration.
-h Same as option --help
--help
Prints brief help message.
-l UID
Same as option --login UID.
--login UID
Use UID as identity to authenticate against RPC server.
-o Same as option --object
--object
This option is used to specify the object on which the command is operating. Make sure you choose the right object. Of course this
will also fail when the object is not fetchable with (in the objects list of) --task.
--password SECRET
Use SECRET as credential to authenticate against RPC server.
-V Same as option --version.
--version
Prints the version and exits.
--verbose
Not implemented yet.
-v Same as option --verbose.
-w SECRET
Same as option --password SECRET.
perl v5.14.2 2012-12-07 CIPUX_CAT_WEB_MODULE(1p)
Check Out this Related Man Page
CIPUX_OBJECT_CLIENT(1p) User Contributed Perl Documentation CIPUX_OBJECT_CLIENT(1p)NAME
cipux_object_client - create, destroy CipUX objects
VERSION
version 3.4.0.3
SYNOPSIS
cipux_object_client [OPTIONS] -a <ACTION>
cipux_object_client [OPTIONS] -a list
cipux_object_client [OPTIONS] -a create -t <TYPE> -o <OBJECT>
cipux_object_client [OPTIONS] -a destroy -t <TYPE> -o <OBJECT>
OPTIONS -c | --cfg : cipux-object.conf
-D | --debug [<LEVEL>] : print debug messages for developers
-h | --help : print help (this message + options)
-l | --list : lists configuration scopes
-p | --pretty : nice boxed output
-V | --version : print only version
--verbose : print more messages
USAGE
cipux_object_client [OPTIONS] -l : lists CipUX objects
cipux_object_client [OPTIONS] -h : help page
cipux_object_client [OPTIONS] -V : prints version
DESCRIPTION
TODO
REQUIRED ARGUMENTS
One of -l or -h or -V is required.
ARGUMENTS -c Same as option --cfg.
--cfg
To specify the configuration file, if any. The preset location for the configuration file is:(1) ~/.cipux/cipux-object.conf
or(2) /etc/cipux/cipux-object.conf
If both are missing, you have to use this option --cfg to specify one.
-D Same as option --debug.
--debug
To see more output, what the internals is doing, you can enable the --debug and see more messages printed to STDOUT. The suggestion is
not to use debug output for production code.
-h Same as option --help
--help
Prints brief help message.
-l Same as option --list
--list
Lists all object scopes. The object scopes are read from the configuration file. The preset location of the configuration file is
/etc/cipux/cipux-storage-structure.conf. One object type is needed for the --type option.
Prints a list of configuration types to STDOUT. No object will be changed. This is useful if(1) you would like to see what kind of
objects this layer can handle and(2) if you would like to test the preset or another object layer configuration file. You can use this
with all other options, they will be ignored except -p | -pretty or -D | --debug.
Example:
cipux_object_client -l -p
+-----------------------+
| type |
+=======================+
| cipux_account |
| cipux_share |
| cipux_room |
| cipux_configuration |
| cipux_machines |
| netgroup |
| cipux_room |
+-----------------------+
-p Same as option --pretty.
--pretty
On command which produce an output, this option can be used to draw a fancy box around the output.
-V Same as option --version.
--version
Prints the version and exits.
--verbose
Not implemented jet.
-v Same as option --verbose.
DIAGNOSTICS
TODO
EXIT STATUS
TODO
CONFIGURATION
TODO
DEPENDENCIES
Carp CipUX::Object::Client version
INCOMPATIBILITIES
Not known.
BUGS AND LIMITATIONS
Not known.
SEE ALSO
See the CipUX web page and the manual at <http://www.cipux.org>
See the mailing list http://sympa.cipworx.org/wws/info/cipux-devel <http://sympa.cipworx.org/wws/info/cipux-devel>
AUTHOR
Christian Kuelker <christian.kuelker@cipworx.org>
LICENSE AND COPYRIGHT
Copyright (C) 2007 - 2009 by Christian Kuelker
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
perl v5.12.3 2011-05-05 CIPUX_OBJECT_CLIENT(1p)