poll_activity_status
Configuration for Activity Status resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| instance_level_progress | <Integer> | Read-write | Instance level Polling Progress Percentage. Maximum value = |
| status | <String> | Read-write | Status. |
| message | <String> | Read-write | Message. |
| ns_ip_address | <String> | Read-write | NetScaler IP Address. Minimum length = 1 Maximum length = 64 |
| total_instances | <Integer> | Read-write | Total number of devices to be polled. |
| timestamp | <Double> | Read-write | timestamp in seconds. |
| id | <String> | Read-write | Id is system generated key for all the task logs. |
| act_id | <String> | Read-only | Activity Id. |
| module | <String> | Read-only | Module name in which the Polling is done. |
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>
Note:
Mandatory parameters are marked in red and placeholder content is marked in <green>.
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/poll_activity_status
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "poll_activity_status":[{
"instance_level_progress":<Integer_value>,
"status":<String_value>,
"message":<String_value>,
"ns_ip_address":<String_value>,
"total_instances":<Integer_value>,
"act_id":<String_value>,
"timestamp":<Double_value>,
"id":<String_value>,
"module":<String_value>}]}
get
URL: https://<MGMT-IP>/nitro/v1/config/poll_activity_status/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "poll_activity_status":[{
"instance_level_progress":<Integer_value>,
"status":<String_value>,
"message":<String_value>,
"ns_ip_address":<String_value>,
"total_instances":<Integer_value>,
"act_id":<String_value>,
"timestamp":<Double_value>,
"id":<String_value>,
"module":<String_value>}]}