1.60 August 19, 2015 Sergey Satskiy Group lists for GET2/READ/READ2 for NS 4.23.0 1.61 October 26, 2015 Sergey Satskiy Adding a note about the command synopsis. 1.62 11, 2016 Sergey Satskiy Adding information the ‘scope’ feature for NS 4.25.0 1.63 September 16, 2016 Sergey Satskiy GET2/READ2 allowed any_aff together with prioritized_aff for NS 4.27.0 1.64 September 27, 2016 Sergey Satskiy Fixed RECO output description 1.65 October 13, 2016 Sergey Satskiy REDO and REREAD commands for NS 4.28.0 1.66 December 13, 2016 Sergey Satskiy ‘-‘ affinity and group for NS 4.29.0 1.67 May 11, 2017 Sergey Satskiy Added GET2 output parameters (submitter_notif_host and submitter_notif_port) for NS 4.30.0 1.68 November 17, 2017 Sergey Satskiy Addig need_progress_msg parameter for SST2/WST2/LISTEN/SUBMIT commands; adding need_stolen for LISTEN command. Job change notification format changes are described. The changes are for NS-4.31.0. 1.69 November 20, 2017 Sergey Satskiy Adding need_progress_msg parameter for STATUS2 command for NS 4.31.0 1.70 November 23, 2018 Sergey Satskiy Adding new DUMP options for NS 4.42.0 NetSchedule Protocol This document describes the NetSchedule server protocol in detail. Overview The NetSchedule protocol is based on human readable strings exchanged over a TCP/IP connection. An exchange unit is a line which is ended by a carriage return character. The figure below shows the overall structure of the protocol. Protocol Structure A session of communication with a NetSchedule server starts with opening a TCP/IP connection.
InputLimit Integer: input limit in bytes OutputLimit Integer: output in bytes Id1 value identifier Val1 url encoded Example: OK:max_input_size=1048576&max_output_size=1048576&nc::service=NC_Test The GETC command Privileges: any. Requires a queue: yes NetSchedule output type: multiple lines Synopsis: GETC [IP] [SID] [PHID] Description: prints the queue parameters. Parameter Name Description IP ip IP address of a remote client Note: Introduced in version 4.14.0. SID sid Session ID of a remote client Note: Introduced in version 4.14.0. PHID ncbi_phid CGI page hit ID Note: Introduced in version 4.17.0 Output synopsis (single line): OK:<name>=<value> Parameter Description Name The queue parameter name value The queue parameter value Example: GETC OK:timeout=3600 OK:notif_hifreq_interval=0.1 OK:notif_hifreq_period=5
Message String: the progress message for the job. The message is printed without double quotes whether or not there were any space characters in the message. The SST command Privileges: any. Requires a queue: yes NetSchedule output type: single line Synopsis: SST<JobKey> [IP] [SID] [PHID] Description: prints the state of a job. The command is obsolete starting from NetSchedule 4.10.0, use SST2 instead. Parameter Name Description JobKey job_key String identifier: the job key. IP ip IP address of a remote client Note: Introduced in version 4.14.0. SID sid Session ID of a remote client Note: Introduced in version 4.14.0. PHID ncbi_phid CGI page hit ID Note: Introduced in version 4.17.0 Output synopsis: OK:<State> Parameter Description Integer: the of the job 0 – pending 1 – running 3 – canceled 4 – failed 5 – done 6 – reading 7 – confirmed 8 – read failed -1 – job not Example: SST JSID_01_4_130.14.24.194_9102 OK:0