IBM Books

IBM LoadLeveler for AIX 5L: Using and Administering

Summary of LoadLeveler APIs

Table 5 summarizes LoadLeveler APIs.

Table 5. Application Programming Interfaces

API Description Who Can Issue? For More Information
Accounting Generates accounting reports GetHistory -- Users and LoadLeveler Administrators See page"Accounting API"
Checkpointing Checkpoint LoadLeveler jobs All APIs (ll_init_ckpt, ll_ckpt, ll_set_ckpt_callbacks, ll_unset_ckpt_callbacks) -- Users and LoadLeveler Administrators See page "Checkpointing API"
Data Access Accesses LoadLeveler objects and allows you to retrieve data from objects All subroutines (ll_query, ll_set_request, ll_reset_request, ll_get_objs, ll_get_data, ll_next_obj, ll_free_objs, ll_deallocate) -- Users and LoadLeveler Administrators See page "Data Access API"
Error Handling Converts an error object into an error message ll_error -- Users and LoadLeveler Administrators See page "Error Handling API"
Parallel Job Tools for parallel job submission All subroutines (ll_get_hostlist, ll_start_host) -- Users and LoadLeveler Administrators See page "Parallel Job API"
Query Provides information about the jobs and machines in the LoadLeveler cluster All subroutines (ll_get_jobs, ll_free_jobs, ll_get_nodes, ll_free_nodes) -- Users and LoadLeveler Administrators See page "Query API"
Submit Submits jobs to LoadLeveler
  • llsubmit -- Users and LoadLeveler Administrators
  • llfree_job_info -- Users and LoadLeveler Administrators

See page "Submit API"
Workload Management Performs LoadLeveler control operations and provides tools to be used with an external scheduler
  • ll_control
    • LoadLeveler Administrators only:

      LL_CONTROL_DRAIN

      LL_CONTROL_DRAIN_SCHEDD

      LL_CONTROL_DRAIN_STARTD

      LL_CONTROL_FAVOR_JOB

      LL_CONTROL_FAVOR_USER

      LL_CONTROL_FLUSH

      LL_CONTROL_HOLD_SYSTEM

      LL_CONTROL_PURGE_SCHEDD

      LL_CONTROL_RECONFIG

      LL_CONTROL_RECYCLE

      LL_CONTROL_RESUME

      LL_CONTROL_RESUME_SCHEDD

      LL_CONTROL_RESUME_STARTD

      LL_CONTROL_STOP

      LL_CONTROL_SUSPEND

      LL_CONTROL_UNFAVOR_JOB

      LL_CONTROL_UNFAVOR_USER

    • Users and LoadLeveler Administrators:

      LL_CONTROL_HOLD_USER

      LL_CONTROL_PRIO_ABS

      LL_CONTROL_PRIO_ADJ

      LL_CONTROL_START

  • ll_modify -- Users and LoadLeveler Administrators (some functions limited to Gang scheduling)
  • ll_preempt -- LoadLeveler Administrators (function limited to Gang and external schedulers)
  • ll_start_job -- LoadLeveler Administrators, for use with external schedulers only
  • ll_terminate_job -- LoadLeveler Administrators only

See page "Workload Management API"
User exits

Allows:

  • Handling DCE security
  • Handling AFS tokens
  • Filtering job scripts
  • Overriding default mail program
  • Job prolog
  • Job epilog

LoadLeveler administrators only
Note:Other User exits are available with functions limited to specific APIs.
See page "User exits"

[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]