A Command Line Reference

This appendix contains information about the abctl commands included in Oracle Virtual Assembly Builder.

A.1 Commands

This section describes the available commands. Commands fall into two categories:

  • Commands for creating appliances and assemblies, creating appliance templates and assembly archives, and creating deployment plans.

  • Commands for configuring deployment targets, uploading assembly archives to Deployer, creating assembly instances, and deploying, undeploying, starting, and stopping assembly instances and scaling appliance instances. These commands interface with the Oracle Virtual Assembly Builder Deployer Web service.

When Oracle Virtual Assembly Builder Studio is installed, all commands are available. When only Oracle Virtual Assembly Builder Deployer is installed, a subset of the commands are available. Table A-1 indicates which commands are available depending on which Oracle Virtual Assembly Builder components have been installed.

Table A-1 Available Commands by Installation Type

Command Name and Section Command Availability for Installation Type
Installation of Deployer only Installation of Studio only Installation of Studio and Deployer

Section A.1.1, "addAssemblyUsers"

Yes

Yes

Yes

Section A.1.2, "addTargetUser"

Yes

Yes

Yes

Section A.1.3, "addToAssembly"

No

Yes

Yes

Section A.1.4, "captureFileSets"

No

Yes

Yes

Section A.1.5, "connectEndpoints"

No

Yes

Yes

Section A.1.6, "createAssembly"

No

Yes

Yes

Section A.1.7, "createAssemblyArchive"

No

Yes

Yes

Section A.1.8, "createAssemblyInstance"

Yes

Yes

Yes

Section A.1.9, "createDeployerConnection"

Yes

Yes

Yes

Section A.1.10, "createEMConnection"

No

Yes

Yes

Section A.1.11, "createExternalResources"

No

Yes

Yes

Section A.1.12, "createTags"

Yes

Yes

Yes

Section A.1.13, "createTarget"

Yes

Yes

Yes

Section A.1.14, "createTemplate"

No

Yes

Yes

Section A.1.15, "delete"

No

Yes

Yes

Section A.1.16, "deleteAssemblyArchive"

Yes

Yes

Yes

Section A.1.17, "deleteAssemblyInstance"

Yes

Yes

Yes

Section A.1.18, "deleteDeployerConnection"

Yes

Yes

Yes

Section A.1.19, "deleteEMConnection"

No

Yes

Yes

Section A.1.20, "deleteEMAssemblyArchive"

No

Yes

Yes

Section A.1.21, "deleteFailedApplianceInstances"

Yes

Yes

Yes

Section A.1.22, "deleteRequests"

Yes

Yes

Yes

Section A.1.23, "deleteTags"

Yes

Yes

Yes

Section A.1.24, "deleteTarget"

Yes

Yes

Yes

Section A.1.25, "deployAssemblyInstance"

Yes

Yes

Yes

Section A.1.26, "describeApplianceInstances"

Yes

Yes

Yes

Section A.1.27, "describeAssemblyArchives"

Yes

Yes

Yes

Section A.1.28, "describeAssemblyInstances"

Yes

Yes

Yes

Section A.1.29, "describeAssemblyUsers"

Yes

Yes

Yes

Section A.1.30, "describeCatalog"

No

Yes

Yes

Section A.1.31, "describeDeployer"

Yes

Yes

Yes

Section A.1.32, "describeDeployerConnections"

Yes

Yes

Yes

Section A.1.33, "describeDeploymentPlans"

No

Yes

Yes

Section A.1.34, "describeEMAssemblyArchives"

No

Yes

Yes

Section A.1.35, "describeEMConnection"

No

Yes

Yes

Section A.1.36, "describeEndpoints"

No

Yes

Yes

Section A.1.37, "describeRegistrations"

Yes

Yes

Yes

Section A.1.38, "describeRequests"

Yes

Yes

Yes

Section A.1.39, "describeScalingGroups"

Yes

Yes

Yes

Section A.1.40, "describeTags"

Yes

Yes

Yes

Section A.1.41, "describeTargetConfigurations"

Yes

Yes

Yes

Section A.1.42, "describeTargetNames"

Yes

Yes

Yes

Section A.1.43, "describeTargetUsers"

Yes

Yes

Yes

Section A.1.44, "describeTargets"

Yes

Yes

Yes

Section A.1.45, "describeUserTargets"

Yes

Yes

Yes

Section A.1.46, "describeVnets"

Yes

Yes

Yes

Section A.1.47, "downloadAssemblyArchive"

Yes

Yes

Yes

Section A.1.48, "downloadAssemblyMetadata"

Yes

Yes

Yes

Section A.1.49, "downloadDeploymentPlan"

Yes

Yes

Yes

Section A.1.50, "downloadEMAssemblyArchive"

No

Yes

Yes

Section A.1.51, "export"

No

Yes

Yes

Section A.1.52, "getDefaultTarget"

Yes

Yes

Yes

Section A.1.53, "getTargetType"

Yes

Yes

Yes

Section A.1.54, "help"

Yes

Yes

Yes

Section A.1.55, "import"

No

Yes

Yes

Section A.1.56, "introspectCoherenceWeb"

No

Yes

Yes

Section A.1.57, "introspectForms"

No

Yes

Yes

Section A.1.58, "introspectGenericProd"

No

Yes

Yes

Section A.1.59, "introspectOHS"

No

Yes

Yes

Section A.1.60, "introspectOTD"

No

Yes

Yes

Section A.1.61, "introspectRACDB"

No

Yes

Yes

Section A.1.62, "introspectReports"

No

Yes

Yes

Section A.1.63, "introspectSIDB"

No

Yes

Yes

Section A.1.64, "introspectSOA"

No

Yes

Yes

Section A.1.65, "introspectTuxedo"

No

Yes

Yes

Section A.1.66, "introspectWebCache"

No

Yes

Yes

Section A.1.67, "introspectWLS"

No

Yes

Yes

Section A.1.68, "redeployAssemblyInstance"

Yes

Yes

Yes

Section A.1.69, "registerAssemblyArchive"

Yes

Yes

Yes

Section A.1.70, "removeAssemblyUsers"

Yes

Yes

Yes

Section A.1.71, "removeTargetUsers"

Yes

Yes

Yes

Section A.1.72, "restartAssemblyInstance"

Yes

Yes

Yes

Section A.1.73, "scale"

Yes

Yes

Yes

Section A.1.74, "setDefaultTarget"

Yes

Yes

Yes

Section A.1.75, "startAssemblyInstance"

Yes

Yes

Yes

Section A.1.76, "stopAssemblyInstance"

Yes

Yes

Yes

Section A.1.77, "undeployAssemblyInstance"

Yes

Yes

Yes

Section A.1.78, "unregisterAssemblyArchive"

Yes

Yes

Yes

Section A.1.79, "updateAssemblyArchive"

Yes

Yes

Yes

Section A.1.80, "updateTarget"

Yes

Yes

Yes

Section A.1.81, "uploadAssemblyArchive"

Yes

Yes

Yes

Section A.1.82, "uploadEMAssemblyArchive"

No

Yes

Yes

Section A.1.83, "version"

Yes

Yes

Yes


A.1.1 addAssemblyUsers

Details for this command follow.

A.1.1.1 Synopsis

$ abctl addAssemblyUsers -assembly String -user String... -connectionName String

A.1.1.2 Description

Adds one or more users to an assembly.

A.1.1.3 Options

Table A-2 shows the command options for addAssemblyUsers.

Table A-2 addAssemblyUsers options

Name Alias Req'd Default Values Possible Values Description

-assembly

a

true

none

A string representing the name of the assembly.

Specifies the assembly to which to add users

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-user

u

true

none

A string representing the username(s) to add.

Specifies one or more users to add to an assembly.


A.1.1.4 Examples

Here are some command examples.

A.1.1.4.1 Adding Users to an Assembly
$ abctl addAssemblyUsers -assembly MyAssembly -user User1 User2

A.1.2 addTargetUser

Details for this command follow.

A.1.2.1 Synopsis

$ abctl addTargetUser -user String -target String [-properties String...] 
-connectionName String

A.1.2.2 Description

Adds a user to a target.

A.1.2.3 Options

Table A-3 shows the command options for addTargetUser.

Table A-3 addTargetUser options

Name Alias Req'd Default Values Possible Values Description

-user

u

true

none

A string representing the username of the user.

The username of the user.

-target

t

true

none

A string representing the target to which the user is being added.

The target to which a user is being added.

-properties

p

false

none

A string representing property=value pairs to apply to the user.

The properties to apply to the user. If the target type is Exalogic then you can specify the following properties: exalogic.user, exalogic.pwd and exalogic.tenancy.

exalogic.user is the name of the Enterprise Manager Operations Center (EMOC) user to be used for this OVAB user's operations against Oracle Exalogic.

exalogic.pwd is the password of that user.

exalogic.tenancy is an EMOC account UUID that the user is a member of. In EMOC, a user can be a member of more than one account so we require you to declare which one. Operations that Oracle Virtual Assembly Builder performs against EMOC on the user's behalf use that account when creating artifacts, or using resources in EMOC.

An example of an account UUID: ACC-824db9d1-d37f-4cf1-b485-791276f48eff

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


Note:

The OVAB_USER_ID is typically the same as the OVAB_USER_ID you gave when performing createDeployerConnection. For example:

createDeployerConnection -name mydeployer -url https://deployerhost:7001 -username OVAB_USER_ID

A.1.2.4 Examples

Here are some command examples.

A.1.2.4.1 Adding Users to an Assembly
$ abctl addTargetUser -connectionName MyConnection -user OVAB_USER_ID -target exalogic -properties exalogic.user=EMOC_USER_ID exalogic.pwd=EMOC_PASSWORD exalogic.tenancy=EMOC_ACCOUNT_UUID

A.1.3 addToAssembly

Details for this command follow.

A.1.3.1 Synopsis

$ abctl addToAssembly -name String -into String

A.1.3.2 Description

Adds an existing appliance or assembly to another existing assembly.

A.1.3.3 Options

Table A-4 shows the command options for addToAssembly.

Table A-4 addToAssembly options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

The name of an existing appliance or atomic assembly.

The name of an existing appliance or atomic assembly to add.

-into

i

true

none

The name of a non-atomic assembly.

The name of an existing assembly to populate.


A.1.3.4 Examples

Here are some command examples.

A.1.3.4.1 Adding an Appliance into an Existing Assembly
$ abctl addToAssembly -name myAppliance -into myAssembly

A.1.4 captureFileSets

Details for this command follow.

A.1.4.1 Synopsis

$ abctl captureFileSets -name String [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path] [-quiet] [-force]

A.1.4.2 Description

Creates file sets for the specified appliance or assembly.

A.1.4.3 Options

Table A-6 shows the command options for captureFileSets.

Table A-5 captureFileSets options

Name Alias Req'd Default Values Possible Values Description

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, the remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the ssh user to use for accessing the remote machine. If set, the remoteHost must be specified as well.

-sudoUser

su

false

none

User name of sudo user.

Name of the user on the remote machine to sudo as before executing operations. Note that sudoUser is equivalent to Run as user in Oracle Virtual Assembly Builder Studio.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

Path on the remote machine to work out of. If set, the remoteUser and remoteHost must be specified as well.

-remoteCleanup

rc

false

none

N/A

Remote clean up flag. When set, the remote working directory is deleted after the operation. Otherwise the directory is not be modified. If set, the remoteUser and remoteHost must be specified as well.

-privateKeyFile

pkf

false

~/.ssh/id_rsa

Location of a private key file.

Private SSH key file on the local machine.

-quiet

q

false

none

N/A

By default, the command shows detailed progress/success messages. If -quiet is set, the command turns off verbose mode and shows only one or two progress/success messages.

-name

n

false

Derived directory name prefixed by component type name.

Name of an appliance or assembly. Nested appliances or assemblies are referred to with slash ('/'), for example: mySite/myOhs

Specify the name of an appliance or assembly to be captured. For an assembly, only an atomic assembly name can be specified. To capture a non-atomic assembly, its sub-appliances and sub-assemblies must be captured individually.

-force

f

false

none

N/A

If specified, existing file sets and any appliance templates created from it will be overwritten. The operation can fail if there is an existing registered appliance template that was created from an existing file set. The flag has no effect if no file set or template exists.


A.1.4.4 Examples

Here are some command examples.

A.1.4.4.1 Capture File Sets
% abctl captureFileSets -name myOhs -force

A.1.5 connectEndpoints

Details for this command follow.

A.1.5.1 Synopsis

$ abctl connectEndpoints -from String -fromOutput String -to String -toInput String

A.1.5.2 Description

Creates a new connection between an output and an input. The protocols of the output and input must match, and the owners of the output and input must be part of the same assembly.

A.1.5.3 Options

Table A-6 shows the command options for connectEndpoints.

Table A-6 connectEndpoints options

Name Alias Req'd Default Values Possible Values Description

-from

f

true

none

Name of appliance or assembly.

The name of an appliance or assembly to connect from.

-fromOutput

fout

true

none

Appliance output or assembly output.

Appliance output or assembly output to connect from.

-to

t

true

none

Name of appliance or assembly.

The name of an appliance or assembly to connect to.

-toInput

tin

true

none

Appliance input or assembly input.

Appliance input or assembly input to connect to.


A.1.5.4 Examples

Here are some command examples.

A.1.5.4.1 connectEndpoints
% abctl connectEndpoints -from mySite/myOhs -fromOutput output1 -to mySite/myWls -toInput default

A.1.6 createAssembly

Details for this command follow.

A.1.6.1 Synopsis

$ abctl createAssembly -name String [-defaultNetwork String] [-force]

A.1.6.2 Description

Creates a new assembly in the catalog if one does not already exist by the specified name.

A.1.6.3 Options

Table A-7 shows the command options for createAssembly.

Table A-7 createAssembly options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Name of the new assembly.

Name of a new assembly to be created.

-defaultNetwork

dn

false

none

Name of the default vNet.

If specified, specifies the name to use for the assembly's default vNet.

-force

f

false

none

N/A

If -force is set, the existing appliance or assembly in the catalog using the same as the newly-created assembly will be overridden.


A.1.6.4 Examples

Here are some command examples.

A.1.6.4.1 Creating an Assembly
$ abctl createAssembly -name myAssembly -defaultNetwork intranet

A.1.7 createAssemblyArchive

Details for this command follow.

A.1.7.1 Synopsis

$ abctl createAssemblyArchive -name String -platform String [-noCompress] [-force] [-quiet]

A.1.7.2 Description

Creates an assembly archive for the named top-level assembly. This command can only be invoked on a top-level assembly. Additionally, all the sub-appliances within the assembly must previously have been templated using the createTemplate command.

A.1.7.3 Options

Table A-9 shows the command options for createAssemblyArchive.

Table A-8 createAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Name of an appliance or atomic assembly. Nested appliances or assemblies are referred to with slash ('/'), for example: mySite/myOhs.

Name of an appliance or assembly in the catalog. Only the top-level appliance or assembly is allowed.

-platform

p

true

none

A string representing any valid platform for which templates have been created for the named assembly.

Target platform for which the assembly archive is built. Valid platforms is Exalogic.

-force

f

false

false

N/A

If specified, any existing assembly archive will be overridden. If no archive exists, this flag has no effect.

-quiet

q

false

none

N/A

By default, the command shows detailed progress/success messages. If -quiet is set, the command turns off verbose mode and shows only one or two progress/success messages.


A.1.7.4 Examples

Here are some command examples.

A.1.7.4.1 Creating an Assembly Archive
$ abctl createAssemblyArchive -name myWlsAssembly -platform Exalogic -nocompress

A.1.8 createAssemblyInstance

Details for this command follow.

A.1.8.1 Synopsis

$ abctl createAssemblyInstance -deploymentPlan Path -name String -version String [-target String] -connectionName String

A.1.8.2 Description

Creates an assembly instance for an assembly.

A.1.8.3 Options

Table A-9 shows the command options for createAssemblyInstance.

Table A-9 createAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-deploymentPlan

dp

true

none

A file path to the assembly deployment plan on disk.

Specifies a path to a deployment plan file to use for the assembly instance.

-name

n

true

none

A string representing the name of the assembly.

The name of the assembly.

-version

v

true

none

A string representing the version of the assembly.

Assembly version.

-target

t

false

none

A string representing the name of the target.

The name of the target.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer Web Service.

The name of a connection to the Deployer Web Service.


A.1.8.4 Examples

Here are some command examples.

A.1.8.4.1 Creating an Assembly Instance
$ abctl createAssemblyInstance -deploymentPlan c:/MyDeploymentPlan.xml -name MyAssembly -version 1

A.1.9 createDeployerConnection

Details for this command follow.

A.1.9.1 Synopsis

$ abctl createDeployerConnection -name String -url String [-username String] [-noReviewCert]

A.1.9.2 Description

Creates a new connection between abctl and the Deployer. If you specify a connection using the HTTPS protocol, you may be prompted to approve a certificate.

A.1.9.3 Options

Table A-10 shows the command options for createDeployerConnection.

Table A-10 createDeployerConnection options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the Deployer connection.

The name of the Deployer connection.

-url

u

true

none

A string representing the URL of the Deployer Web service.

The URL of the Deployer.

-username

un

true

none

A string representing the username.

The username to use to authenticate with the Deployer Web service.

-noReviewCert

nr

false

none

N/A

If set, do not present the HTTPS connection certificate for approval.


A.1.9.4 Examples

Here are some command examples.

A.1.9.4.1 Creating a Deployer Connection
$ abctl createDeployerConnection -name MyDeployerConnection -url http://localhost:7001 -username cloudAdmin

A.1.10 createEMConnection

Details for this command follow.

A.1.10.1 Synopsis

$ abctl createEmConnection -connectionURL emMachine:port -connectionUser admin -namedHostCredential hostCredential -remoteUser mySshUser -remoteWorkingDir myRemoteWorkingDir [-sshPort port] [-privateKeyFile ~/.ssh/id_rsa]

A.1.10.2 Description

Creates a connection to an Enterprise Manager Software Library, and persists the connection in a connections file.

You must specify the fully qualified hostname of the remote Enterprise Manager machine, for example myhost.example.com instead of myhost.

When you perform this command, you are prompted for a connection password.

A.1.10.3 Options

Table A-11 shows the command options for createEMConnection.

Table A-11 createEMConnection options

Name Alias Req'd Default Values Possible Values Description

-connectionURL

c

true

none

Hostname:port.

URL for connecting to EM Software Library.

-connectionUser

cu

true

none

Valid EM Software Library User.

User for EM Software Library.

-namedHostCredential

n

true

none

Valid Named Host Credential.

Named Host Credential.

-remoteUser

ru

true

none

Valid SSH user.

SSH user for connecting to the machine where the EM Software Library is located.

-sshPort

s

false

none

Valid SSH port number.

SSH port for EM Software Library machine.

-privateKeyFile

pkf

false

none

~/.ssh/id_rsa, id_rsa

Local private SSH key file used for SSH to the remote EM Software Library machine.

-remoteWorkingDir

rwd

true

none

/scratch,/home/mydir

Valid directory on EM Software Library machine, where assembly archives are uploaded and consumed. Oracle Corporation recommends that you do not use the /tmp directory.


A.1.10.4 Examples

Here are some command examples.

A.1.10.4.1 createEMConnection
$ abctl createEmConnection -connectionURL emMachine:7791 -connectionUser admin -namedHostCredential hostCredential -remoteUser mySshUser -remoteWorkingDir /scratch/myovas [-sshPort 23] [-privateKeyFile ~/.ssh/id_rsa]

A.1.11 createExternalResources

Details for this command follow.

A.1.11.1 Synopsis

$ abctl createExternalResources -from String [-fromOutput String] [-name String] [-recurse]

A.1.11.2 Description

Creates external resources for each of an appliance's or assembly's unconnected outputs.

A.1.11.3 Options

Table A-12 shows the command options for createExternalResources.

Table A-12 createExternalResources options

Name Alias Req'd Default Values Possible Values Description

-from

f

true

none

Appliance or assembly name.

Name of the appliance or assembly for which you want to external resources.

-fromOutput

fout

false

none

Appliance output or assembly output name.

Name of the appliance or assembly output for which you want to create an external resource.

-name

n

false

none

New external resource name.

Name of the new external resource appliance. This parameter is only applicable when creating an external resource for an individual output using the -fromOutput parameter.

-recurse

r

false

none

N/A

If specified, create external resources for each of an assembly's sub-elements.


A.1.11.4 Examples

Here are some command examples.

A.1.11.4.1 Create External Resources for an Assembly
% abctl createExternalResources -from mySite/myWls
A.1.11.4.2 Create External Resources for Each of an Assembly's Sub-elements
% abctl createExternalResources -from mySite -r
A.1.11.4.3 Create an External Resource for the jdbc0 Output
% abctl createExternalresources -from mySite/myWls -fromOutput jdbc0 -name my_Ext_JDBC

A.1.12 createTags

Details for this command follow.

A.1.12.1 Synopsis

$ abctl createTags -tag String... -resource String... -connectionName String

A.1.12.2 Description

Creates one or more tags for a resource.

A.1.12.3 Options

Table A-13 shows the command options for createTags.

Table A-13 createTags options

Name Alias Req'd Default Values Possible Values Description

-tag

t

true

none

A set of name=value pairs specifying the tags.

Specifies one or more tags to tag a resource with.

-resource

r

true

none

A string specifying the resource id of the object to tag.

Specifies one or more resources to apply a tag to.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer Web Service.

The name of a connection to the Deployer Web Service.


A.1.12.4 Examples

Here are some command examples.

A.1.12.4.1 Create Tags
$ abctl createTags -tag key=value -resource MyResource 

A.1.13 createTarget

Details for this command follow.

A.1.13.1 Description

Creates a deployment target. This command is enabled in releases where OVM is a target environment, but is disabled for Oracle Exalogic. This is because the single target in an Oracle Exalogic installation is preconfigured and cannot be changed.

A.1.14 createTemplate

Details for this command follow.

A.1.14.1 Synopsis

$ abctl createTemplate -name String -platform String [-quiet] [-baseImage Path] [-force]

A.1.14.2 Description

Creates an appliance template for a given appliance or assembly.

A.1.14.3 Options

Table A-14 shows the command options for createTemplate.

Table A-14 createTemplate options

Name Alias Req'd Default Values Possible Values Description

-baseImage

bi

false

If not specified, the command attempts to locate the base image from $<AB_INSTANCE>/templates/baseImage/OVM/OEL. If not found there, it attempts to locate it from $<ORACLE_HOME>/templates/baseImage/OVM/OEL.

Path to a valid base image.

Path to a valid base image used to create an appliance template.

-force

f

false

false

N/A

If -force is set, the existing template(s) for assemblies or appliances will be overridden. If the template does not exist, this flag has no effect.

-name

n

true

none

Name of appliance or assembly in catalog. Nested appliances or assemblies are referred to with a slash ("/"). For example: mySite/myOhs.

Name of an appliance or assembly in the catalog.

-platform

p

true

none

OVM, Exalogic

Target platform for which the appliance template is built. The values are case-sensitive.

-quiet

q

false

false

N/A

By default, the command shows detailed progress/success messages. If -quiet is set, the command turns off verbose mode and shows only one or two progress/success messages.


A.1.14.4 Examples

Examples for this command follow.

A.1.14.4.1 No valid base image is found
$ abctl createTemplate -name myOhs -platform OVM
Executing createTemplate command.
Error: OAB-7389: Failed to create VM template for myOhs.
Caused by: OAB-20343: Unable to locate a valid default base image.
  Action: Specify a base image location, or place a base image in default location. Refer to user guide for detail.
A.1.14.4.2 Template already exists for given OS type
$ abctl createTemplate -name myOhs -platform OVM
Executing createTemplate command.
Error: OAB-7389: Failed to create VM template for myOhs.
Caused by: OAB-20120: Appliance myOhs already has template for OEL.
  Action: Use -force flag to override existing template.
A.1.14.4.3 Successful Template Creation
$ abctl createTemplate -name myOhs -platform OVM -baseImage /private/baseImage/OVM/OEL/System.img
Executing createTemplate command.
Set the root and vnc passwords that will be configured in the template.
Enter root password:
Retype root password:
Enter vnc password:
Retype vnc password:
  Step 1 of 2: Creating template for appliance myOhs started.
    Step 1 of 6: Copying base image to catalog started.
    Step 2 of 6: Copying base image to catalog completed.
    Step 3 of 6: Creating AB image started.
    Step 4 of 6: Creating AB image completed.
    Step 5 of 6: Creating product disk for myOhs_root started.
    Step 6 of 6: Creating product disk for myOhs_root completed.
  Step 2 of 2: Creating template for appliance myOhs completed.
Successfully created template for myOhs.

A.1.15 delete

Details for this command follow.

A.1.15.1 Synopsis

$ abctl delete [-name] String [-archiveOnly]

A.1.15.2 Description

Deletes the appliance or assembly with the given name. Only the top-level appliance or assembly can be deleted. Nested appliances or assemblies cannot be deleted using this command. Also, top level appliances or assemblies that share captured file sets and/or templates for an assembly that has an archive cannot be deleted.

A.1.15.3 Options

Table A-15 shows the command options for delete.

Table A-15 delete options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Name of the top-level appliance or assembly.

Name of the top-level appliance or assembly to be deleted.

-archiveOnly

o

false

none

N/A

If specified, delete only the assembly archive, leaving the rest of the assembly intact.


A.1.15.4 Examples

Here are some command examples.

A.1.15.4.1 Attempted to delete nested appliance/assembly
$ abctl delete -name mySite/myOhs
Executing delete command.
Error: OAB-7672: Unable to delete mySite/myOhs from catalog.
  Cause: Nested appliance or assembly cannot be deleted. 
  Action: Use AbStudio (GUI) to delete nested appliances or assemblies.
A.1.15.4.2 Successful Delete
$ abctl delete -name myOhs
Executing delete command.
Successfully deleted myOhs.
A.1.15.4.3 Delete of Only an Archive
$ abctl delete -name myOhs -archiveOnly
A.1.15.4.4 Delete Failed
$ abctl delete -name myOhs
Deleted metadata
Deleted File Sets
Error: Failed to delete templates. 

A.1.16 deleteAssemblyArchive

Details for this command follow.

A.1.16.1 Synopsis

$ abctl deleteAssemblyArchive -name String [-version String] -connectionName String

A.1.16.2 Description

This command deletes an assembly archive from the Deployer repository. This operation may only be performed if there are no registrations for the assembly archive.

A.1.16.3 Options

Table A-16 shows the command options for deleteAssemblyArchive.

Table A-16 deleteAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the assembly archive.

Name of an assembly in the Deployer.

-version

v

false

The default is the latest version number assigned by the Deployer.

A string representing the version of the assembly archive.

Specifies the version of the assembly archive to delete from the Deployer repository.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.16.4 Examples

Here are some command examples.

A.1.16.4.1 Deleting an Assembly Archive
$ abctl deleteAssemblyArchive -name TheAssemblyArchive -version 1

A.1.17 deleteAssemblyInstance

Details for this command follow.

A.1.17.1 Synopsis

$ abctl deleteAssemblyInstance -assemblyInstanceId String -connectionName String

A.1.17.2 Description

Deletes an assembly instance.

This operation can only be executed when the assembly instance is in an undeployed state.

A.1.17.3 Options

Table A-17 shows the command options for deleteAssemblyInstance.

Table A-17 deleteAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

d

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to be deleted.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.17.4 Examples

Here are some command examples.

A.1.17.4.1 Deleting an Assembly Instance
$ abctl deleteAssemblyInstance -assemblyInstanceId MyId -c myDeployerConn

A.1.18 deleteDeployerConnection

Details for this command follow.

A.1.18.1 Synopsis

$ abctl deleteDeployerConnection [-name] String

A.1.18.2 Description

Deletes a connection to the Deployer, and removes the connection from the connections file.

A.1.18.3 Options

Table A-18 shows the command options for deleteDeployerConnection.

Table A-18 deleteDeployerConnection options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the Deployer connection.

The name of the Deployer connection.


A.1.18.4 Examples

Here are some command examples.

A.1.18.4.1 Deleting a Connection to the Deployer
$ abctl deleteDeployerConnection -name WLS1

A.1.19 deleteEMConnection

Details for this command follow.

A.1.19.1 Synopsis

$ abctl deleteEMConnection

A.1.19.2 Description

Deletes the connection to the EM Software Library.

A.1.19.3 Options

None.

A.1.19.4 Examples

Here are some command examples.

A.1.19.4.1 Deleting the EM Connection
$ abctl deleteEMConnection 

A.1.20 deleteEMAssemblyArchive

Details for this command follow.

A.1.20.1 Synopsis

$ abctl deleteEMAssemblyArchive -name String -version String

A.1.20.2 Description

Deletes the specified version of an assembly archive from the Enterprise Manager Software Library.

A.1.20.3 Options

Table A-19 shows the command options for deleteEMAssemblyArchive.

Table A-19 deleteEMAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Name of assembly archive

Name of assembly archive to delete from the EM Software Library.

-version

v

true

none

1.0, 1.2, 2.0, etc.

Version of an assembly archive to delete from the EM Software Library.


A.1.20.4 Examples

Here is a command example.

A.1.20.4.1 Delete EM Assembly Archive
% abctl deleteEMAssemblyArchive -name archiveName -version 1.2

A.1.21 deleteFailedApplianceInstances

Details for this command follow.

A.1.21.1 Synopsis

$ abctl deleteFailedApplianceInstances -applianceId String -applianceInstanceIds String... -connectionName String

A.1.21.2 Description

Deletes one or more appliance instances in the failed state.

A.1.21.3 Options

Table A-20 shows the command options for deleteFailedApplianceInstances.

Table A-20 deleteFailedApplianceInstances options

Name Alias Req'd Default Values Possible Values Description

-applianceId

a

true

none

A string representing the ID of the appliance.

The ID of the appliance.

-applianceInstanceIds

ai

true

none

A string representing the IDs of the appliances.

The IDs of the appliance instances in a failed state to delete.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.21.4 Examples

Here is a command example.

A.1.21.4.1 Delete Failed Appliance Instances
% abctl deleteFailedApplianceInstances -applianceId MyId -applianceInstanceIds MyInstanceId1

A.1.22 deleteRequests

Details for this command follow.

A.1.22.1 Synopsis

$ abctl deleteRequests [-requestId String...] -connectionName String

A.1.22.2 Description

Deletes one or more previously completed requests.

A.1.22.3 Options

Table A-66 shows the command options for deleteRequests.

Table A-21 deleteRequests options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-requestId

d

false

none

A string representing the requestId.

The requestId of a previously completed request.


A.1.22.4 Examples

Here are some command examples.

A.1.22.4.1 Delete Requests
$ abctl deleteRequests

A.1.23 deleteTags

Details for this command follow.

A.1.23.1 Synopsis

$ abctl deleteTags -tag String... -resource String... -connectionName String

A.1.23.2 Description

This command deletes one or more tags for a resource.

A.1.23.3 Options

Table A-22 shows the command options for deleteTags.

Table A-22 deleteTags options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-resource

r

true

none

A string specifying the resource id of the object to remove the tag from.

Specifies one or more resources to remove a tag from.

-tag

t

true

none

A set of name=value pairs specifying the tags.

Specifies one or more tags to remove from a resource.


A.1.23.4 Examples

Here are some command examples.

A.1.23.4.1 Deleting Tags
$ abctl deleteTags -tag foo -resource MyResource

A.1.24 deleteTarget

Details for this command follow.

A.1.24.1 Synopsis

$ abctl deleteTarget -name String -connectionName String

A.1.24.2 Description

This command deletes a target and all configuration information. If this target was a default for a user or all users, then that default is unset.

A.1.24.3 Options

Table A-23 shows the command options for deleteTarget.

Table A-23 deleteTarget options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the target.

The name of the target.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.24.4 Examples

Here are some command examples.

A.1.24.4.1 Deleting a Target
$ abctl deleteTarget -name MyTarget

A.1.25 deployAssemblyInstance

Details for this command follow.

A.1.25.1 Synopsis

$ abctl deployAssemblyInstance -assemblyInstanceId String -connectionName String
[-waitForComplete] [-pollTime String]

A.1.25.2 Description

This command deploys an assembly archive.

A.1.25.3 Options

Table A-24 shows the command options for deployAssemblyInstance.

Table A-24 deployAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to be deployed.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-waitForComplete

w

false

no

N/A

Specifies whether to wait for an asynchronous operation to complete successfully.

-pollTime

pt

false

5

A string representing the number of seconds.

Specifies the amount of time to wait for an asynchronous operation to complete successfully.


A.1.25.4 Examples

Here are some command examples.

A.1.25.4.1 Deploying an Assembly Instance
$ abctl deployAssemblyInstance -assemblyInstanceId MyId

A.1.26 describeApplianceInstances

Details for this command follow.

A.1.26.1 Synopsis

$ abctl describeApplianceInstances [-assemblyInstanceId String...] [-applianceInstanceId String...] [-applianceIndex String...] -connectionName String

A.1.26.2 Description

Describes one or more deployed instances of an assembly.

A.1.26.3 Options

Table A-25 shows the command options for describeApplianceInstances.

Table A-25 describeApplianceInstances options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

as

false

none

A string representing the assemblyInstanceId.

One or more assemblyInstanceIds.

-applianceInstanceId

ap

false

none

A string representing the applianceId.

One or more applianceIds.

-applianceIndex

ai

false

none

A string representing the instanceId.

One or more instanceIds.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.26.4 Examples

Here are some command examples.

A.1.26.4.1 Describe Appliance Instances
$ abctl describeApplianceInstances

A.1.27 describeAssemblyArchives

Details for this command follow.

A.1.27.1 Synopsis

$ abctl describeAssemblyArchives [-assembly String...] -connectionName String

A.1.27.2 Description

Describes one or more assembly archives in the Deployer.

A.1.27.3 Options

Table A-26 shows the command options for describeAssemblyArchives.

Table A-26 describeAssemblyArchives options

Name Alias Req'd Default Values Possible Values Description

-assembly

a

false

none

A list of the assemblies to describe.

Specifies the assemblies to describe.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.27.4 Examples

Here are some command examples.

A.1.27.4.1 Describe Assembly Archives
$ abctl describeAssemblyArchives -assembly TheAssembly

A.1.28 describeAssemblyInstances

Details for this command follow.

A.1.28.1 Synopsis

$ abctl describeAssemblyInstances [-assemblyInstanceId String...] -connectionName String

A.1.28.2 Description

Describes one or more assembly instances.

A.1.28.3 Options

Table A-27 shows the command options for describeAssemblyInstances.

Table A-27 describeAssemblyInstances options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

false

none

A comma-separated list of assembly instance IDs.

Identifiers of one or more assembly instances to be described.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.28.4 Examples

Here are some command examples.

A.1.28.4.1 Describe Assembly Instances
$ abctl describeAssemblyInstances

A.1.29 describeAssemblyUsers

Details for this command follow.

A.1.29.1 Synopsis

$ abctl describeAssemblyUsers -assembly String -connectionName String

A.1.29.2 Description

This command describes one or more users of an assembly.

A.1.29.3 Options

Table A-27 shows the command options for describeAssemblyUsers.

Table A-28 describeAssemblyUsers options

Name Alias Req'd Default Values Possible Values Description

-assembly

a

false

none

A string representing the name of the assembly.

Specifies the assembly whose users will be described.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.29.4 Examples

Here are some command examples.

A.1.29.4.1 Describe Assembly Users
$ abctl describeAssemblyUsers -assembly MyAssembly

A.1.30 describeCatalog

Details for this command follow.

A.1.30.1 Synopsis

$ abctl describeCatalog [-name] String] [-long]

A.1.30.2 Description

Lists appliances and assemblies in the catalog.

A.1.30.3 Options

Table A-29 shows the command options for describeCatalog.

Table A-29 describeCatalog options

Name Alias Req'd Default Values Possible Values Description

-long

l

false

N/A

N/A

Lists information with maximum detail. Included for compatibility only.

-name

n

false

None.

Name of an appliance or assembly. Nested appliances or assemblies are referred to with slash ('/'), for example: mySite/myOhs.

If not specified, all appliances and assemblies in the catalog are displayed. If the name of an assembly is specified, its sub- appliances and sub-assemblies are listed in addition to the assembly itself. If the name of an appliance is specified, only that appliance is listed.


A.1.30.4 Examples

Here are some command examples.

A.1.30.4.1 Describe Catalog in Long Format
$ abctl describeCatalog -name myAssembly -long

A.1.31 describeDeployer

Details for this command follow.

A.1.31.1 Synopsis

$ abctl describeDeployer -connectionName String

A.1.31.2 Description

Describes a Deployer instance.

A.1.31.3 Options

Table A-30 shows the command options for describeDeployer.

Table A-30 describeDeployer options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.31.4 Examples

Here are some command examples.

A.1.31.4.1 Describe Deployer
$ abctl describeDeployer

A.1.32 describeDeployerConnections

Details for this command follow.

A.1.32.1 Synopsis

$ abctl describeDeployerConnections

A.1.32.2 Description

Describes the configured Deployer connections.

A.1.32.3 Options

None.

A.1.32.4 Examples

Here are some command examples.

A.1.32.4.1 Describe Deployer Connections
$ abctl describeDeployerConnections

A.1.33 describeDeploymentPlans

Details for this command follow.

A.1.33.1 Synopsis

$ abctl describeDeploymentPlans [-name String] [-plan String] [-long]

A.1.33.2 Description

Describes the available deployment plans.

A.1.33.3 Options

Table A-30 shows the command options for describeDeploymentPlans.

Table A-31 describeDeploymentPlan options

Name Alias Req'd Default Values Possible Values Description

-name

n

false

.*

Any regular expression.

Name of an assembly or assemblies, specified as a regular expression.

-plan

p

false

.*

Any regular expression.

Name of a plan or plans. It is specified as a regular expression.

-long

l

false

none

N/A

Flag to indicate if the long version of information is required.


A.1.33.4 Examples

Here are some command examples.

A.1.33.4.1 Describe Deployment Plans
$ abctl describeDeploymentPlans -name myAssembly -plan myPlan -long

A.1.34 describeEMAssemblyArchives

Details for this command follow.

A.1.34.1 Synopsis

$ abctl describeEMAssemblyArchives [-name nameOfAssemblyArchive]

A.1.34.2 Description

Describes assembly archives in the EM Software Library.

A.1.34.3 Options

Table A-30 shows the command options for describeEMAssemblyArchives.

Table A-32 describeEMAssemblyArchives options

Name Alias Req'd Default Values Possible Values Description

-name

n

false

.*

Existing assembly archive names.

Name of an assembly or assemblies, specified as a regular expression.


A.1.34.4 Examples

Here are some command examples.

A.1.34.4.1 Describe EM Assembly Archives
$ abctl describeEMAssemblyArchives [-name nameOfAssemblyArchive]

A.1.35 describeEMConnection

Details for this command follow.

A.1.35.1 Synopsis

$ abctl describeEMConnection

A.1.35.2 Description

Describes the configured EM Software Library connection.

A.1.35.3 Options

None.

A.1.35.4 Examples

Here are some command examples.

A.1.35.4.1 Describe EM Connection
$ abctl describeEMConnection

A.1.36 describeEndpoints

Details for this command follow.

A.1.36.1 Synopsis

$ abctl describeEndpoints -name String [-recurse]

A.1.36.2 Description

Lists the endpoints of an appliance or assembly. Specify -recurse to list endpoints of an assembly's sub-appliances and sub-assemblies.

A.1.36.3 Options

Table A-33 shows the command options for describeEndpoints.

Table A-33 describeEndpoints options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

None.

Name of an appliance or assembly.

Name of an appliance or assembly whose endpoints will be listed.

-recurse

r

false

N/A

N/A

If specified, list the endpoints for an assembly's sub-elements instead of endpoints for the assembly itself.


A.1.36.4 Examples

Here are some command examples.

A.1.36.4.1 Describe Endpoints
$ abctl describeEndpoints -name mySite/myWls -r

A.1.37 describeRegistrations

Details for this command follow.

A.1.37.1 Synopsis

$ abctl describeRegistrations [-assembly String] [-version String] -connectionName String

A.1.37.2 Description

This command describes one or more assembly registrations.

A.1.37.3 Options

Table A-34 shows the command options for describeRegistrations.

Table A-34 describeRegistrations options

Name Alias Req'd Default Values Possible Values Description

-assembly

a

false

none

A string representing the name of the assembly.

The name of an assembly.

-version

v

true

none

A string representing the version of the assembly.

Assembly version.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.37.4 Examples

Here are some command examples.

A.1.37.4.1 Describe Registrations
$ abctl describeRegistrations -assembly MyAssembly -version 1

A.1.38 describeRequests

Details for this command follow.

A.1.38.1 Synopsis

$ abctl describeRequests [-requestId String...] -connectionName String

A.1.38.2 Description

This command describes one or more previously issued asynchronous requests.

A.1.38.3 Options

Table A-35 shows the command options for describeRequests.

Table A-35 describeRequests options

Name Alias Req'd Default Values Possible Values Description

-requestId

r

false

none

A string representing the requestId.

The requestId of a previously issued asynchronous request.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.38.4 Examples

Here are some command examples.

A.1.38.4.1 Describe Requests
$ abctl describeRequests

A.1.39 describeScalingGroups

Details for this command follow.

A.1.39.1 Synopsis

$ abctl describeScalingGroups [-assemblyInstanceId String...] [-scalingGroupId String...] -connectionName String

A.1.39.2 Description

Describes one or more scaling groups.

A.1.39.3 Options

Table A-36 shows the command options for describeScalingGroups.

Table A-36 describeScalingGroups options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

false

none

A string representing the assemblyInstanceId.

The identifier of a previously created assembly instance.

-scalingGroupId

s

false

none

A string representing the scalingGroupId.

The identifier of a previously created scaling group.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.39.4 Examples

Here are some command examples.

A.1.39.4.1 Describe Scaling Groups
$ abctl describeScalingGroups -c myDeployerConn

A.1.40 describeTags

Details for this command follow.

A.1.40.1 Synopsis

$ abctl describeTags -resource String [-tag String...] -connectionName String

A.1.40.2 Description

This command describes one or more tags associated with artifacts maintained by the Deployer.

A.1.40.3 Options

Table A-37 shows the command options for describeTags.

Table A-37 describeTags options

Name Alias Req'd Default Values Possible Values Description

-resource

-r

true

none

A string specifying the resource id of the resource.

Specifies the resource for which to get tag information.

-tag

-t

false

none

A string representing the name of the tag.

Specifies one or more tags for which to get the values.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.40.4 Examples

Here are some command examples.

A.1.40.4.1 Describe Tags
$ abctl describeTags -tag foo -resource MyResource

A.1.41 describeTargetConfigurations

Details for this command follow.

A.1.41.1 Synopsis

$ abctl describeTargetConfigurations [-target String...] -connectionName String

A.1.41.2 Description

This command describes one or more target configurations.

A.1.41.3 Options

Table A-38 shows the command options for describeTargetConfigurations.

Table A-38 describeTargetConfigurations options

Name Alias Req'd Default Values Possible Values Description

-target

t

false

none

A string representing the name of the target.

The name of one or more targets.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.41.4 Examples

Here are some command examples.

A.1.41.4.1 Describe Target Configurations
$ abctl describeTargetConfigurations -target MyTarget

A.1.42 describeTargetNames

Details for this command follow.

A.1.42.1 Synopsis

$ abctl describeTargetNames -type String -connectionName String

A.1.42.2 Description

Lists the names of the targets of the type specified.

A.1.42.3 Options

Table A-39 shows the command options for describeTargetNames.

Table A-39 describeTargetNames options

Name Alias Req'd Default Values Possible Values Description

-type

t

true

none

A string representing the type of target. Possible values are exalogic or ovm.

The type of the target.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.42.4 Examples

Here are some command examples.

A.1.42.4.1 Describe Target Names
$ abctl describeTargetNames

A.1.43 describeTargetUsers

Details for this command follow.

A.1.43.1 Synopsis

$ abctl describeTargetUsers -target String -connectionName String

A.1.43.2 Description

Lists the users of the specified target.

A.1.43.3 Options

Table A-40 shows the command options for describeTargetUsers.

Table A-40 describeTargetUsers options

Name Alias Req'd Default Values Possible Values Description

-target

t

true

none

A string representing the name of the target.

The name of the target.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.43.4 Examples

Here are some command examples.

A.1.43.4.1 Describe Target Users
$ abctl describeTargetUsers -target MyTarget

A.1.44 describeTargets

Details for this command follow.

A.1.44.1 Synopsis

$ abctl describeTargets [-target String...] -connectionName String

A.1.44.2 Description

This command describes runtime information for one or more deployment targets.

A.1.44.3 Options

Table A-41 shows the command options for describeTargets.

Table A-41 describeTargets options

Name Alias Req'd Default Values Possible Values Description

-target

t

false

none

A string representing the name of the target.

The name of one or more targets.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.44.4 Examples

Here are some command examples.

A.1.44.4.1 Describe Targets
$ abctl describeTargets

A.1.45 describeUserTargets

Details for this command follow.

A.1.45.1 Synopsis

$ abctl describeUserTargets -user String -connectionName String

A.1.45.2 Description

This command describes one or more types of deployment targets.

A.1.45.3 Options

Table A-42 shows the command options for describeUserTargets.

Table A-42 describeUserTargets options

Name Alias Req'd Default Values Possible Values Description

-user

u

true

none

A string representing the username of the user.

The username of the user.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.45.4 Examples

Here are some command examples.

A.1.45.4.1 Describe User Targets
$ abctl describeUserTargets -user MyUser

A.1.46 describeVnets

Details for this command follow.

A.1.46.1 Synopsis

$ abctl describeVnets -target String [-id String...] -connectionName String

A.1.46.2 Description

This command describes one or more networks in the target environment.

A.1.46.3 Options

Table A-42 shows the command options for describeVnets.

Table A-43 describeVnets options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-id

i

false

none

A string representing the network ID.

The network IDs to describe.

-target

t

true

none

A string representing the target name.

The name of a target whose networks will be described.


A.1.46.4 Examples

Here are some command examples.

A.1.46.4.1 Describe Vnets
$ abctl describeVnets -target myTarget -c myDeployerConn

A.1.47 downloadAssemblyArchive

Details for this command follow.

A.1.47.1 Synopsis

$ abctl downloadAssemblyArchive -name String -version String [-fileName Path] -connectionName String

A.1.47.2 Description

This command downloads an assembly archive from the Deployer repository.

A.1.47.3 Options

Table A-44 shows the command options for downloadAssemblyArchive.

Table A-44 downloadAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the assembly.

The name of the assembly archive.

-version

v

true

none

A string representing the version of the assembly.

The version of the assembly archive.

-fileName

r

true

none

A string representing the new name and/or location of the assembly.

The new name of the assembly archive.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.47.4 Examples

Here are some command examples.

A.1.47.4.1 Download Assembly Archive
$ abctl downloadAssemblyArchive -name MyAssembly -version 1 RenamedAssembly.ova -c myDeployerConn

A.1.48 downloadAssemblyMetadata

Details for this command follow.

A.1.48.1 Synopsis

$ abctl downloadAssemblyMetadata -name String -version String [-fileName Path] [-generatePlan] -connectionName String

A.1.48.2 Description

Downloads assembly metadata descriptor from the Deployer. This allows you to determine what is in the assembly without downloading the entire archive.

A.1.48.3 Options

Table A-45 shows the command options for downloadAssemblyMetadata.

Table A-45 downloadAssemblyMetadata options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-fileName

fn

false

none

An absolute or relative path to a file where the assembly metadata will be written.

The new name of the OVF.

The file name where the assembly metadata will be written. If omitted, the metadata will be saved as <assembly name>.ovf in the current working directory. You may specify an absolute or relative path to a file.

-generatePlan

g

false

none

N/A

If set, generate a default deployment plan. The plan will be generated in the same location where the downloaded metadata is saved.

-name

n

true

none

A string representing the name of the assembly.

The name of the assembly for which a metadata descriptor will be downloaded.

-version

v

true

none

A string representing the version of the assembly.

Assembly version.


A.1.48.4 Examples

Here are some command examples.

A.1.48.4.1 Download Assembly Metadata
$ abctl downloadAssemblyMetadata -name MyAssembly -version 1

A.1.49 downloadDeploymentPlan

Details for this command follow.

A.1.49.1 Synopsis

$ abctl downloadDeploymentPlan -name

A.1.49.2 Description

Downloads a deployment plan from the Deployer.

A.1.49.3 Options

Table A-47 shows the command options for downloadDeploymentPlan.

Table A-46 downloadDeploymentPlan options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Deployment plan name.

Name of deployment plan to download.


A.1.49.4 Examples

Here is a command example.

A.1.49.4.1 Download Deployment Plan
% abctl downloadDeploymentPlan -name MyDeploymentPlan

A.1.50 downloadEMAssemblyArchive

Details for this command follow.

A.1.50.1 Synopsis

$ abctl downloadEMAssemblyArchive -name String -version String [-downloadAs String] [-force]

A.1.50.2 Description

Downloads an assembly archive from the Enterprise Manager Software Library and imports it into the Oracle Virtual Assembly Builder Studio catalog. The assembly archive is reverse engineered to have the Oracle Virtual Assembly Builder metadata, file sets and templates created and persisted in the catalog.

By default, the download fails if an assembly with the same name already exists in the catalog. The -downloadAs option can be used to download an assembly with a different name.

A.1.50.3 Options

Table A-47 shows the command options for downloadEMAssemblyArchive.

Table A-47 downloadEMAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Assembly archive name.

Name of assembly archive to download.

-version

v

true

none

A string representing the version of the assembly archive.

Specifies the version of the assembly archive to download from Enterprise Manager Software Library.

-force

f

false

false

N/A

If set, overwrites an existing assembly in the catalog that has the same name as the imported assembly.

-downloadAs

 

false

none

Assembly archive name.

Name to assign to a downloaded assembly inside the catalog.


A.1.50.4 Examples

Here is a command example.

A.1.50.4.1 downloadEMAssemblyArchive
% abctl downloadEMAssemblyArchive -name archiveName -version 1.0 -force -downloadAs newName

A.1.51 export

Details for this command follow.

A.1.51.1 Synopsis

$ abctl export -name String -toDir Path [-quiet] [-metadataOnly]

A.1.51.2 Description

Exports an appliance or assembly to disk so that it can later be imported to another catalog.

A.1.51.3 Options

Table A-48 shows the command options for export.

Table A-48 export options

Name Alias Req'd Default Values Possible Values Description

-metadataOnly

m

false

none

N/A

Indicates that only the metadata portion of the appliance or assembly will be exported.

-name

n

true

none

Top level appliance or assembly in the catalog. Nested appliances cannot be exported.

Name of a top level appliance or assembly in the catalog.

-quiet

q

false

none

N/A

By default, the command shows detailed progress/success messages. If -quiet is set, the command turns off verbose mode and shows only one or two progress/success messages.

-toDir

td

true

none

A path to a directory. The directory must be empty. A non-existing directory will be created.

Path to the directory to which a specified appliance or assembly will be exported. If a relative path is given, it will be relative to AB_INSTANCE.


A.1.51.4 Examples

Here are some command examples.

A.1.51.4.1 Regular export
$ abctl export -name mySite -toDir /tmp/mySite.export
Executing export to /tmp/mySite.export.
  Step 1 of 4: Copying from source to dest.
    Copying: 100% of   52MB completed.
    Copying: 100% of  690MB completed.
    Copying: 100% of   86MB completed.
    Copying: 100% of   405B completed.
    Copying: 100% of  188MB completed.
    Copying: 100% of  1024B completed.
  Step 2 of 4: Copying from source to dest completed.
  Step 3 of 4: Archiving temporary catalog.
    Zipping: 100% of  138MB completed.
    Copying: 100% of  690MB completed.
    Copying: 100% of  188MB completed.
  Step 4 of 4: Archiving temporary catalog completed.
Successfully exported to /tmp/mySite.export.
A.1.51.4.2 Export with -metadataOnly flag
$ abctl export -name mySite -toDir /tmp/mySite.export -metadataOnly
Executing export to /tmp/mySite.export.
  Step 1 of 2: Archiving temporary catalog.
    Zipping: 100% of  6163B completed.
  Step 2 of 2: Archiving temporary catalog completed.
Successfully exported to /tmp/mySite.export.
A.1.51.4.3 Export to a non-empty directory
$ abctl export -name myOhs -toDir /tmp/non-empty-dir
Executing export to /tmp/non-empty-dir.
Error: OAB-7443: Failed to export myWls to /tmp/non-empty-dir.
Caused by: OAB-09509: Directory is not empty at /tmp/non-empty-dir.
  Action: Clean up the directory, or choose an empty directory.

A.1.52 getDefaultTarget

Details for this command follow.

A.1.52.1 Synopsis

$ abctl getDefaultTarget -connectionName String

A.1.52.2 Description

This command returns the default target.

A.1.52.3 Options

Table A-49 shows the command options for getDefaultTarget.

Table A-49 getDefaultTarget options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.52.4 Examples

Here are some command examples.

A.1.52.4.1 Get Default Target
$ abctl getDefaultTarget -c myDeployerConn

A.1.53 getTargetType

Details for this command follow.

A.1.53.1 Synopsis

$ abctl getTargetType -name String -connectionName String

A.1.53.2 Description

This command returns the type of the target.

A.1.53.3 Options

Table A-50 shows the command options for getTargetType.

Table A-50 getTargetType options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the target

The name of the target.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.


A.1.53.4 Examples

Here are some command examples.

A.1.53.4.1 Get Target Type
$ abctl getTargetType -name MyTarget

A.1.54 help

Details for this command follow.

A.1.54.1 Synopsis

help [[-command] string] [-usage]

A.1.54.2 Description

Prints a brief help message or more detailed help for a specified command.

A.1.54.3 Options

Table A-51 shows the command options for help.

Table A-51 help options

Name Alias Req'd Default Values Possible Values Description

-command

c

false

none

Any command of this utility.

Specifies the command for which Help should be printed.

-usage

u

false

none

N/A

Print only an option summary of the specified command.


A.1.54.4 Examples

Here is an example.

A.1.54.4.1 Print help, help for introspectWLS command and option summary for import command
abctl help, abctl help -command introspectWLS,
abctl help -usage -command import

A.1.55 import

Details for this command follow.

A.1.55.1 Synopsis

$ abctl import -from Path [-quiet] [-importAs String] [-force]

A.1.55.2 Description

Imports an appliance from a specified directory or an assembly from either a specified directory or a specified assembly archive.

A.1.55.3 Options

Table A-51 shows the command options for import.

Table A-52 import options

Name Alias Req'd Default Values Possible Values Description

-from

fr

true

none

An assembly archive file or a directory containing an exported appliance or assembly.

Path to a valid export location or assembly archive file.

-quiet

q

false

none

N/A

By default, the command shows detailed progress/success messages. If -quiet is set, the command turns off verbose mode and shows only one or two progress/success messages.

-importAs

ia

false

none

A unique name among top-level appliances or assemblies in a catalog.

If specified, imported appliancie or assembly will be saved with the given name in the catalog.

-force

f

false

false

N/A

If specified, existing top-level appliance or assembly in catalog using the same name as imported appliance or assembly will be overwritten.


A.1.55.4 Examples

Here are some command examples.

A.1.55.4.1 Import Assembly Archive
$ abctl import -from /tmp/mySite.ova -importAs myNewSite
A.1.55.4.2 Import from an Export Location
$ abctl import -fromDir /tmp/myWls.export -importAs wls_1

A.1.56 introspectCoherenceWeb

Details for this command follow.

A.1.56.1 Synopsis

$ abctl introspectCoherenceWeb -wlsHome Path -domainRoot Path -adminUser String [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]

A.1.56.2 Description

This command is an alias for introspectWLS. It examines the configuration of an installed WebLogic Server domain to determine what file sets must be captured and what configuration must be changed at deployment. All collected data is stored in the catalog upon successful completion.

A.1.56.3 Options

Table A-53 shows the command options for introspectCoherenceWeb.

Table A-53 introspectCoherenceWeb options

Name Alias Req'd Default Values Possible Values Description

-adminUser

au

true

none

N/A

Administrative name for the WebLogic Server domain.

-domainRoot

dr

true

none

N/A

Full path to the WebLogic Server domain root.

-force

f

false

none

N/A

Overwrite any introspection in the catalog that exists with the same name.

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

none

N/A

Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, the remoteUser and remoteHost must be specified as well.

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, the remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the ssh user to use for accessing the remote machine. If set, the remoteHost must be specified as well.

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

Path on the remote machine to work out of. If set, the remoteUser and remoteHost must be specified as well.

-skipFileSetCapture

sf

false

none

N/A

If specified, file sets are not captured for the component during introspection.

-sudoUser

su

false

none

User name of sudo user.

Specifies a sudo user. When specified, remote capturing of file sets or introspection will substitute the user (sudo) as the sudo user before running the remote Assembly Builder.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.

-wlsHome

wh

true

none

N/A

Full path to the WebLogic Server Home, generally <middleware home>/wlserver_10.3


A.1.56.4 Examples

Here is a command example.

A.1.56.4.1 Basic Introspection of a Coherence Appliance

This is a basic introspection of a Coherence appliance to a specific catalog, using a capture name of myIntrospection.

$ abctl introspectCoherenceWeb -name myIntrospection <Coherence options>

A.1.57 introspectForms

Details for this command follow.

A.1.57.1 Synopsis

introspectForms -wlsHome Path -domainRoot Path -adminUser String [-soaGlobalCP Path] [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]

A.1.57.2 Description

This command is an alias for introspectWLS. Examines the configuration of an installed Oracle WebLogic Server domain to determine what file sets needs to be captured and what configuration needs to be changed at deployment.

All collected data is stored in the catalog upon successful completion.

A.1.57.3 Options

Table A-54 shows the command options for introspectForms.

Table A-54 introspectForms options

Name Alias Req'd Default Values Possible Values Description

-adminUser

au

true

none

N/A

Administrative name for the Oracle WebLogic Server domain.

-domainRoot

dr

true

none

N/A

Full path to the Oracle WebLogic Server domain root.

-force

f

false

none

N/A

Overwrite any introspection in the catalog that exists with the same name.

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, remoteUser and remoteHost must be specified as well.

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the SSH user to use for accessing the remote machine. If set, remoteHost must be specified as well.

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

Path on the remote machine to work out of. If set, remoteUser and remoteHost must be specified as well.

-soaGlobalCP

sgcp

false

none

Location of optional global configuration plan.

The absolute path to an optional global configuration plan.

-skipFileSetCapture

sf

false

none

N/A

If specified, file sets are not captured for the component during introspection.

-sudoUser

su

false

none

User name of sudo user.

Specifies a sudo user. When specified, remote capturing of file sets or introspection will substitute the user (sudo) as the sudo user before running the remote Assembly Builder.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.

-wlsHome

wh

true

none

WLS Home

Full path to the Oracle WebLogic Server home (usually, <middleware home>/wlserver_10.3).


A.1.57.4 Examples

Here are some command examples.

A.1.57.4.1 Basic Introspection

This is a basic introspection of a Forms appliance.

abctl introspectForms <Forms options>
A.1.57.4.2 Introspection with a specific capture name

An introspection of component "Forms" saved with an appliance/assembly name of "myIntrospection":

% abctl introspectForms -name myIntrospection <Forms options>

A.1.58 introspectGenericProd

Details for this command follow.

A.1.58.1 Synopsis

$ abctl introspectGenericProd -productRoots String [-propertyFile Path] [-scriptRootDir Path] [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]

A.1.58.2 Description

Captures products generically by taking as input the set of product directories to capture and a set of scripts to run on the appliance instance during deployment operations. Information to create appliance properties, inputs, and outputs can also be captured.

A.1.58.3 Options

Table A-55 shows the command options for introspectGenericProd.

Table A-55 introspectGenericProd options

Name Alias Req'd Default Values Possible Values Description

-force

f

false

none

N/A

Overwrite any introspection in the catalog that exists with the same name.

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-productRoots

pr

true

none

The colon-separated list of product directories to capture.

A list of one or more colon-separated paths. Each path must be a directory that exists. All files and directories within each specified directory are captured as file sets. All specified paths are available at the same locations on the appliance instance during deployment.

-propertyFile

pf

true

none

Properties file containing properties to add to the appliance.

If the propertyFile parameter is specified then it must point to a file that exists and is readable.

A property file must be a text file containing a list of name/value pairs. Each property in the property file will be added as a user property into the appliance. Like any other user property, these properties can be edited in the generated appliance and can be overridden in deployment plans.

During deployment the properties will be written back out to a file, including the values as edited within the appliance or overridden in the deployment plan. The regenerated properties file will be made available to all scripts during their execution through an environment variable named '$AB_USERPROPS_FILE'.

These properties are intended for eventual consumption by the scripts captured through the 'scriptRootDir' parameter. For this reason, the property names and values must be in a format that can be sourced by a shell script.

Each line in a property file must consist of zero or more lines where each line must be a property declaration, a comment, or a blank line. Each property declaration must be equivalent to a variable declaration (name=value) where the name can be converted to an environment variable. Property declarations must be contained on a single line. Ending a line with '\' will not result in line continuation.

Comments and blank lines are discarded at dehydration and will not be reproduced when the file is regenerated at reconfiguration.

All properties will be marked as 'required' in the appliance metadata. Property declarations without any assigned value (nothing after '=') will be set to null in the appliance metadata, requiring that the user assign a value to that property prior to deployment.

Whitespace is not permitted anywhere to the left of '=' in a property declaration. Whitespace to the right of '=' is assumed to be part of the intended value and will be preserved (resulting in failure if the value is sourced).

Quotes around property values will be preserved and will be visible to scripts as part of the value. When editing a property value, it is the responsibility of the user to add/remove/preserve quotes as necessary according to the rules of shell interpretation.

-remoteCleanup

rc

false

none

N/A

Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, the remoteUser and remoteHost must be specified as well.

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, the remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the ssh user to use for accessing the remote machine. If set, the remoteHost must be specified as well.

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

Path on the remote machine to work out of. If set, the remoteUser and remoteHost must be specified as well.

-scriptRootDir

srd

false

none

The top level directory containing the script subdirectories.

The script root directory is the top level directory containing the script subdirectories. If the specified directory does not exist or is not readable then an error will be returned and an appliance will not be created.

Scripts must be placed within the root script directory under the following well-known subdirectories: config.d/, start.d/, ping.d/, stop.d/. Scripts under each subdirectory will be captured during introspection and stored with the appliance. During deployment the appropriate set of scripts according to the requested operation will be executed sequentially.

The script root directory need not contain all well-known subdirectories and well-known subdirectories that do exist may be empty.

All scripts are executed as the root user to provide the flexibility of performing operations requiring root privileges or switching to another user as necessary.

The path to a properties file containing the variables specified at introspection will be made available during script execution through the '$AB_USERPROPS_FILE' environment variable. This file can be sourced by the script.

All scripts must exit with a zero exit status upon success. Any script exiting with a non-zero exit status will result in the failure of the operation.

-skipFileSetCapture

sf

false

none

N/A

If specified, file sets are not captured for the component during introspection.

-sudoUser

su

false

none

User name of sudo user.

Specifies a sudo user. When specified, remote capturing of file sets or introspection will substitute the user (sudo) as the sudo user before running the remote Assembly Builder.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.


A.1.58.4 Examples

Here is a command example.

A.1.58.4.1 Basic Introspection of Appliance "GenericProd"

This is a basic introspection of appliance Coherence to a specific catalog, using a capture name of myIntrospection.

$ abctl introspectGenericProd <GenericProd options>
A.1.58.4.2 Basic Introspection of Appliance "GenericProd"

This is an introspection of a generic appliance saved with an appliance/assembly name of "myIntrospection".

$ abctl introspectGenericProd -name myIntrospection <GenericProd options>

A.1.59 introspectOHS

Details for this command follow.

A.1.59.1 Synopsis

introspectOHS -oracleInstance Path -componentName String [-name string] [-force] 
[-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] 
[-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]

A.1.59.2 Description

Examines the configuration of an installed OHS component to determine what file sets must be captured and what configuration must be changed at deployment. All collected data is stored in the catalog upon successful completion.

A.1.59.3 Options

Table A-56 shows the command options for introspectOHS.

Table A-56 introspectOHS options

Name Alias Req'd Default Values Possible Values Description

-componentName

cn

true

none

N/A

The name of the Oracle HTTP Server appliance to introspect (for example: ohs1).

-force

f

false

none

N/A

Overwrite any introspection in the catalog that exists with the same name.

-name

n

false

Derived directory name prefixed by component type name

Any name not previously used within the catalog

Specifies a name by which the introspection output is stored.

-oracleInstance

oi

true

none

N/A

The absolute path of the ORACLE_INSTANCE to introspect.

-privateKeyFile

pkf

false

none

Location of a private key file.

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, remoteUser and remoteHost must be specified as well.

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the SSH user to use for accessing the remote machine. If set, remoteHost must be specified as well.

-remoteWorkingDir

rwd

false

/tmp/abRemote

N/A

Path on the remote machine to work out of. If set, remoteUser and remoteHost must be specified as well.

-skipFileSetCapture

sf

false

none

N/A

If specified, file sets are not captured for the component during introspection.

-sudoUser

su

false

none

User name of sudo user.

Name of the user on the remote machine to sudo as before executing operations.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.


A.1.59.4 Examples

Here are some command examples.

A.1.59.4.1 Successful Introspection
% abctl introspectOHS -name myOHS -oracleInstance /ora/inst1 -componentName ohs1
Launching introspection of appliance 'OHS' ...
  Step 1 of 5: OHS introspection starting
    Step 1 of 4: OHS Httpd Configuration parsed
    Step 2 of 4: OHS Httpd configuration transformed
    Step 3 of 4: OHS Httpd configuration processed
    Step 4 of 4: OHS Httpd configuration written
  Step 2 of 5: HTTPD processing completed
    Step 1 of 3: OHS OPMN configuration parsed
    Step 2 of 3: OHS OPMN configuration processed
    Step 3 of 3: OHS OPMN configuration writtend
  Step 3 of 5: OPMN XML processing completed
    Step 1 of 2: OHS opmnctl script parsed
    Step 2 of 2: Appliance updated with ORACLE_HOME
  Step 4 of 5: OPMNCTL processing completed
  Step 5 of 5: OHS introspection complete
Task is done: DehydrateJob completed
Introspection complete
Storing result in catalog: '/Oracle/IntrospectionCatalog' ...
Introspection stored as 'myohs' in the catalog
%
A.1.59.4.2 Failed Introspection

bad -oracleInstance value

% abctl introspectOHS -oracleInstance /ora/dontexist -componentName foobar
Launching introspection of appliance 'OHS' ...
  Step 1 of 5: OHS task starting
Task is done: DehydrateJob failed with error: The specified Oracle Instance does not exist.
Error: Introspection failed
Caused by: The specified Oracle Instance does not exist.
%

A.1.60 introspectOTD

Details for this command follow.

A.1.60.1 Synopsis

introspectOTD -oracleHome Path -oracleInstance Path -configName String [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]

A.1.60.2 Description

Examines the configuration of an installed Oracle Traffic Director configuration to determine what file sets need to be captured and what configuration needs to be changed at deployment. All collected data is stored in the catalog upon successful completion. Note that Oracle Traffic Director administration server will not be introspected and will be recreated from scratch during reconfiguration.

A.1.60.3 Options

Table A-57 shows the command options for introspectOTD.

Table A-57 introspectOTD options

Name Alias Req'd Default Values Possible Values Description

-configName

cn

true

none

Name of the Oracle Traffic Director configuration.

Specifies the name of an Oracle Traffic Director configuration which needs to be introspected.

-force

f

false

none

N/A

Overwrite any introspection in the catalog that exists with the same name.

-name

n

false

Derived directory name prefixed by component type name

Any name not previously used within the catalog

Specifies a name by which the introspection output is stored.

-oracleHome

oh

true

none

The directory where Oracle Traffic Director is installed.

Specify the absolute path to the directory where Oracle Traffic Director is installed.

-oracleInstance

oi

true

none

N/A

The absolute path of the ORACLE_INSTANCE to introspect.

-privateKeyFile

pkf

false

none

Location of a private key file.

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, remoteUser and remoteHost must be specified as well.

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the SSH user to use for accessing the remote machine. If set, remoteHost must be specified as well.

-remoteWorkingDir

rwd

false

/tmp/abRemote

N/A

Path on the remote machine to work out of. If set, remoteUser and remoteHost must be specified as well.

-skipFileSetCapture

sf

false

none

N/A

If specified, file sets are not captured for the component during introspection.

-sudoUser

su

false

none

User name of sudo user.

Name of the user on the remote machine to sudo as before executing operations.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.


A.1.60.4 Examples

Here are some command examples.

A.1.60.4.1 Basic Introspection
% abctl introspectOTD <OTD options>
A.1.60.4.2 Introspection of appliance "OTD" saved with the name "myIntrospection"
% abctl introspectOTD -name myIntrospection <OTD options>

A.1.61 introspectRACDB

Details for this command follow.

A.1.61.1 Synopsis

introspectRACDB -crsHome Path -dbHome Path [-globalDbName String] [-sysDBAUserName String] -shutdownDBOK String [-asmHome Path] [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]

A.1.61.2 Description

Examines CRS and RAC Database configuration and captures metadata.

A.1.61.3 Options

Table A-58 shows the command options for introspectRACDB.

Table A-58 introspectRACDB options

Name Alias Req'd Default Values Possible Values Description

-asmHome

ch

false

none

N/A

This parameter is required if ASM is used as the storage type and it is installed in a separate Oracle Home.

-crsHome

ch

true

none

N/A

The ORACLE_HOME of the Oracle CRS to be introspected.

-dbHome

dh

true

none

N/A

The ORACLE_HOME of the Oracle RDBMS to be introspected.

-globalDbName

dun

false

value specified for -oracleSid

N/A

The global database name of the Oracle RDBMS to be introspected.

-force

f

false

none

N/A

Overwrite any introspection in the catalog that exists with the same name.

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

none

N/A

Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, remoteUser and remoteHost must be specified as well.

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the ssh user to use for accessing the remote machine. If set, remoteHost must be specified as well.

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

Path on the remote machine to work out of. If set, remoteUser and remoteHost must be specified as well.

-shutdownDBOK

sdbok

true

none

N/A

This flag needs to be passed to approve the database reboot.

-skipFileSetCapture

sf

false

none

N/A

If specified, file sets are not captured for the component during introspection.

-sysDBAUserName

sdbaun

false

none

N/A

Database account with SYSDBA privileges. This parameter is required only if OS authentication is disabled for the current database.

-sudoUser

su

false

none

User name of sudo user.

Specifies a sudo user. When specified, remote capture of file sets or introspection will substitute the user (sudo) as the sudo user before running the remote Assembly Builder.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.


A.1.61.4 Examples

Here are some command examples.

A.1.61.4.1 Basic Introspection

This is a basic introspection of a single-instance DB appliance.

abctl introspectRACDB <DB options>
A.1.61.4.2 Introspection into a specific catalog with a specific capture name
% abctl introspectRACDB -name myIntrospection <DB options>

A.1.62 introspectReports

Details for this command follow.

A.1.62.1 Synopsis

introspectReports -wlsHome Path -domainRoot Path -adminUser String [-soaGlobalCP Path] [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]

A.1.62.2 Description

This command is an alias for introspectWLS. Examines the configuration of an installed Oracle WebLogic Server domain to determine what file sets needs to be captured and what configuration needs to be changed at deployment.

All collected data is stored in the catalog upon successful completion.

A.1.62.3 Options

Table A-61 shows the command options for introspectReports.

Table A-59 introspectReports options

Name Alias Req'd Default Values Possible Values Description

-adminUser

au

true

none

N/A

Administrative name for the Oracle WebLogic Server domain.

-domainRoot

dr

true

none

N/A

Full path to the Oracle WebLogic Server domain root.

-force

f

false

none

N/A

Overwrite any introspection in the catalog that exists with the same name.

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, remoteUser and remoteHost must be specified as well.

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the SSH user to use for accessing the remote machine. If set, remoteHost must be specified as well.

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

Path on the remote machine to work out of. If set, remoteUser and remoteHost must be specified as well.

-soaGlobalCP

sgcp

false

none

Location of optional global configuration plan.

The absolute path to an optional global configuration plan.

-skipFileSetCapture

sf

false

none

N/A

If specified, file sets are not captured for the component during introspection.

-sudoUser

su

false

none

User name of sudo user.

Specifies a sudo user. When specified, remote capturing of file sets or introspection will substitute the user (sudo) as the sudo user before running the remote Assembly Builder.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.

-wlsHome

wh

true

none

WLS Home

Full path to the Oracle WebLogic Server home (usually, <middleware home>/wlserver_10.3).


A.1.62.4 Examples

Here are some command examples.

A.1.62.4.1 Basic Introspection

This is a basic introspection of a Reports appliance.

abctl introspectReports <Reports options>
A.1.62.4.2 Introspection with a specific capture name

An introspection of component "Reports" saved with an appliance/assembly name of "myIntrospection":

% abctl introspectReports -name myIntrospection <Reports options>

A.1.63 introspectSIDB

Details for this command follow.

A.1.63.1 Synopsis

introspectSIDB -dbHome Path -oracleSid String [-name String] [-force] [-noing] [-remoteHost String] [-remoteUser String] [-remoteWorkingDir Path] -shutdownDBOK String [-remoteCleanup] [-dataFileDir Path] [-flashRecoveryDir Path] [-sudoUser]

A.1.63.2 Description

Examines single-instance Oracle database (releases 10.2, 11.1, 11.2) configuration and captures metadata.

A.1.63.3 Options

Table A-60 shows the command options for introspectSIDB.

Table A-60 introspectSIDB options

Name Alias Req'd Default Values Possible Values Description

-dataFileDir

dfd

false

DB 10.2 release: <Parent directory of $ORACLE_HOME>/oradata

DB 11.1 and 11.2 release: $ORACLE_BASE/oradata

N/A

The full path of the database files. This parameter is required if your database file directory is different from the default.

-dbHome

dh

true

none

N/A

The ORACLE_HOME of the Oracle RDBMS to be introspected.

-flashRecoveryDir

frd

false

DB 10.2 release: <Parent directory of $ORACLE_HOME>/flash_recovery_area

DB 11.1 release: $ORACLE_BASE/flash_recovery_area

DB 11.2 release: $ORACLE_BASE/recovery_area

N/A

The full path of the database flash recovery files. This parameter is required if your recovery area is different from the default. If you do not have a recovery area, you can ignore this parameter.

-force

f

false

none

N/A

Overwrite any introspection in the catalog that exists with the same name.

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored

-oracleSid

os

true

none

N/A

The SID of the Oracle RDBMS to be introspected.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

none

N/A

Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, remoteUser and remoteHost must be specified as well.

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the ssh user to use for accessing the remote machine. If set, remoteHost must be specified as well.

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

Path on the remote machine to work out of. If set, remoteUser and remoteHost must be specified as well.

-shutdownDBOK

sdbok

true

none

N/A

This flag needs to be passed to approve the database reboot.

-skipFileSetCapture

sf

false

none

N/A

If specified, file sets are not captured for the component during introspection.

-sudoUser

su

false

none

User name of sudo user.

Specifies a sudo user. When specified, remote capture of file sets or introspection will substitute the user (sudo) as the sudo user before running the remote Assembly Builder.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.


A.1.63.4 Examples

Here are some command examples.

A.1.63.4.1 Basic Introspection

This is a basic introspection of a single-instance DB appliance.

abctl introspectSIDB <DB options>
A.1.63.4.2 Introspection into a specific catalog with a specific capture name
% abctl introspectSIDB -name myIntrospection <DB options>

A.1.64 introspectSOA

Details for this command follow.

A.1.64.1 Synopsis

introspectSOA -wlsHome Path -domainRoot Path -adminUser String [-soaGlobalCP Path] [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]

A.1.64.2 Description

This command is an alias for introspectWLS. Examines the configuration of an installed Oracle WebLogic Server domain to determine what file sets need to be captured and what configuration needs to be changed at deployment. All collected data is stored in the catalog upon successful completion.

A.1.64.3 Options

Table A-61 shows the command options for introspectSOA.

Table A-61 introspectSOA options

Name Alias Req'd Default Values Possible Values Description

-adminUser

au

true

none

N/A

Administrative name for the Oracle WebLogic Server domain.

-domainRoot

dr

true

none

N/A

Full path to the Oracle WebLogic Server domain root.

-force

f

false

none

N/A

Overwrite any introspection in the catalog that exists with the same name.

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, remoteUser and remoteHost must be specified as well.

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the SSH user to use for accessing the remote machine. If set, remoteHost must be specified as well.

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

Path on the remote machine to work out of. If set, remoteUser and remoteHost must be specified as well.

-soaGlobalCP

sgcp

false

none

Location of optional global configuration plan.

The absolute path to an optional global configuration plan.

-skipFileSetCapture

sf

false

none

N/A

If specified, file sets are not captured for the component during introspection.

-sudoUser

su

false

none

User name of sudo user.

Specifies a sudo user. When specified, remote capturing of file sets or introspection will substitute the user (sudo) as the sudo user before running the remote Assembly Builder.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.

-wlsHome

wh

true

none

WLS Home

Full path to the Oracle WebLogic Server home (usually, <middleware home>/wlserver_10.3).


A.1.64.4 Examples

Here are some command examples.

A.1.64.4.1 Basic Introspection

This is a basic introspection of a single-instance DB appliance.

abctl introspectSOA <SOA options>
A.1.64.4.2 Introspection with a specific capture name
% abctl introspectSOA -name myIntrospection <SOA options>

A.1.65 introspectTuxedo

Details for this command follow.

A.1.65.1 Synopsis

introspectTuxedo -TUXDIR Path -TUXCONFIG Path [-environmentScript Path] [-oracleClientDir Path] [-tnsNamesLocation Path] [-artCICSAppHome Path]  [-artBatchSecurityProfile Path] [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]

A.1.65.2 Description

Examines a single or multiple-machine Oracle Tuxedo domain, and the Oracle Home Directory that it resides on (including add-ons).

A.1.65.3 Options

Table A-62 shows the command options for introspectTuxedo.

Table A-62 introspectTuxedo options

Name Alias Req'd Default Values Possible Values Description

-artCICSBatchHome

acicsah

false

none

N/A

The absolute path to the ART CICS Application Home.

-artBatchSecurityProfile

absp

false

none

N/A

The absolute path to the security_profile for ART Batch.

-environmentScript

es

false

none

The absolute path to the environment script of the application to introspect

The absolute path to the script that sets the environment of the Tuxedo application to introspect.

-force

f

false

none

N/A

Overwrite any introspection in the catalog that exists with the same name.

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-oracleClientDir

ocd

false

none

The absolute path to the Oracle Database Client software.

The absolute path to the location where the Oracle Database Client software is installed.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, remoteUser and remoteHost must be specified as well.

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the SSH user to use for accessing the remote machine. If set, remoteHost must be specified as well.

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

Path on the remote machine to work out of. If set, remoteUser and remoteHost must be specified as well.

-soaGlobalCP

sgcp

false

none

Location of optional global configuration plan.

The absolute path to an optional global configuration plan.

-skipFileSetCapture

sf

false

none

N/A

If specified, file sets are not captured for the component during introspection.

-sudoUser

su

false

none

User name of sudo user.

Specifies a sudo user. When specified, remote capturing of file sets or introspection will substitute the user (sudo) as the sudo user before running the remote Assembly Builder.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.

-tnsNamesLocation

tnl

false

none

The absolute path to the TNSNAMES.ora file.

The absolute path to the location of the TNSNAMES.ora file.

-TUXDIR

tuxdir

true

none

N/A

The absolute path to the TUXDIR to introspect.

-TUXCONFIG

tuxconfig

true

none

N/A

The absolute path to the TUXCONFIG file of the application to introspect.


A.1.65.4 Examples

Here are some command examples.

A.1.65.4.1 Basic Introspection

This is a basic introspection of a single-instance DB appliance.

abctl introspectTuxedo <Tuxedo options>
A.1.65.4.2 Introspection with a specific capture name
% abctl introspectTuxedo -name myIntrospection <Tuxedo options>

A.1.66 introspectWebCache

Details for this command follow.

A.1.66.1 Synopsis

$ abctl introspectWebCache -oracleInstance Path -componentName String [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]

A.1.66.2 Description

Examines the configuration of an installed Web Cache component and records what must be captured as file sets, and what must be configured during deployment. All collected data is stored in the catalog upon successful completion.

A.1.66.3 Options

Table A-63 shows the command options for introspectWebCache.

Table A-63 introspectWebCache options

Name Alias Req'd Default Values Possible Values Description

-componentName

cn

true

none

N/A

The name of the Web Cache component to introspect.

-force

f

false

none

N/A

Overwrite any introspection in the catalog that exists with the same name.

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-oracleInstance

oi

true

none

N/A

The absolute path of the ORACLE_INSTANCE to introspect.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, remoteUser and remoteHost must be specified as well.

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the SSH user to use for accessing the remote machine. If set, remoteHost must be specified as well.

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

Path on the remote machine to work out of. If set, remoteUser and remoteHost must be specified as well.

-skipFileSetCapture

sf

false

none

N/A

If specified, file sets are not captured for the component during introspection.

-sudoUser

su

false

none

User name of sudo user.

Specifies a sudo user. When specified, remote capturing of file sets or introspection will substitute the user (sudo) as the sudo user before running the remote Assembly Builder.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.


A.1.66.4 Examples

Here are some command examples.

A.1.66.4.1 Basic introspection of Web Cache appliance to the default catalog and allowing introspection to choose a default capture name within the catalog
$  introspectWebCache <WebCache options>
A.1.66.4.2 Introspection of Web Cache appliance put into a specific catalog under a capture name of "web cache"
abctl introspectWebCache -name webcache -oracleInstance
/oracle/instances/instance1 -componentName webcache1
 
Launching introspection of appliance 'WebCache' ...
Step 1 of 9: Webcache task starting
Step 9 of 9: Webcache task complete
Task is done: DehydrateJob completed
Introspection complete
Storing result in catalog ...
backup needed
Introspection stored as 'webcache' in the catalog
A.1.66.4.3 Introspection with incorrect component Name
abctl introspectWebCache -name webcache -oracleInstance
 /bea/Oracle_WT1/instances/instance1/ -componentName webcache2
Launching introspection of appliance 'WebCache' ...
Task is done: DehydrateJob failed with error: Unable to find file: /bea/Oracle_WT1/instances/instance1/config/WebCache/webcache2/webcache.xml
Error: Introspection failed
Caused by: Unable to find file: /bea/Oracle_WT1/instances/instance1/config/WebCache/webcache2/webcache.xml

A.1.67 introspectWLS

Details for this command follow.

A.1.67.1 Synopsis

introspectWLS -wlsHome Path -domainRoot Path -adminUser String [-soaGlobalCP Path] [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]

A.1.67.2 Description

Examines the configuration of an installed WebLogic Server component to determine what file sets must be captured and what configuration must be changed at deployment. All collected data is stored in the catalog upon successful completion.

A.1.67.3 Extensions

The CoherenceWeb, SOACoherence, and SOA extensions are available as alias commands.

A.1.67.4 CoherenceWeb Extension Description

Inspects and captures Coherence cluster and cache server configuration that is defined within a WebLogic domain configuration. This extension supports the out-of-process deployment topology in which cache servers run in their own processes.

A.1.67.5 SOACoherence Extension Description

Inspects and captures Coherence configuration specified within SOA managed server start arguments to enable SOA cluster high availability.

A.1.67.6 SOA Extension Description

Oracle SOA platform plug-in. Examines the configuration of an installed Oracle WebLogic Server domain to determine what file sets need to be captured and what configuration needs to be changed at deployment.

A.1.67.7 Options

Table A-64 shows the command options for introspectWLS.

Table A-64 introspectWLS options

Name Alias Req'd Default Values Possible Values Description

-adminUser

au

true

none

N/A

Administrative name for the WebLogic Server domain.

-domainRoot

dr

true

none

N/A

Full path to the WebLogic Server domain root.

-force

f

false

none

N/A

Overwrite any introspection in the catalog that exists with the same name.

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, remoteUser and remoteHost must be specified as well.

-remoteHost

rh

false

none

N/A

Host name or IP address and optional SSH port of the remote machine. If set, remoteUser must be specified as well.

-remoteUser

ru

false

none

N/A

Name of the SSH user to use for accessing the remote machine. If set, remoteHost must be specified as well.

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

Path on the remote machine to work out of. If set, remoteUser and remoteHost must be specified as well.

-skipFileSetCapture

sf

false

none

N/A

If specified, file sets are not captured for the component during introspection.

-soaGlobalCP

sgcp

false

none

Location of optional global configuration plan.

The absolute path to an optional global configuration plan.

-sudoUser

su

false

none

User name of sudo user.

Specifies a sudo user. When specified, remote capturing of file sets or introspection will substitute the user (sudo) as the sudo user before running the remote Assembly Builder.

If sudoUser is specified, you cannot use the privateKeyFile. That is, sudoUser can only be used when you provide a password.

-wlsHome

wh

true

none

WLS Home

Full path to the Oracle WebLogic Server home (usually, <middleware home>/wlserver_10.3).


A.1.67.8 Examples

Here are some command examples.

A.1.67.8.1 Successful Introspection:

local execution with use of all options

% abctl introspectWLS -name myWlsCapture
-wlsHome /ora/mw/wlserver_10.3 -domainRoot /ora/mw/user_projects/domains/MyDomain -adminUser weblogic
Launching introspection of appliance 'WLS' ...
  Step 1 of 3: WLS dehydration starting. Due to domain template creation this may take some time
    Step 1 of 15: WlsAssemblyBuilder has started creating the AssemblyBuilder
      Step 1 of 2: Capturing Node Manager configuration.
      Step 2 of 2: Node Manager capture complete.
    Step 12 of 15: Processor: 10 completed
    Step 15 of 15: WlsAssemblyBuilder has completed the AssemblyBuilder
  Step 2 of 3: WLS Assembly is completed
  Step 3 of 3: WLS dehydration completed
Task is done: DehydrateJob completed
Introspection complete
Storing result in catalog: ...
Introspection stored as 'myWlsCapture' in the catalog
%
A.1.67.8.2 Successful Introspection:

local execution with all defaults and short names

% abctl introspectWLS -adminUser weblogic -wh /ora/mw/wlserver_10.3 
-dr /ora/mw/user_projects/domains/MyDomain
Launching introspection of appliance 'WLS' ...
  Step 1 of 3: WLS dehydration starting. Due to domain template creation this may take some time
    Step 1 of 15: WlsAssemblyBuilder has started creating the AssemblyBuilder
      Step 1 of 2: Capturing Node Manager configuration.
      Step 2 of 2: Node Manager capture complete.
    Step 12 of 15: Processor: 10 completed
    Step 15 of 15: WlsAssemblyBuilder has completed the AssemblyBuilder
  Step 2 of 3: WLS Assembly is completed
  Step 3 of 3: WLS dehydration completed
Task is done: DehydrateJob completed
Introspection complete
Storing result in catalog: '/ora/ab/catalog' ...
Introspection stored as 'WLS-1256089687424' in the catalog
%
A.1.67.8.3 Missing -wlsHome Parameter
% abctl introspectWLS -domainRoot
/ora/mw/user_projects/domains/MyDomain
Error: missing required parameter 'wlsHome'
 
Command usage:
 
introspectWLS [-name string]
   [-remoteHost string] [-remotePort numeric] [-remoteUser string]
   [-remoteWorkingDir path] -wlsHome path -domainRoot path
 
Try 'abctl help -command introspectWLS' for detailed help of the command.
 
%
A.1.67.8.4 Bad -domainRoot path
$ abctl introspectWLS -adminUser weblogic -wlsHome /scratch/aime1/Oracle/Middleware/wlserver_10.3/ -domainRoot /tmp/foobar -name test
Enter 'Admin Password':
Launching introspection of appliance 'WLS' ...
 Step 1 of 3: Started WLS dehydration (expect delays during domain template creation)..
Task is done: Dehydration failed with error: The domainRoot specified does not exist..
Error: OAB-7105: Introspection failed.
Caused by: OAB-50005: The domainRoot specified does not exist.

A.1.68 redeployAssemblyInstance

Details for this command follow.

A.1.68.1 Synopsis

$ abctl redeployAssemblyInstance -assemblyInstanceId String -connectionName String [-waitForComplete] [-pollTime String]

A.1.68.2 Description

Redeploys an assembly instance, and is equivalent to performing an undeployAssemblyInstance followed by a deployAssemblyInstance.

A.1.68.3 Options

Table A-65 shows the command options for redeployAssemblyInstance.

Table A-65 redeployAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to redeploy.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-pollTime

pt

false

5

A string representing the number of seconds.

Specifies the amount of time to wait for an asynchronous operation to complete successfully.

-waitForComplete

w

false

no

N/A

Specifies whether to wait for an asynchronous operation to complete successfully.


A.1.68.4 Examples

Here are some command examples.

A.1.68.4.1 Redeploy Deployment
$ abctl redeployAssemblyInstance -assemblyInstanceId MyId

A.1.69 registerAssemblyArchive

Details for this command follow.

A.1.69.1 Synopsis

$ abctl registerAssemblyArchive -name String [-version String] [-target String] -connectionName String [-waitForComplete] [-pollTime String]

A.1.69.2 Description

Registers an assembly archive in the Deployer.

A.1.69.3 Options

Table A-66 shows the command options for registerAssemblyArchive.

Table A-66 registerAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-name

n

true

none

A string representing the name of the assembly archive.

The name of the assembly archive.

-pollTime

pt

false

5

A string representing the number of seconds.

Specifies the amount of time to wait for an asynchronous operation to complete successfully.

-target

t

false

none

A string representing the name of the target.

The name of the target.

-version

v

false

none

A string representing the version of the assembly archive.

The version of the assembly archive.

-waitForComplete

w

false

no

N/A

Specifies whether to wait for an asynchronous operation to complete successfully.


A.1.69.4 Examples

Here are some command examples.

A.1.69.4.1 Register Assembly Archive
$ abctl registerAssemblyArchive -connectionName MyDeployerConnection -name TheAssembly -version 1

A.1.70 removeAssemblyUsers

Details for this command follow.

A.1.70.1 Synopsis

$ abctl removeAssemblyUsers -assembly String -user String... -connectionName String

A.1.70.2 Description

Removes one or more users from an assembly.

A.1.70.3 Options

Table A-68 shows the command options for removeAssemblyUsers.

Table A-67 getDefaultTarget options

Name Alias Req'd Default Values Possible Values Description

-assembly

a

false

none

A string representing the name of the assembly archive.

Specifies the assembly to remove users from.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-user

u

true

none

A string representing the usernames of the users to remove from an assembly archive.

The usernames of the users to remove from an assembly archive.


A.1.70.4 Examples

Here are some command examples.

A.1.70.4.1 Remove Assembly Users
$ abctl removeAssemblyUsers -assembly MyAssembly -user User1 User2

A.1.71 removeTargetUsers

Details for this command follow.

A.1.71.1 Synopsis

$ abctl removeTargetUsers -user String... -target String -connectionName String

A.1.71.2 Description

This command removes a user from the target.

A.1.71.3 Options

Table A-68 shows the command options for removeTargetUsers.

Table A-68 getDefaultTarget options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-target

t

true

none

A string representing the target to add the user to.

The target to add the user to.

-user

u

true

none

A string representing the usernames of the users to remove from the target

The usernames of the users to remove from the target.


A.1.71.4 Examples

Here are some command examples.

A.1.71.4.1 Remove Target Users
$ abctl removeTargetUsers -user Username -target Targetname

A.1.72 restartAssemblyInstance

Details for this command follow.

A.1.72.1 Synopsis

$ abctl restartAssemblyInstance -assemblyInstanceId String -connectionName String [-waitForComplete] [-pollTime String]

A.1.72.2 Description

This command restarts an assembly instance, and is equivalent to performing a stopAssemblyInstance followed by a startAssemblyInstance.

A.1.72.3 Options

Table A-69 shows the command options for restartAssemblyInstance.

Table A-69 restartAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to be restarted.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-pollTime

t

false

5

A string representing the number of seconds.

Specifies the amount of time to wait for an asynchronous operation to complete successfully.

-waitForComplete

w

false

no

N/A

Specifies whether to wait for an asynchronous operation to complete successfully.


A.1.72.4 Examples

Here are some command examples.

A.1.72.4.1 Restart Deployment
$ abctl restartAssemblyInstance -assemblyInstanceId MyId

A.1.73 scale

Details for this command follow.

A.1.73.1 Synopsis

$ abctl scale -scalingGroupId String -target String -connectionName String [-waitForComplete] [-pollTime String]

A.1.73.2 Description

Scales a scaling group to a new size.

A.1.73.3 Options

Table A-70 shows the command options for scale.

Table A-70 scale options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-pollTime

pt

false

5

A string representing the number of seconds.

Specifies the amount of time to wait for an asynchronous operation to complete successfully.

-scalingGroupId

s

true

none

A string representing the scalingGroupId.

The scalingGroupId of a scalingGroup.

-target

t

true

none

A string representing the new target.

The new value to scale to.

-waitForComplete

w

false

no

N/A

Specifies whether to wait for an asynchronous operation to complete successfully.


A.1.73.4 Examples

Here are some command examples.

A.1.73.4.1 Scale a Scaling Group
$ abctl scale -scalingGroupId FOO -target 4

A.1.74 setDefaultTarget

Details for this command follow.

A.1.74.1 Synopsis

$ abctl setDefaultTarget -name String -connectionName String

A.1.74.2 Description

This command sets a target as the default.

A.1.74.3 Options

Table A-71 shows the command options for setDefaultTarget.

Table A-71 setDefaultTarget options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-name

n

true

none

A string representing the name of the target.

The name of the target.


A.1.74.4 Examples

Here are some command examples.

A.1.74.4.1 Set Default Target
$ abctl setDefaultTarget -name MyTarget

A.1.75 startAssemblyInstance

Details for this command follow.

A.1.75.1 Synopsis

$ abctl startAssemblyInstance -assemblyInstanceId String -connectionName String [-waitForComplete] [-pollTime String]

A.1.75.2 Description

Starts an assembly instance.

A.1.75.3 Options

Table A-72 shows the command options for startAssemblyInstance.

Table A-72 startAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to be started.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-pollTime

pt

false

5

A string representing the number of seconds.

Specifies the amount of time to wait for an asynchronous operation to complete successfully.

-waitForComplete

w

false

no

N/A

Specifies whether to wait for an asynchronous operation to complete successfully.


A.1.75.4 Examples

Here are some command examples.

A.1.75.4.1 Start Assembly Instance
$ abctl startAssemblyInstance

A.1.76 stopAssemblyInstance

Details for this command follow.

A.1.76.1 Synopsis

$ abctl stopAssemblyInstance -assemblyInstanceId String [-force] -connectionName String [-waitForComplete] [-pollTime String]

A.1.76.2 Description

This command stops a deployment for an assembly instance.

A.1.76.3 Options

Table A-73 shows the command options for stopAssemblyInstance.

Table A-73 stopAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to be stopped.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-force

f

false

none

True/false.

Flag to indicate if local cleanup should be done even if the resource manager is not available.

-pollTime

pt

false

5

A string representing the number of seconds.

Specifies the amount of time to wait for an asynchronous operation to complete successfully.

-waitForComplete

w

false

no

N/A

Specifies whether to wait for an asynchronous operation to complete successfully.


A.1.76.4 Examples

Here are some command examples.

A.1.76.4.1 Stop Assembly Instance
$ abctl stopAssemblyInstance

A.1.77 undeployAssemblyInstance

Details for this command follow.

A.1.77.1 Synopsis

$ abctl undeployAssemblyInstance -assemblyInstanceId String -connectionName String [-waitForComplete] [-pollTime String]

A.1.77.2 Description

Undeploys an assembly instance.

A.1.77.3 Options

Table A-74 shows the command options for undeployAssemblyInstance.

Table A-74 undeployAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

d

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to undeploy.

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-pollTime

pt

false

5

A string representing the number of seconds.

Specifies the amount of time to wait for an asynchronous operation to complete successfully.

-waitForComplete

w

false

no

N/A

Specifies whether to wait for an asynchronous operation to complete successfully.


A.1.77.4 Examples

Here are some command examples.

A.1.77.4.1 Undeploy Assembly Instance
$ abctl undeployAssemblyInstance -assemblyInstanceId MyId

A.1.78 unregisterAssemblyArchive

Details for this command follow.

A.1.78.1 Synopsis

$ abctl unregisterAssemblyArchive -name String [-version String] [-target String] -connectionName String [-waitForComplete] [-pollTime String]

A.1.78.2 Description

This command unregisters an assembly from the Deployer.

A.1.78.3 Options

Table A-75 shows the command options for unregisterAssemblyArchive.

Table A-75 unregisterAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-name

n

true

none

A string representing the name of the assembly archive.

The name of the assembly archive.

-pollTime

pt

false

5

A string representing the number of seconds.

Specifies the amount of time to wait for an asynchronous operation to complete successfully.

-target

t

false

none

A string representing the name of the target.

The name of the target.

-version

v

false

none

A string representing the version of the assembly archive.

The version of the assembly archive.

-waitForComplete

w

false

no

N/A

Specifies whether to wait for an asynchronous operation to complete successfully.


A.1.78.4 Examples

Here are some command examples.

A.1.78.4.1 Unregister Assembly Archive
$ abctl unregisterAssemblyArchive -name TheAssembly -version 1

A.1.79 updateAssemblyArchive

Details for this command follow.

A.1.79.1 Synopsis

$ abctl updateAssemblyArchive -name String -version String -description String -connectionName String

A.1.79.2 Description

This command updates the description (attributes) of an assembly archive in the Deployer.

A.1.79.3 Options

Table A-76 shows the command options for updateAssemblyArchive.

Table A-76 updateAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-description

d

true

none

A string representing the description of the assembly archive.

The description of the assembly archive.

-name

n

true

none

A string representing the name of the assembly archive.

The name of the assembly archive.

-version

v

true

none

A string representing the version of the assembly archive.

The version of the assembly archive.


A.1.79.4 Examples

Here are some command examples.

A.1.79.4.1 Update Assembly Archive
$ abctl updateAssemblyArchive -name MyAssembly -version 1 -description NewDescription

A.1.80 updateTarget

Details for this command follow.

A.1.80.1 Synopsis

$ abctl updateTarget -name String [-properties String...] -connectionName String

A.1.80.2 Description

Updates property values.

A.1.80.3 Options

Table A-77 shows the command options for updateTarget.

Table A-77 updateTarget options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-name

n

true

none

A string representing the name of the target.

The name of the target.

-properties

p

false

none

A string representing the properties and values to update.

A set of key=value pairs representing the property and its new value.

For an Oracle Exalogic environment, you can only set the operation timeout, exalogic.vmOperationTimeout.

The operation timeout defines how long the Deployer waits for operations it executes against the IaaS backend before it considers the operation failed.

Most Deployer operations involve multiple backend operations and the timeout applies to each one individually. For example if the timeout is 900 seconds, every disk copy is given 900 seconds to complete. This allows you to attempt to tune the value based on the performance of your system rather than how many artifacts are in each assembly.


A.1.80.4 Examples

Here are some command examples.

A.1.80.4.1 Update Target
$ abctl updateTarget -name MyTarget -properties prop=newvalue

A.1.81 uploadAssemblyArchive

Details for this command follow.

A.1.81.1 Synopsis

$ abctl uploadAssemblyArchive -fileName Path -name String [-description String] -connectionName String

A.1.81.2 Description

Uploads an assembly archive to Oracle Virtual Assembly Builder Deployer.

A.1.81.3 Options

Table A-78 shows the command options for uploadAssemblyArchive.

Table A-78 uploadAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the name of the connection to the Deployer.

The name of a connection to the Deployer.

-fileName

fn

true

none

A string representing the file path to the assembly archive on disk.

Uploads an assembly archive to the Deployer.

-name

n

true

none

A string representing the name of the assembly archive.

The name of the assembly archive.

-description

d

false

none

A string representing the description of the assembly archive.

The description of the assembly archive.


A.1.81.4 Examples

Here are some command examples.

A.1.81.4.1 Upload Assembly Archive
$ abctl uploadAssemblyArchive -fileName=c:/mySite.ova -name TheAssembly -version 1

A.1.82 uploadEMAssemblyArchive

Details for this command follow.

A.1.82.1 Synopsis

$ abctl uploadEMAssemblyArchive -name String -[description String]

A.1.82.2 Description

Uploads an assembly archive to the Enterprise Manager Software Library. The assembly can only be a top-level assembly, and the assembly archive must be created for the assembly.

A.1.82.3 Options

Table A-79 shows the command options for uploadEMAssemblyArchive.

Table A-79 uploadEMAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Top level appliance or assembly in the catalog.

Name of a top level appliance or assembly in the catalog.

-description

d

false

none

Textual description.

A description of the assembly and assembly archive.


A.1.82.4 Examples

Here is a command example.

A.1.82.4.1 uploadEMAssemblyArchive
% abctl uploadEMAssemblyArchive -name archiveName -description "my assembly archive" 

A.1.83 version

Details for this command follow.

A.1.83.1 Synopsis

$ abctl version

A.1.83.2 Description

Displays the Oracle Virtual Assembly Builder specification version.

A.1.83.3 Example

$ abctl version

A.2 Help

Details for this command follow.

A.2.1 Synopsis

$ abctl help [-command String] [-category] [-usage] 

A.2.2 Description

With no parameters, the help command displays a list of help categories that you can query to obtain the list of available commands along with the brief description of each command.

When the -all option is specified, the help command lists all available commands with a short description of each command. When a command name is specified, then detailed Help about the specified command is printed. When a command name is specified and the -usage parameter is specified, just the synopsis (argument usage) is printed.

When the -category option is specified, the help command lists the commands available under that category. Commands may appear under more than one category.

A.2.3 Options

Table A-80 shows the command options for help.

Table A-80 help options

Name Alias Req'd Default Values Possible Values Description

-command

c

false

none

Name of a command.

Name of one of the commands listed when help is invoked without arguments. If specified, then detailed help information about the specified command is provided.

-usage

u

false

none

 

Not valid when the -command parameter is not specified. When this flag is specified only synopsis details are provided about the corresponding specified command.

-category

c

false

none

 

When this flag is specified, the help command lists the commands available under the specified category.

-quiet

q

false

none

N/A

By default, the command shows detailed progress/success messages. If -quiet is set, the command turns off verbose mode and shows only one or two progress/success messages.


A.2.4 Examples

Here are some command examples.

A.2.4.1 No Arguments

$ abctl help
 
Usage: abctl command [options]
 
Command                 Description
------------------------------------------------------------------------------
abctl help all             List all commands.abctl help catalog         Manage appliances and assemblies.abctl help deployer        Setup and manage OVAB Deployer.abctl help deployments     Deploy and manage assembly deployments.abctl help EM              Manage assemblies in EM Software Library.abctl help general         General help commands.abctl help introspection   Capture product installations.abctl help targets         Configure and manage deployment targets.
 
Try "abctl help -command cmd_name" for detailed help of a specific command.
 

A.2.4.2 Specifying Help on a Category of Commands

$ abctl help catalog
 
Usage: abctl command [options]
 
Command                 Description
------------------------------------------------------------------------------
addToAssembly            Adds an appliance or assembly to an assembly.connectEndpoints         Create a new connection between two endpoints.createAssembly           Creates a new empty assembly.createAssemblyArchive    Creates an assembly archive.createExternalResources  Creates and connects external resources for                          unconnected outputs.createTemplate           Creates an appliance template.delete                   Deletes an appliance or assembly.describeCatalog          Lists appliances and assemblies in the catalog.describeEndpoints        Lists endpoints of an appliance or assembly.export                   Exports an appliance or assembly to disk.import                   Imports an appliance or assembly from disk.
 
Try "abctl help <command>" for detailed help of a specific command.
 

A.2.4.3 Help with a -command parameter specified

$ abctl help -command captureFileSets
 
NAME
 
captureFileSets
 
SYNOPSIS
 
captureFileSets -name String [-remoteHost String] [-remoteUser String] \ [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] \ [-privateKeyFile Path] [-quiet] [-force]
 
DESCRIPTION
 
Creates file sets for specified appliance or assembly.
 
OPTIONS
 
Name: remoteHost
Aliases: rh
Type: String
Required: false
Value description: String
Default value: 
Possible values: 
Description: Host name or IP address and optional SSH port of the remote
    machine.  If specified, the remoteUser must be specified as well.
 
Name: remoteUser
Aliases: ru
Type: String
Required: false
Value description: String
Default value: 
Possible values: 
Description: Name of the SSH user to use for accessing the remote machine.  If
    specified, the remoteHost must be specified as well.

...

EXAMPLES
 
abctl captureFileSets -name myOhs -force

A.2.4.4 Help with a -command parameter specified and -usage flag specified

$ abctl help -command captureFileSets -usage
 
Command usage:
 
captureFileSets -name String [-remoteHost String] [-remoteUser String] \ [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] \ [-privateKeyFile Path] [-quiet] [-force]
 
Try 'abctl help -command captureFileSets' for detailed help of the command.