portallocation

Last published : Oct 30, 2026
Configuration for portallocation resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
srcip <String> Read-write IP address for which Port allocation needs to be seen. IP address can be SNIP/VIP/NSIP.
destip <String> Read-write Destination IP address or Server IP for which Port allocation needs to be seen.
destport <Integer> Read-write Destination Port or Server port configuration.
Minimum value = 1
Maximum value = 65535
protocol <Integer> Read-write Protocol for the traffic. TCP traffic: 1, All other protocol traffic: 0.
Minimum value = 0
Maximum value = 1
nodeid <Integer> Read-write Unique number that identifies the cluster node.
Minimum value = 0
Maximum value = 31
freeports <Integer> Read-only Freeports for the desired IP address and other parameters.
Minimum value = 0
Maximum value = 2147483647
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • 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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/portallocation Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/portallocation? args=srcip: <String_value> , destip:<String_value>, destport:<Integer_value>, protocol:<Integer_value>, nodeid: <Integer_value>
Use this query-parameter to get portallocation resources based on additional properties.
attrs http:// <netscaler-ip-address> /nitro/v1/config/portallocation? 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/portallocation? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of portallocation resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/portallocation? view=summary
Use this query-parameter to get the summary output of portallocation 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/portallocation? pagesize=#no;pageno=#no
Use this query-parameter to get the portallocation 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:
{ "portallocation": [ {
srcip:<String_value>,<b>destip:<String_value>,</b><b>destport:<Integer_value>,</b><b>protocol:<Integer_value>,</b>nodeid:<Integer_value>"freeports":<Integer_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/portallocation? args=srcip: <String_value> , destip:<String_value>, destport:<Integer_value>, protocol:<Integer_value>, nodeid: <Integer_value> ;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:
{ "portallocation": [ { "__count": "#no"} ] }