Stop task

POST

/tasks/stop/{id}

Stop the task through a coordinated drain, capture, and release. After a Core restart, only the stop barrier of RUNNING RSVP tasks without Data Plane and Access Plane is restored, provided that all routing agents have kept their registration and assignment. Start and RSVP commands are not repeated. If the participant set cannot be restored, HTTP 409 keeps the task RUNNING and no stop is sent to the agents.

Contract

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

Parameters

1 parameter

Name	Location	Required	Type	Description
id	path	yes	integer	Task ID

Responses

4 responses

Status	Description	Type
200	Successful response	object
401	Unauthorized	object
409	The full participant set of the RSVP task could not be confirmed after a Core restart; the agents were not stopped	object
500	Invalid ID, task not found or not running, or stop failed	object

Response 200: object

{
  "accessPlane": [
    {
      "accessLine": [
        0
      ],
      "agent": {
        "id": 0
      },
      "dhcp": [
        0
      ],
      "dhcpv6": [
        0
      ],
      "dot1x": [
        0
      ],
      "gptp": [
        0
      ],
      "groupId": 0,
      "igmp": [
        0
      ],
      "interfaces": [
        0
      ],
      "ipoe": [
        0
      ],
      "isServer": true,
      "l2tp": [
        0
      ],
      "lag": [
        0
      ],
      "links": [
        0
      ],
      "openflow": [
        0
      ],
      "ppp": [
        0
      ],
      "pppoe": [
        0
      ],
      "role": "<string>",
      "sessions": [
        0
      ],
      "stp": [
        0
      ]
    }
  ],
  "comment": "<string>",
  "configuration": [
    {
      "plugin": {
        "id": 0
      },
      "subplugins": {
        "duration": {},
        "subplugins": [
          {}
        ]
      },
      "values": {
        "applicationParams": {},
        "benchmarkParams": {},
        "clientPortRange": "<string>",
        "compromisedHostParams": {},
        "convergenceEncapsulation": {},
        "convergenceFlows": 0,
        "convergenceReassembly": true,
        "cpuCores": 0,
        "cveReplayParams": {},
        "dnsParams": {},
        "duration": {},
        "frameSize": 0,
        "fuzzingParams": {},
        "harReplayParams": {},
        "httpParams": {},
        "icmpParams": {},
        "initialTps": 0,
        "invalidChecksum": true,
        "ipLayer": {},
        "ipsecAuthMethod": "<string>",
        "ipsecCa": "<string>",
        "ipsecCert": "<string>",
        "ipsecCipher": "<string>",
        "ipsecCipherKey": "<string>",
        "ipsecDpdInterval": 0,
        "ipsecDpdTimeout": 0,
        "ipsecEncrypt": 0,
        "ipsecIkeDh": "<string>",
        "ipsecIkeEncr": "<string>",
        "ipsecIkePrf": "<string>",
        "ipsecInnerDstEnd": "<string>",
        "ipsecInnerDstStart": "<string>",
        "ipsecInnerSrcEnd": "<string>",
        "ipsecInnerSrcStart": "<string>",
        "ipsecKey": "<string>",
        "ipsecLoadConcurrentHs": 0,
        "ipsecLoadHsRatePps": 0,
        "ipsecLoadKeepalivePps": 0,
        "ipsecLoadLocalBaseIp": "<string>",
        "ipsecLoadPeerBaseIp": "<string>",
        "ipsecLoadPeerCount": 0,
        "ipsecLoadPeerShareEndpoint": 0,
        "ipsecLoadRecycleAfterMs": 0,
        "ipsecLoadResponderIdleRecycleMs": 0,
        "ipsecLoadResponderPoolCap": 0,
        "ipsecLoadRole": "<string>",
        "ipsecLoadSrcIpCount": 0,
        "ipsecMode": "<string>",
        "ipsecMultiChildCount": 0,
        "ipsecNatt": 0,
        "ipsecPeerBase": "<string>",
        "ipsecPeerCount": 0,
        "ipsecPfs": 0,
        "ipsecPsk": "<string>",
        "ipsecRekeyTime": 0,
        "ipsecSaLifetime": 0,
        "ipsecSpi": "<string>",
        "ipsecTsDstEnd": "<string>",
        "ipsecTsDstStart": "<string>",
        "ipsecTsSrcEnd": "<string>",
        "ipsecTsSrcStart": "<string>",
        "ipsecTunnelCount": 0,
        "ipsecTunnelOpenRatePps": 0,
        "ipsecTunnelPeerShareEndpoint": 0,
        "ipsecTunnelSrcIpCount": 0,
        "ipsecTunnelUniqueTsi": 0,
        "isServer": true,
        "keepAlive": {},
        "l2PolicyVersion": 0,
        "malwareFiles": [
          0
        ],
        "maxStreams": 0,
        "packetConstructorParams": {},
        "packetsPerSecond": 0,
        "payload": {},
        "pcapReplayParams": {},
        "ppsPerConnection": 0,
        "ppsUnlimited": true,
        "qosClasses": [
          {}
        ],
        "qosEnabled": true,
        "qosLoadPct": 0,
        "qosMarkType": "<string>",
        "reopenSessionTime": 0,
        "requestInterval": 0,
        "requestsPerSecond": 0,
        "rocev2Params": {},
        "rotationMode": "<string>",
        "rpsUnlimited": true,
        "sessionsPerSecond": 0,
        "sources": [
          {}
        ],
        "statelessServerParams": {},
        "targets": [
          {}
        ],
        "tcpConfiguration": {},
        "tlsParams": {},
        "totalSessions": 0,
        "tpsRampStep": 0,
        "tunnelClientIp": "<string>",
        "tunnelEndpoints": "<string>",
        "tunnelID": 0,
        "tunnelIDs": [
          0
        ],
        "tunnelServerIp": "<string>",
        "wafModules": {}
      }
    }
  ],
  "controlPlane": [
    {
      "access": [
        0
      ],
      "agent": {
        "id": 0
      },
      "bfd": [
        0
      ],
      "bgp": [
        0
      ],
      "evpn": [
        0
      ],
      "fec129": [
        0
      ],
      "igmp": [
        0
      ],
      "igmp-querier": [
        0
      ],
      "interfaces": [
        [
          0
        ]
      ],
      "isServer": true,
      "isis": [
        0
      ],
      "ldp": [
        0
      ],
      "link-oam": [
        0
      ],
      "mld": [
        0
      ],
      "mld-querier": [
        0
      ],
      "mldp": [
        0
      ],
      "mpls-oam": [
        0
      ],
      "mpls-tp": [
        0
      ],
      "ospf": [
        0
      ],
      "pim": [
        0
      ],
      "pseudowire": [
        0
      ],
      "rip": [
        0
      ],
      "rsvp": [
        0
      ],
      "streams": [
        0
      ],
      "traffic": [
        0
      ],
      "vpls": [
        0
      ],
      "vpws": [
        0
      ]
    }
  ],
  "createdAt": "<string>",
  "deletedAt": "<string>",
  "dumps": {
    "captureArp": true,
    "enabled": true,
    "savelen": 0
  },
  "error": "<string>",
  "finishedAt": "<string>",
  "id": 0,
  "issuer": {
    "agreementAccepted": true,
    "createdAt": "<string>",
    "deletedAt": "<string>",
    "email": "<string>",
    "group": {
      "createdAt": "<string>",
      "deletedAt": "<string>",
      "id": 0,
      "issuer": {},
      "issuerID": 0,
      "name": "<string>",
      "permissions": [
        {}
      ],
      "updatedAt": "<string>",
      "users": [
        {}
      ]
    },
    "groupID": 0,
    "id": 0,
    "isActive": true,
    "isRequiredToSetPassword": true,
    "lastLogin": "<string>",
    "notificationsReadAt": "<string>",
    "passwordLength": 0,
    "permissions": [
      0
    ],
    "realName": "<string>",
    "updatedAt": "<string>"
  },
  "issuerID": 0,
  "project": {
    "ID": 0,
    "activeTaskCount": 0,
    "archivedAt": "<string>",
    "createdAt": "<string>",
    "description": "<string>",
    "errorTaskCount": 0,
    "issuer": {
      "agreementAccepted": true,
      "createdAt": "<string>",
      "deletedAt": "<string>",
      "email": "<string>",
      "group": {},
      "groupID": 0,
      "id": 0,
      "isActive": true,
      "isRequiredToSetPassword": true,
      "lastLogin": "<string>",
      "notificationsReadAt": "<string>",
      "passwordLength": 0,
      "permissions": [
        0
      ],
      "realName": "<string>",
      "updatedAt": "<string>"
    },
    "issuerID": 0,
    "lastActivityAt": "<string>",
    "name": "<string>",
    "taskCount": 0,
    "updatedAt": "<string>"
  },
  "projectID": 0,
  "startedAt": "<string>",
  "status": 0,
  "updatedAt": "<string>"
}

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