PyLoadL

Reservation API

Synopsis

  rc, errObj = ll_bind( res_id, job_list, bind_op )

  rc, errObj = ll_remove_reservation( res_id_list, res_user_list, res_host_list, res_group_list )

  rc, errObj = ll_make_reservation( start_date, period, res_type, res_data, users_list, groups_list, group_owner )

  rc, errObj = ll_change_reservation( res_IDs, param_dict )

Description

The LoadLeveler Reservation API via PyLoadL has the following functions:

ll_bind

The ll_bind routine enables you to bind job steps to a reservation. The ll_bind routine can also be used to unbind a list of job steps from the reservations to which they are currently bound to, or whichever reservation they have requested to bind to in the event that the bind has not yet occurred.

  rc = ll_bind( res_id, job_list, bind_op )

ll_remove_reservation

Function to enable you to cancel one or more reservations.

rc, errObj = ll_remove_reservation( res_id_list, res_user_list, res_host_list, res_group_list )

Parameters

1. res_id_list

   List : Reservation IDs in format: "host.rid.r".
   

2. res_users

   List : Reservation owners.
   

3. res_host_list

   List : Machine names.
   

4. res_group_list

   List : Loadleveler groups.
   

ll_make_reservation

Function to enable you to create a reservations.

rc, errObj = ll_make_reservation( start_date, period, res_type, res_data, users_list, groups_list, group_owner )

Parameters

1. start_date

   String : Start time of reservation in the format of "[mm/dd[/[cc]yy] ]HH:MM".
   

2. period

   Numeric : Duration of reservation in minutes.
   

3. res_type

   Constant : Indicates how the nodes should be reserved.
   

4. res_data

   Specifies options that control characteristics of the reservation. The follow values can be OR'ed together to set this parameter
   

1. RESERVATION_SHARED

   Selects the SHARED option for the reservation. For a SHARED reservation, after all bound job steps which can run on the reserved nodes are scheduled to run, the remaining resources can be used to run job steps not bound to the reservation. Only bound job steps can be scheduled to run on a reservation that is not shared.
   

2. RESERVATION_REMOVE_ON_IDLE

   Selects the REMOVE_ON_IDLE option for the reservation. For a REMOVE_ON_IDLE reservation, if all bound job steps are finished or if all bound job steps are Idle and none can run on the reserved nodes, the reservation will be removed (canceled) automatically by LoadLeveler. If this option is not set, the reservation will remain, regardless of being used or not.
   

5. users_list

   List : Users to use reservation.
   

6. groups_list

   List : Loadleveler groups to use reservation.
   

7. group_owner

   String : Loadleveler group owner.
   

ll_change_reservation


Function to enable you to change the attribute of a reservation.

rc, errObj = ll_change_reservation( res_IDs, param_dict )

Parameters

1. res_IDs

   List : Reservation IDs in format: "host.rid.r"
   

2. param_dict

   Dictionary : { RES_OP: OP_VALUE, ....}
   

Reservation Data Type	How nodes are reserved	Data Type
RESERVATION_BY_NODE	By number of nodes	string
RESERVATION_BY_HOSTLIST	By specifying a hostlist	list
RESERVATION_BY_JOBSTEP	By specifying a jobstep	string
RESERVATION_BY_JCF	By specifying a job command file	string
RESERVATION_BY_BG_CNODE	By number of Blue Gene c-nodes	numeric
RESERVATION_BY_HOSTFILE	By specifying a host file	string

To Modify	RES_OP	OP_VALUE
start_time	RESERVATION_START_TIME	string
start_time	RESERVATION_ADD_START_TIME	string
duration	RESERVATION_DURATION	numeric
number_of_nodes	RESERVATION_BY_NODE	numeric
number_of_nodes	RESERVATION_ADD_NUM_NODE	numeric
hostlist	RESERVATION_BY_HOSTLIST	list
hostlist	RESERVATION_ADD_HOSTS	list
hostlist	RESERVATION_DEL_HOSTS	list
jobstep	RESERVATION_BY_JOBSTEP	string
job_command_file	RESERVATION_BY_JCF	string
userlist	RESERVATION_USERLIST	list
userlist	RESERVATION_ADD_USERS	list
userlist	RESERVATION_DEL_USERS	list
grouplist	RESERVATION_GROUPLIST	list
grouplist	RESERVATION_ADD_GROUPS	list
grouplist	RESERVATION_DEL_GROUPS	list
shared mode	RESERVATION_MODE_SHARED	numeric
remove on idle	RESERVATION_MODE_REMOVE_ON_IDLE	numeric
owner	RESERVATION_OWNER	string
group	RESERVATION_GROUP	string
hostfile	RESERVATION_BY_HOSTFILE	string
number_of_bg_cnodes	RESERVATION_BY_BG_CNODE	numeric

---