cas_config
Configuration for CAS configuration resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| eventHubToken | <String> | Read-write | eventHubToken. |
| status | <Integer> | Read-write | Status updated by Agent after reading configuration. |
| turnOnEvent | <Boolean> | Read-write | Specifies whether events have to be turned on or not. |
| eventHubEndpoint | <String> | Read-write | End Point. |
| blobToken | <String> | Read-write | blobToken. |
| blobName | <String> | Read-write | The container name of the blob for the tenant. Blob name is same as container name. |
| blobAccount | <String> | Read-write | Account. |
| CustomerId | <String> | Read-write | CWC CustomerId. |
| agent_id | <String> | Read-write | Id is system generated key for agent registered with NMX Cloud.. |
| expires | <Double> | Read-write | Token Expire date. |
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>.
add
URL: https://<MGMT-IP>/nitro/v1/config/cas_config?onerror=<String_value>
HTTP Method: null
Request Payload:
{cas_config: {
"eventHubToken":<String_value>,
"blobAccount":<String_value>,
"CustomerId":<String_value>,
"blobName":<String_value>,
"status":<Integer_value>,
"blobToken":<String_value>,
"eventHubEndpoint":<String_value>,
"turnOnEvent":<Boolean_value>,
"agent_id":<String_value>,
"expires":<Double_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "cas_config":[{
"eventHubToken":<String_value>,
"status":<Integer_value>,
"turnOnEvent":<Boolean_value>,
"eventHubEndpoint":<String_value>,
"blobToken":<String_value>,
"blobName":<String_value>,
"blobAccount":<String_value>,
"CustomerId":<String_value>,
"agent_id":<String_value>,
"expires":<Double_value>}]}
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/cas_config
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "cas_config":[{
"eventHubToken":<String_value>,
"status":<Integer_value>,
"turnOnEvent":<Boolean_value>,
"eventHubEndpoint":<String_value>,
"blobToken":<String_value>,
"blobName":<String_value>,
"blobAccount":<String_value>,
"CustomerId":<String_value>,
"agent_id":<String_value>,
"expires":<Double_value>}]}
modify
URL: https://<MGMT-IP>/nitro/v1/config/cas_config/agent_id_value<String>
HTTP Method: null
Request Payload:
{cas_config:{
"eventHubToken":<String_value>,
"blobAccount":<String_value>,
"CustomerId":<String_value>,
"blobName":<String_value>,
"status":<Integer_value>,
"blobToken":<String_value>,
"eventHubEndpoint":<String_value>,
"turnOnEvent":<Boolean_value>,
"agent_id":<String_value>,
"expires":<Double_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "cas_config":[{
"eventHubToken":<String_value>,
"status":<Integer_value>,
"turnOnEvent":<Boolean_value>,
"eventHubEndpoint":<String_value>,
"blobToken":<String_value>,
"blobName":<String_value>,
"blobAccount":<String_value>,
"CustomerId":<String_value>,
"agent_id":<String_value>,
"expires":<Double_value>}]}