Skip to content

callhome

Configuration for callhome resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
nodeid<Double>Read-writeUnique number that identifies the cluster node.
Minimum value = 0
Maximum value = 31
mode<String>Read-writeCallHome mode of operation.
Default value: Default
Possible values = Default, CSP
emailaddress<String>Read-writeEmail address of the contact administrator.
Maximum length = 78
hbcustominterval<Double>Read-writeInterval (in days) between CallHome heartbeats.
Default value: 7
Minimum value = 1
Maximum value = 30
proxymode<String>Read-writeEnables 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-writeIP address of the proxy server.
Minimum length = 1
proxyauthservice<String>Read-writeName of the service that represents the proxy server.
Maximum length = 128
port<Integer>Read-writeHTTP 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-onlyFirst occurrence SSL card failure.
sslcardlatestfailure<String>Read-onlyLatest occurrence SSL card failure.
powfirstfail<String>Read-onlyFirst occurrence power supply unit failure.
powlatestfailure<String>Read-onlyLatest occurrence power supply unit failure.
hddfirstfail<String>Read-onlyFirst occurrence hard disk drive failure.
hddlatestfailure<String>Read-onlyLatest occurrence hard disk drive failure.
flashfirstfail<String>Read-onlyFirst occurrence compact flash failure.
flashlatestfailure<String>Read-onlyLatest occurrence compact flush failure.
rlfirsthighdrop<String>Read-onlyFirst occurence of high rate limit drops.
rllatesthighdrop<String>Read-onlyLatest occurence of high rate limit drops.
restartlatestfail<String>Read-onlyLatest occurrence warm restart failure.
memthrefirstanomaly<String>Read-onlyFirst occurrence of memory anomaly.
memthrelatestanomaly<String>Read-onlyLatest occurrence of memory anomaly.
callhomestatus<String[]>Read-onlyCallhome 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)

UPDATE| UNSET| GET (ALL)

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

update

URL:http://<Citrix-ADC-IP-address(NSIP)>/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>
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/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
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/callhome

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

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>
}]}