Commands for apps

For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.

Commands for apps

When we invoke the mfpadm program, you can include various commands for apps.

The list apps command

The list apps command returns a list of the apps that are deployed in a runtime. Syntax: list apps [runtime-name]
It takes the following arguments:
Table 1. list apps command arguments
Argument Description
runtime-name Name of the runtime.

The list apps command takes the following options after the object.
Table 2. list apps command options
Option Description
--xml Produce XML output instead of tabular output.

Example
list apps mfp
This command is based on the Applications (GET) REST service.

The deploy app command

The deploy app command deploys an app version in a runtime. Syntax: deploy app [runtime-name] file
It takes the following arguments:
Table 3. deploy app command arguments
Argument Description
runtime-name Name of the runtime.
file The application descriptor, a JSON file.

Example
deploy app mfp MyApp/application-descriptor.json
This command is based on the Application (POST) REST service.

The show app command

The show app command shows details about an app in a runtime, in particular its environments and versions. Syntax: show app [runtime-name] app-name
It takes the following arguments:
Table 4. show app command arguments
Argument Description
runtime-name Name of the runtime.
app-name Name of an app.

The show app command takes the following options after the object.
Table 5. show app command options
Option Description
--xml Produce XML output instead of tabular output.

Example
show app mfp MyApp
This command is based on the Application (GET) REST service.

The delete app command

The delete app command removes (undeploys) an app, from all environments and all versions, from a runtime. Deleting an application from MobileFirst Operations Console will remove all push subscriptions on that application as well. Syntax: delete app [runtime-name] app-name
It takes the following arguments:
Table 6. delete app command arguments
Argument Description
runtime-name Name of the runtime.
app-name Name of an app

Example
delete app mfp MyApp
This command is based on the Application Version (DELETE) REST service.

The show app version command

The show app version command show details about an app version in a runtime. Syntax: show app version [runtime-name] app-name environment version
It takes the following arguments:
Table 7. show app command arguments
Argument Description
runtime-name Name of the runtime.
app-name Name of an app.
environment Mobile platform.
version Version of the app.

The show app version command takes the following options after the object.
Table 8. show app command options
Argument Description
--xml Produces XML output instead of tabular output.

Example
show app version mfp MyApp iPhone 1.1
This command is based on the Application Version (GET) REST service.

The delete app version command

The delete app version command removes (undeploys) an app version from a runtime. Syntax: delete app version [runtime-name] app-name environment version
It takes the following arguments:
Table 9. delete app version command arguments
Argument Description
runtime-name Name of the runtime.
app-name Name of an app.
environment Mobile platform.
version Version of the app.

Example
delete app version mfp MyApp iPhone 1.1
This command is based on the Application Version (DELETE) REST service.

The app command prefix

The app command prefix takes the following arguments before the verb.
Table 10. app command prefix arguments
Argument Description
runtime-name Name of the runtime.
app-name Name of an app.

The app show license-config command

The app show license-config command shows the token license configuration of an app. Syntax: app [runtime-name] app-name show license-config
It takes the following options after the object:
Table 11. app show license-config option
Argument Description
--xml Produces XML output instead of tabular output.

Example
app mfp MyApp show license-config
This command is based on the Application license configuration (GET) REST service.

The app set license-config command

The app set license-config command specifies the token license configuration of an app. Syntax: app [runtime-name] app-name set license-config app-type license-type
It takes the following arguments after the verb.
Table 12. app set license-config command arguments
Argument Description
appType Type of app: B2C or B2E.
licenseType Type of application: APPLICATION or ADDITIONAL_BRAND_DEPLOYMENT or NON_PRODUCTION.

Example
app mfp MyApp iPhone 1.1 set license-config B2E APPLICATION
This command is based on the Application License Configuration (POST) REST service.

The app delete license-config command

The app delete license-config command resets the token license configuration of an app, that is, reverts it to the initial state. Syntax: app [runtime-name] app-name delete license-config

Example
app mfp MyApp iPhone 1.1 delete license-config
This command is based on the License configuration (DELETE) REST service.

The app version command prefix

The app version command prefix takes the following arguments before the verb.
Table 13. app version command prefix arguments
Argument Description
runtime-name Name of the runtime.
app-name Name of an app.
environment Mobile platform
version Version of the app

The app version get descriptor command

The app version get descriptor command returns the application descriptor of a version of an app. Syntax: app version [runtime-name] app-name environment version get descriptor [> tofile]
It takes the following arguments after the verb.
Table 14. app version get descriptor command options
Argument Description Required Default
> tofile Name of the output file. No Standard output

Example
app version mfp MyApp iPhone 1.1 get descriptor > /tmp/MyApp-application-descriptor.json
This command is based on the Application Descriptor (GET) REST service.

The app version get web-resources command

The app version get web-resources command returns the web resources of a version of an app, as a .zip file. Syntax: app version [runtime-name] app-name environment version get web-resources [> tofile]
It takes the following arguments after the verb.
Table 15. app version get web-resources command options
Argument Description Required Default
> tofile Name of the output file. No Standard output

Example
app version mfp MyApp iPhone 1.1 get web-resources > /tmp/MyApp-web.zip
This command is based on the Retrieve Web Resource (GET) REST service.

The app version set web-resources command

The app version set web-resources command specifies the web resources for a version of an app. Syntax: app version [runtime-name] app-name environment version set web-resources file
It takes the following arguments after the verb.
Table 16. app version set web-resources command arguments
Argument Description
file Name of the input file (must be a .zip file).

Example
app version mfp MyApp iPhone 1.1 set web-resources /tmp/MyApp-web.zip
This command is based on the Deploy a web resource (POST) REST service.

The app version get authenticity-data command

The app version get authenticity-data command returns the authenticity data of a version of an app. Syntax: app version [runtime-name] app-name environment version get authenticity-data [> tofile]
It takes the following arguments after the verb.
Table 17. app version get authenticity-data command options
Argument Description Required Default
> tofile Name of the output file. No Standard output

Example
app version mfp MyApp iPhone 1.1 get authenticity-data > /tmp/MyApp.authenticity_data
This command is based on the Export runtime resources (GET) REST service.

The app version set authenticity-data command

The app version set authenticity-data command specifies the authenticity data for a version of an app. Syntax: app version [runtime-name] app-name environment version set authenticity-data file
It takes the following arguments after the verb.
Table 18. app version set authenticity-data command arguments
Argument Description
file Name of the input file:
Either a .authenticity_data file,
Or a device file (.ipa or .apk or .appx), from which the authenticity data is extracted.

Examples
app version mfp MyApp iPhone 1.1 set authenticity-data /tmp/MyApp.authenticity_data
app version mfp MyApp iPhone 1.1 set authenticity-data MyApp.ipa
app version mfp MyApp android 1.1 set authenticity-data MyApp.apk
This command is based on the Deploy Application Authenticity Data (POST) REST service.

The app version delete authenticity-data command

The app version delete authenticity-data command deletes the authenticity data for a version of an app. Syntax: app version [runtime-name] app-name environment version delete authenticity-data

Example
app version mfp MyApp iPhone 1.1 delete authenticity-data
This command is based on the Application Authenticity (DELETE) REST service.

The app version show user-config command

The app version show user-config command shows the user configuration of a version of an app. Syntax: app version [runtime-name] app-name environment version show user-config [--xml]
It takes the following options after the verb.
Table 19. app version show user-config command options
Argument Description Required Default
[--xml] Produce output in XML format instead of JSON format. No Standard output

Example
app version mfp MyApp iPhone 1.1 show user-config
This command is based on the Application Configuration (GET) REST service.

The app version set user-config command

The app version set user-config command specifies the user configuration for a version of an app or a single property among this configuration. Syntax for the entire configuration: app version [runtime-name] app-name environment version set user-config file
It takes the following arguments after the verb.
Table 20. app version set user-config command arguments
Argument Description
file Name of the JSON or XML file that contains the new configuration.

Syntax for a single property: app version [runtime-name] app-name environment version set user-config property = value
The app version set user-config command takes the following arguments after the verb.
Table 21. app version set user-config command arguments
Argument Description
property Name of the JSON property. For a nested property, use the syntax prop1.prop2.....propN. For a JSON array element, use the index instead of a property name.
value The value of the property.

Examples
app version mfp MyApp iPhone 1.1 set user-config /tmp/MyApp-config.json
app version mfp MyApp iPhone 1.1 set user-config timeout = 240
This command is based on the Application Configuration (PUT) REST service.

Parent topic: Administering MobileFirst applications through the command line


Option	Description
--xml	Produce XML output instead of tabular output.


Argument	Description
runtime-name	Name of the runtime.
file	The application descriptor, a JSON file.


Argument	Description
appType	Type of app: B2C or B2E.
licenseType	Type of application: APPLICATION or ADDITIONAL_BRAND_DEPLOYMENT or NON_PRODUCTION.


Argument	Description	Required	Default
> tofile	Name of the output file.	No	Standard output


Argument	Description
property	Name of the JSON property. For a nested property, use the syntax prop1.prop2.....propN. For a JSON array element, use the index instead of a property name.
value	The value of the property.