Product Documentation

Globally Binding NetScaler Resources

Sep 01, 2016

Some NetScaler resources can be bound globally to affect the whole system. For example, if a compression policy is bound to an load balancing virtual server, the policy affects only the traffic on that virtual server. However, if bound globally, it can affect any traffic on the NetScaler appliance regardless of the virtual server that handles the traffic.

The names of NITRO resources that can be used to bind resources globally have the pattern <featurename>global_<resourcetype>_binding. For example, the object aaaglobal_aaapreauthenticationpolicy_binding is used to bind preauthentication policies globally.

For example, to bind the policy named preautpol1 globally at priority 200:
  • Request:

    HTTP Method
    POST
    URL
    http://<netscaler-ip-address>/nitro/v1/config/aaaglobal_aaapreauthenticationpolicy_binding/preautpol1
    Request Headers
    Cookie:NITRO_AUTH_TOKEN=<tokenvalue> 
    Content-Type:application/json
    
    Request Payload
    { 
        "aaaglobal_aaapreauthenticationpolicy_binding": 
        { 
            "policy":"preautpol1", 
            "priority":"200" 
        } 
    }
    
  • 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.

To unbind a global resource, in the URL use the args query parameter to specify the resource to be unbound.

For example, to unbind the policy named preautpol1:
  • Request:

    HTTP Method
    DELETE
    URL
    http://<netscaler-ip-address>/nitro/v1/config/aaaglobal_aaapreauthenticationpolicy_binding?args=policy:preautpol1
    Request Header
    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.