Changes between Version 6 and Version 7 of installation_QCG_Broker_Client

Show
Ignore:
Timestamp:
05/18/11 17:54:37 (11 years ago)
Author:
bartek
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • installation_QCG_Broker_Client

    v6 v7  
    225225Regardless from the mode the QCG-Broker java based command-line client supports following list of operations: 
    226226 
    227 || '''Operation''' || '''Arguments''' || '''Description''' || 
    228 || '''submit_job''' || `<desc_file>` (GRMS or JSDL) || submits a job to be executed. The description of job can be expressed either in native QCG-Broker language or if it is possible in JSDL one. If the description is valid client returns to the user a globally unique job identifier, which unambiguously identifies the job in the system.  QCG defines jobs as a sets of dependent tasks that constitute a logical whole (workflow). Each task is executed by system only if all tasks it depends on are in specified by the user states. || 
    229 || '''list_jobs''' || `[<limit>]` `[<status>]` || lists jobs belonging to the `user`. It is possible either to `limit` number of jobs or to display only ones in given state. All possible states are listed below  the table. || 
    230 || '''list_user_jobs''' || `[<limit>]` `[<status>]` `<user>` || lists jobs belonging to the given `user`. The functionality is destined for administrative purposes. || 
    231 || '''test_description''' || `<desc_file>` (GRMS or JSDL) || validates job description ||  
    232 || '''translate_description''' || `<desc_file>` JSDL || translates job description to native QCG-Broker one || 
    233 || '''job_info''' || `<jobId>` `[<showJobDesc>]` || return complex information about the given job. If the `showJobDesc is` `false` the job description is not shown || 
    234 || '''cancel_job''' || `<jobId>` || cancels execution of the given job || 
    235 || '''commit_job''' || `<jobId>` || allows to approve the job submitted with two phase commit mechanism to be processed by the system. The two phase commit mechanism can be used to register notifications before the processing of the job will be started by broker. || 
    236 || '''list_tasks''' || `<jobId>` `[<status>]` || lists tasks belonging to given job. Optionally it is possible to specify the task's status. Possible task statuses are listed below the table. || 
    237 || '''tasks_statuses''' || `<jobId>` `<summary>` || lists tasks constituting the given job with their statuses. If the `summary` argument is `true` some kind of statistics is additionally displayed. || 
    238 || '''register_job_notification''' || `<jobId>` `<url>` || registers notification consumer for the given job || 
    239 || '''list_job_notifications''' || `<jobId>` || lists notifications registered for the given job || 
    240 || '''register_tasks_notification''' || `<jobId>` `<url>` || register notification for all tasks of the given job || 
    241 || '''monitor_job''' || `<jobId>` `[<interval>]` || monitors status changes of tasks belonging to given job. The `interval` argument determines delay in seconds between next status checks. || 
    242 || '''monitor_task''' || `<jobId>` `<taskId>` `[<interval>]` || monitors status changes of allocations belonging to the given tasks. The `interval` argument determines delay in seconds between next status checks. || 
    243 || '''task_info''' || `<jobId>` `<taskId>` `[<showDesc>` `[<limit>]]` || displays information about the given task. If the `showDesc` is `false` the task description is not shown. If the `limit` argument is specified the history of the task is limited to given value. || 
    244 || '''register_task_notification''' || `<jobId>` `<taskId>` `<url>` || registers task's notification consumer || 
    245 || '''list_task_notifications''' || `<jobId>` `<taskId>` || lists task's notifications || 
    246 || '''cancel_task''' || `<jobId>` `<taskId>` || cancels execution of the given task || 
    247 || '''commit_task''' || `<jobId>` `<taskId>` || commits the given task to be processed by the system || 
    248 || '''reserve_resources''' || `[<taskId>]` `<job_desc>` (GRMS or JSDL) || reserve resources that meet either the wole job or given task requirements. The reservation identifier is returned. This functionality is not implemented yet! || 
    249 || '''reservation_info''' || `<reservationId>` || return complex information concerning the given reservation: list of reserved resources, local identifiers of reservations, reservation time slot. This functionality id not implemented yet! || 
    250 || '''cancel_reservation''' || `<reservationId>` || releases reserved resources. This functionality is not implemented yet! || 
     227||= '''Operation''' =||= '''Arguments''' =||= '''Description''' =|| 
     228||='''submit_job''' =|| `<desc_file>` (GRMS or JSDL) || submits a job to be executed. The description of job can be expressed either in native QCG-Broker language or if it is possible in JSDL one. If the description is valid client returns to the user a globally unique job identifier, which unambiguously identifies the job in the system.  QCG defines jobs as a sets of dependent tasks that constitute a logical whole (workflow). Each task is executed by system only if all tasks it depends on are in specified by the user states. || 
     229||='''list_jobs''' =|| `[<limit>]` `[<status>]` || lists jobs belonging to the `user`. It is possible either to `limit` number of jobs or to display only ones in given state. All possible states are listed below  the table. || 
     230||='''list_user_jobs''' =|| `[<limit>]` `[<status>]` `<user>` || lists jobs belonging to the given `user`. The functionality is destined for administrative purposes. || 
     231||='''test_description''' =|| `<desc_file>` (GRMS or JSDL) || validates job description ||  
     232||='''translate_description''' =|| `<desc_file>` JSDL || translates job description to native QCG-Broker one || 
     233||='''job_info''' =|| `<jobId>` `[<showJobDesc>]` || return complex information about the given job. If the `showJobDesc is` `false` the job description is not shown || 
     234||='''cancel_job''' =|| `<jobId>` || cancels execution of the given job || 
     235||='''commit_job''' =|| `<jobId>` || allows to approve the job submitted with two phase commit mechanism to be processed by the system. The two phase commit mechanism can be used to register notifications before the processing of the job will be started by broker. || 
     236||='''list_tasks''' =|| `<jobId>` `[<status>]` || lists tasks belonging to given job. Optionally it is possible to specify the task's status. Possible task statuses are listed below the table. || 
     237||='''tasks_statuses''' =|| `<jobId>` `<summary>` || lists tasks constituting the given job with their statuses. If the `summary` argument is `true` some kind of statistics is additionally displayed. || 
     238||= '''register_job_notification''' || `<jobId>` `<url>` || registers notification consumer for the given job || 
     239||='''list_job_notifications''' =|| `<jobId>` || lists notifications registered for the given job || 
     240||='''register_tasks_notification''' =|| `<jobId>` `<url>` || register notification for all tasks of the given job || 
     241||='''monitor_job''' =|| `<jobId>` `[<interval>]` || monitors status changes of tasks belonging to given job. The `interval` argument determines delay in seconds between next status checks. || 
     242||='''monitor_task''' =|| `<jobId>` `<taskId>` `[<interval>]` || monitors status changes of allocations belonging to the given tasks. The `interval` argument determines delay in seconds between next status checks. || 
     243||='''task_info''' =|| `<jobId>` `<taskId>` `[<showDesc>` `[<limit>]]` || displays information about the given task. If the `showDesc` is `false` the task description is not shown. If the `limit` argument is specified the history of the task is limited to given value. =|| 
     244||='''register_task_notification''' =|| `<jobId>` `<taskId>` `<url>` || registers task's notification consumer || 
     245||='''list_task_notifications''' =|| `<jobId>` `<taskId>` || lists task's notifications || 
     246||='''cancel_task''' =|| `<jobId>` `<taskId>` || cancels execution of the given task || 
     247||='''commit_task''' =|| `<jobId>` `<taskId>` || commits the given task to be processed by the system || 
     248||='''reserve_resources''' =|| `[<taskId>]` `<job_desc>` (GRMS or JSDL) || reserve resources that meet either the wole job or given task requirements. The reservation identifier is returned. This functionality is not implemented yet! || 
     249||='''reservation_info''' =|| `<reservationId>` || return complex information concerning the given reservation: list of reserved resources, local identifiers of reservations, reservation time slot. This functionality id not implemented yet! || 
     250||='''cancel_reservation=''' =|| `<reservationId>` || releases reserved resources. This functionality is not implemented yet! || 
    251251 
    252252== Usage examples ==