install
Configuration for 0 resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| url | <String> | Read-write | Url for the build file. Must be in the following formats:
http://[user]:[password]@host/path/to/file
https://[user]:[password]@host/path/to/file
sftp://[user]:[password]@host/path/to/file
scp://[user]:[password]@host/path/to/file
ftp://[user]:[password]@host/path/to/file
file://path/to/file.
|
| y | <Boolean> | Read-write | Do not prompt for yes/no before rebooting. |
| l | <Boolean> | Read-write | Use this flag to enable callhome. |
| enhancedupgrade | <Boolean> | Read-write | Use this flag for upgrading from/to enhancement mode. |
| resizeswapvar | <Boolean> | Read-write | Use this flag to change swap size on ONLY 64bit nCore/MCNS/VMPE systems NON-VPX systems. |
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 Citrix ADC appliance, the URL is as follows:http://<Citrix-ADC-IP-address(NSIP)>/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 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>.
Install
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/install
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"install":{
<b>"url":<String_value>,
</b>"y":<Boolean_value>,
"l":<Boolean_value>,
"enhancedupgrade":<Boolean_value>,
"resizeswapvar":<Boolean_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