RapidDeploy JMX Command Line Interface

This version of the command line interface is only available in version 3.1.1 which will be available at the end of Feb 2012.  A pre-release version is available to download in the nightly builds downloads.

———————————————————————
RapidDepploy JMX Client Usage:
———————————————————————

java -jar $MV_HOME/jmx/lib/mv-jmx.jar com.midvision.rapiddeploy.jmx.client.MVClient -help

-help <Displays this help>
-help -operation <operation> <Displays help for operation>
-list <Displays this help>

or on UNIX/LINUX use the shell script

./$MV_HOME/jmx/bin/run-jmx-client.sh -help -operation createProject

or on Windows use the batch script

%MV_HOME%\jmx\bin\run-jmx-client.bat -help -operation createProject

———————————————————————
CONNECTION SETTINGS
———————————————————————

java -jar $MV_HOME/jmx/lib/mv-jmx.jar com.midvision.rapiddeploy.jmx.client.MVClient -hostname <hostname> -port <port> -username <username> -password <password> -operation <operation> [operation arguments]

-hostname <hostname of the RapidDeploy JMX server – OPTIONAL (If not set then defaults to localhost)>
-port <port of the RapidDeploy JMX server – OPTIONAL (If not set then defaults to 1799)>
-username <RapidDeploy username – MANDATORY>
-password <RapidDeploy password – MANDATORY>
-websphereAdminUsername <WebSphere admin console username for the container of the RapidDeploy JMX server – OPTIONAL (required if RapidDeploy is deployed to a WebSphere container)>
-websphereAdminPassword <WebSphere admin console password for the container of the RapidDeploy JMX server – OPTIONAL (required if RapidDeploy is deployed to a WebSphere container)>
-cell <cell name of the WebSphere container of the RapidDeploy JMX server – OPTIONAL (required if RapidDeploy is deployed to a WebSphere container)>
-node <node name of the WebSphere container of the RapidDeploy JMX server – OPTIONAL (required if RapidDeploy is deployed to a WebSphere container)>
-process <process name of the WebSphere container of the RapidDeploy JMX server – OPTIONAL (required if RapidDeploy is deployed to a WebSphere container)>

Example usage:

java -jar $MV_HOME/jmx/lib/mv-jmx.jar -help
java -jar $MV_HOME/jmx/lib/mv-jmx.jar -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation discoverProject -projectName TestProject01
java -jar $MV_HOME/jmx/lib/mv-jmx.jar -username mvadmin -password mvadmin -operation discoverProject -projectName TestProject01
java -jar $MV_HOME/jmx/lib/mv-jmx.jar -hostname localhost -port 8879 -username mvadmin -password mvadmin -websphereAdminUsername wasadmin -websphereAdminPassword wasadmin -cell Cell01 -node Node01 -process Process01 -operation discoverProject -projectName TestProject01

Command Line Administration

JMX Display Help

./$MV_HOME/jmx/bin/run-jmx-client.sh –help

JMX List Operations

List all operations

./$MV_HOME/jmx/bin/run-jmx-client.sh –list

Display help for a specific operation

./$MV_HOME/jmx/bin/run-jmx-client.sh -help -operation createProject

JMX Create Project

———————————————————————

- createProject

Creates a RapidDeploy project.

Operation arguments:

-projectName <project name – MANDATORY>
-projectDirectory <project directory – MANDATORY>
-collectionTypeId <project collection type id – MANDATORY>
-description <project description – OPTIONAL>
-deploymentType <deployment type> (possible values: [codeDeploy, binaryInstall, raf, genericAutomation], defaults to codeDeploy)
-logDirectory <project log directory – OPTIONAL (If not set then defaults to the rapiddeploy property ‘deployment.log.directory’)>
-buildStore <project build store directory – OPTIONAL (If not set then defaults to the rapiddeploy property ‘build.store.directory’)>
-promotionStore <project promotion store directory – OPTIONAL (If not set then defaults to the rapiddeploy property ‘build.store.directory’)>
-packageSearchString <project deployment package search string – OPTIONAL (If not set then defaults to the project name)>
-propertyFileExtension <project property file extension – OPTIONAL (If not set then defaults to the ‘dict’)>
-masterInDatabase <project mastered in database – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>
-buildType <build type – OPTIONAL> (possible values: [unset, hudson, maven, cruisecontrol, bamboo, buildforge, anthill, ant, custom, rtc], defaults to unset)
-buildServer <project build server – OPTIONAL>
-buildPort <project build port – OPTIONAL>
-svnEnabled <project is stored in an SVN repository – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>
-svnUsername <project svn username – OPTIONAL, required if svnEnabled is true>
-svnPassword <project svn password – OPTIONAL, required if svnEnabled is true>
-svnRepositoryUrl <project svn URL – OPTIONAL, required if svnEnabled is true>
-clearCaseEnabled <project is stored in an ClearCase repository – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>
-clearCaseActivity <project ClearCase activity – OPTIONAL, required if clearCaseEnabled is true>
-createDirectories <indicates if the directories are created on the file system (possible values: ‘true’, ‘false’) – OPTIONAL, defaults to true>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation createProject -projectName TempProj01 -description “Test Project 01 Desc” -deploymentType codeDeploy -projectDirectory ${mv_home}/projects/TempProj01 -logDirectory /${mv_home}/projects/TempProj01/logs -buildStore ${mv_home}/projects/buildstore -promotionStore ${mv_home}/projects/promotionstore -packageSearchString TempProj01 -propertyFileExtension conf -collectionTypeId 1 -masterInDatabase true -createDirectories true

JMX Discover a Project

———————————————————————

- discoverProject

Discovers a RapidDeploy project.

Operation arguments:

-projectName <project name – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation discoverProject -projectName TempProj01

JMX Run a Code Deployment Job

———————————————————————

- runJob

Executes a job.

-projectName <project name – MANDATORY>
-serverName <server name – MANDATORY>
-environmentName <environment name – OPTIONAL, required if project deployment type is: codeDeploy>
-instanceName <instance name – OPTIONAL, required if project deployment type is: codeDeploy>
-applicationName <application name – OPTIONAL, required if project deployment type is: codeDeploy>
-installationPath <server name – OPTIONAL, required if project deployment type is: binaryInstall>
-packageName <package name – OPTIONAL>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation runJob -projectName HELLO_WORLD -serverName hwserver01 -environmentName unset -instanceName unset -applicationName unset -packageName HELLO_WORLD_0_0_1

JMX Take a Snapshot

———————————————————————

- takeSnapshot

Takes a snapshot of the project instance.

-projectName <project name – MANDATORY>
-serverName <server name – MANDATORY>
-environmentName <environment name – MANDATORY>
-instanceName <instance name – MANDATORY>
-applicationName <application name – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation takeSnapshot -projectName HELLO_WORLD -serverName hwserver01 -environmentName unset -instanceName unset -applicationName unset

JMX Create a User

———————————————————————

- createUser

Creates a RapidDeploy User.

Operation arguments:

-user <new user name – MANDATORY>
-firstName <users first name – MANDATORY>
-lastName <users last name – MANDATORY>
-email <users email address – MANDATORY>
-userPassword <user password – MANDATORY>
-description <user description – OPTIONAL>
-admin <user is administrator role – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>
-secAdmin <user is administrator role – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>
-urlRequestor <user is administrator role – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>
-dbRequestor <user is administrator role – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation createUser -user wonka -firstName Willy -lastName Wonka -email willy.wonka@chocolatefactory.com -userPassword chocolate -description “Willy Wonka RD User” -admin true -secAdmin false -urlRequestor false -dbRequestor true

JMX Add User to a Group

———————————————————————

- addUserToGroup

Adds a RapidDeploy User to a group.

Operation arguments:

-user <username of the user to add to a group – MANDATORY>
-group <group name the group – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation addUserToGroup -user wonka -group admin

JMX Delete User from a Group

———————————————————————

- deleteUserFromGroup

Deletes a RapidDeploy User from a group.

Operation arguments:

-user <username of the user to delete from a group – MANDATORY>
-group <group name the group – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation deleteUserFromGroup -user wonka -group admin

JMX Create a Deployment Package

———————————————————————

- createDeploymentPackage

Creates a project deployment package.

-projectName <project name – MANDATORY>
-packageName <package name – MANDATORY>
-archiveType <package name – OPTIONAL> (possible values: [tar, jar, zip, war, ear, rar], defaults to jar)

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation createDeploymentPackage -projectName HELLO_WORLD -packageName HELLO_WORLD_0_0_2 -archiveType jar

JMX Delete a Deployment Package

———————————————————————

- deleteDeploymentPackage

Deletes a project deployment package.

-projectName <project name – MANDATORY>
-packageName <package name – MANDATORY>
-archiveType <package name – OPTIONAL> (possible values: [tar, jar, zip, war, ear, rar], defaults to jar)

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation deleteDeploymentPackage -projectName HELLO_WORLD -packageName HELLO_WORLD_0_0_2 -archiveType jar

JMX Create a Server

———————————————————————

- createServer

Creates a RapidDeploy target server.

Operation arguments:

-displayName <display name, used within RapidDeploy to reference this target server. – MANDATORY>
-hostname <resolvable hostname or IP address of this server – MANDATORY>
-remoteBuildStore <location on the target server where deployment packages will be copied to. This location must exist and be writeable by the Ssh user or Remote agent. – MANDATORY>
-osType <any valid OS type software product – OPTIONAL e.g AIX, Linux, Windows>
-version <version of the OS – OPTIONAL>
-allowDeployments <indicates if deployments are allowed to this target server – OPTIONAL (possible values: ‘true’, ‘false’), defaults to true>
-timeout <timeout must be between 1000 and 10000000, in milliseconds, for either Ssh or Remoting deployments. This should be set to a value that significantly exceeds a standard deployment time on this server. – OPTIONAL defaults to 1800000 milliseconds>
-sshEnabledDeployments <indicates if deployments are allowed via ssh to this target server – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>
-sshEnabledDiscovery <indicates if discovery are allowed via ssh to this target server – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>
-sshPort <ssh port on the target server – OPTIONAL defaults to 22>
-sshUserName <ssh user on the target server – OPTIONAL>
-sshPassword <password for the ssh user on the target server. Required if using username/password authentication. – OPTIONAL>
-sshKeyfilePath <ssh private key file location on the RapidDeploy server. This value is not required if username/password authentication is being used. – OPTIONAL>
-sshKeyfilePassPhrase <passphrase for the key file, if passphrase protected and using username/keyfile/passphrase authentication. – OPTIONAL>
-remotingEnabledDeployments <indicates if deployments are allowed via remote agent to this target server – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>
-remotingEnabledDiscovery <indicates if discovery are allowed via remote agent to this target server – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>
-remotingPort <remote agent port on the target server – OPTIONAL defaults to 20000>
-remotingPath <path to the Agent files on the target server – OPTIONAL>
-javaManaged <indicates if RapidDeploy will manage (deploy and update) Java on the target server – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>
-javaLocalPath <path to JAVA_HOME on this RapidDeploy server – OPTIONAL>
-javaRemotePath <path to JAVA_HOME on the target server – OPTIONAL>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation createServer -displayName TestJMXServer -serverHostname 127.0.0.1 -remoteBuildStore ${mv_home}/buildstore/remote -osType Windows -version 7 -allowDeployments true -timeout 180000 -remotingEnabledDeployments true -remotingEnabledDiscovery true

JMX Create an Environment

———————————————————————

- createEnvironment

Creates a RapidDeploy target environment.

Operation arguments:

-serverName <server display name, parent server of the environment. – MANDATORY>
-environmentName <environment display name, used within RapidDeploy to reference this environment. – MANDATORY>
-product <any valid software product as defined in RapidDeploy- OPTIONAL e.g JBoss Application Server>
-version <version of the software product – OPTIONAL>
-environmentType <environment type – OPTIONAL> (possible values: [UNKNOWN, DEVELOPMENT, TEST, PRODUCTION], defaults to UNKNOWN)
-binaryPath <binary path of this environment – OPTIONAL>
-allowDeployments <indicates if deployments are allowed to this target environment – OPTIONAL (possible values: ‘true’, ‘false’), defaults to true>
-connectionPort <connection port to the target environment – OPTIONAL>
-connectionClass <connection class to the target environment – OPTIONAL>
-connectionString <connection string to the target environment – OPTIONAL>
-environmentUserName <username on the target environment – OPTIONAL>
-environmentPassword <password on the target environment – OPTIONAL>
-notes <notes on the target environment – OPTIONAL>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation createEnvironment -serverName TestJMXServer -environmentName TestJMXEnvironment -product prod -version 6 -environmentType UNKNOWN -binaryPath ${mv_home}/apps/jmx -allowDeployments true -connectionPort 8898 -connectionClass JMXConnectionClass -connectionString JMXConnectionString -environmentUserName user -environmentPassword password -notes “Here are some environment notes”

JMX Create an Instance

———————————————————————

- createInstance

Creates a RapidDeploy target instance.

Operation arguments:

-serverName <server display name, parent server of the environment. – MANDATORY>
-environmentName <environment display name, parent server of the instance. – MANDATORY>
-instanceName <instance display name, used within RapidDeploy to reference this instance. – MANDATORY>
-collectionTypeId <project collection type id – MANDATORY>
-version <version of the software product instance – OPTIONAL>
-binaryPath <binary path of this instance – OPTIONAL>
-allowDeployments <indicates if deployments are allowed to this target instance – OPTIONAL (possible values: ‘true’, ‘false’), defaults to true>
-approvalRequired <indicates if approval is required for deployments to this target instance – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>
-connectionPort <connection port to this target instance – OPTIONAL>
-connectionHost <connection host to this target instance – OPTIONAL>
-alias <alias of this target instance – OPTIONAL>
-instanceUserName <username on the target instance – OPTIONAL>
-instancePassword <password on the target instance – OPTIONAL>
-notes <notes on the target instance – OPTIONAL>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation createInstance -serverName TestJMXServer -environmentName TestJMXEnvironment -instanceName TesJMXInstance -collectionTypeId 22 -version 6.0 -allowDeployments true -approvalRequired true -binaryPath ${mv_home}/apps/jmx -connectionPort 8879 -connectionHost localhost -alias JMXAlias -instanceUserName user -instancePassword password -notes “Here are some instance notes”

JMX Create or Update a Project Data Dictionary Variable

———————————————————————

- createOrUpdateDataDictionaryVariable

Executes a job.

-projectName <project name – MANDATORY>
-serverName <server name – MANDATORY>
-environmentName <environment name – MANDATORY>
-instanceName <instance name – MANDATORY>
-applicationName <application name – MANDATORY>
-key <data dictionary key – MANDATORY>
-value <data dictionary value – MANDATORY>
-encrypt <encrypt the value on the file system – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation createOrUpdateDataDictionaryVariable -projectName HELLO_WORLD -serverName hwserver01 -environmentName unset -instanceName unset -applicationName unset -key @@JMX_KEY@@ -value new_jmx_value -encrypt false

JMX Create URL Library

———————————————————————

- createUrlLibrary

Creates a URL Library.

Operation arguments:

-name <url library name. – MANDATORY>
-description <url library description. – OPTIONAL>
-type <url library environment type. – OPTIONAL> (possible values: [UNKNOWN, DEVELOPMENT, TEST, PRODUCTION], defaults to UNKNOWN)
-absolutePath <url library absolute path to the library file. – OPTIONAL>
-relativePath <url library relative path to the library file. – OPTIONAL>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation createUrlLibrary -name Jmx_Url_Lib_1 -description “JMX URL Lib Desc” type UNKNOWN -absolutePath ${mv_home}/libraries/jmx_url_lib.txt -relativePath ../../jmx_url_lib.txt

JMX Add URL Endpoint to URL Library

———————————————————————

- addUrlToLibrary

Adds a URL Endpoint to a URL Library.

Operation arguments:

-name <url library name. – MANDATORY>
-jndiName <url endpoint jndi name. – MANDATORY>
-urlName <url endpoint URL. – MANDATORY>
-url <url endpoint name. – MANDATORY>
-description <url endpoint description. – OPTIONAL>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation addUrlToLibrary -name Jmx_Url_Lib_1 -jndiName jndi/JMXUrl -description “JMX URL Lib Desc” -urlName jmxUrl -url http://www.google.com

JMX Extract URL Library to XML File

———————————————————————

- extractUrlLibraryToXml

Writes a URL Library to a file as xml.

Operation arguments:

-name <url library name. – MANDATORY>
-fileName <file path to write the XML to. – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -

password mvadmin -operation extractUrlLibraryToXml -name Jmx_Url_Lib_1 -fileName ${mv_home}/libraries/jmx_url_lib.xml

JMX Write URL Library from XML File

———————————————————————

- writeUrlLibraryFromXml

Reads a URL Library from an xml file as writes it to the rapiddeploy database.

Operation arguments:

-name <url library name. – MANDATORY>
-fileName <file path to read the XML from. – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation writeUrlLibraryFromXml -name Jmx_Url_Lib_1 -fileName ${mv_home}/libraries/jmx_url_lib.xml

JMX Associate URL Library to Instance

———————————————————————

- associateUrlLibraryToInstance

Associates or unassociates a URL Library to a project instance.

Operation arguments:

-name <url library name. – MANDATORY>
-projectName <project name – MANDATORY>
-serverName <server name – MANDATORY>
-environmentName <environment name – MANDATORY>
-instanceName <instance name – MANDATORY>
-applicationName <application name – MANDATORY>
-associate <if set to true the library is associated to the instance, if set to false it is unassociated to an instance – OPTIONAL (possible values: ‘true’, ‘false’), defaults to true>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation associateUrlLibraryToInstance -name Jmx_Url_Lib_1 -projectName HELLO_WORLD -serverName hwserver01 -environmentName unset -instanceName unset -applicationName unset -associate true

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation associateUrlLibraryToInstance -name Jmx_Url_Lib_1 -projectName HELLO_WORLD -serverName hwserver01 -environmentName unset -instanceName unset -applicationName unset -associate false

JMX Remove URL from Library

———————————————————————

- removeUrlFromLibrary

Deletes a URL Endpoint and removed it from the Library.

Operation arguments:

-name <url library name. – MANDATORY>
-jndiName <url endpoint jndi name. – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation removeUrlFromLibrary -name Jmx_Url_Lib_1 -jndiName jndi/JMXUrl

JMX Delete URL Library

———————————————————————

- deleteUrlLibrary

Deletes a URL Library.

Operation arguments:

-name <url library name. – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation deleteUrlLibrary -name Jmx_Url_Lib_1

JMX Create Database Library

———————————————————————

- createDbLibrary

Creates a DB Library.

Operation arguments:

-name <db library name. – MANDATORY>
-description <db library description. – OPTIONAL>
-type <db library environment type. – OPTIONAL> (possible values: [UNKNOWN, DEVELOPMENT, TEST, PRODUCTION], defaults to UNKNOWN)
-absolutePath <db library absolute path to the library file. – OPTIONAL>
-relativePath <db library relative path to the library file. – OPTIONAL>
-driverPath <db library path to the driver. – OPTIONAL>
-driverClassName <db library driver classname. – OPTIONAL>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation createDbLibrary -name Jmx_Db_Lib_1 -description “JMX DB Lib Desc” type UNKNOWN -absolutePath ${mv_home}/libraries/jmx_db_lib.txt -relativePath ../../jmx_db_lib.txt -driverPath /u01/app/oracle/product/10.2.0/jdbc/lib/ojdbc14.jar -driverClassName oracle.jdbc.pool.OracleConnectionPoolDataSource

JMX Add Datasource to Library

———————————————————————

- addDbToLibrary

Adds a DataSource to a Database Provider Library.

Operation arguments:

-name <db library name. – MANDATORY>
-jndiName <data source jndi name. – MANDATORY>-dbUrl <data source URL. – MANDATORY>
-dataSourceName <data source name. – MANDATORY>
-driverClassName <data source driver classname. – MANDATORY>
-dataSourceUserName <data source user name. – MANDATORY>
-dataSourcePassword <data source password. – MANDATORY>
-cmpConnectionFactoryName <data source CMP connection factory name. – MANDATORY>
-description <data source description. – OPTIONAL>
-dataSourceSchemaNames <data source schema names. – OPTIONAL>
-dataSourceJaasAlias <data source JAAS alias. – OPTIONAL>
-dataSourceAttributes <data source attributes. – OPTIONAL>
-dataSourceHelperClass <data source helper class. – OPTIONAL>
-dataSourcePurgePolicy <data source purge policy. – OPTIONAL>
-dataSourceConnectionTimeout <data source connection timeout. – OPTIONAL>
-dataSourceAgedTimeout <data source aged timeout. – OPTIONAL>
-dataSourceUnusedTimeout <data source unused timeout. – OPTIONAL>
-dataSourceReapTime <data source reap time. – OPTIONAL>
-dataSourceStatementCacheSize <data source statement cache size. – OPTIONAL>
-dataSourceConnectionPoolMin <data source minimum connection pool size. – OPTIONAL>
-dataSourceConnectionPoolMax <data source maximum connection pool size. – OPTIONAL>
-dataSourceStuckTime <data source stuck time. – OPTIONAL>
-dataSourceStuckTimerTime <data source stuck timer time. – OPTIONAL>
-dataSourceStuckThreshold <data source stuck threshold. – OPTIONAL>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation addDbToLibrary -name Jmx_Db_Lib_1 -description “JMX DataSource Desc” -jndiName jndi/JMXDS -dbUrl jdbc:localhost:1521 -dataSourceName JMXDataSource -dataSourceUserName user1 -dataSourcePassword password1 -driverClassName oracle.jdbc.pool.OracleConnectionPoolDataSource -cmpConnectionFactoryName cmpFactory

JMX Extract Database Library to XML File

———————————————————————

- extractDbLibraryToXml

Writes a DB Library to a file as xml.

Operation arguments:

-name <database library name. – MANDATORY>
-fileName <file path to write the XML to. – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation extractDbLibraryToXml -name Jmx_Db_Lib_1 -fileName ${mv_home}/libraries/jmx_db_lib.xml

JMX Write Database Library from XML File

———————————————————————

- writeDbLibraryFromXml

Reads a DB Library from an xml file as writes it to the rapiddeploy database.

Operation arguments:

-name <database library name. – MANDATORY>
-fileName <file path to read the XML from. – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation writeDbLibraryFromXml -name Jmx_Db_Lib_1 -fileName ${mv_home}/libraries/jmx_db_lib.xml

JMX Associate Database Library to Instance

———————————————————————

- associateDbLibraryToInstance

Associates or unassociates a Database Library to a project instance.

Operation arguments:

-name <database library name. – MANDATORY>
-projectName <project name – MANDATORY>
-serverName <server name – MANDATORY>
-environmentName <environment name – MANDATORY>
-instanceName <instance name – MANDATORY>
-applicationName <application name – MANDATORY>
-associate <if set to true the library is associated to the instance, if set to false it is unassociated to an instance – OPTIONAL (possible values: ‘true’, ‘false’), defaults to true>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation associateDbLibraryToInstance -name Jmx_Db_Lib_1 -projectName HELLO_WORLD -serverName hwserver01 -environmentName unset -instanceName unset -applicationName unset -associate true

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation associateDbLibraryToInstance -name Jmx_Db_Lib_1 -projectName HELLO_WORLD -serverName hwserver01 -environmentName unset -instanceName unset -applicationName unset -associate false

JMX Remove Datasource from Library

———————————————————————

- removeDbFromLibrary

Deletes a DataSource and removed it from the Library.

Operation arguments:

-name <data provider library name. – MANDATORY>
-jndiName <data source jndi name. – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation removeDbFromLibrary -name Jmx_Db_Lib_1 -jndiName jndi/JMXDS

JMX Delete Database Library

———————————————————————

- deleteDbLibrary

Deletes a DB Library.

Operation arguments:

-name <db library name. – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation deleteDbLibrary -name Jmx_Db_Lib_1

JMX Create Environment Installation

———————————————————————

- createEnvironmentInstallation

Creates an environment installation object in RapidDeploy.

Operation arguments:

-projectName <project name – MANDATORY>
-serverName <server name – MANDATORY>
-path <installation path – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation createEnvironmentInstallation -serverName TestJMXServer -projectName TempProj01 -path ${mv_home}/JMX_Install_Path

JMX Add Property to Environment Installation

———————————————————————

- addPropertyToEnvironmentInstallation

Adds a property to an environment installation.

Operation arguments:

-projectName <project name – MANDATORY>~
-serverName <server name – MANDATORY>
-path <installation path – MANDATORY>
-key <property key to be added – MANDATORY>
-value <property value to be added – MANDATORY>
-encrypt <encrypt the property value – OPTIONAL (possible values: ‘true’, ‘false’), defaults to false>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation addPropertyToEnvironmentInstallation -serverName TestJMXServer -projectName TempProj01 -path ${mv_home}/JMX_Install_Path -key @@JMX_KEY@@ -value new_jmx_value -encrypt false

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation addPropertyToEnvironmentInstallation -serverName TestJMXServer -projectName TempProj01 -path ${mv_home}/JMX_Install_Path -key @@JMX_KEY_ENCRYPTED@@ -value new_jmx_encrypted_value -encrypt true

JMX Remove Property from Environment Installation

———————————————————————

- removePropertyFromEnvironmentInstallation

Removes a property from an environment installation.

Operation arguments:

-projectName <project name – MANDATORY>
-serverName <server name – MANDATORY>
-path <installation path – MANDATORY>
-key <property key to be removed – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation removePropertyFromEnvironmentInstallation -serverName TestJMXServer -projectName TempProj01 -path ${mv_home}/JMX_Install_Path -key @@JMX_KEY@@

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation removePropertyFromEnvironmentInstallation -serverName TestJMXServer -projectName TempProj01 -path ${mv_home}/JMX_Install_Path -key @@JMX_KEY_ENCRYPTED@@

JMX Delete Environment Installation

———————————————————————

- deleteEnvironmentInstallation

Deletes an environment installation object from RapidDeploy.

Operation arguments:

-projectName <project name – MANDATORY>
-serverName <server name – MANDATORY>
-path <installation path – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation deleteEnvironmentInstallation -serverName TestJMXServer -projectName TempProj01 -path ${mv_home}/JMX_Install_Path

JMX Delete Project

———————————————————————

- deleteProject

Deletes a RapidDeploy project.

Operation arguments:

-projectName <project name – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation deleteProject -projectName TempProj01

JMX Delete User

———————————————————————

- deleteUser

Deletes a RapidDeploy User.

Operation arguments:

-user <username of the user to delete – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation deleteUser -user wonka

JMX Delete Instance

———————————————————————

- deleteInstance

Deletes a RapidDeploy target instance.

Operation arguments:

-serverName <server display name, parent server of the environment. – MANDATORY>
-environmentName <environment display name, used within RapidDeploy to reference this environment. – MANDATORY>
-instanceName <instance display name, used within RapidDeploy to reference this instance. – MANDATORY>

Example Instance

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation deleteInstance -serverName TestJMXServer -environmentName TestJMXEnvironment -instanceName TesJMXInstance

JMX Delete Environment

———————————————————————

- deleteEnvironment

Deletes a RapidDeploy target environment.

Operation arguments:

-serverName <server display name, parent server of the environment. – MANDATORY>
-environmentName <environment display name, used within RapidDeploy to reference this environment. – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation deleteEnvironment -serverName TestJMXServer -environmentName TestJMXEnvironment

JMX Delete Server

———————————————————————

- deleteServer

Deletes a RapidDeploy target server.

Operation arguments:

-displayName <display name, used within RapidDeploy to reference this target server. – MANDATORY>

Example Usage

./$MV_HOME/jmx/bin/run-jmx-client.sh -hostname localhost -port 1799 -username mvadmin -password mvadmin -operation deleteServer -displayName TestJMXServer