Update an LSF configuration by abstracted configuration category(PUT)

Description

URL

scheme://domain:port/platform/ws/lsfconfig/{configId}/clusterparameters

scheme://domain:port/platform/ws/lsfconfig/{configId}/resources

scheme://domain:port/platform/ws/lsfconfig/{configId}/hosts

scheme://domain:port/platform/ws/lsfconfig/{configId}/hostgroups

scheme://domain:port/platform/ws/lsfconfig/{configId}/queues

scheme://domain:port/platform/ws/lsfconfig/{configId}/users

scheme://domain:port/platform/ws/lsfconfig/{configId}/usergroups

scheme://domain:port/platform/ws/lsfconfig/{configId}/resourcelimits

scheme://domain:port/platform/ws/lsfconfig/{configId}/resourcereservations

Description

Updates parameters in the database for an abstracted configuration category.

For a list of supported LSF parameters in each abstract configuration category, see LSF Parameters you can modify with the abstracted configuration categories.

To modify parameters not supported by the abstract categories, use the file-based configuration APIs Update an LSF configuration by LSF file name(PUT).

Upon successful return, the response will include a Content-Location header with the URI of the saved LSF configuration abstracted category, and an updated Last-Modified value that the client can use in future requests.

A conditional PUT request with an If-Unmodified-Since header must be supplied to prevent lost updates in the server, otherwise, a 403 (Forbidden) response code will be returned.

If the supplied If-Unmodified-Since header does not match the actual last modified time of the LSF configuration category in request, a 412 (Precondition Failed) response code will be returned.

If the key LSF configuration data in the request body cannot be validated by the server, a 422 (Unprocessable Entity) response code will be returned with the corresponding error messages in the response body.

HTTP Method PUT
Parameters None

Request

Method PUT
Request-URI

/platform/ws/lsfconfig/{configId}/clusterparameters

/platform/ws/lsfconfig/{configId}/resources

/platform/ws/lsfconfig/{configId}/hosts

/platform/ws/lsfconfig/{configId}/hostgroups

/platform/ws/lsfconfig/{configId}/queues

/platform/ws/lsfconfig/{configId}/users

/platform/ws/lsfconfig/{configId}/usergroups

/platform/ws/lsfconfig/{configId}/resourcelimits

/platform/ws/lsfconfig/{configId}/resourcereservations

Request-Header Name Value
Accept application/xml, or application/json
If-Modified-Since (only if the client has a copy of the resource stored locally) {last modified time}
Message-Body

The XML definition of the abstracted configuration category.

For additional information, refer to the schema file ./schemas/lsfconfig/lsfConfResource.xsd.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<lsfConfigResource name="%s" lastModifiedTime="%s">
    <section name="%s">
        <element>
            <attr key="%s" value="%s"/>
            <attr key="%s" value="%s"/>
         ...
        </element>
    </section>
</lsfConfigResource>

Response

Response Code
  • 303 See Other: Action performed successfully. Get the URI for details.
  • 403 Forbidden: Access is restricted by role-based access control permissions.
  • 404 Not Found: The specified configuration abstract category does not exist.
  • 412 Precondition Failed: The supplied If-Unmodified-Since header does not match the actual last modified time of the LSF configuration abstract category in the database.
  • 422 Unprocessable Entity: The request body contains semantically erroneous data.
  • 500 Internal Server Error: Exception occurred.
Response-Header Name Value
Content-Type application/xml or application/json

Location (only if response code is 303)

A URI with the link to the new resource.

Message Body Success Message

If successful, returns detailed information about the specified LSF configuration category.

For additional information, refer to the schema file ./schemas/lsfconfig/lsfConfResource.xsd.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<lsfConfigResource name="%s" lastModifiedTime="%s">
    <section name="%s">
        <element>
            <attr key="%s" value="%s"/>
            <attr key="%s" value="%s"/>
         ...
        </element>
    </section>
</lsfConfigResource>
Failure Message

If not successful, returns an error message.

For additional information, refer to the schema file ./schemas/error/error.xsd.

<error>
  <message>
     %s
  </message>
</error>