Product Documentation

callhome

Sep 08, 2016

Configuration for callhome resource.

Properties (click to see Operations)

Name Data Type Permissions Description
emailaddress
<String>
Read-write
Email address of the contact administrator.
Maximum length = 78
proxymode
<String>
Read-write
Enables or disables the proxy mode. The proxy server can be set by either specifying the IP address of the server or the name of the service representing the proxy server.
Default value: NO
Possible values = YES, NO
ipaddress
<String>
Read-write
IP address of the proxy server.
Minimum length = 1
proxyauthservice
<String>
Read-write
Name of the service that represents the proxy server.
Maximum length = 128
port
<Integer>
Read-write
HTTP port on the Proxy server. This is a mandatory parameter for both IP address and service name based configuration.
Minimum value = 1
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
sslcardfirstfailure
<String>
Read-only
First occurrence SSL card failure.
sslcardlatestfailure
<String>
Read-only
Latest occurrence SSL card failure.
powfirstfail
<String>
Read-only
First occurrence power supply unit failure.
powlatestfailure
<String>
Read-only
Latest occurrence power supply unit failure.
hddfirstfail
<String>
Read-only
First occurrence hard disk drive failure.
hddlatestfailure
<String>
Read-only
Latest occurrence hard disk drive failure.
flashfirstfail
<String>
Read-only
First occurrence compact flash failure.
flashlatestfailure
<String>
Read-only
Latest occurrence compact flush failure.
restartlatestfail
<String>
Read-only
Latest occurrence warm restart failure.
callhomestatus
<String[]>
Read-only
Callhome feature enabled/disable, register with upload server successful/failed.
Possible values = ENABLED, DISABLED, SUCCESSFUL, FAILED

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

update

URL: http://<netscaler-ip-address>/nitro/v1/config/callhome

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"callhome":{
      "emailaddress":<String_value>,
      "proxymode":<String_value>,
      "ipaddress":<String_value>,
      "proxyauthservice":<String_value>,
      "port":<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/callhome?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"callhome":{
      "emailaddress":true,
      "proxymode":true,
      "ipaddress":true,
      "proxyauthservice":true,
      "port":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/callhome

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 Headers:

Content-Type:application/json

Response Payload:

{ "callhome": [ {
      "emailaddress":<String_value>,
      "proxymode":<String_value>,
      "ipaddress":<String_value>,
      "port":<Integer_value>,
      "proxyauthservice":<String_value>,
      "sslcardfirstfailure":<String_value>,
      "sslcardlatestfailure":<String_value>,
      "powfirstfail":<String_value>,
      "powlatestfailure":<String_value>,
      "hddfirstfail":<String_value>,
      "hddlatestfailure":<String_value>,
      "flashfirstfail":<String_value>,
      "flashlatestfailure":<String_value>,
      "restartlatestfail":<String_value>,
      "callhomestatus":<String[]_value>
}]}