When you call the mfpadm Ant task, you 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. It has the
following attributes:
Table 1. show-global-config command attributes| Attribute |
Description |
Required |
Default |
|---|
| output |
Name of the output file. |
No |
Not applicable |
| outputproperty |
Name of the Ant property for the output. |
No |
Not applicable |
The show-user-config command
The
show-user-config command, outside of
<adapter> and
<app-version> elements, shows the user configuration of a runtime. It has the
following attributes:
Table 2. show-user-config command attributes| Attribute |
Description |
Required |
Default |
|---|
| runtime |
Name of the runtime. |
Yes |
Not available |
| format |
Specifies the output format. Either json or
xml. |
Yes |
Not available |
| output |
Name of the file in which to store the output. |
No |
Not applicable |
| outputproperty |
Name of an Ant property in which to store the output. |
No |
Not applicable |
The set-user-config command
The
set-user-config command, outside of
<adapter> and
<app-version> elements, specifies the user configuration of a runtime. It has
the following attributes for setting the entire configuration.
Table 3. set-user-config command attributes| Attribute |
Description |
Required |
Default |
|---|
| runtime |
Name of the runtime. |
Yes |
Not available |
| file |
Name of the JSON or XML file that contains the new configuration. |
Yes |
Not available |
The
set-user-config command has the following attributes for setting a single
property in the configuration.
Table 4. set-user-config command attributes| Attribute |
Description |
Required |
Default |
|---|
| runtime |
Name of the runtime. |
Yes |
Not available |
| 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. |
Yes |
Not available |
| value |
The value of the property. |
Yes |
Not available |
Examples
<set-user-config runtime="mfp" file="myconfig.json"/>
<set-user-config runtime="mfp" property="timeout" value="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. This command
has the following attributes:
Table 5. show-confidential-clients command attributes| Attribute |
Description |
Required |
Default |
|---|
| runtime |
Name of the runtime. |
Yes |
Not available |
| format |
Specifies the output format. Either json or
xml. |
Yes |
Not available |
| output |
Name of the file in which to store the output. |
No |
Not applicable |
| outputproperty |
Name of an Ant property in which to store the output. |
No |
Not applicable |
Example
<show-confidential-clients runtime="mfp" format="xml" output="clients.xml"/>
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. This command
has the following attributes:
Table 6. set-confidential-clients command group attributes| Attribute |
Description |
Required |
Default |
|---|
| runtime |
Name of the runtime. |
Yes |
Not available |
| file |
Name of the JSON or XML file that contains the new configuration. |
Yes |
Not available |
Example
<set-confidential-clients runtime="mfp" file="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. This command has
the following attributes:
Table 7. set-confidential-clients-rule command attributes| Attribute |
Description |
Required |
Default |
|---|
| runtime |
Name of the runtime. |
Yes |
Not available |
| id |
The identifier of the rule. |
Yes |
Not available |
| displayName |
The display name of the rule. |
Yes |
Not available |
| secret |
The secret of the rule. |
Yes |
Not available |
| allowedScope |
The scope of the rule. A space-separated list of tokens. |
Yes |
Not available |
Example
<set-confidential-clients-rule runtime="mfp"
id="push" displayName="Push" secret="lOa74Wxs" allowedScope="**"/>
This command is based on the Confidential Clients (PUT) REST service.