ADC NITRO APIs

callhome

August 17, 2023

Contributed by:

Configuration for callhome resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
nodeid		Read-write	Unique number that identifies the cluster node. Minimum value = 0 Maximum value = 31
mode		Read-write	CallHome mode of operation. Default value: Default Possible values = Default, CSP
emailaddress		Read-write	Email address of the contact administrator. Maximum length = 78
hbcustominterval		Read-write	Interval (in days) between CallHome heartbeats. Default value: 7 Minimum value = 1 Maximum value = 30
proxymode		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		Read-write	IP address of the proxy server. Minimum length = 1
proxyauthservice		Read-write	Name of the service that represents the proxy server. Maximum length = 128
port		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		Read-only	First occurrence SSL card failure.
sslcardlatestfailure		Read-only	Latest occurrence SSL card failure.
powfirstfail		Read-only	First occurrence power supply unit failure.
powlatestfailure		Read-only	Latest occurrence power supply unit failure.
hddfirstfail		Read-only	First occurrence hard disk drive failure.
hddlatestfailure		Read-only	Latest occurrence hard disk drive failure.
flashfirstfail		Read-only	First occurrence compact flash failure.
flashlatestfailure		Read-only	Latest occurrence compact flush failure.
rlfirsthighdrop		Read-only	First occurence of high rate limit drops.
rllatesthighdrop		Read-only	Latest occurence of high rate limit drops.
restartlatestfail		Read-only	Latest occurrence warm restart failure.
memthrefirstanomaly		Read-only	First occurrence of memory anomaly.
memthrelatestanomaly		Read-only	Latest occurrence of memory anomaly.
callhomestatus	<String[]>	Read-only	Callhome feature enabled/disable, register with upload server successful/failed. Possible values = ENABLED, DISABLED, SUCCESSFUL, FAILED, INVALID HOSTNAME, NO DNSSERVER, HOSTNAME RESOLUTION FAILED

Operations

(click to see Properties )

GET (ALL)
UPDATE
UNSET

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

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":{
      "mode":<String_value>,
      "emailaddress":<String_value>,
      "hbcustominterval":<Double_value>,
      "proxymode":<String_value>,
      "ipaddress":<String_value>,
      "proxyauthservice":<String_value>,
      "port":<Integer_value>
}}

<!--NeedCopy-->

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":{
      "mode":true,
      "emailaddress":true,
      "hbcustominterval":true,
      "proxymode":true,
      "ipaddress":true,
      "proxyauthservice":true,
      "port":true
}}

<!--NeedCopy-->

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

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/callhome? args=nodeid: <Double_value>

Use this query-parameter to get callhome resources based on additional properties.

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:

{ "callhome": [ {
nodeid:<Double_value>      "mode":<String_value>,
      "emailaddress":<String_value>,
      "hbcustominterval":<Double_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>,
      "rlfirsthighdrop":<String_value>,
      "rllatesthighdrop":<String_value>,
      "restartlatestfail":<String_value>,
      "memthrefirstanomaly":<String_value>,
      "memthrelatestanomaly":<String_value>,
      "callhomestatus":<String[]_value>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

callhome

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

callhome

Properties

Operations

update

unset

get (all)

In this article