sdx_builtin_agent
Configuration for SDX built in agent registration resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| activation_code | <String> | Read-write | activation code. |
| service_url | <String> | Read-write | service url. |
| vpx_user_name | <String> | Read-write | vpx user name. |
| status | <String> | Read-write | builtin agent conn status. |
| sdx_user_name | <String> | Read-write | sdx user name. |
| vpx_password | <String> | Read-write | vpx password. |
| sdx_password | <String> | Read-write | sdx password. |
| profile_name | <String> | Read-write | sdx device profile name. |
Operations
(click to see Properties )
- REGISTER
- GET (ALL)
- DE_REGISTER
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=yesIf 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
register
URL: https://<MGMT-IP>/nitro/v2/config/sdx_builtin_agent?action=register;onerror=<String_value> HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"sdx_builtin_agent": {
"vpx_password":<String_value>,
"activation_code":<String_value>,
"vpx_user_name":<String_value>,
"sdx_password":<String_value>,
"status":<String_value>,
"sdx_user_name":<String_value>,
"service_url":<String_value>,
"profile_name":<String_value>}}
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, "sdx_builtin_agent":[{
"activation_code":<String_value>,
"service_url":<String_value>,
"vpx_user_name":<String_value>,
"status":<String_value>,
"sdx_user_name":<String_value>,
"vpx_password":<String_value>,
"sdx_password":<String_value>,
"profile_name":<String_value>}]}
get (all)
URL: https://<MGMT-IP>/nitro/v2/config/sdx_builtin_agent Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/sdx_builtin_agent ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of sdx_builtin_agent 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/sdx_builtin_agent ?pagesize=#no;pageno=#no Use this query-parameter to get the sdx_builtin_agent resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/sdx_builtin_agent ?count=yes Use this query-parameter to get the count of sdx_builtin_agent resources.
HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
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 Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "sdx_builtin_agent":[{
"activation_code":<String_value>,
"service_url":<String_value>,
"vpx_user_name":<String_value>,
"status":<String_value>,
"sdx_user_name":<String_value>,
"vpx_password":<String_value>,
"sdx_password":<String_value>,
"profile_name":<String_value>}]}
de_register
URL: https://<MGMT-IP>/nitro/v2/config/sdx_builtin_agent?action=de_register;onerror=<String_value> HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"sdx_builtin_agent": {
"vpx_password":<String_value>,
"activation_code":<String_value>,
"vpx_user_name":<String_value>,
"sdx_password":<String_value>,
"status":<String_value>,
"sdx_user_name":<String_value>,
"service_url":<String_value>,
"profile_name":<String_value>}}
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, "sdx_builtin_agent":[{
"activation_code":<String_value>,
"service_url":<String_value>,
"vpx_user_name":<String_value>,
"status":<String_value>,
"sdx_user_name":<String_value>,
"vpx_password":<String_value>,
"sdx_password":<String_value>,
"profile_name":<String_value>}]}