George Chlipala > TAM-Admin-0.35 > TAM::Admin::Group

Download:
TAM-Admin-0.35.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

TAM::Admin::Group - Perl extension for TAM Admin API

SYNOPSIS ^

  use TAM::Admin;

  # Connect to the policy server as sec_master
  my $pdadmin = TAM::Admin->new('sec_master', 'password');

  # Get the iv-admin group and print basic information
  my $group = $pdadmin->get_group('iv-admin');
  print 'Group ID: ', $group->id, "\n";
  print 'Group CN: ', $group->cn, "\n";
  print 'Group DN: ', $group->dn, "\n";

DESCRIPTION ^

TAM::Admin::Group is a support module for the TAM::Admin module.

METHODS ^

id

Return the TAM ID of the group.

cn

Return the LDAP CN of the group.

dn

Returns the LDAP DN of the group.

description(<description>)

Return the current description of the group. The method will set the description to the value of the first parameter, if passed.

remove

Remove the group from TAM only. This method is equivalent to the following pdadmin command.

   pdadmin> group delete <userid>

delete

Remove the group from TAM and LDAP. This method is equivalent to the following pdadmin command.

   pdadmin> group delete -registry <userid>

ok

Returns true if the last action was successful.

error

Returns true if the last action was unsuccessful.

message([<index>])

Returns the error message for the last action. The index will specify which error message to return if the last action resulted in more that one error condition. The index is 0 based.

code([<index>])

Returns the error code for the last action. The index will specify which error code to return if the last ction resulted in more that one error condition. The index is 0 based.

msg_count ^

Returns the number of errors generated for the last action.

AUTHOR ^

George Chlipala, george@walnutcs.com

SEE ALSO ^

perl(1).

syntax highlighting: