nsmigration

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

Properties

(click to see Operations )
Name Data Type Permissions Description
dumpsession <String> Read-write Displays the current active migrated session details, if DUMPSESSION option is YES.
Default value: NO
Possible values = YES, NO
migrationstatus <String> Read-only ISSU Migration Status.
Possible values = Migration is not yet started, Migration is in progress and Failover is not yet done, Migration is in progress and Failover is completed, Rollback is initiated and Failover is not yet done, Rollback is initiated and Failover is completed, Migration is completed
migrationstarttime <String> Read-only Timestamp for start migration.
Minimum length = 1
migrationendtime <String> Read-only Timestamp for migration complete.
Minimum length = 1
migrationrollbackstarttime <String> Read-only Timestamp for start migration rollback.
Minimum length = 1
srcip <String> Read-only IP address to match against the source IP address of an incoming IPv4 packet.
srcport <Integer> Read-only Port number to match against the source port number of an incoming IPv4 packet.
destip <String> Read-only IP address to match against the destination IP address of an incoming IPv4 packet.
destport <Integer> Read-only Port number to match against the destination port number of an incoming IPv4 packet.
timeout <Integer> Read-only Time for which the connection is idle.
migdfdsessionsallocated <Integer> Read-only Number of migration sessions allocated.
migdfdsessionsactive <Integer> Read-only Number of migration sessions active.
migl4sessionsallocated <Integer> Read-only Number of migration sessions allocated.
migl4sessionsactive <Integer> Read-only Number of migration sessions active.
migdfdsessionsallocatedrollback <Integer> Read-only Number of migration sessions allocated.
migdfdsessionsactiverollback <Integer> Read-only Number of migration sessions active.
migl4sessionsallocatedrollback <Integer> Read-only Number of migration sessions allocated.
migl4sessionsactiverollback <Integer> Read-only Number of migration sessions active.
mighastateflag <Integer> Read-only Current master state in HA.
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

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

start

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsmigration? action=start HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"nsmigration":{
}}
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

stop

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsmigration? action=stop HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"nsmigration":{
}}
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

complete

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsmigration? action=complete HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"nsmigration":{
}}
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/nsmigration Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/nsmigration? args=dumpsession: <String_value>
Use this query-parameter to get nsmigration resources based on additional properties.
attrs http:// <netscaler-ip-address> /nitro/v1/config/nsmigration? 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/nsmigration? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of nsmigration resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/nsmigration? view=summary
Use this query-parameter to get the summary output of nsmigration 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/nsmigration? pagesize=#no;pageno=#no
Use this query-parameter to get the nsmigration 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:
{ "nsmigration": [ {
dumpsession:<String_value>"migrationstatus":<String_value>,
"migrationstarttime":<String_value>,
"migrationendtime":<String_value>,
"migrationrollbackstarttime":<String_value>,
"dumpsession":<String_value>,
"srcip":<String_value>,
"srcport":<Integer_value>,
"destip":<String_value>,
"destport":<Integer_value>,
"timeout":<Integer_value>,
"migdfdsessionsallocated":<Integer_value>,
"migdfdsessionsactive":<Integer_value>,
"migl4sessionsallocated":<Integer_value>,
"migl4sessionsactive":<Integer_value>,
"migdfdsessionsallocatedrollback":<Integer_value>,
"migdfdsessionsactiverollback":<Integer_value>,
"migl4sessionsallocatedrollback":<Integer_value>,
"migl4sessionsactiverollback":<Integer_value>,
"mighastateflag":<Integer_value>,
"_nextgenapiresource":<String_value>
}]}

count

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