LSF Configuration APIs Quick Reference
The following tables list all the available LSF configuration APIs.
General configuration APIs
| Configuration APIs | HTTP Method | Description |
|---|---|---|
|
/platform/ws/lsfconfig/load |
POST | Load a new LSF configuration from LSF |
| /platform/ws/lsfconfig | GET | Get a list of LSF configurations in the database |
| /platform/ws/lsfconfig/{configId} | GET | Get detailed information about an LSF configuration |
| DELETE | Delete an LSF configuration from the database | |
| POST | Apply an LSF configuration to LSF |
Abstracted category configuration APIs
| Configuration APIs | HTTP Method | Description |
|---|---|---|
|
/platform/ws/lsfconfig/{configId}/clusterparameters |
GET | Get detailed information about parameters related to the cluster in the configuration. |
| PUT | Saves parameter settings in the database related to the cluster. | |
|
/platform/ws/lsfconfig/{configId}/resources |
GET | Get detailed information about parameters related to resources in the configuration. |
| PUT | Saves parameter settings in the database related to resources. | |
|
/platform/ws/lsfconfig/{configId}/hosts |
GET | Get detailed information about parameters related to hosts in the configuration. |
| PUT | Saves parameter settings in the database related to hosts. | |
|
/platform/ws/lsfconfig/{configId}/hostgroups |
GET | Get detailed information about parameters related to the hosts in the configuration. |
| PUT | Saves parameter settings in the database related to host groups. | |
|
/platform/ws/lsfconfig/{configId}/queues |
GET | Get detailed information about parameters related to the queues in the configuration. |
| PUT | Saves parameter settings in the database related to queues. | |
|
/platform/ws/lsfconfig/{configId}/users |
GET | Get detailed information about parameters related to users in the configuration. |
| PUT | Saves parameter settings in the database related to users. | |
|
/platform/ws/lsfconfig/{configId}/usergroups |
GET | Get detailed information about parameters related to user groups in the configuration. |
| PUT | Saves parameter settings in the database related to user groups | |
|
/platform/ws/lsfconfig/{configId}/resourcelimits |
GET | Get detailed information about parameters related to resource limits in the configuration. |
| PUT | Saves parameter settings in the database related to resource limits. | |
|
/platform/ws/lsfconfig/{configId}/resourcereservations |
GET | Get detailed information about parameters related to resource reservations in the configuration. |
| PUT | Saves parameter settings in the database related to resource reservation. |
File-based configuration APIs
| Configuration APIs | HTTP Method | Description |
|---|---|---|
| /platform/ws/lsfconfig/notconfigurable_list | GET | Return the list of LSF configuration attributes that cannot be modified |
|
/platform/ws/lsfconfig/{configId}/lsf_conf |
GET | Get detailed information about parameters in the lsf.conf file in the configuration. |
| PUT | Saves parameter settings for lsf.conf for the specified LSF configuration in the database. | |
|
/platform/ws/lsfconfig/{configId}/ego_conf |
GET | Get detailed information about parameters in the ego.conf file in the configuration. |
| PUT | Saves parameter settings for ego.conf for the specified LSF configuration in the database. | |
|
/platform/ws/lsfconfig/{configId}/lsf_cluster |
GET | Get detailed information about parameters in the lsf.cluster.cluster_name file in the ClusterAdmins, Parameters, and Host sections. |
| PUT | Saves parameter settings for lsf.cluster.cluster_name for the specified LSF configuration in the database. | |
|
/platform/ws/lsfconfig/{configId}/lsf_shared |
GET | Get detailed information about parameters in the lsf.shared file in the Resource section. |
| PUT | Saves parameter settings for lsf.shared for the specified LSF configuration in the database. | |
|
/platform/ws/lsfconfig/{configId}/lsb_queues |
GET | Get detailed information about parameters in the lsb.queues file in the Queue sections. |
| PUT | Saves parameter settings for lsb.queues for the specified LSF configuration in the database. | |
|
/platform/ws/lsfconfig/{configId}/lsb_hosts |
GET | Get detailed information about parameters in the lsb.hosts file, in the Host sections. |
| Saves parameter settings for lsb.hosts for the specified LSF configuration in the database. | ||
|
/platform/ws/lsfconfig/{configId}/lsb_params |
GET | Get detailed information about parameters in the lsb.params file in the Parameters sections. |
| PUT | Saves parameter settings for lsb.params for the specified LSF configuration in the database. | |
| /platform/ws/lsfconfig/{configId}/lsb_users | GET | Get detailed information about parameters in the lsb.users file in the User and UserGroup sections. |
| PUT | Saves parameter settings for lsb.users for the specified LSF configuration in the database. | |
|
/platform/ws/lsfconfig/{configId}/lsb_resources |
GET | Get detailed information about parameters in the lsb.resources file in the Limit, ResourceReservation and ReservationUsage sections. |
| PUT | Saves parameter settings for lsb.resources for the specified LSF configuration in the database. |