systemglobal_auditnslogpolicy_binding¶
Binding object showing the auditnslogpolicy that can be bound to systemglobal.
Properties¶
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
priority | <Double> | Read-write | The priority of the command policy. |
globalbindtype | <String> | Read-write | .
Default value: SYSTEM_GLOBAL Possible values = SYSTEM_GLOBAL, VPN_GLOBAL, RNAT_GLOBAL |
nextfactor | <String> | Read-write | On success invoke label. Applicable for advanced authentication policy binding. |
feature | <String> | Read-write | The feature to be checked while applying this config. |
gotopriorityexpression | <String> | Read-write | Applicable only to advance authentication 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. |
builtin | <String[]> | Read-write | Indicates that a variable is a built-in (SYSTEM INTERNAL) type.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL |
policyname | <String> | Read-write | The name of the command policy. |
__count | <Double> | Read-write | 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/systemglobal_auditnslogpolicy_binding
HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{
"systemglobal_auditnslogpolicy_binding":{
"policyname":<String_value>,
"priority":<Double_value>,
"nextfactor":<String_value>,
"gotopriorityexpression":<String_value>
}}
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/systemglobal_auditnslogpolicy_binding
Query-parameters:
args
http:// <netscaler-ip-address> /nitro/v1/config/systemglobal_auditnslogpolicy_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/systemglobal_auditnslogpolicy_binding
Query-parameters:
filter
http:// <netscaler-ip-address> /nitro/v1/config/systemglobal_auditnslogpolicy_binding? filter=property-name1:property-value1,property-name2:property-value2
Use this query-parameter to get the filtered set of systemglobal_auditnslogpolicy_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/systemglobal_auditnslogpolicy_binding? pagesize=#no;pageno=#no
Use this query-parameter to get the systemglobal_auditnslogpolicy_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:
{ "systemglobal_auditnslogpolicy_binding": [ {
"priority":<Double_value>,
"globalbindtype":<String_value>,
"nextfactor":<String_value>,
"feature":<String_value>,
"gotopriorityexpression":<String_value>,
"builtin":<String[]_value>,
"policyname":<String_value>
}]}
get (all)¶
URL: http:// <netscaler-ip-address> /nitro/v1/config/systemglobal_auditnslogpolicy_binding
HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Query-parameters:
bulkbindings
http:// <netscaler-ip-address> /nitro/v1/config/systemglobal_auditnslogpolicy_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:
{ "systemglobal_auditnslogpolicy_binding": [ {
"priority":<Double_value>,
"globalbindtype":<String_value>,
"nextfactor":<String_value>,
"feature":<String_value>,
"gotopriorityexpression":<String_value>,
"builtin":<String[]_value>,
"policyname":<String_value>
}]}
count¶
URL: http:// <netscaler-ip-address> /nitro/v1/config/systemglobal_auditnslogpolicy_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:
{ "systemglobal_auditnslogpolicy_binding": [ { "__count": "#no"} ] }