Using a command-line interface to manage a package

In addition to using BMC Remedy Deployment Management console, you can use a command-line interface (CLI) to promote data and definitions across development, QA, and production environments. 

You can perform multiple command-line operations such as Build, Import, Export, Deploy, and Rollback. If you have package-level or content-level precheck qualification defined, these prechecks also work from the CLI.

Advantages of using CLI to manage a package 

• The AR System Administrator can push a package to all servers using a single command. This reduces the efforts required to manually upgrade all servers to the latest package.
• An administrator or a package deployer can trigger package deployment across environments. This saves time for manual deployment and increases the frequency of deployments.
• A Package Creator and an administrator can automatically build an application package. This saves time and automates the build to test the toolchain.

Using CLI 

When you use a CLI to manage a package, BMC Remedy Deployment Application permission model is applicable. For information about roles and permissions, see BMC Remedy Deployment Application roles and permissions.

Use the following files to run the commands to deploy, import, export, or rollback a package:

• (Windows) ard2putil.bat
• (UNIX) ard2putil.sh

These files are located in the <AR_Install_Dir>/ARSystem/pluginsvr directory.

The command syntax is as follows:

ard2putil.bat -x <serverName> -u <userName>  -p <password> [-a authString] [-portnum <TCPPort>]  [-k packageName]  [-v packageVersion] [-m packageOperations] [-f filename ]

The following table describes the details about the commands:

help <operation name>

ard2putil.bat -x <serverName> 
-u <userName> 
-p <password> 
[-portnum 0] -m "list"

ard2putil.bat -x <serverName> 
-u <userName> -p <password> 
[-portnum 0]  -m "import" 
-f <packageLocation>

ard2putil.bat -x <serverName> 
-u <userName> -p <password> 
[-portnum 0]  -m "build" 
-k <packageName> 
-v <packageVersion> 

ard2putil.bat -x <serverName> 
-u <userName> -p <password> 
[-portnum 0]  -m "deploy" 
-k <packageName> -v <packageVersion> 

ard2putil.bat -x <serverName> 
-u <userName> -p <password> 
[-portnum 0]  -m "export" 
-k <packageName> 
-v <packageVersion>

ard2putil.bat -x <serverName> 
-u <userName> -p <password> 
[-portnum 0]  -m "rollback" 
-k <packageName> 
-v <packageVersion>

ard2putil.bat -x <serverName> 
-u <userName> -p <password> 
[-portnum 0]  -m "status" 
-k <packageName> 
-v <packageVersion> 

ard2putil.bat -x <serverName> 
-u <userName> -p <password> 
[-portnum 0]  -m "delete" 
-k <packageName> 
-v <packageVersion>

ard2putil.bat -x <serverName> 
-u <userName> -p <password> 
[-portnum 0]  -m "copy" 
-k <packageName> 
-v <packageVersion>

Before you begin

Ensure that in the deployConfig.properties file, the value of the filedeployer.localDeploymentRequired parameter is set to false.
The deployConfig.properties file is located in the following folder:

• (Windows) /AR_Install_Dir
• (UNIX) /ARSystem/bin

To apply a package using CLI

The AR System Administrator or a Package Deployer can use CLI to apply a package provided by BMC. Perform the following steps to apply a package:

1. Open a command prompt.
2. Navigate to the <AR_Install_Dir>/ARSystem/pluginsvr directory.
3. Run the following command based on the operating system you are using:
   • (Windows) ard2putil.bat
   • (UNIX) ard2putil.sh
4. Import the package by using the Import command as follows: 
   ard2putil.bat -x "localhost" -u Demo -p "" -portnum 0  -m "import" -f "C:\D2P_Packages\<fileName>.zip"
   
   For example:
   ard2putil.bat -x "localhost" -u Demo -p "" -portnum 0  -m "import" -f "C:\D2P_Packages\ITSM1808_01.zip"
5. Deploy the package by using the Deploy command as follows:
   ard2putil.bat -x "localhost" -u Demo -p "" -portnum 0  -m "deploy" -k "<fileName>.zip" -v "1"
   
   For example:
   ard2putil.bat -x "localhost" -u Demo -p "" -portnum 0  -m "deploy" -k "ITSM1808_01.zip" -v "1"

For information about applying a package using Remedy Deployment Management Console, see  Applying a deployment package  in BMC Remedy IT Service Management Deployment online documentation.

Related topic

Creating and deploying a package using BMC Remedy Deployment Application