Administrating applications through Terminal

Overview

You can administer MobileFirst applications through the mfpadm program.

IBM Mobile Foundation SDK versions later than 8.0.0.0-MFPF-IF201701250919 has an updated App authenticity support, which is mfpadm commands to switch between dynamic or static validation and also to reset it.

Navigate to the IBM Mobile Foundation installation directory /MobilefirstPlatformServer/shortcuts and run the mfpadm commands.

1.To switch between validation types:

	mfpadm --url=  --user=  --passwordfile= --secure=false app version [RUNTIME] [APPNAME] [ENVIRONMENT] [VERSION] set authenticity-validation TYPE

Value for TYPE can be static or dynamic

Example for android: Here we are setting the validation TYPE to dynamic.

  mfpadm --url=http://localhost:8080/mfpadmin --user=admin --passwordfile="C:\userhome\mfppassword\MFP_password.txt" --secure=false app version mfp test android 1.0 set authenticity-validation dynamic

2.To reset the data using the below command which clears the fingerprint of the app.

  mfpadm --url=  --user=  --passwordfile= --secure=false app version [RUNTIME] [APPNAME] [ENVIRONMENT] [VERSION] reset authenticity

Example :

  mfpadm --url=http://localhost:8080/mfpadmin --user=admin --passwordfile="C:\userhome\mfppassword\MFP_password.txt" --secure=false app version mfp sample.com.pincodeandroid android 1.0 reset authenticity

Jump to

• Comparison with other facilities
• Prerequisites

Comparison with other facilities

You can run administration operations with IBM Mobile Foundation in the following ways:

• The MobileFirst Operations Console, which is interactive.
• The mfpadm Ant task.
• The mfpadm program.
• The MobileFirst administration REST services.

The mfpadm Ant task, mfpadm program, and REST services are useful for automated or unattended execution of operations, such as the following use cases:

• Eliminating operator errors in repetitive operations, or
• Operating outside the operator’s normal working hours, or
• Configuring a production server with the same settings as a test or preproduction server.

The mfpadm program and the mfpadm Ant task are simpler to use and have better error reporting than the REST services. The advantage of the mfpadm program over the mfpadm Ant task is that it is easier to integrate when integration with operating system commands is already available. Moreover, it is more suitable to interactive use.

Prerequisites

The mfpadm tool is installed with the MobileFirst Server installer. In the rest of this page, product_install_dir indicates the installation directory of the MobileFirst Server installer.

The mfpadm command is provided in the product_install_dir/shortcuts/ directory as a set of scripts:

• mfpadm for UNIX / Linux
• mfpadm.bat for Windows

These scripts are ready to run, which means that they do not require specific environment variables. If the environment variable JAVA_HOME is set, the scripts accept it.
To use the mfpadm program, either put the product_install_dir/shortcuts/ directory into your PATH environment variable, or reference its absolute file name in each call.

For more information about running the MobileFirst Server installer, see Running IBM Installation Manager.

Jump to

• Calling the mfpadm program
• Commands for general configuration
• Commands for adapters
• Commands for apps
• Commands for devices
• Commands for troubleshooting

Calling the mfpadm program

You can use the mfpadm program to administer MobileFirst applications.

Syntax

Call the mfpadm program as follows:

mfpadm --url= --user= ... [--passwordfile=...] [--secure=false] some command

The mfpadm program has the following options:

url
The URL preferably uses the HTTPS protocol. For example, if you use default ports and context roots, use this URL:

• For WebSphere Application Server: https://server:9443/mfpadmin
• For Tomcat: https://server:8443/mfpadmin

secure
The --secure option is set to true by default. Setting it to --secure=false might have the following effects:

• The user and password might be transmitted in an unsecured way (possibly even through unencrypted HTTP).
• The server’s SSL certificates are accepted even if self-signed or if they were created for a different host name from the server’s host name.

password
Specify the password in a separate file that you pass in the --passwordfile option. In interactive mode (see Interactive mode), you can alternatively specify the password interactively. The password is sensitive information and therefore needs to be protected. You must prevent other users on the same computer from knowing these passwords. To secure the password, before you enter the password into a file, you must remove the read permissions of the file for users other than yourself. For example, you can use one of the following commands:

• On UNIX: chmod 600 adminpassword.txt
• On Windows: cacls adminpassword.txt /P Administrators:F %USERDOMAIN%\%USERNAME%:F

For this reason, do not pass the password to a process through a command-line argument. On many operating systems, other users can inspect the command-line arguments of your processes.

The mfpadm calls contains a command. The following commands are supported.

Interactive mode

Alternatively, you can also call mfpadm without any command in the command line. You can then enter commands interactively, one per line. The exit command, or end-of-file on standard input (Ctrl-D on UNIX terminals) terminates mfpadm.

Help commands are also available in this mode. For example:

• help
• help show versions
• help device
• help device set status

Command history in interactive mode

On some operating systems, the interactive mfpadm command remembers the command history. With the command history, you can select a previous command, using the arrow-up and arrow-down keys, edit it, and execute it.

On Linux
The command history is enabled in terminal emulator windows if the rlwrap package is installed and found in PATH. To install the rlwrap package:

• On Red Hat Linux: sudo yum install rlwrap
• On SUSE Linux: sudo zypper install rlwrap
• On Ubuntu: sudo apt-get install rlwrap

On OS X
The command history is enabled in the Terminal program if the rlwrap package is installed and found in PATH. To install the rlwrap package:

1. Install MacPorts by using the installer from www.macports.org.
2. Run the command: sudo /opt/local/bin/port install rlwrap
3. Then, to make the rlwrap program available in PATH, use this command in a Bourne-compatible shell: PATH=/opt/local/bin:$PATH

On Windows
The command history is enabled in cmd.exe console windows.

In environments where rlwrap does not work or is not required, you can disable its use through the option --no-readline.

The configuration file

You can also store the options in a configuration file, instead of passing them on the command line at every call. When a configuration file is present and the option –configfile=file is specified, you can omit the following options:

• –url=URL
• –secure=boolean
• –user=name
• –passwordfile=file
• –timeout=seconds
• –connect-timeout=seconds
• –socket-timeout=seconds
• –connection-request-timeout=seconds
• –lock-timeout=seconds
• runtime-name

Use these commands to store these values in the configuration file.

Use this command to list the values that are stored in the configuration file: mfpadm [--configfile=file] config

The configuration file is a text file, in the encoding of the current locale, in Java .properties syntax. These are the default configuration files:

• UNIX: ${HOME}/.mfpadm.config
• Windows: My Documents\IBM MobileFirst Platform Server Data\mfpadm.config

Note: When you do not specify a --configfile option, the default configuration file is used only in interactive mode and in config commands. For noninteractive use of the other commands, you must explicitly designate the configuration file if you want to use one.

Important: The password is stored in an obfuscated format that hides the password from an occasional glimpse. However, this obfuscation provides no security.

Generic options

There are also the usual generic options:

XML format

The commands that receive an XML response from the server verify that this response complies with the specific schema. You can disable this check by specifying --xmlvalidation=none.

Output character set

Normal output that is produced by the mfpadm program is encoded in the encoding format of the current locale. On Windows, this encoding format is “ANSI code page”. The effects are as follows:

• Characters outside of this character set are converted to question marks when they are output.
• When the output goes to a Windows command prompt window (cmd.exe), non-ASCII characters are incorrectly displayed because such windows assume characters to be encoded in “OEM code page”.

To work around this limitation:

• On operating systems other than Windows, use a locale whose encoding is UTF-8. This format is the default locale on Red Hat Linux and OS X. Many other operating systems have a en_US.UTF-8 locale.
• Or use the mfpadm Ant task, with attribute output="some file name" to redirect the output of a command to a file.

Commands for general configuration

When you call the mfpadm program, you can include various commands that access the global configuration of the IBM MobileFirst Server or of a runtime.

The show global-config command

The show global-config command shows the global configuration.

Syntax: show global-config

It takes the following options:

Example

show global-config

This command is based on the Global Configuration (GET) REST service.

The show user-config command

The show user-config command shows the user configuration of a runtime.

Syntax: show user-config [--xml] [runtime-name]

It takes the following arguments:

The show user-config command takes the following options after the verb.

Example

show user-config mfp

This command is based on the Runtime Configuration (GET) REST service.

The set user-config command

The set user-config command specifies the user configuration of a runtime or a single property among this configuration.

Syntax for the entire configuration: set user-config [runtime-name] file

It takes the following arguments:

Syntax for a single property: set user-config [runtime-name] property = value

The set user-config command takes the following arguments:

Examples

set user-config mfp myconfig.json

set user-config mfp timeout = 240

This command is based on the Runtime configuration (PUT) REST service.

The show confidential-clients command

The show confidential-clients command shows the configuration of the confidential clients that can access a runtime. For more information about confidential clients, see Confidential clients.

Syntax: show confidential-clients [--xml] [runtime-name]

It takes the following arguments:

The show confidential-clients command takes the following options after the verb.

Example

show confidential-clients --xml mfp

This command is based on the Confidential Clients (GET) REST service.

The set confidential-clients command

The set confidential-clients command specifies the configuration of the confidential clients that can access a runtime. For more information about confidential clients, see Confidential clients.

Syntax: set confidential-clients [runtime-name] file

Its takes the following arguments:

Example

set confidential-clients mfp clients.xml

This command is based on the Confidential Clients (PUT) REST service.

The set confidential-clients-rule command

The set confidential-clients-rule command specifies a rule in the configuration of the confidential clients that can access a runtime. For more information about confidential clients, see Confidential clients.

Syntax: set confidential-clients-rule [runtime-name] id displayName secret allowedScope

It takes the following arguments:

Example

set confidential-clients-rule mfp push Push lOa74Wxs "**"

This command is based on the Confidential Clients (PUT) REST service.

Commands for adapters

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

The list adapters command

The list adapters command returns a list of the adapters that are deployed for a runtime.

Syntax: list adapters [runtime-name]

It takes the following arguments:

The list adapters command takes the following options after the object.

Example

list adapters mfp

This command is based on the Adapters (GET) REST service.

The deploy adapter command

The deploy adapter command deploys an adapter in a runtime.

Syntax: deploy adapter [runtime-name] file

It takes the following arguments:

Example

deploy adapter mfp MyAdapter.adapter

This command is based on the Adapter (POST) REST service.

The show adapter command

The show adapter command shows details about an adapter.

Syntax: show adapter [runtime-name] adapter-name

It takes the following arguments.

The show adapter command takes the following options after the object.

Example

show adapter mfp MyAdapter

This command is based on the Adapter (GET) REST service.

The delete adapter command

The delete adapter command removes (undeploys) an adapter from a runtime.

Syntax: delete adapter [runtime-name] adapter-name

It takes the following arguments:

Example

delete adapter mfp MyAdapter

This command is based on the Adapter (DELETE) REST service.

The adapter command prefix

The adapter command prefix takes the following arguments before the verb.

The adapter get binary command

The adapter get binary command returns the binary adapter file.

Syntax: adapter [runtime-name] adapter-name get binary [> tofile]

It takes the following options after the verb.

Example

adapter mfp MyAdapter get binary > /tmp/MyAdapter.adapter

This command is based on the Export runtime resources (GET) REST service.

The adapter show user-config command

The adapter show user-config command shows the user configuration of the adapter.

Syntax: adapter [runtime-name] adapter-name show user-config [--xml]

It takes the following options after the verb.

Example

adapter mfp MyAdapter show user-config

This command is based on the Adapter Configuration (GET) REST service.

The adapter set user-config command

The adapter set user-config command specifies the user configuration of the adapter or a single property within this configuration.

Syntax for the entire configuration: adapter [runtime-name] adapter-name set user-config file

It takes the following arguments after the verb.

Syntax for a single property: adapter [runtime-name] adapter-name set user-config property = value

It takes the following arguments after the verb.

Examples

adapter mfp MyAdapter set user-config myconfig.json

adapter mfp MyAdapter set user-config timeout = 240

This command is based on the Adapter configuration (PUT) REST service.

Commands for apps

When you 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:

The list apps command takes the following options after the object.

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:

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:

The show app command takes the following options after the object.

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.

Syntax: delete app [runtime-name] app-name

It takes the following arguments:

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:

The show app version command takes the following options after the object.

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:

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.

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:

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Commands for devices

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

The list devices command

The list devices command returns the list of devices that have contacted the apps of a runtime.

Syntax: list devices [runtime-name] [--query query]

It takes the following arguments:

The list devices command takes the following options after the object.

Examples

list-devices mfp

list-devices mfp --query=john

This command is based on the Devices (GET) REST service.

The remove device command

The remove device command clears the record about a device that has contacted the apps of a runtime.

Syntax: remove device [runtime-name] id

It takes the following arguments:

Example

remove device mfp 496E974CCEDE86791CF9A8EF2E5145B6

This command is based on the Device (DELETE) REST service.

The device command prefix

The device command prefix takes the following arguments before the verb.

The device set status command

The device set status command changes the status of a device, in the scope of a runtime.

Syntax: device [runtime-name] id set status new-status

It takes the following arguments:

The status can have one of the following values:

• ACTIVE
• LOST
• STOLEN
• EXPIRED
• DISABLED

Example

device mfp 496E974CCEDE86791CF9A8EF2E5145B6 set status EXPIRED

This command is based on the Device Status (PUT) REST service.

The device set appstatus command

The device set appstatus command changes the status of a device, regarding an app in a runtime.

Syntax: device [runtime-name] id set appstatus app-name new-status

It takes the following arguments:

The status can have one of the following values:

• ENABLED
• DISABLED

Example

device mfp 496E974CCEDE86791CF9A8EF2E5145B6 set appstatus MyApp DISABLED

This command is based on the Device Application Status (PUT) REST service.

Commands for troubleshooting

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

The show info command

The show info command shows basic information about the MobileFirst administration services that can be returned without accessing any runtime nor database. This command can be used to test whether the MobileFirst administration services are running at all.

Syntax: show info

It takes the following options after the object.

Example

show info

The show versions command

The show versions command displays the MobileFirst versions of various components:

• mfpadmVersion: the exact MobileFirst Server version number from which mfp-ant-deployer.jar is taken.
• productVersion: the exact MobileFirst Server version number from which mfp-admin-service.war is taken
• mfpAdminVersion: the exact build version number of mfp-admin-service.war alone.

Syntax: show versions

It takes the following options after the object.

Example

show versions

The show diagnostics command

The show diagnostics command shows the status of various components that are necessary for the correct operation of the MobileFirst administration service, such as the availability of the database and of auxiliary services.

Syntax: show diagnostics

It takes the following options after the object.

Example

show diagnostics

The unlock command

The unlock command releases the general-purpose lock. Some destructive operations take this lock in order to prevent concurrent modification of the same configuration data. In rare cases, if such an operation is interrupted, the lock might remain in locked state, making further destructive operations impossible. Use the unlock command to release the lock in such situations.

Example

unlock

The list runtimes command

The list runtimes command returns a list of the deployed runtimes.

Syntax: list runtimes [--in-database]

It takes the following options:

Examples

list runtimes

list runtimes --in-database

This command is based on the Runtimes (GET) REST service.

The show runtime command

The show runtime command shows information about a given deployed runtime.

Syntax: show runtime [runtime-name]

It takes the following arguments:

The show runtime command takes the following options after the object.

This command is based on the Runtime (GET) REST service.

Example

show runtime mfp

The delete runtime command

The delete runtime command deletes a runtime, including its apps and adapters, from the database. You can delete a runtime only when its web application is stopped.

Syntax: delete runtime [runtime-name] condition

It takes the following arguments:

Example

delete runtime mfp empty

This command is based on the Runtime (DELETE) REST service.

The list farm-members command

The list farm-members command returns a list of the farm member servers on which a given runtime is deployed.

Syntax: list farm-members [runtime-name]

It takes the following arguments:

The list farm-members command takes the following options after the object.

Example

list farm-members mfp

This command is based on the Farm topology members (GET) REST service.

The remove farm-member command

The remove farm-member command removes a server from the list of farm members on which the specified runtime is deployed. Use this command when the server has become unavailable or disconnected.

Syntax: remove farm-member [runtime-name] server-id

It takes the following arguments.

The remove farm-member command takes the following options after the object.

Example

remove farm-member mfp srvlx15

This command is based on the Farm topology members (DELETE) REST service.