ADC NITRO APIs

tmglobal_auditsyslogpolicy_binding

Binding object showing the auditsyslogpolicy that can be bound to tmglobal.

Properties

(click to see Operations )

Name Data Type Permissions Description
priority <Double> Read-write The priority of the policy.
gotopriorityexpression <String> Read-write Applicable only to advance tmsession policy. Expression or other value specifying the next policy to be evaluated if the current policy evaluates to TRUE. Specify one of the following values: - NEXT - Evaluate the policy with the next higher priority number. - END - End policy evaluation. - An expression that evaluates to a number. If you specify an expression, the number to which it evaluates determines the next policy to evaluate, as follows: - If the expression evaluates to a higher numbered priority, the policy with that priority is evaluated next. - If the expression evaluates to the priority of the current policy, the policy with the next higher numbered priority is evaluated next. - If the expression evaluates to a priority number that is numerically higher than the highest numbered priority, policy evaluation ends. An UNDEF event is triggered if: - The expression is invalid. - The expression evaluates to a priority number that is numerically lower than the current policy's priority. - The expression evaluates to a priority number that is between the current policy's priority number (say, 30) and the highest priority number (say, 100), but does not match any configured priority number (for example, the expression evaluates to the number 85). This example assumes that the priority number increments by 10 for every successive policy, and therefore a priority number of 85 does not exist in the policy label.
policyname <String> Read-write The name of the policy.
bindpolicytype <Double> Read-only Bound policy type.
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET
  • GET (ALL)
  • 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

add

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

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{
"tmglobal_auditsyslogpolicy_binding":{
"policyname":<String_value>,
"priority":<Double_value>,
"gotopriorityexpression":<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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/tmglobal_auditsyslogpolicy_binding Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/tmglobal_auditsyslogpolicy_binding? args=policyname: <String_value>

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

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/tmglobal_auditsyslogpolicy_binding Query-parameters: filter http:// <netscaler-ip-address> /nitro/v1/config/tmglobal_auditsyslogpolicy_binding? filter=property-name1:property-value1,property-name2:property-value2

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

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

Use this query-parameter to get the tmglobal_auditsyslogpolicy_binding 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:

{  "tmglobal_auditsyslogpolicy_binding": [ {
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"policyname":<String_value>,
"bindpolicytype":<Double_value>
}]}

<!--NeedCopy-->

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/tmglobal_auditsyslogpolicy_binding HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters: bulkbindings http:// <netscaler-ip-address> /nitro/v1/config/tmglobal_auditsyslogpolicy_binding? bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

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:

{  "tmglobal_auditsyslogpolicy_binding": [ {
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"policyname":<String_value>,
"bindpolicytype":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/tmglobal_auditsyslogpolicy_binding? 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:

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

<!--NeedCopy-->
tmglobal_auditsyslogpolicy_binding