Application Extension Platform 1.x -- AXP Packaging Tool Parameters

From DocWiki

AXP Packaging Tool Arguments

Argument	Description	Required/Optional	Range of Expected Values	Example
project-dir	Project directory. Contains package files, templates, and temporary files created during packaging.	Required	Any valid directory on the machine.	xyz_src/empty_app/package
auth-bundle	Software authorization file location. File contains authorization details that allow your application to run on the target application service module. (Replaces dev-cert and dev-auth parameters from AXP 1.1 or higher.)	Required	Any valid authorization file.	/xyz_src/auth_bundle.sig
private-key	Location of private key file. File contains the RSA key used to sign the third party application software.	Required	Any valid private key.	/xyz_src/privkey.txt
name	Name of packaged application	Required	Cannot contain white space or special characters.	myapp
version	Version of packaged application	Required	[0-9]+([.][0-9]+) {0,8} Only numbers are permitted. Note: If you are repackaging a Cisco AXP 1.1 application with the Cisco AXP 1.5 SDK, you must use a different version number for your application and use the same UUID for your application as you used for Cisco AXP 1.1. This ensures that the application is identified and upgraded correctly when upgrade CLI commands are used.	1.0
description	Description of application’s function	Optional	Any valid string.	myapp utility
uuid	Application’s unique identifier	Optional	Either:1. (Recommended) a UUID value generated, for example, with the Linux “uuidgen” tool. or 2. A UUID automatically generated when you do not enter a value. If you are repackaging a Cisco AXP 1.1 application with the Cisco AXP 1.5 SDK, you must use the same UUID for your application, and use a different version number for your application. This ensures that the application is identified and upgraded correctly when upgrade CLI commands are used.	25773fde-b599-459c-b0fa-5be90cc73a2f
source-dir	Directory location for the application files to be packaged. The directory structure must mirror the desired directory structure on the target file system.	Required	Any valid directory that contains application files to be packaged.	/xyz_src/empty_app/build
protect	List of files to be protected. The files are in a text file containing a list of files, one per line, that are checked for signs of alteration before application initialization.	Optional	Any valid file location.
preupgrade	Location of preupgrade script.	Optional	Any valid script. See the “Scripts Performed before Installation” section on page 145.	/bin/preupgrade.sh
preupgrade-oldver	Location of preupgrade-oldver script	Optional	Any valid script. See the “Scripts Performed before Installation” section on page 145.	/bin/preupgrade-oldver.sh
deps	Package Dependencies. The UUIDs of all the packages on which the application depends. Refer to Dependencies in the Cisco AXP SDK section of the Cisco AXP Developer Guide.	Optional	One or more UUIDs and versions. Multiple UUIDs are separated by colons. For one UUID, the version is separated from the UUID by a comma.	'f463dc25-4749-48bd-b08c-25d8939c068b,all'
disk-limit	Maximum amount of disk space allowed for application—size specified in megabytes. Refer to Disk Limit in the Cisco AXP SDK section of the Cisco AXP Developer Guide.	Required	2M or higher. Minimum value of 2M (2 MB). This value must be larger than the size of files specified in source-dir. The maximum value is the same as the maximum space allowed by the vserver. Note: If disk-wildcard is set, the disk-limit specifies the minimum required disk resources.	10M
memory-limit	Amount of memory space allowed for application—size specified in megabytes. For this RAM usage limit, consider the target hardware resources. The application might fail to install or run if the requested amount of resources is not available on the target hardware.	Required	Memory limit specified in megabytes. Must be a positive value. Up to the maximum allowed by the vserver. (1M = 1048576 bytes). Note: If memory-wildcard is set, the memory-limit specifies the minimum required memory resources.	256M
cpu-wildcard	CPU wildcard. Grants extra CPU resources to an application if those resources are available.	Optional	No argument needed. Note: If cpu-wildcard is set, the cpu-limit specifies the minimum required CPU resources.	y
swap	Swap Space. ON: Enable swap after reboot OFF: Disable swap after reboot.	Optional	ON, OFF	ON
postinstall	Location of postinstall script. The script is run after installation. For example, the script allows console access to be gained and then modification of the package. The script must be packaged with the application.	Optional	Any valid location for a post install script. Specify the location of the script using a relative path with respect to the common root directory. For example, if script postinstall.sh is in directory /xyz-source/build/bin, and the common root directory is /xyz-source/build, specify the location of the script as /bin/postinstall.sh.	/bin/postinstall.sh
cap-config	Location of capabilities configuration file. The file can relax some restrictions in the virtual instance by configuring capabilities that have been granted by the development authorization file.	Optional	Any valid location containing a capabilities configuration file.	/bin/postinstall.sh
file	Location of configuration text file.	Optional if all other required parameters are specified. Otherwise required.	Any valid location containing a text configuration file.	/bin/textfile.txt
disk-wildcard	Disk wildcard. Grants extra disk resources to an application if those resources are available.	Optional	No argument needed. Values: y, <none>. Note: If disk-wildcard is set, the disk-limit specifies the minimum required CPU resources.
memory-wildcard	Memory wildcard. Grants extra memory resources to an application if those resources are available.	Optional	No argument needed. Values: y, <none> Note: If memory-wildcard is set, the memory-limit specifies the minimum required memory resources.
cpu-limit	CPU resources utilized by the application. Based on CPU index, not percentage utilization. Refer to CPU Limit in the Cisco AXP SDK section of the Cisco AXP Developer Guide.	Required	Must be greater than 100. Note: If --cpu-wildcard is set—the --cpu-limit specifies the minimum required cpu resources.	1000
shutdown-timeout	Shutdown Timeout	Optional	Time (in seconds) granted for shutdown scripts before the application is killed. This time period allows the application to shut down processes. Default: 30 Must be greater than or equal to 0 and less than 300. For example, it enables processes to be ended that would allow a database to be left in a consistent state if they were terminated too soon.	40
user-defined-linux	Creates an application package that does not have a dependency on a AXP Reference OS. Installing this package creates a skeleton virtual instance.	Optional	No argument is required. Values: y, <none>	y
tmpfs	Sets the temporary file system type for an application to be either disk-based or memory-based. If an application uses a memory-based temporary file-system, the size of the file system can also be specified. Refer to Application /tmp Directory in the Cisco AXP SDK section of the Cisco AXP Developer Guide.	Optional	“disk”: disk-based temporary file system. “mem”: memory-based temporary file system. This is the default. A size of 16 MB is assumed unless a different value is specified (see mem, <size> below). “mem, <size>”: indicates a specific size of memory-based file system. For example, “mem,32” specifies a 32 MB memory-based file system..	“disk” “mem” “mem,32”
share-timezones	Causes the time zone information, which is currently being used in the host, to be shared by the guest OS. The timezone information is copied into the guest OS running this application package. Refer to Share Timezones in the Cisco AXP SDK section of the Cisco AXP Developer Guide.	Optional	Values: ON, OFF Default: ON.	ON

Return to: Application Extension Platform 1.x -- Packaging an Application using the SDK

Return to start of Getting Started Guide: Cisco AXP Getting Started Guide