Skip to content
Was this article helpful?

journalcontext

Configuration for JournalContext configuration resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
scopes <journalcontextscope> Read-write The effected entities due to this request.
is_default <String> Read-write The context is default or not.
service_name <String> Read-write Name of service-request which started the context.
end_time <String> Read-write End time of request.
status <String> Read-write Status of context could be attempted/finished/Error/Rollback in progress/Rollback Completed.
name <String> Read-write Name of the context.
start_time <String> Read-write Start time of request..
id <String> Read-write Id is system generated key for context.
message <String> Read-write message to be displayed if there is some error in processing request.

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/journalcontext

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/journalcontext ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of journalcontext resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/journalcontext ?pagesize=#no;pageno=#no

Use this query-parameter to get the journalcontext resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/journalcontext ?count=yes

Use this query-parameter to get the count of journalcontext resources.

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "journalcontext":[{
      "scopes":<journalcontextscope_value>,
      "is_default":<String_value>,
      "service_name":<String_value>,
      "end_time":<String_value>,
      "status":<String_value>,
      "name":<String_value>,
      "start_time":<String_value>,
      "id":<String_value>,
      "message":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/journalcontext/id_value<String>

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "journalcontext":[{
      "scopes":<journalcontextscope_value>,
      "is_default":<String_value>,
      "service_name":<String_value>,
      "end_time":<String_value>,
      "status":<String_value>,
      "name":<String_value>,
      "start_time":<String_value>,
      "id":<String_value>,
      "message":<String_value>}]}
Was this article helpful?