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

Commands for general configuration

When we call the mfpadm program, we can include various commands that access the global configuration of the IBM MobileFirst™ Platform 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:

Table 1. show global-config options

Argument	Description
--xml	Produces XML output instead of tabular output.

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:

Table 2. show user-config arguments

Argument	Description
runtime-name	Name of the runtime.

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

Table 3. show user-config options

Argument	Description	Required	Default
--xml	Produces output in XML format instead of JSON format.	No	Standard output

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:

Table 4. set user-config arguments

Attribute	Description
runtime-name	Name of the runtime.
file	Name of the JSON or XML file that contains the new configuration.

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

The set user-config command takes the following arguments:

Table 5. set user-config arguments

Argument	Description
runtime-name	Name of the runtime.
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

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:s

Table 6. show confidential-clients arguments

Attribute	Description
runtime-name	Name of the runtime.

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

Table 7. show confidential-clients options

Argument	Description	Required	Default
--xml	Produces output in XML format instead of JSON format.	No	Standard output

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:

Table 8. set confidential-clients arguments

Attribute	Description
runtime-name	Name of the runtime.
file	Name of the JSON or XML file that contains the new configuration.

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:

Table 9. set confidential-clients-rule arguments

Attribute	Description
runtime	Name of the runtime.
id	The identifier of the rule.
displayName	The display name of the rule.
secret	The secret of the rule.
allowedScope	The scope of the rule. A space-separated list of tokens. Use double-quotes to pass a list of two or more tokens.

Example

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

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

Parent topic: Administering MobileFirst applications through the command line