Targets and Attributes in Build File
For more information on using the CLI, see the section Using Command-Line Interface.
This section only describes the elements and attributes specific to suspending or unsuspending an enterprise feature. For more information on the common attributes, see Understanding AMXAdminTask.
Target Elements
The following targets can be specified in the
target
element of the Ant build file:
Target | Description |
---|---|
suspend | Put the enterprise in a suspended state. |
unsuspend | Put the enterprise in an suspended state. |
setReadOnly | Put the enterprise in a read-only state. |
unsetReadOnly | Put the enterprise in a write state. |
status | Check if an enterprise is suspended or unsuspended. Possible values that can be returned are:
|
statusReadOnly | Check if an enterprise is read-only. Possible values that can be returned are:
|
AMXAdminTask Attributes
The following attributes can be specified in the
AMXAdminTask
element of the Ant build file:
Attribute | Type | Description |
---|---|---|
suspendEnterpriseTimeoutInSec | Integer | The maximum time an enterprise can take to be put in the suspended state after which the CLI script fails and the enterprise is reverted back to the
unsuspended state.
Default: 1800 seconds |
suspendCfTimeoutInSec | Integer | The maximum time each runtime node can take to be put in the
suspended state after which the CLI script fails and the enterprise is reverted back to the
unsuspended state.
Default: 1800 seconds |
note | String | If an enterprise is in a suspended or read-only state, the message "
Using the
Default: No description Tip: You can also set the note text using the
-D option while executing the build script.
|