Instances

ns_callhome

March 20, 2024

Contributed by:

Configuration for Citrix ADC Callhome Information resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
proxy_mode		Read-write	Deploy the callhome proxy mode.Possible values YES or NO. Maximum length = 78
proxy_server_ip		Read-write	Proxy Server IP address. Minimum length = 1 Maximum length = 64
ip_address		Read-write	Citrix ADC IP Address for callhome. Minimum length = 1 Maximum length = 64
proxy_server_port		Read-write	Proxy server Port. Maximum value =
email_address		Read-write	The contact person’s E-mail address. Maximum length = 78
name		Read-write	Name of the vpx Instance. Maximum length = 78
ns_ip_address_arr	<String[]>	Read-write	List of Citrix ADC IP Address. Minimum length = 1 Maximum length = 64
powfirstfail		Read-only	First occurrence power supply unit failure.
callhomesenablestatus		Read-only	Callhome feature enabled/disable.
powlatestfail		Read-only	Latest occurrence power supply unit failure.
flashlatestfail		Read-only	Latest occurrence compact flash failure.
restartfirstfail		Read-only	First occurrence warm restart failure.
hddlatestfail		Read-only	Latest occurrence hard disk drive failure.
flashfirstfail		Read-only	First occurrence compact flash failure.
restartlatestfail		Read-only	Latest occurrence warm restart failure.
hddfirstfail		Read-only	First occurrence hard disk drive failure.
callhomestatus		Read-only	Callhome feature register with upload server successful/failed.
sslcardfirstfailure		Read-only	First occurrence SSL card failure.
sslcardlatestfailure		Read-only	Latest occurrence SSL card failure.

Operations

(click to see Properties )

POLLNOW
ENABLE
GET (ALL)
UPDATE
DISABLE

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

pollnow

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

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_callhome": {
<b>"ip_address":<String_value></b>,
"proxy_mode":<String_value>,
"name":<String_value>,
"email_address":<String_value>,
"ns_ip_address_arr":<String_value[]>,
"proxy_server_ip":<String_value>,
"proxy_server_port":<Integer_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, "ns_callhome":[{
"powfirstfail":<String_value>,
"callhomesenablestatus":<String_value>,
"proxy_mode":<String_value>,
"powlatestfail":<String_value>,
"flashlatestfail":<String_value>,
"restartfirstfail":<String_value>,
"hddlatestfail":<String_value>,
"proxy_server_ip":<String_value>,
"flashfirstfail":<String_value>,
"ip_address":<String_value>,
"restartlatestfail":<String_value>,
"proxy_server_port":<Integer_value>,
"hddfirstfail":<String_value>,
"email_address":<String_value>,
"callhomestatus":<String_value>,
"name":<String_value>,
"ns_ip_address_arr":<String_value>,
"sslcardfirstfailure":<String_value>,
"sslcardlatestfailure":<String_value>}]}

<!--NeedCopy-->

enable

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

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_callhome": {
<b>"ip_address":<String_value></b>,
"proxy_mode":<String_value>,
"name":<String_value>,
"email_address":<String_value>,
"ns_ip_address_arr":<String_value[]>,
"proxy_server_ip":<String_value>,
"proxy_server_port":<Integer_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_callhome":[{
"powfirstfail":<String_value>,
"callhomesenablestatus":<String_value>,
"proxy_mode":<String_value>,
"powlatestfail":<String_value>,
"flashlatestfail":<String_value>,
"restartfirstfail":<String_value>,
"hddlatestfail":<String_value>,
"proxy_server_ip":<String_value>,
"flashfirstfail":<String_value>,
"ip_address":<String_value>,
"restartlatestfail":<String_value>,
"proxy_server_port":<Integer_value>,
"hddfirstfail":<String_value>,
"email_address":<String_value>,
"callhomestatus":<String_value>,
"name":<String_value>,
"ns_ip_address_arr":<String_value>,
"sslcardfirstfailure":<String_value>,
"sslcardlatestfailure":<String_value>}]}

<!--NeedCopy-->

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ns_callhome Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/ns_callhome ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of ns_callhome resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ns_callhome ?pagesize=#no;pageno=#no Use this query-parameter to get the ns_callhome resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/ns_callhome ?count=yes Use this query-parameter to get the count of ns_callhome resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_callhome":[{
"powfirstfail":<String_value>,
"callhomesenablestatus":<String_value>,
"proxy_mode":<String_value>,
"powlatestfail":<String_value>,
"flashlatestfail":<String_value>,
"restartfirstfail":<String_value>,
"hddlatestfail":<String_value>,
"proxy_server_ip":<String_value>,
"flashfirstfail":<String_value>,
"ip_address":<String_value>,
"restartlatestfail":<String_value>,
"proxy_server_port":<Integer_value>,
"hddfirstfail":<String_value>,
"email_address":<String_value>,
"callhomestatus":<String_value>,
"name":<String_value>,
"ns_ip_address_arr":<String_value>,
"sslcardfirstfailure":<String_value>,
"sslcardlatestfailure":<String_value>}]}

<!--NeedCopy-->

update

URL: https://<MGMT-IP>/nitro/v2/config/ns_callhome/ip_address_value<String> HTTPS Method: PUT

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_callhome":{
"proxy_mode":<String_value>,
"name":<String_value>,
"email_address":<String_value>,
"ns_ip_address_arr":<String_value[]>,
"proxy_server_ip":<String_value>,
"proxy_server_port":<Integer_value>,
"ip_address":<String_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_callhome":[{
"powfirstfail":<String_value>,
"callhomesenablestatus":<String_value>,
"proxy_mode":<String_value>,
"powlatestfail":<String_value>,
"flashlatestfail":<String_value>,
"restartfirstfail":<String_value>,
"hddlatestfail":<String_value>,
"proxy_server_ip":<String_value>,
"flashfirstfail":<String_value>,
"ip_address":<String_value>,
"restartlatestfail":<String_value>,
"proxy_server_port":<Integer_value>,
"hddfirstfail":<String_value>,
"email_address":<String_value>,
"callhomestatus":<String_value>,
"name":<String_value>,
"ns_ip_address_arr":<String_value>,
"sslcardfirstfailure":<String_value>,
"sslcardlatestfailure":<String_value>}]}

<!--NeedCopy-->

disable

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

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_callhome": {
<b>"ip_address":<String_value></b>,
"proxy_mode":<String_value>,
"name":<String_value>,
"email_address":<String_value>,
"ns_ip_address_arr":<String_value[]>,
"proxy_server_ip":<String_value>,
"proxy_server_port":<Integer_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_callhome":[{
"powfirstfail":<String_value>,
"callhomesenablestatus":<String_value>,
"proxy_mode":<String_value>,
"powlatestfail":<String_value>,
"flashlatestfail":<String_value>,
"restartfirstfail":<String_value>,
"hddlatestfail":<String_value>,
"proxy_server_ip":<String_value>,
"flashfirstfail":<String_value>,
"ip_address":<String_value>,
"restartlatestfail":<String_value>,
"proxy_server_port":<Integer_value>,
"hddfirstfail":<String_value>,
"email_address":<String_value>,
"callhomestatus":<String_value>,
"name":<String_value>,
"ns_ip_address_arr":<String_value>,
"sslcardfirstfailure":<String_value>,
"sslcardlatestfailure":<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

ns_callhome

March 20, 2024

Contributed by:

March 20, 2024

Contributed by:

ns_callhome

Properties

Operations

pollnow

enable

get (all)

update

disable

In this article