CipUX XML-RPC API Documentation 2006-10-27
==========================================

Under Perl Frontier::Client the return value on success is:
 * a reference to an array (if the output is a list, see cipux_task_list_*)
 * a string if the output is a single value
 * nothing
When the return value is an error, the XML-RPC type 'fault' is used.
For a `fault' type, the `value' array contains a hash with the two 
members `faultCode' and `faultMessage'.     
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_users:

  $return = cipux_task_list_users($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_users
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_room_network_address:

  $return = cipux_task_tell_me_room_network_address($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      RID (login: role ID, example: student)


EXAMPLES:

     $return = cipux_task_tell_me_room_network_address($login, $ticket, $RID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_own_password:

  $return = cipux_task_change_own_password($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)
  * 1 auxilliary options:
      password (a secret)


EXAMPLES:

     $return = cipux_task_change_own_password($login, $ticket, $UID);
     
     $return = cipux_task_change_own_password($login, $ticket, $UID, $password);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_examination:

  $return = cipux_task_tell_me_user_examination($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_examination($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_role:

  $return = cipux_task_tell_me_user_role($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_role($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_canonical_name:

  $return = cipux_task_tell_me_user_canonical_name($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_canonical_name($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_examination_user:

  $return = cipux_task_create_examination_user($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      leader ()
  * 1 auxilliary options:
      uhquota (user hard quota)
      usquota (user soft quota)
      ghquota (group hard quota)
      gsquota (groups soft quota)


EXAMPLES:

     $return = cipux_task_create_examination_user($login, $ticket, $UID, $leader);
     $return = cipux_task_create_examination_user($login, $ticket, $UID, $leader, $uhquota, $usquota, $ghquota, $gsquota);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_images:

  $return = cipux_task_list_images($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_images
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_internet_status:

  $return = cipux_task_tell_me_user_internet_status($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_internet_status($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_last_warning:

  $return = cipux_task_tell_me_user_last_warning($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_last_warning($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_enable_global_course:

  $return = cipux_task_enable_global_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_enable_global_course($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_add_user_to_course:

  $return = cipux_task_add_user_to_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      CID (login: course ID, example: linuxcourse)
      member_UID (member login of a given course: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_add_user_to_course($login, $ticket, $CID, $member_UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_delete_role:

  $return = cipux_task_delete_role($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      RID (login: role ID, example: student)


EXAMPLES:

     $return = cipux_task_delete_role($login, $ticket, $RID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_canonical_name:

  $return = cipux_task_change_user_canonical_name($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_canonical_name($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_roles:

  $return = cipux_task_list_roles($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_roles
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_disable_course:

  $return = cipux_task_disable_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_disable_course($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_warning:

  $return = cipux_task_tell_me_user_warning($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_warning($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_objects:

  $return = cipux_task_list_objects($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_objects
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_remove_user_from_course:

  $return = cipux_task_remove_user_from_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      CID (login: course ID, example: linuxcourse)
      member_UID (member login of a given course: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_remove_user_from_course($login, $ticket, $CID, $member_UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_room:

  $return = cipux_task_create_room($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 5 mandatory options:
      CN (CN: canonical name)
      network_address (network address, example 192.168.100.  
      network_mask (network mask, example 255.255.255.  
      gateway_address (gateway address, example 192.168.100.25  
      gateway_mask (gateway mask, example 255.255.255.  
  * 1 auxilliary options:
      description (some abitrary string)


EXAMPLES:

     $return = cipux_task_create_room($login, $ticket, $CN, $network_address, $network_mask, $gateway_address, $gateway_mask);
     $return = cipux_task_create_room($login, $ticket, $CN, $network_address, $network_mask, $gateway_address, $gateway_mask, $description);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_enable_internet_for_user:

  $return = cipux_task_enable_internet_for_user($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_enable_internet_for_user($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_print_apply_for_admission:

  $return = cipux_task_print_apply_for_admission($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_print_apply_for_admission($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_disable_user_posix_account:

  $return = cipux_task_disable_user_posix_account($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_disable_user_posix_account($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_enable_user:

  $return = cipux_task_enable_user($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_enable_user($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_role:

  $return = cipux_task_change_user_role($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)
      RID (login: role ID, example: student)


EXAMPLES:

     $return = cipux_task_change_user_role($login, $ticket, $UID, $RID);
     $return = cipux_task_change_user_role($login, $ticket, $UID, $RID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_image:

  $return = cipux_task_create_image($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 9 mandatory options:
      CN (CN: canonical name)
      image_name (some abitrary string)
      image_type (the type of the image: tar, dd)
      image_protect (portection, TRUE or FALSE, example: TRUE)
      image_enabled (in use? TRUE or FALSE, example: FALSE)
      image_size (image size)
      checksum (MD5 Checksum string)
      hardware_type_number (internal CipUX number for the hardware, example:   
      image_slot_number (internal CipUX number of the image slot, example:   


EXAMPLES:

     $return = cipux_task_create_image($login, $ticket, $CN, $image_name, $image_type, $image_protect, $image_enabled, $image_size, $checksum, $hardware_type_number, $image_slot_number);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_object:

  $return = cipux_task_create_object($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 5 mandatory options:
      OID (login: object ID, example for object = user : chkuelker)
      firstname (human first name)
      lastname (human family name)
      user_node_role (role like: account, share, ..)
      group_node_role (role like: student, teacher, skel, ...)
  * 1 auxilliary options:
      group_type ()
      password (a secret)
      default_CID (default course login: course ID, group ID)
      snd_skel_Uid (secondary skeleton ID: example cycle  
      uhquota (user hard quota)
      usquota (user soft quota)
      ghquota (group hard quota)
      gsquota (groups soft quota)


EXAMPLES:

     $return = cipux_task_create_object($login, $ticket, $OID, $firstname, $lastname, $user_node_role, $group_node_role);
     
     $return = cipux_task_create_object($login, $ticket, $OID, $firstname, $lastname, $user_node_role, $group_node_role, $group_type, $password, $default_CID, $snd_skel_Uid, $uhquota, $usquota, $ghquota, $gsquota);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_cipux_config_variable_value:

  $return = cipux_task_tell_me_cipux_config_variable_value($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      system (system: CAT, CipUX)
      variable ()


EXAMPLES:

     $return = cipux_task_tell_me_cipux_config_variable_value($login, $ticket, $system, $variable);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_room_network_mask:

  $return = cipux_task_tell_me_room_network_mask($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      RID (login: role ID, example: student)


EXAMPLES:

     $return = cipux_task_tell_me_room_network_mask($login, $ticket, $RID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_enable_course_samba_account:

  $return = cipux_task_enable_course_samba_account($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_enable_course_samba_account($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_mail:

  $return = cipux_task_change_user_mail($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_mail($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_phone:

  $return = cipux_task_change_user_phone($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_phone($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_creation_date:

  $return = cipux_task_change_user_creation_date($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_creation_date($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_soft_quota:

  $return = cipux_task_change_user_soft_quota($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_soft_quota($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_remove_user_from_global_course:

  $return = cipux_task_remove_user_from_global_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      CID (login: course ID, example: linuxcourse)
      member_UID (member login of a given course: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_remove_user_from_global_course($login, $ticket, $CID, $member_UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_address:

  $return = cipux_task_change_user_address($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_address($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_image_slots:

  $return = cipux_task_list_image_slots($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_image_slots
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_delete_global_course:

  $return = cipux_task_delete_global_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_delete_global_course($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_faculty:

  $return = cipux_task_tell_me_user_faculty($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_faculty($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_delete_hardware_type:

  $return = cipux_task_delete_hardware_type($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CN (CN: canonical name)


EXAMPLES:

     $return = cipux_task_delete_hardware_type($login, $ticket, $CN);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_machines:

  $return = cipux_task_list_machines($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_machines
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_firstname:

  $return = cipux_task_tell_me_user_firstname($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_firstname($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_address:

  $return = cipux_task_tell_me_user_address($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_address($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_course_password:

  $return = cipux_task_change_course_password($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)
  * 1 auxilliary options:
      password (a secret)


EXAMPLES:

     $return = cipux_task_change_course_password($login, $ticket, $CID);
     
     $return = cipux_task_change_course_password($login, $ticket, $CID, $password);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_expire_date:

  $return = cipux_task_change_user_expire_date($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_expire_date($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_disable_internet_for_course:

  $return = cipux_task_disable_internet_for_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_disable_internet_for_course($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_lastname:

  $return = cipux_task_change_user_lastname($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_lastname($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_phone:

  $return = cipux_task_tell_me_user_phone($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_phone($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_user_members_of_global_course:

  $return = cipux_task_list_user_members_of_global_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_list_user_members_of_global_course($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_delete_user:

  $return = cipux_task_delete_user($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_delete_user($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_delete_image_slot:

  $return = cipux_task_delete_image_slot($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CN (CN: canonical name)


EXAMPLES:

     $return = cipux_task_delete_image_slot($login, $ticket, $CN);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_users_internet_status:

  $return = cipux_task_tell_me_users_internet_status($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_tell_me_users_internet_status
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_delete_skel:

  $return = cipux_task_delete_skel($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      SID (login: skel ID, example: cycle  


EXAMPLES:

     $return = cipux_task_delete_skel($login, $ticket, $SID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_delete_user_homedir:

  $return = cipux_task_delete_user_homedir($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_delete_user_homedir($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_hardware_type:

  $return = cipux_task_create_hardware_type($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 4 mandatory options:
      CN (CN: canonical name)
      hardware_type_name (some abitrary string)
      hardware_type_protect (portection, TRUE or FALSE, example: TRUE)
      hardware_type_nic (a kernel module name for a network interface, example: 3c509x )


EXAMPLES:

     $return = cipux_task_create_hardware_type($login, $ticket, $CN, $hardware_type_name, $hardware_type_protect, $hardware_type_nic);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_global_courses:

  $return = cipux_task_list_global_courses($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_global_courses
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_hardware_types:

  $return = cipux_task_list_hardware_types($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_hardware_types
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_users_samba_status:

  $return = cipux_task_tell_me_users_samba_status($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_tell_me_users_samba_status
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_role:

  $return = cipux_task_create_role($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      RID (login: role ID, example: student)
  * 1 auxilliary options:
      password (a secret)


EXAMPLES:

     $return = cipux_task_create_role($login, $ticket, $RID);
     
     $return = cipux_task_create_role($login, $ticket, $RID, $password);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_hard_quota:

  $return = cipux_task_change_user_hard_quota($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_hard_quota($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_examination_course:

  $return = cipux_task_create_examination_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      CID (login: course ID, example: linuxcourse)
      leader ()
  * 1 auxilliary options:
      password (a secret)
      uhquota (user hard quota)
      usquota (user soft quota)
      ghquota (group hard quota)
      gsquota (groups soft quota)


EXAMPLES:

     $return = cipux_task_create_examination_course($login, $ticket, $CID, $leader);
     
     $return = cipux_task_create_examination_course($login, $ticket, $CID, $leader, $password, $uhquota, $usquota, $ghquota, $gsquota);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_last_warning:

  $return = cipux_task_change_user_last_warning($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_last_warning($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_restore_user_homedir:

  $return = cipux_task_restore_user_homedir($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)
  * 1 auxilliary options:
      homedirpath;skel_UID ()


EXAMPLES:

     $return = cipux_task_restore_user_homedir($login, $ticket, $UID);
     $return = cipux_task_restore_user_homedir($login, $ticket, $UID, $homedirpath, $skel_UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_warning:

  $return = cipux_task_change_user_warning($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_warning($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_last_logon:

  $return = cipux_task_tell_me_user_last_logon($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_last_logon($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_disable_internet_for_user:

  $return = cipux_task_disable_internet_for_user($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_disable_internet_for_user($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_internet_status:

  $return = cipux_task_change_user_internet_status($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_internet_status($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_university_id:

  $return = cipux_task_change_user_university_id($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_university_id($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_user:

  $return = cipux_task_create_user($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 4 mandatory options:
      UID (login: user ID, example: chkuelker)
      firstname (human first name)
      lastname (human family name)
      role (role, like stutent, teacher, ...)
  * 1 auxilliary options:
      password (a secret)
      default_CID (default course login: course ID, group ID)
      snd_skel_Uid (secondary skeleton ID: example cycle  
      uhquota (user hard quota)
      usquota (user soft quota)
      ghquota (group hard quota)
      gsquota (groups soft quota)


EXAMPLES:

     $return = cipux_task_create_user($login, $ticket, $UID, $firstname, $lastname, $role);
     
     $return = cipux_task_create_user($login, $ticket, $UID, $firstname, $lastname, $role, $password, $default_CID, $snd_skel_Uid, $uhquota, $usquota, $ghquota, $gsquota);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_delete_course:

  $return = cipux_task_delete_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_delete_course($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_skel:

  $return = cipux_task_create_skel($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      SID (login: skel ID, example: cycle  
  * 1 auxilliary options:
      password (a secret)


EXAMPLES:

     $return = cipux_task_create_skel($login, $ticket, $SID);
     
     $return = cipux_task_create_skel($login, $ticket, $SID, $password);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_applicant:

  $return = cipux_task_create_applicant($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 3 mandatory options:
      firstname (human first name)
      lastname (human family name)
      role (role, like stutent, teacher, ...)
  * 1 auxilliary options:
      password (a secret)
      default_CID (default course login: course ID, group ID)
      snd_skel_Uid (secondary skeleton ID: example cycle  
      uhquota (user hard quota)
      usquota (user soft quota)
      ghquota (group hard quota)
      gsquota (groups soft quota)


EXAMPLES:

     $return = cipux_task_create_applicant($login, $ticket, $firstname, $lastname, $role);
     
     $return = cipux_task_create_applicant($login, $ticket, $firstname, $lastname, $role, $password, $default_CID, $snd_skel_Uid, $uhquota, $usquota, $ghquota, $gsquota);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_machine:

  $return = cipux_task_create_machine($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      MID (some abitrary string)
  * 1 auxilliary options:
      client_number (Computer number, last digit of the IP, example: 25  
      mac_address (the MAC address of the client: example 00:04:B7:71:C1:A5 )
      room_name (some fancy name for a room)
      master (master mode, TRUE or FALSE, exaple: FALSE)
      image_slot_number (internal CipUX number of the image slot, example:   
      hardware_type_number (internal CipUX number for the hardware, example:   


EXAMPLES:

     $return = cipux_task_create_machine($login, $ticket, $MID);
     $return = cipux_task_create_machine($login, $ticket, $MID, $client_number, $mac_address, $room_name, $master, $image_slot_number, $hardware_type_number);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_examination:

  $return = cipux_task_change_user_examination($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_examination($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_status:

  $return = cipux_task_change_user_status($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_status($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_enable_user_posix_account:

  $return = cipux_task_enable_user_posix_account($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_enable_user_posix_account($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_room_gateway_mask:

  $return = cipux_task_tell_me_room_gateway_mask($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      RID (login: role ID, example: student)


EXAMPLES:

     $return = cipux_task_tell_me_room_gateway_mask($login, $ticket, $RID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_disable_course_posix_account:

  $return = cipux_task_disable_course_posix_account($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_disable_course_posix_account($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_rpc_functions:

  $return = cipux_task_list_rpc_functions($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_rpc_functions
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_disable_global_course:

  $return = cipux_task_disable_global_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_disable_global_course($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_soft_quota:

  $return = cipux_task_tell_me_user_soft_quota($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_soft_quota($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_mail:

  $return = cipux_task_tell_me_user_mail($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_mail($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_students:

  $return = cipux_task_list_students($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_students
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_last_logon:

  $return = cipux_task_change_user_last_logon($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_last_logon($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_credit:

  $return = cipux_task_change_user_credit($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_credit($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_courses:

  $return = cipux_task_list_courses($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_courses
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_delete_machine:

  $return = cipux_task_delete_machine($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      MID (some abitrary string)


EXAMPLES:

     $return = cipux_task_delete_machine($login, $ticket, $MID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_room_gateway_address:

  $return = cipux_task_tell_me_room_gateway_address($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      RID (login: role ID, example: student)


EXAMPLES:

     $return = cipux_task_tell_me_room_gateway_address($login, $ticket, $RID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_guests:

  $return = cipux_task_list_guests($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_guests
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_remove_nonexistent_users_from_all_courses:

  $return = cipux_task_remove_nonexistent_users_from_all_courses($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_remove_nonexistent_users_from_all_courses
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_enable_internet_for_course:

  $return = cipux_task_enable_internet_for_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_enable_internet_for_course($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_users_cipux_status:

  $return = cipux_task_tell_me_users_cipux_status($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_tell_me_users_cipux_status
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_cipux_config_variable_value:

  $return = cipux_task_change_cipux_config_variable_value($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      system (system: CAT, CipUX)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_cipux_config_variable_value($login, $ticket, $system, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_disable_user:

  $return = cipux_task_disable_user($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_disable_user($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_delete_image:

  $return = cipux_task_delete_image($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CN (CN: canonical name)


EXAMPLES:

     $return = cipux_task_delete_image($login, $ticket, $CN);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_firstname:

  $return = cipux_task_change_user_firstname($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_firstname($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_expire_date:

  $return = cipux_task_tell_me_user_expire_date($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_expire_date($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_lastname:

  $return = cipux_task_tell_me_user_lastname($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_lastname($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_enable_user_samba_account:

  $return = cipux_task_enable_user_samba_account($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_enable_user_samba_account($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_delete_room:

  $return = cipux_task_delete_room($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CN (CN: canonical name)


EXAMPLES:

     $return = cipux_task_delete_room($login, $ticket, $CN);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_password:

  $return = cipux_task_change_user_password($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)
  * 1 auxilliary options:
      password (a secret)


EXAMPLES:

     $return = cipux_task_change_user_password($login, $ticket, $UID);
     
     $return = cipux_task_change_user_password($login, $ticket, $UID, $password);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_users_posix_status:

  $return = cipux_task_tell_me_users_posix_status($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_tell_me_users_posix_status
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_university_id:

  $return = cipux_task_tell_me_user_university_id($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_university_id($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_hard_quota:

  $return = cipux_task_tell_me_user_hard_quota($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_hard_quota($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_global_course:

  $return = cipux_task_create_global_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)
  * 1 auxilliary options:
      password (a secret)
      uhquota (user hard quota)
      usquota (user soft quota)
      ghquota (group hard quota)
      gsquota (groups soft quota)


EXAMPLES:

     $return = cipux_task_create_global_course($login, $ticket, $CID);
     
     $return = cipux_task_create_global_course($login, $ticket, $CID, $password, $uhquota, $usquota, $ghquota, $gsquota);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_enable_course:

  $return = cipux_task_enable_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_enable_course($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_group_node_role:

  $return = cipux_task_list_group_node_role($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      role (role, like stutent, teacher, ...)


EXAMPLES:

     $return = cipux_task_list_group_node_role($login, $ticket, $role);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_disable_user_samba_account:

  $return = cipux_task_disable_user_samba_account($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_disable_user_samba_account($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_status:

  $return = cipux_task_tell_me_user_status($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_status($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_skels:

  $return = cipux_task_list_skels($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_skels
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_user_members_of_course:

  $return = cipux_task_list_user_members_of_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_list_user_members_of_course($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_reset_user_homedir:

  $return = cipux_task_reset_user_homedir($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)
  * 1 auxilliary options:
      homedirpath;skel_UID ()


EXAMPLES:

     $return = cipux_task_reset_user_homedir($login, $ticket, $UID);
     $return = cipux_task_reset_user_homedir($login, $ticket, $UID, $homedirpath, $skel_UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_disable_course_samba_account:

  $return = cipux_task_disable_course_samba_account($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_disable_course_samba_account($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_backup_user_homedir:

  $return = cipux_task_backup_user_homedir($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_backup_user_homedir($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_faculty:

  $return = cipux_task_change_user_faculty($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_faculty($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_creation_date:

  $return = cipux_task_tell_me_user_creation_date($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_creation_date($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_global_course_password:

  $return = cipux_task_change_global_course_password($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)
  * 1 auxilliary options:
      password (a secret)


EXAMPLES:

     $return = cipux_task_change_global_course_password($login, $ticket, $CID);
     
     $return = cipux_task_change_global_course_password($login, $ticket, $CID, $password);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_rooms:

  $return = cipux_task_list_rooms($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_rooms
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_change_user_remark:

  $return = cipux_task_change_user_remark($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      UID (login: user ID, example: chkuelker)
      value (some value, mostly string, or a number)


EXAMPLES:

     $return = cipux_task_change_user_remark($login, $ticket, $UID, $value);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_course:

  $return = cipux_task_create_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)
  * 1 auxilliary options:
      password (a secret)
      uhquota (user hard quota)
      usquota (user soft quota)
      ghquota (group hard quota)
      gsquota (groups soft quota)


EXAMPLES:

     $return = cipux_task_create_course($login, $ticket, $CID);
     
     $return = cipux_task_create_course($login, $ticket, $CID, $password, $uhquota, $usquota, $ghquota, $gsquota);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_create_image_slot:

  $return = cipux_task_create_image_slot($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 4 mandatory options:
      CN (CN: canonical name)
      image_slot_name (some abitrary string)
      image_slot_protect (portection, TRUE or FALSE, example: TRUE)
      image_slot_enabled (in use? TRUE or FALSE, example: FALSE)


EXAMPLES:

     $return = cipux_task_create_image_slot($login, $ticket, $CN, $image_slot_name, $image_slot_protect, $image_slot_enabled);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_remark:

  $return = cipux_task_tell_me_user_remark($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_remark($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_tell_me_user_credit:

  $return = cipux_task_tell_me_user_credit($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      UID (login: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_tell_me_user_credit($login, $ticket, $UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_enable_course_posix_account:

  $return = cipux_task_enable_course_posix_account($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      CID (login: course ID, example: linuxcourse)


EXAMPLES:

     $return = cipux_task_enable_course_posix_account($login, $ticket, $CID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_add_user_to_global_course:

  $return = cipux_task_add_user_to_global_course($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 2 mandatory options:
      CID (login: course ID, example: linuxcourse)
      member_UID (member login of a given course: user ID, example: chkuelker)


EXAMPLES:

     $return = cipux_task_add_user_to_global_course($login, $ticket, $CID, $member_UID);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_user_node_role:

  $return = cipux_task_list_user_node_role($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:

  * 1 mandatory options:
      role (role, like stutent, teacher, ...)


EXAMPLES:

     $return = cipux_task_list_user_node_role($login, $ticket, $role);
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
FUNCTION cipux_task_list_teachers:

  $return = cipux_task_list_teachers($login,$ticket,[OTHER PARAMETER]);


OTHER PARAMETER:



EXAMPLES:

     cipux_task_list_teachers
----------------------------------------------------------------------------