Update an LSF configuration by LSF file name(PUT)

Description

URL

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

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

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

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

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

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

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

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

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

Description

Updates parameters in the database for an LSF configuration file.

For a list of supported LSF parameters in each configuration file category, see LSF Parameters you can modify with the file-based configuration APIs.

For the format to use for time-based configuration parameters, see Time format for LSF time-based configuration parameters.

For a list of parameters that cannot be modified through the API, use /platform/ws/lsfconfig/notconfigurable_list(GET).

Upon successful return, the response will include a Content-Location header with the URI of the saved LSF configuration file, 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}/lsf_conf

/platform/ws/lsfconfig/{configId}/ego_conf

/platform/ws/lsfconfig/{configId}/lsf_cluster

/platform/ws/lsfconfig/{configId}/lsf_shared

/platform/ws/lsfconfig/{configId}/lsb_params

/platform/ws/lsfconfig/{configId}/lsb_resources

/platform/ws/lsfconfig/{configId}/lsb_hosts

/platform/ws/lsfconfig/{configId}/lsb_queues

/platform/ws/lsfconfig/{configId}/lsb_users

Request-Header Name Value
Accept application/xml, or application/json
If-Unmodified-Since {last modified time}
Message-Body

The XML definition of the configuration file.

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

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

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 file 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 file 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

Content-Location (Only if response code is 303)

URI of the saved LSF configuration file category.
Message Body Success Message

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

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<lsfConfigFile name="%s" lastModifiedTime="%s">
    <section name="%s">
        <element>
            <attr key="%s" value="%s"/>
           <attr key="%s" value="%s"/>
        </element>
    </section>
	<section name="%s">
        <element>
            <attr key="%s" value="%s"/>
           <attr key="%s" value="%s"/>
        </element>
    </section>
	...
</lsfConfigFile>
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>