Cisco Cisco ASA 5580 Adaptive Security Appliance
About the ASA REST API
REST Agent in ASA
REST Agent in ASA
9
REST Agent in ASA
Enabling REST Agent in ASA
With the current rest-api implementation, JRE and rest-api agent are bundled in the ASA image. This causes significant
increase in the size of ASA image from 9.3.1 release. And with this approach, Java is bundled by default in ASA images
and this caused concerns from field/sales engineers.
and this caused concerns from field/sales engineers.
To address this issue, through rounds of discussions, it is decided that we will package rest-api + JRE together, sign and
publish separately on CCO. (New keys will be needed signing the REST package) This way, shipped ASA images will not
have rest-api plugin package. Only the customers needing rest-api will download the separate package, put it on flash
and invoke the CLI command to start rest-api agent. As a result, we plan to add the following CLI to install/uninstall rest-
and invoke the CLI command to start rest-api agent. As a result, we plan to add the following CLI to install/uninstall rest-
api image. Users still need to invoke the existing "[no] rest-api agent" command to enable/disable rest-api agent after
the installation. But per customer requirement, "[no] rest-api agent" will now be part of the running config instead of
storing in a file on flash.
storing in a file on flash.
[no] rest-api image disk0:/<package>
Description
- It will perform the compatibility/validation checks and inform if there are problems. If all checks pass, it will install the
rest-api image.
- Installing/updating rest-api package will not trigger reboot of ASA.
- This config will be saved in the startup config file.
- This config will be saved in the startup config file.
- "clear configure" will clear this config.
- To uninstall, use the "no" form of the command.
Syntax & Help message
image Use this keyword to install the REST API image on ASA.
Output of Show Commands
REST API image file, <path to the file>
E.g. CLI sequence for installing rest-api image:
copy tftp://<tftpserver/asa-restapi-9.3.2-32.pkg disk0:
rest-api image disk0:/asa-restapi-9.3.2-32.pkg
E.g. CLI sequence for uninstalling rest-api image:
E.g. CLI sequence for uninstalling rest-api image:
no rest-api image disk0:/asa-restapi-9.3.2-32.pkg
E.g. CLI sequence for Upgrading rest-api image:
messages
List of Dictionaries
List of error or warning messages
code
String
Error/Warning/Info code
details
String
Detailed message corresponding to Error/Warning/Info