Control selected RSVP-TE protocol instances

POST

/tasks/{id}/rsvp/protocol/sessions/control

Selects 1-64 profile-indexed protocol instances by an array or semicolon-separated range string. All selected sessions are read and generation-checked before ordered dispatch through the existing agent CPF control. A failed or uncertain member stops further dispatch; response records accepted, failed, unknown and not-attempted members. Never retry an unknown result without querying current state. This local index scheme is not claimed to match exact IxNetwork device numbering or atomicity.

Contract

Parameter	Value
Section	tasks
Authentication	CookieAuth
Consumes	application/json
Produces	application/json

Parameters

2 parameters

Name	Location	Required	Type	Description
id	path	yes	integer	Canonical positive task ID
request	body	yes	object	Agent, profile revision, runtime generation, session indices and CPF action

Parameter request: object

{
  "action": "stop",
  "agent": "<string>",
  "expected-profile-revision": "<string>",
  "runtime-generation": "<string>",
  "session-indices": {}
}

Responses

9 responses

Status	Description	Type
200	All selected instances accepted	object
207	Partial or unknown result	object
400	Invalid selection	object
401	Session required	object
403	Agent not registered for this task	object
404	Task not found	object
409	Profile, task or runtime generation changed before dispatch	object
500	Task lookup failed	object
502	Agent preflight read failed	object

Response 200: object

{
  "action": "<string>",
  "agent": "<string>",
  "members": [
    {
      "http-status": 0,
      "index": 0,
      "instance": 0,
      "response": {},
      "status": "accepted"
    }
  ],
  "profile-revision": "<string>",
  "runtime-generation": "<string>",
  "state": "complete",
  "task-id": 0
}

Response 207: object

{
  "action": "<string>",
  "agent": "<string>",
  "members": [
    {
      "http-status": 0,
      "index": 0,
      "instance": 0,
      "response": {},
      "status": "accepted"
    }
  ],
  "profile-revision": "<string>",
  "runtime-generation": "<string>",
  "state": "complete",
  "task-id": 0
}

{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }