Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

auditmessageaction

May 23, 2024
Contributed by: 
C

Configuration for message action resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name of the audit message action. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Cannot be changed after the message action is added. The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my message action” or ‘my message action’). Minimum length = 1
loglevel Read-write Audit log level, which specifies the severity level of the log message being generated.. The following loglevels are valid
  • EMERGENCY - Events that indicate an immediate crisis on the server.
  • ALERT - Events that might require action.
  • CRITICAL - Events that indicate an imminent server crisis.
  • ERROR - Events that indicate some type of error.
  • WARNING - Events that require action in the near future.
  • NOTICE - Events that the administrator should know about.
  • INFORMATIONAL - All but low-level events.
  • DEBUG - All events, in extreme detail. Possible values = EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG
    		•
    stringbuilderexpr Read-write Default-syntax expression that defines the format and content of the log message.
    logtonewnslog Read-write Send the message to the new nslog.

    Possible values = YES, NO
    bypasssafetycheck Read-write Bypass the safety check and allow unsafe expressions.

    Default value: NO

    Possible values = YES, NO
    loglevel1 Read-only .

    Possible values = ALL, EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG, NONE
    hits Read-only The number of times the action has been taken.
    undefhits Read-only The number of times the action resulted in UNDEF.
    referencecount Read-only The number of references to the action.
    __count Read-only count parameter

    Operations

    (click to see Properties )

    • ADD
    • DELETE
    • UPDATE
    • UNSET
    • GET (ALL)
    • GET
    • COUNT

    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

    unset

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction? action=unset HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"auditmessageaction":{
<b>"name":<String_value>,
</b>"logtonewnslog":true,
"bypasssafetycheck":true
}}

<!--NeedCopy-->

    Response: HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    delete

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction/ name_value<String> HTTP Method: DELETE

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Response: HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    update

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"auditmessageaction":{
<b>"name":<String_value>,
</b>"loglevel":<String_value>,
"stringbuilderexpr":<String_value>,
"logtonewnslog":<String_value>,
"bypasssafetycheck":<String_value>
}}

<!--NeedCopy-->

    Response: HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    add

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"auditmessageaction":{
<b>"name":<String_value>,
</b><b>"loglevel":<String_value>,
</b><b>"stringbuilderexpr":<String_value>,
</b>"logtonewnslog":<String_value>,
"bypasssafetycheck":<String_value>
}}

<!--NeedCopy-->

    Response: HTTP Status Code on Success: 201 Created

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction? attrs=property-name1,property-name2

    Use this query parameter to specify the resource details that you want to retrieve.

    filter http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction? filter=property-name1:property-val1,property-name2:property-val2

    Use this query-parameter to get the filtered set of auditmessageaction resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

    view http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction? view=summary

    Use this query-parameter to get the summary output of auditmessageaction resources configured on NetScaler.

    Note: By default, the retrieved results are displayed in detail view (?view=detail).

    pagination http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction? pagesize=#no;pageno=#no

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

    HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Response: HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    Response Header:

    Content-Type:application/json

    Response Payload: 

    { "auditmessageaction": [ {
"name":<String_value>,
"loglevel":<String_value>,
"loglevel1":<String_value>,
"stringbuilderexpr":<String_value>,
"logtonewnslog":<String_value>,
"bypasssafetycheck":<String_value>,
"hits":<Double_value>,
"undefhits":<Double_value>,
"referencecount":<Double_value>
}]}

<!--NeedCopy-->

    get

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction/ name_value<String> ? attrs=property-name1,property-name2

    Use this query parameter to specify the resource details that you want to retrieve.

    view http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction/ name_value<String> ? view=summary

    Use this query-parameter to get the summary output of auditmessageaction resources configured on NetScaler.

    Note: By default, the retrieved results are displayed in detail view (?view=detail).

    HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Response: HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    Response Header:

    Content-Type:application/json

    Response Payload: 

    {  "auditmessageaction": [ {
"name":<String_value>,
"loglevel":<String_value>,
"loglevel1":<String_value>,
"stringbuilderexpr":<String_value>,
"logtonewnslog":<String_value>,
"bypasssafetycheck":<String_value>,
"hits":<Double_value>,
"undefhits":<Double_value>,
"referencecount":<Double_value>
}]}

<!--NeedCopy-->

    count

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditmessageaction? count=yes HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Response: HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    Response Header:

    Content-Type:application/json

    Response Payload: 

    { "auditmessageaction": [ { "__count": "#no"} ] }

<!--NeedCopy-->
    auditmessageaction
    May 23, 2024
    Contributed by: 
    C
    May 23, 2024
    Contributed by: 
    C

    In this article

    Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.