Kill Active Access Sessions¶
Overview¶
This is an API used to kill active access sessions on the BIG-IP system using a BIG-IQ Centralized Management system.
REST Endpoint: /mgmt/cm/access/tasks/kill-sessions/¶
Requests¶
POST /mgmt/cm/access/tasks/kill-sessions¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
action | string | True | Kill session by user (KILL_BY_USER), list of sessions (KILL_BY_LIST_OF_SESSIONS), or all sessions (KILL_ALL_SESSIONS). |
accessGroupNames | array_of_strings | False | One or more access group names. All sessions in these groups will be killed by invoking task. |
clusterNames | array_of_strings | False | One or more cluster names. All sessions in these BIG-IP clusters will be killed by invoking task. |
deviceReferences | reference | False | Reference link to one or more devices where active access sessions reside. |
link | string | False | Reference link to a device in a resolver group. |
userName | string | False | User name of the user who owns the sessions. |
sessions | array_of_objects | False | List of sessions to kill. |
sessionIds | array_of_strings | False | Set of unique IDs, each referencing a session. |
deviceReference | reference | False | Reference link to the device where the session ID resides. |
link | string | False | Reference link to a device in a resolver group. |
resultDetails | array_of_objects | False | As part of the response, during a failure, this populates with a list of device level failure info. |
host | string | False | Hostname of the failed BIG-IP device. |
failedIds | array_of_strings | False | Set of unique IDs, each referencing a failed session. |
deviceReference | reference | False | Reference link to the device where the session ID resides. |
link | string | False | Reference link to a device in a resolver group. |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
action | string | Kill session by user (KILL_BY_USER), list of sessions (KILL_BY_LIST_OF_SESSIONS), or all sessions (KILL_ALL_SESSIONS). |
currentStep | string | Current kill sessions task step. |
accessGroupNames | array_of_strings | One or more access group names. All sessions in these groups will be killed by invoking task. |
clusterNames | array_of_strings | One or more cluster names. All sessions in these BIG-IP clusters will be killed by invoking task. |
deviceReferences | reference | Reference link to one or more devices where active access sessions reside. |
link | string | Reference link to a device in a resolver group. |
userName | string | User name of the user who owns the sessions. |
sessions | array_of_objects | List of sessions to kill. |
sessionIds | array_of_strings | Set of unique IDs, each referencing a session. |
deviceReference | reference | Reference link to the device where the session ID resides. |
link | string | Reference link to a device in a resolver group. |
result | string | As part of response, result denotes whether kill access sessions action was COMPLETE or FAILED. |
resultDetails | array_of_objects | As part of the response, during a failure, this populates with a list of device level failure info. |
host | string | Hostname of the failed BIG-IP device. |
failedIds | array_of_strings | Set of unique IDs, each referencing a failed session. |
deviceReference | reference | Reference link to the device where the session ID resides. |
link | string | Reference link to a device in a resolver group. |
startDateTime | string | Date and time of when this kill user session task began. |
name | string | Name of access kill user session task. |
errorMessage | string | Error message describing details of task failure. |
id | string | Unique ID associated with kill-sessions task. |
endDateTime | string | Date and time of when this kill user session task ended. |
status | string | Status of kill sessions task state. - ex. STARTED, FINISHED. |
kind | string | Type information for access kill user session task - cm:access:tasks:kill-sessions:accesskillsessionstaskitemstate. |
selfLink | string | A reference link URI to the kill-sessions task. |
Error Response¶
HTTP/1.1 400 Bad Request
Error response Bad Request.
HTTP/1.1 404 Not Found
Error response of the Public URI path is not registered.
Permissions¶
Role | Allow |
---|---|
Access_Manager | Yes |
GET /mgmt/cm/access/tasks/kill-sessions/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
action | string | Kill session by user (KILL_BY_USER), list of sessions (KILL_BY_LIST_OF_SESSIONS), or all sessions (KILL_ALL_SESSIONS). |
currentStep | string | Current kill sessions task step. |
accessGroupNames | array_of_strings | One or more access group names. All sessions in these groups will be killed by invoking task. |
clusterNames | array_of_strings | One or more cluster names. All sessions in these BIG-IP clusters will be killed by invoking task. |
deviceReferences | reference | Reference link to one or more devices where active access sessions reside. |
link | string | Reference link to a device in a resolver group. |
userName | string | User name of the user who owns the sessions. |
sessions | array_of_objects | List of sessions to kill. |
sessionIds | array_of_strings | Set of unique IDs, each referencing a session. |
deviceReference | reference | Reference link to the device where the session ID resides. |
link | string | Reference link to a device in a resolver group. |
result | string | As part of response, result denotes whether kill access sessions action was COMPLETE or FAILED. |
resultDetails | array_of_objects | As part of the response, during a failure, this populates with a list of device level failure info. |
host | string | Hostname of the failed BIG-IP device. |
failedIds | array_of_strings | Set of unique IDs, each referencing a failed session. |
deviceReference | reference | Reference link to the device where the session ID resides. |
link | string | Reference link to a device in a resolver group. |
startDateTime | string | Date and time of when this kill user session task began. |
name | string | Name of access kill user session task. |
errorMessage | string | Error message describing details of task failure. |
id | string | Unique ID associated with kill-sessions task. |
endDateTime | string | Date and time of when this kill user session task ended. |
status | string | Status of kill sessions task state. - ex. STARTED, FINISHED. |
kind | string | Type information for access kill user session task - cm:access:tasks:kill-sessions:accesskillsessionstaskitemstate. |
selfLink | string | A reference link URI to the kill-sessions task. |
Error Response¶
HTTP/1.1 400 Bad Request
Error response Bad Request.
HTTP/1.1 404 Not Found
Error response of the Public URI path is not registered.
Permissions¶
Role | Allow |
---|---|
Access_Manager | Yes |
Examples¶
Kill Selected Sessions¶
POST /mgmt/cm/access/tasks/kill-sessions
{
"action": "KILL_ALL_SESSIONS",
"accessGroupNames": "['AccessGroup1', 'AccessGroup2']",
"clusterNames": "['ca-cluster']",
"deviceReferences": [{
"link": "https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642"
}],
"userName": "user1",
"sessions": [{
"sessionIds": "['2a5d7604', '875f7fed']",
"deviceReference": {
"link": "https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642"
}
}],
"resultDetails": [{
"host": "olympus.f5net.com",
"failedIds": "['2a5d7604', '875f7fed']",
"deviceReference": {
"link": "https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642"
}
}]
}
Response¶
HTTP/1.1 200 OK
{
"action": "KILL_ALL_SESSIONS",
"currentStep": "RESOLVE_DEVICES",
"accessGroupNames": "['AccessGroup1', 'AccessGroup2']",
"clusterNames": "['ca-cluster']",
"deviceReferences": [{
"link": "https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642"
}],
"userName": "user1",
"sessions": [{
"sessionIds": "['2a5d7604', '875f7fed']",
"deviceReference": {
"link": "https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642"
}
}],
"result": "COMPLETE",
"resultDetails": [{
"host": "olympus.f5net.com",
"failedIds": "['2a5d7604', '875f7fed']",
"deviceReference": {
"link": "https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642"
}
}],
"startDateTime": "2018-02-01T19:44:17.804-0800",
"name": "task_for_xyz",
"errorMessage": "Something bad happened at step 5.",
"id": "6287e999-9621-4e13-b588-51ca7895736e",
"endDateTime": "2018-02-01T19:44:17.804-0800",
"status": "STARTED",
"kind": "cm:access:tasks:kill-sessions:accesskillsessionstaskitemstate",
"selfLink": "https://localhost/mgmt/cm/access/tasks/kill-sessions/1ab38f85-0178-4ce5-af08-ea5f5fd3ac5e"
}
Get Kill Session Task by Task Id¶
GET /mgmt/cm/access/tasks/kill-sessions/<id>
Response¶
HTTP/1.1 200 OK
{
"action": "KILL_ALL_SESSIONS",
"currentStep": "RESOLVE_DEVICES",
"accessGroupNames": "['AccessGroup1', 'AccessGroup2']",
"clusterNames": "['ca-cluster']",
"deviceReferences": [{
"link": "https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642"
}],
"userName": "user1",
"sessions": [{
"sessionIds": "['2a5d7604', '875f7fed']",
"deviceReference": {
"link": "https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642"
}
}],
"result": "COMPLETE",
"resultDetails": [{
"host": "olympus.f5net.com",
"failedIds": "['2a5d7604', '875f7fed']",
"deviceReference": {
"link": "https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642"
}
}],
"startDateTime": "2018-02-01T19:44:17.804-0800",
"name": "task_for_xyz",
"errorMessage": "Something bad happened at step 5.",
"id": "6287e999-9621-4e13-b588-51ca7895736e",
"endDateTime": "2018-02-01T19:44:17.804-0800",
"status": "STARTED",
"kind": "cm:access:tasks:kill-sessions:accesskillsessionstaskitemstate",
"selfLink": "https://localhost/mgmt/cm/access/tasks/kill-sessions/1ab38f85-0178-4ce5-af08-ea5f5fd3ac5e"
}