Accessing REST API calls with curl

Before you begin

Before accessing the LSF Application Center through https, you must first establish a secure SSH tunnel from your local machine to the LSF management node.

• Open a terminal on your local system.

• Use the SSH command provided in your deployment logs (refer to the variable application_center_tunnel).

  ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o ServerAliveInterval=5 -o ServerAliveCountMax=1 -L 8443:localhost:8443 -L 6080:localhost:6080 -L 8444:localhost:8444 -J ubuntu@<Bastion_Node_IP> lsfadmin@<Management_Node_IP>
  

  This command creates an encrypted tunnel that forwards the required ports (8443, 6080, and 8444) from the LSF management node to your local machine, enabling secure browser access to the Application Center GUI.

Connecting to LSF Application Center with curl

1. Open a new command line from your local device and run the following commands:

   1. Define or export the following variables:

      export SSL_INSECURE=1
      export AC_HOST=localhost
      export AC_PORT=8443
      export AC_USER=lsfadmin
      export AC_PASSWORD=<mynicepassword>
      

   2. Ping the cluster:

      curl -k -X POST -H "Accept: application/json" https://$AC_HOST:$AC_PORT/platform/ws/ping
      

   3. Log in to the cluster:

      curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/xml" -d "<User><name>$AC_USER</name> <pass>$AC_PASSWORD</pass> </User>" https://$AC_HOST:$AC_PORT/platform/ws/logon
      

      The output of this command contains the token that you need to run commands. The token is only valid for a particular time frame.

      Example output:

      {"csrftoken":"dbf6208a-0c01-4cb3-b6e1-9f75390311e5","token":"lsfadmin\"2022-05-25T20:53:12Z\"cn8FS6/FIXiVZc5vMpfPdoob9bosjk85u3lEPseqrWdX+DyWMPYkYgPOC5UJ+a4m87zyjHDq1DhjIZyYx1X47SFGRS4MRzeah94l+EpNBazKilXsG8cVuYyUgtz9M0J6\"PBNNTKLPN3JlyOpnCqI7cg=="}
      

   4. After you receive your token, you need to make two changes to it. First, add "platform_token=" at the beginning of the token, and second, replace the \" with #quote#. See the following example of an updated token:

      export
      MYTOKEN=platform_token=lsfadmin#quote#2022-05-25T20:53:12Z#quote#cn8FS6/FIXiVZc5vMpfPdoob9bosjk85u3lEPseqrWdX+DyWMPYkYgPOC5UJ+a4m87zyjHDq1DhjIZyYx1X47SFGRS4MRzeah94l+EpNBazKilXsG8cVuYyUgtz9M0J6#quote#PBNNTKLPN3JlyOpnCqI7cg==
      

   5. Get cluster information:

      curl -k -X GET -H 'Content-Type: application/xml' -H "Cookie: $MYTOKEN" -H 'Accept:text/plain,application/xml,text/xml,multipart/mixed' -H 'Accept-Language:en-us'  https://$AC_HOST:$AC_PORT/platform/ws/clusters/local
      

   6. Get the LSF Application Center version (Optional):

      curl -k -X GET -H 'Content-Type: application/xml' -H "Cookie: $MYTOKEN" -H 'Accept:text/plain,application/xml,text/xml,multipart/mixed' -H 'Accept-Language:en-us'  https://$AC_HOST:$AC_PORT/platform/ws/version
      

   7. List out the users (Optional):

      curl -k -X GET -H 'Content-Type: application/xml' -H "Cookie: $MYTOKEN" -H 'Accept:text/plain,application/xml,text/xml,multipart/mixed' -H 'Accept-Language:en-us'   https://$AC_HOST:$AC_PORT/platform/ws/users
      

   8. List groups ( ):

      curl -k -X GET -H 'Content-Type: application/xml' -H "Cookie: $MYTOKEN" -H 'Accept:text/plain,application/xml,text/xml,multipart/mixed' -H 'Accept-Language:en-us'   https://$AC_HOST:$AC_PORT/platform/ws/usergroups
      

   9. List host details (Optional):

      curl -k -X GET -H 'Content-Type: application/xml' -H "Cookie: $MYTOKEN" -H 'Accept:text/plain,application/xml,text/xml,multipart/mixed' -H 'Accept-Language:en-us'   https://$AC_HOST:$AC_PORT/platform/ws/hosts
      

   10. List existing jobs:

       curl -k -X GET -H 'Content-Type: application/xml' -H "Cookie: $MYTOKEN" -H 'Accept:text/plain,application/xml,text/xml,multipart/mixed' -H 'Accept-Language:en-us'   https://$AC_HOST:$AC_PORT/platform/ws/pacclient/jobs
       

   11. Get detailed job information by job ID (GET) (Optional):

       curl -k -X GET -H 'Content-Type: application/xml' -H "Cookie: $MYTOKEN" -H 'Accept:text/plain,application/xml,text/xml,multipart/mixed' -H 'Accept-Language:en-us'   https://$AC_HOST:$AC_PORT/platform/ws/jobs/<job ID>
       

   12. Get basic and detailed job information by job attributes (GET) (Optional):

       curl -k -X GET -H 'Content-Type: application/xml' -H "Cookie: $MYTOKEN" -H 'Accept:text/plain,application/xml,text/xml,multipart/mixed' -H 'Accept-Language:en-us'   https://$AC_HOST:$AC_PORT/platform/ws/jobs/fullinfo
       

2. Submit a job:

   curl -k -X POST \
   -H 'Content-Type: multipart/mixed; boundary=bqJky99mlBWa-ZuqjC53mG6EzbmlxB' \
   -H 'Accept: text/xml, application/xml' \
   -H "Cookie: $MYTOKEN" \
   -H 'Accept-Language: en-us' \
   -d '
   --bqJky99mlBWa-ZuqjC53mG6EzbmlxB
   Content-Disposition: form-data; name="AppName"
   Content-ID: <AppName>
   
   generic
   --bqJky99mlBWa-ZuqjC53mG6EzbmlxB
   Content-Disposition: form-data; name="data"
   Content-Type: multipart/mixed; boundary=_Part_1_701508.1145579811786
   Accept-Language: en-us
   Content-ID: <data>
   
   --_Part_1_701508.1145579811786
   Content-Disposition: form-data; name="COMMANDTORUN"
   Content-Type: application/xml; charset=UTF-8
   Content-Transfer-Encoding: 8bit
   Accept-Language: en-us
   
   <AppParam><id>COMMANDTORUN</id><value>sleep 99</value><type></type></AppParam>
   --_Part_1_701508.1145579811786--
   --bqJky99mlBWa-ZuqjC53mG6EzbmlxB--
   ' https://$AC_HOST:$AC_PORT/platform/webservice/pacclient/submitapp