Tivoli::AccessManager::Admin::SSO::Group
Tivoli::AccessManager::Admin::SSO::Group provides the interface to modify, create and delete GSO cred groups.
Initializes a blessed Tivoli::AccessManager::Admin::SSO::Group object.
An initialized Tivoli::AccessManager::Admin::Context object. As with every other class, the only way to change the context is to destroy the Tivoli::AccessManager::Admin::SSO::Cred object and recreate it with the new context. This parameter is required.
The name of the GSO resource group. This is optional. If provided, the module will attempt to determine if a resource group of the same name already exists.
A description for the resource group. This is completely optional.
Some GSO resources to be added to the group. This can be just about anything you want. It can consist of a scalar or a list. The scalar can be a simple string -- the name of the resource -- or it can be either a Tivoli::AccessManager::Admin::SSO::Cred or Tivoli::AccessManager::Admin::SSO::Web object.
A fully blessed Tivoli::AccessManager::Admin::SSO::Cred object under normal circumstances, undef otherwise. Since no TAM API calls are made by this method, "otherwise" can loosely be defined as "syntax error".
Does the same thing as "new", and creates the GSO group as well.
See the parameter list for "new". The only difference is that the name of the resource group is now required.
A Tivoli::AccessManager::Admin::Response object indicating the success or failure of the create operation. If it could be created, the new Tivoli::AccessManager::Admin::SSO::Group object will be embedded in the response object as well.
If you are adding resources at create time, do be aware that this is not an atomic operation -- the resource group can be created by adding the resources can fail.
Lists all GSO resource groups.
An initialized Tivoli::AccessManager::Admin::Context object.
A list of all the resource groups defined in TAM. This list may be empty.
This list is, of course, embedded in a Tivoli::AccessManager::Admin::Response object.
The standard disclaimer. All the methods will return a Tivoli::AccessManager::Admin::Response object unless specifically stated otherwise. See the documentation for that module on how to coax the values out.
The methods also follow the same basic pattern. If an optional parameter is provided, it will have the affect of setting the attribute. All method calls will embed the results of a 'get' in the Tivoli::AccessManager::Admin::Response object.
As you might expect, create can also be used as a method call.
See "new" for a full description. The name parameter is required only if it was not provided to "new"
The success or failure of the operation.
Deletes the GSO resource group.
None.
Adds or removes resources from the resource group.
Adds the named resources to the group. As with "create" and "new", the RESOURCES can be a single value or a list, a list of names or objects or some combination there of.
Removes the named resources from the group. As with "create" and "new", the RESOURCES can be a single value or a list, a list of names or objects or some combination there of.
If both add and remove are provided, the removes will be processed before the adds.
The success or failure of the operations and the current list (ie, the list of resource after all the operations) of resources in the group.
Updates the underlying API structure. You should almost never, ever need to call this directly.
The failure or success of the operation.
The following methods are read only. They do NOT return their data in Tivoli::AccessManager::Admin::Response object.
Returns the name of the resource group.
Returns 1 if the resource group exists, 0 otherwise.
See Tivoli::AccessManager::Admin for the list. This was not possible without the help of a bunch of people smarter than I.
None known.
Mik Firestone <mikfire@gmail.com>
Copyright (c) 2006-2013 Mik Firestone. All rights reserved. This program is free software; you can redistibute it and/or modify it under the same terms as Perl itself.
All references to TAM, Tivoli Access Manager, etc are copyrighted, trademarked and otherwise patented by IBM.
To install Tivoli::AccessManager::Admin, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tivoli::AccessManager::Admin
CPAN shell
perl -MCPAN -e shell install Tivoli::AccessManager::Admin
For more information on module installation, please visit the detailed CPAN module installation guide.