netprofile

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

Properties

(click to see Operations )
Name Data Type Permissions Description
name <String> Read-write Name for the net profile. Must begin with a letter, number, or the underscore character (_), and can consist of letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore characters. Cannot be changed after the profile is created. Choose a name that helps identify the net profile.
Minimum length = 1
td <Integer> Read-write Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.
Minimum value = 0
Maximum value = 4094
srcip <String> Read-write IP address or the name of an IP set.
srcippersistency <String> Read-write When the net profile is associated with a virtual server or its bound services, this option enables the Citrix ADC to use the same address, specified in the net profile, to communicate to servers for all sessions initiated from a particular client to the virtual server.
Default value: DISABLED
Possible values = ENABLED, DISABLED
overridelsn <String> Read-write USNIP/USIP settings override LSN settings for configured
service/virtual server traffic.. .
Default value: DISABLED
Possible values = ENABLED, DISABLED
mbf <String> Read-write Response will be sent using learnt info if enabled. When creating a netprofile, if you do not set this parameter, the netprofile inherits the global MBF setting (available in the enable ns mode and disable ns mode CLI commands, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the netprofile.
Possible values = ENABLED, DISABLED
proxyprotocol <String> Read-write Proxy Protocol Action (Enabled/Disabled).
Default value: DISABLED
Possible values = ENABLED, DISABLED
proxyprotocoltxversion <String> Read-write Proxy Protocol Version (V1/V2).
Default value: V1
Possible values = V1, V2
proxyprotocolaftertlshandshake <String> Read-write ADC doesnt look for proxy header before TLS handshake, if enabled. Proxy protocol parsed after TLS handshake.
Default value: DISABLED
Possible values = ENABLED, DISABLED
badipactionthreshold <Integer> Read-write Number of protocol violation from an IP address before taking action.
Default value: 0
Minimum value = 0
Maximum value = 100000
proxyprotocoltlvoptions <String[]> Read-only Proxy protocol TLV options.
Possible values = cert-cn
_nextgenapiresource <String> Read-only .
__count <Double> 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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/netprofile HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"netprofile":{
<b>"name":<String_value>,
</b>"td":<Integer_value>,
"srcip":<String_value>,
"srcippersistency":<String_value>,
"overridelsn":<String_value>,
"mbf":<String_value>,
"proxyprotocol":<String_value>,
"proxyprotocoltxversion":<String_value>,
"proxyprotocolaftertlshandshake":<String_value>,
"badipactionthreshold":<Integer_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/netprofile/ 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/netprofile HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"netprofile":{
<b>"name":<String_value>,
</b>"srcip":<String_value>,
"srcippersistency":<String_value>,
"overridelsn":<String_value>,
"mbf":<String_value>,
"proxyprotocol":<String_value>,
"proxyprotocoltxversion":<String_value>,
"proxyprotocolaftertlshandshake":<String_value>,
"badipactionthreshold":<Integer_value>
}}
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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/netprofile? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"netprofile":{
<b>"name":<String_value>,
</b>"srcip":true,
"srcippersistency":true,
"badipactionthreshold":true,
"overridelsn":true,
"mbf":true,
"proxyprotocol":true,
"proxyprotocoltxversion":true,
"proxyprotocolaftertlshandshake":true
}}
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 (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/netprofile Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/netprofile? 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/netprofile? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of netprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/netprofile? view=summary
Use this query-parameter to get the summary output of netprofile 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/netprofile? pagesize=#no;pageno=#no
Use this query-parameter to get the netprofile 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:
{ "netprofile": [ {
"name":<String_value>,
"srcip":<String_value>,
"td":<Integer_value>,
"srcippersistency":<String_value>,
"overridelsn":<String_value>,
"mbf":<String_value>,
"proxyprotocol":<String_value>,
"proxyprotocoltxversion":<String_value>,
"proxyprotocolaftertlshandshake":<String_value>,
"proxyprotocoltlvoptions":<String[]_value>,
"badipactionthreshold":<Integer_value>,
"_nextgenapiresource":<String_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/netprofile/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/netprofile/ 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/netprofile/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of netprofile 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:
{  "netprofile": [ {
"name":<String_value>,
"srcip":<String_value>,
"td":<Integer_value>,
"srcippersistency":<String_value>,
"overridelsn":<String_value>,
"mbf":<String_value>,
"proxyprotocol":<String_value>,
"proxyprotocoltxversion":<String_value>,
"proxyprotocolaftertlshandshake":<String_value>,
"proxyprotocoltlvoptions":<String[]_value>,
"badipactionthreshold":<Integer_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/netprofile? 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:
{ "netprofile": [ { "__count": "#no"} ] }