Page tree
Skip to end of metadata
Go to start of metadata

You can use the BMC Middleware Automation CLI to perform a wide range of product operations. To run the CLI, execute a command that invokes the runDeliver script within the cli subdirectory of your BMC Middleware Automation installation. The command must contain the relevant options (depending on the exact operation that you want to perform).

The following table lists all available options for the runDeliver script, with an indication of the operations (or -mode options) that each of these options is used in. For more information about each specific operation supported by the runDeliver script, including a list of only those options that are relevant to the specific operation and examples of commands, see the description of the -mode option.

Notes

  • General options related to logs (-log and -loglevel) and license key (-license) are not mentioned in the pages that focus on individual operations.
  • For more information about the -mode encode option and the additional options that it works with, see Encoding text for encryption through the CLI.
  • Ensure that paths specified by any of these options do not contain the following special characters in any directory names:
    &
    (ampersand), ^ (caret), ! (exclamation mark), % (percent sign), ; (semicolon), # (pound), . (period), $ (dollar sign), ' (left single quote), ` (grave accent), = (equals sign), ~ (tilde)

Full list of runDeliver script options

Option

Relevant operations (modes)

Description

-applicationPath

generateConfiguration

The path to a single WebSphere application archive (.ear or .war) file or to a directory that contains multiple such files, for generating a Configuration (or multiple Configurations).

-captureSnapshotMetaData

  • snapshot
  • snapshotAndTokenize 

Adds a SnapshotInfo element that contains metadata about the Snapshot to the saved XML document.

-changeRequestId

  • install
  • compare

A number or string to identify the specific change requested by this operation, for reference purposes. This ID appears in reports.

-config

  • install
  • preview
  • pullValues
  • tokenize
  • filterSnapshot

The XML file name of the Configuration to use.

-deployTarget

generateConfiguration

(optional) The type of deployment for which to generate a Configuration from a WebSphere application archive, either a deployment to a WebSphere node or a deployment to a WebSphere cluster. Values are node (the default) and cluster.

-deployTargetFile
generateConfiguration(optional) The .txt deploy target file that contains information about the structure of the target environment for application deployment and lists tokens for servers, nodes, and clusters and their relationships. For information about preparing this deploy target file, see Preparing the environment file for the deployTargetFile option.

-disableAutoRollback

install

Disables the automatic rollback of an unsuccessful installation operation on a Geronimo, JBoss, or Tomcat server.

-enableOnFlyVersionUpgrades
  • install
  • preview
  • rollback
Enables the automatic upgrade of product objects (Configuration files, tokens and filters within Server Profiles) that have not yet been upgraded prior to installation, preview, or rollback operations. 
-enableUnversionedContent
  • createServerProfile
  • snapshot
  • generateConfiguration

Allow the creation of new product objects (Configuration files, tokens and filters within Server Profiles) without any version specification. You can use this option if you want to use your new product objects in other product versions without receiving prompts to upgrade these objects (for example, in the interim period before completing the upgrade of BMC Middleware Automation to a newer version). Note, however, that installation and preview operations with such product objects might not work successfully in other versions of BMC Middleware Automation.

-filter

snapshot

filterSnapshot

The name of a Snapshot filter to use during the creation of a Snapshot or when applying a filter to an existing Snapshot or Configuration. For more information about filters, see Filtering a Snapshot.

-h

not applicable

Displays the command usage message

-handleDeletes
(Starting with 8.6.00.003)
  • compare
During the Compare to package operation, this option does not allow you to add the additional delete=true attribute, thus disabling the deletion of the comparison package content from server.

-image

installServerImage

The full path to the server image to install.

-imageName

createServerImage

The name of the new server image to create (optional). The default is the name of the server with the Image string appended at the end.

-imageOutputDir

createServerImage

The path to the output directory in which to store the created server image (optional). The default is the Server Images directory in the workspace.

-license

all

The full path to the product license key (.lic) file, as provided by BMC
Note: To avoid the need to include this option in every command, you can store a copy of the license key file in the cli subdirectory of your product installation, in the same location where the runDeliver script is stored. Alternatively, you can set the LICENSE_FILE property in the setupDeliver.properties file.

-log

all

(optional) The path to the log file to create. By default, the log file is phurnace.log, written in the current directory.

-logLevel

all

The minimum severity level of messages to write to the log file. The options, in order of increasing severity, are DEBUG, INFO, WARN, and ERROR. The default level is INFO, which means that INFO, WARN, and ERROR messages are logged.

-mode

all

The operation to perform, one of the following:

Two additional modes are specific to the WebSphere Portal —listVirtualPortals and installPAA. For more information, see the description of the -portal option.

-output

  • topology
  • snapshot
  • tokenize
  • snapshotAndTokenize
  • filterSnapshot
  • generateConfiguration
  • sync

For most operations: The name of the Snapshot or Configuration (.xml) file to create. The default Snapshot file name is phurnaceexport.xml, written in the current directory.

For topology retrieval: The name of the output .xml file in which to capture the topology of the application server instance.

For generation of Configuration files from WebSphere application archive files: The name of the output Configuration file (generated from a single application archive) or the name of the directory in which to store multiple Configuration files (generated from multiple application archives).

For a token set synchronizaton operation: The name of the target Server Profile or the name of a text file that lists multiple target Server Profiles.

-outputProfile

  • createServerProfile
  • pullValues

The name of an output Server Profile to be created during the following operations:

  • Server Profile creation, using the createServerProfile mode
  • Pulling token values from a Configuration to a Server Profile, if you want to save the token values in a separate copy of the target Server Profile

-package

  • compare
  • tokenizeAndCompare

The output packaged Configuration (.xml file) created from a comparison of two Configurations or Snapshots (specified by the -sourceInput and -targetInput options). The newly packaged Configuration contains the differences between the two input Configurations, and can be used in an installation operation to bring the source application server (represented by the -sourceInput option) to the same state as the target application server (represented by the -targetInput option).

-portal
  • testConnect
  • snapshot
  • snapshotAndTokenize
  • tokenize
  • compare
  • tokenizeAndCompare
  • install
  • preview
  • rollback

  • listVirtualPortals

  • installPAA

Performs the operation on a WebSphere Portal server, using the runDeliver script (instead of the separate runPortal script, which was used in previous versions of BMC Middleware Automation). For this option to work properly, ensure that it is the first argument in the command.

For more information, see Running the Portal CLI and Portal CLI command examples.

-profile

almost all
(except for
Snapshot comparison
modes)

The file name of the Server Profile to use.

-profileProperties

createServerProfile

The name of an optional properties file for use during the creation of a server profile. This properties file contains input properties that override those in the input Server Profile template that you specify using the -profile option.
For a list of properties that you can include in this properties file, see Properties for Server Profile creation through the CLI.

-properties

  • snapshot
  • snapshotAndTokenize

The full path to the properties file to be used by the runDeliver script. Include this option if you want to use a properties file other than the default setupDeliver.properties file.
You can have a set of properties files, where each properties file is tailored to a specific application server.
Alternatively, you can use the DELIVER_PROPERTIES environment variable to set the full path to an alternate properties file (before you run the runDeliver command).

-pluginNodeName
  • pluginGenerate
  • pluginPropagate

Name of the node on which the target web server is located. For more information, see WebSphere web server plug-in generation and propagation through the CLI.

-pluginPropagateKeyring
  • pluginPropagate
 Propagate the web server plug-in's keyring file. See WebSphere web server plug-in generation and propagation through the CLI.
-pluginServerName
  • pluginGenerate
  • pluginPropagate

Comma- separated web server names, to which you want to generate and propagate the plug-in. For more information, see WebSphere web server plug-in generation and propagation through the CLI.

-propagatePlugins
  • install

Option that enforces WebSphere plug-ins propagation, even if an automatic propagation is disabled. For more information, see WebSphere web server plug-in generation and propagation through the CLI.

-generatePlugins
  • install

Option that enforces WebSphere plug-ins generation, even if an automatic generation is disabled. For more information, see WebSphere web server plug-in generation and propagation through the CLI.

-report

  • install
  • compare

The name of the report file to create. For an installation, preview, or rollback action, this report ends with the .report extension. For a comparison action, the report can have the .report extension (for UI display) or the .xml, .html, or .pdf extension.

Note: For an installation or preview action, if you do not use the -report option, a default report.xml file is created nonetheless. To export this report to PDF or HTML (as described in Exporting reports to PDF or HTML), you must first change the name and extension of this report to filename.report.

-retrieveSignersLogging

install

Option for saving a local retrieveSigners.log file for tracing the execution of the retrieveSigners command during a WebSphere installation operation.

-rollbackDir

install

The path to the directory in which to save rollback data for the installation operation.
To use this option, ensure that the Capture full rollback data on install check box in the Server Profile is selected.

-serverPath

  • createServerImage
  • installServerImage

The path to the application server instance on the remote host computer, for the creation of a server image or for the installation of a server image.

-sourceInput

  • compare
  • tokenizeAndCompare

The name and path of a source Snapshot or Configuration (.xml) file to compare with a target Snapshot or Configuration (as specified by the -targetInput option)

-sourceProfile

tokenizeAndCompare

The name and path of a Server Profile to associate with the specified -sourceInput file, for use in a tokenizeAndCompare operation

-sourceTokens

tokenizeAndCompare

The name of a token set defined in the specified -sourceProfile to use during the tokenization stage of a tokenizeAndCompare operation

-syncnodes

install

Invokes the synchronization of nodes immediately after a successful installation operation on a WebSphere server. 

-targetInput

  • compare
  • tokenizeAndCompare

The name and path of a target Snapshot or Configuration (.xml) file to compare with the source Snapshot or Configuration (which you specified using the -sourceInput option)

-targetProfile

tokenizeAndCompare

The name and path of a Server Profile to associate with the specified -targetInput file, for use in a tokenizeAndCompare operation

-targetTokens

tokenizeAndCompare

The name of a token set defined in the specified -targetProfile to use during the tokenization stage of a tokenizeAndCompare operation

-taskDataTokens
generateConfiguration

The full path to a properties file that contains token values for a WebSphere configuration, for use in the generation of a WebSphere Configuration from an application archive.

If you do not use the -taskDataTokens option to specify a properties file, a special default set of tokens is used in this operation. You can override any of the tokens in this default token set using either the -tokens option or the -taskDataTokens option (that is, by either specifying a token set from the Server Profile or by specifying a properties file). The -taskDataTokens option has highest precedence and overrides any overlapping token keys specified through either the -tokens option or the default token set. For more information about the default token set and about preparing the properties file, see Generating a WebSphere Configuration from an application archive through the CLI.

-tokens

  • install
  • preview
  • tokenize
  • snapshotAndTokenize
  • generateConfiguration
  • sync
  • pullValues

For an installation operation: The name of the Token Set to use when installing a Configuration. This option is required when you use the -config option.

For tokenizing a Snapshot or Configuration: The name of the Token Set to use for tokenization.

For generation of Configuration files from WebSphere application archive files: The name of a Token Set from the specified Server Profile to incorporate into the generated Configuration.

For a token set synchronizaton operation: The names of the Token Sets to synchronize between Server Profiles. Separate multiple Token Sets with commas.

For pulling values from a Configuration to a Server Profile: The name of the Token Set in the target Server Profile in which you want to store token values.

-tokensPropFile

  • install
  • preview
  • createServerImage

The full path to a properties file that contains token values for the installation or preview of a Configuration or for creating a server image.

Note: For the creation of a server image, this argument is optional; if it is not specified, the server image is created without tokens.

-useOldEncryptionMethods
  • createServerProfile
  • snapshot
  • snapshotAndTokenize
Forces the use of the Weblogic or Websphere native encryption methods and no encryption for Tomcat during the current operation, even if the PHE1 protocol was set  as the protocol to be used for encryptions.