NetScaler SDX 14.1 NITRO API Reference

virtual_nmi

Configuration for Virtual NMI generate resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
sync_operation Read-write sync operation.
host_ip_address Read-write Host IP Address of the VM on which we are sending virtual NMI signal.
type Read-write Type of device.

Minimum length = 1

Maximum length = 64
ip_address Read-write IP Address of the VM on which we are sending virtual NMI signal.
act_id Read-only Activity Id.

Operations

(click to see Properties )

  • INITIATE_CRASH_DUMP

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

initiate_crash_dump

URL: https://<MGMT-IP>/nitro/v2/config/virtual_nmi?action=initiate_crash_dump;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"virtual_nmi": {
"host_ip_address":<String_value>,
"ip_address":<String_value>,
"sync_operation":<Boolean_value>,
"type":<String_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "virtual_nmi":[{
"sync_operation":<Boolean_value>,
"act_id":<String_value>,
"host_ip_address":<String_value>,
"type":<String_value>,
"ip_address":<String_value>}]}

<!--NeedCopy-->
virtual_nmi