Skip to content

journaltask

Configuration for JournalTask configuration resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
rollback_instruction<String>Read-writeRollback instruction for the journal task.
status<String>Read-writeStatus of context could be attempted/finished/Error/Rollback in progress/Rollback Completed.
name<String>Read-writeName of the context.
start_time<String>Read-writeStart time of request..
end_time<String>Read-writeEnd time of request.
service_name<String>Read-writeName of service-request which started the context.
error_message<String>Read-writemessage to be displayed if there is some error in processing journal task.
context_id<String>Read-writeRequest/Context id of the task.
rollback_method<String>Read-writeRollback method for the journal task.
id<String>Read-writeId is sequential number identifying Journal Task.

Operations

(click to see Properties)

GET (ALL)| GET

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/journaltask

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "journaltask":[{
"rollback_instruction":<String_value>,
"status":<String_value>,
"name":<String_value>,
"start_time":<String_value>,
"end_time":<String_value>,
"service_name":<String_value>,
"error_message":<String_value>,
"context_id":<String_value>,
"rollback_method":<String_value>,
"id":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/journaltask/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "journaltask":[{
"rollback_instruction":<String_value>,
"status":<String_value>,
"name":<String_value>,
"start_time":<String_value>,
"end_time":<String_value>,
"service_name":<String_value>,
"error_message":<String_value>,
"context_id":<String_value>,
"rollback_method":<String_value>,
"id":<String_value>}]}