This appendix contains information about the abctl commands included in Oracle Virtual Assembly Builder.
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 | |
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
|
No |
Yes |
Yes |
|
|
Yes |
Yes |
Yes |
|
Details for this command follow.
Table A-2 shows the command options for addAssemblyUsers.
Table A-2 addAssemblyUsers options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
true |
none |
A string representing the name of the assembly. |
Specifies the assembly to which to add users |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
u |
true |
none |
A string representing the username(s) to add. |
Specifies one or more users to add to an assembly. |
Details for this command follow.
$ abctl addTargetUser -user String -target String [-properties String...] -connectionName String
Table A-3 shows the command options for addTargetUser.
Table A-3 addTargetUser options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
u |
true |
none |
A string representing the username of the user. |
The username of the user. |
|
|
t |
true |
none |
A string representing the target to which the user is being added. |
The target to which a user is being added. |
|
|
p |
false |
none |
A string representing property=value pairs to apply to the user. |
The properties to apply to the user. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Table A-4 shows the command options for addToAssembly.
Table A-4 addToAssembly options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
The name of an existing appliance or atomic assembly. |
The name of an existing appliance or atomic assembly to add. |
|
|
i |
true |
none |
The name of a non-atomic assembly. |
The name of an existing assembly to populate. |
Details for this command follow.
$ abctl captureFileSets -name String [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path] [-quiet] [-force]
Table A-6 shows the command options for captureFileSets.
Table A-5 captureFileSets options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, the |
|
|
ru |
false |
none |
N/A |
Name of the ssh user to use for accessing the remote machine. If set, the |
|
|
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. |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, the |
|
|
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 |
|
|
pkf |
false |
~/.ssh/id_rsa |
Location of a private key file. |
Private SSH key file on the local machine. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
|
|
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. |
|
|
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. |
Details for this command follow.
$ abctl connectEndpoints -from String -fromOutput String -to String -toInput String
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.
Table A-6 shows the command options for connectEndpoints.
Table A-6 connectEndpoints options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
f |
true |
none |
Name of appliance or assembly. |
The name of an appliance or assembly to connect from. |
|
|
fout |
true |
none |
Appliance output or assembly output. |
Appliance output or assembly output to connect from. |
|
|
t |
true |
none |
Name of appliance or assembly. |
The name of an appliance or assembly to connect to. |
|
|
tin |
true |
none |
Appliance input or assembly input. |
Appliance input or assembly input to connect to. |
Details for this command follow.
Creates a new assembly in the catalog if one does not already exist by the specified name.
Table A-7 shows the command options for createAssembly.
Table A-7 createAssembly options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
Name of the new assembly. |
Name of a new assembly to be created. |
|
|
dn |
false |
none |
Name of the default vNet. |
If specified, specifies the name to use for the assembly's default vNet. |
|
|
f |
false |
none |
N/A |
If |
Details for this command follow.
$ abctl createAssemblyArchive -name String -platform String [-noCompress] [-force] [-quiet]
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.
Table A-9 shows the command options for createAssemblyArchive.
Table A-8 createAssemblyArchive options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
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. |
|
|
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. |
|
|
f |
false |
false |
N/A |
If specified, any existing assembly archive will be overridden. If no archive exists, this flag has no effect. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
Details for this command follow.
$ abctl createAssemblyInstance -deploymentPlan Path -name String -version String [-target String] -connectionName String
Table A-9 shows the command options for createAssemblyInstance.
Table A-9 createAssemblyInstance options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
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. |
|
|
n |
true |
none |
A string representing the name of the assembly. |
The name of the assembly. |
|
|
v |
true |
none |
A string representing the version of the assembly. |
Assembly version. |
|
|
t |
false |
none |
A string representing the name of the target. |
The name of the target. |
|
|
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. |
Details for this command follow.
$ abctl createDeployerConnection -name String -url String [-username String] [-noReviewCert]
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.
Table A-10 shows the command options for createDeployerConnection.
Table A-10 createDeployerConnection options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
A string representing the name of the Deployer connection. |
The name of the Deployer connection. |
|
|
u |
true |
none |
A string representing the URL of the Deployer Web service. |
The URL of the Deployer. |
|
|
un |
false |
none |
A string representing the username. |
The username to use to authenticate with the Deployer Web service. |
|
|
nr |
false |
none |
N/A |
If set, do not present the HTTPS connection certificate for approval. |
Details for this command follow.
$ abctl createEmConnection -connectionURL emMachine:port -connectionUser admin -namedHostCredential hostCredential -remoteUser mySshUser -remoteWorkingDir myRemoteWorkingDir [-sshPort port] [-privateKeyFile ~/.ssh/id_rsa]
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.
Table A-11 shows the command options for createEMConnection.
Table A-11 createEMConnection options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
Hostname:port. |
URL for connecting to EM Software Library. |
|
|
cu |
true |
none |
Valid EM Software Library User. |
User for EM Software Library. |
|
|
n |
true |
none |
Valid Named Host Credential. |
Named Host Credential. |
|
|
ru |
true |
none |
Valid SSH user. |
SSH user for connecting to the machine where the EM Software Library is located. |
|
|
s |
false |
none |
Valid SSH port number. |
SSH port for EM Software Library machine. |
|
|
pkf |
false |
none |
~/.ssh/id_rsa, id_rsa |
Local private SSH key file used for SSH to the remote EM Software Library machine. |
|
|
rwd |
true |
|
/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 |
Details for this command follow.
$ abctl createExternalResources -from String [-fromOutput String] [-name String] [-recurse]
Creates external resources for each of an appliance's or assembly's unconnected outputs.
Table A-12 shows the command options for createExternalResources.
Table A-12 createExternalResources options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
f |
true |
none |
Appliance or assembly name. |
Name of the appliance or assembly for which you want to external resources. |
|
|
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. |
|
|
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 |
|
|
r |
false |
none |
N/A |
If specified, create external resources for each of an assembly's sub-elements. |
Details for this command follow.
Table A-13 shows the command options for createTags.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
t |
true |
none |
A set of name=value pairs specifying the tags. |
Specifies one or more tags to tag a resource with. |
|
|
r |
true |
none |
A string specifying the resource id of the object to tag. |
Specifies one or more resources to apply a tag to. |
|
|
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. |
Details for this command follow.
$ abctl createTarget -name String -type String -connectionName String [-properties String...] [-default]
Creates a deployment target. This command is enabled for Oracle VM targets, but disabled for Oracle Exalogic. The single target in an Oracle Exalogic installation is preconfigured and cannot be changed.
The following are required and optional properties for the createTarget command. (The asterisks (*) indicate a required property):
ovm [ovm.url*, ovm.poolName*, ovm.user*, ovm.pwd*, ovm.vmmversion*, ovm.
vmOperationTimeout]
Oracle recommends that you configure your target connections for Oracle VM 3 with TCP instead of HTTP protocol.
To configure with TCP, specify a URL of the form "tcp://their-ovm-host:54321".
Table A-14 shows the command options for createTarget.
Table A-14 createTarget options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
A string representing the name of the target. |
The name of the target. |
|
|
t |
true |
none |
A string representing the type of target. Possible value is |
The type of assembly instance target. |
|
|
p |
false |
none |
A string representing property=value pairs to set on the target. |
The properties to set on the target. |
|
|
d |
false |
false |
N/A |
If set, indicates that this target is the default target. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
$ abctl createTemplate -name String -platform String [-quiet] [-baseImage Path] [-force]
Table A-15 shows the command options for createTemplate.
Table A-15 createTemplate options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
bi |
false |
If not specified, the command attempts to locate the base image from |
Path to a valid base image. |
Path to a valid base image used to create an appliance template. |
|
|
f |
false |
false |
N/A |
If |
|
|
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. |
|
|
p |
true |
none |
OVM, Exalogic |
Target platform for which the appliance template is built. |
|
|
q |
false |
false |
N/A |
By default, the command shows detailed progress/success messages. If |
Examples for this command follow.
$ 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.
$ 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.
$ 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.
Details for this command follow.
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, registered appliances or assemblies cannot be deleted.
Table A-16 shows the command options for delete.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
Name of the top-level appliance or assembly. |
Name of the top-level appliance or assembly to be deleted. |
|
|
o |
false |
none |
N/A |
If specified, delete only the assembly archive, leaving the rest of the assembly intact. |
Here are some command examples.
$ 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.
$ abctl delete -name myOhs Executing delete command. Successfully deleted myOhs.
Details for this command follow.
$ abctl deleteAssemblyArchive -name String [-version String] -connectionName String
This command deletes an assembly from the Deployer. This operation may only be performed if there are no registrations for the assembly archive.
Table A-17 shows the command options for deleteAssemblyArchive.
Table A-17 deleteAssemblyArchive options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
A string representing the name of the assembly. |
Name of an assembly in the Deployer. |
|
|
v |
false |
The default is the latest version number assigned by the Deployer. |
A string representing the version of the assembly. |
Specifies the version of the assembly to delete from the Deployer. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Deletes an assembly instance.
This operation can only be executed when the assembly instance is in an undeployed state.
Table A-18 shows the command options for deleteAssemblyInstance.
Table A-18 deleteAssemblyInstance options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
d |
true |
none |
A string representing the |
The identifier of an assembly instance to be deleted. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Deletes a connection to the Deployer, and removes the connection from the connections file.
Details for this command follow.
Deletes the specified version of an assembly archive from the Enterprise Manager Software Library.
Table A-20 shows the command options for deleteEMAssemblyArchive.
Table A-20 deleteEMAssemblyArchive options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
Name of assembly archive |
Name of assembly archive to delete from the EM Software Library. |
|
|
v |
true |
none |
1.0, 1.2, 2.0, etc. |
Version of an assembly archive to delete from the EM Software Library. |
Details for this command follow.
$ abctl deleteFailedApplianceInstances -applianceId String -applianceInstanceIds String... -connectionName String
Table A-21 shows the command options for deleteFailedAssemblyInstances.
Table A-21 deleteFailedAssemblyInstances options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
true |
none |
A string representing the ID of the appliance. |
The ID of the appliance. |
|
|
ai |
true |
none |
A string representing the IDs of the appliances. |
The IDs of the appliance instances in a failed state to delete. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Table A-67 shows the command options for deleteRequests.
Table A-22 deleteRequests options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
d |
false |
none |
A string representing the |
The |
Details for this command follow.
Table A-23 shows the command options for deleteTags.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
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. |
|
|
t |
true |
none |
A set of name=value pairs specifying the tags. |
Specifies one or more tags to remove from a resource. |
Details for this command follow.
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.
Table A-24 shows the command options for deleteTarget.
Table A-24 deleteTarget options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
A string representing the name of the target. |
The name of the target. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
$ abctl deployAssemblyInstance -assemblyInstanceId String -connectionName String [-waitForComplete] [-pollTime String]
Table A-25 shows the command options for deployAssemblyInstance.
Table A-25 deployAssemblyInstance options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
true |
none |
A string representing the |
The identifier of an assembly instance to be deployed. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
w |
false |
no |
N/A |
Specifies whether to wait for an asynchronous operation to complete successfully. |
|
|
pt |
false |
5 |
A string representing the number of seconds. |
Specifies the amount of time to wait for an asynchronous operation to complete successfully. |
Details for this command follow.
$ abctl describeApplianceInstances [-assemblyInstanceId String...] [-applianceInstanceId String...] [-applianceIndex String...] -connectionName String
Table A-26 shows the command options for describeApplianceInstances.
Table A-26 describeApplianceInstances options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
as |
false |
none |
A string representing the assemblyInstanceId. |
One or more |
|
|
ap |
false |
none |
A string representing the |
One or more |
|
|
ai |
false |
none |
A string representing the |
One or more |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Table A-27 shows the command options for describeAssemblyArchives.
Table A-27 describeAssemblyArchives options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
false |
none |
A list of the assemblies to describe. |
Specifies the assemblies to describe. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
$ abctl describeAssemblyInstances [-assemblyInstanceId String...] -connectionName String
Table A-28 shows the command options for describeAssemblyInstances.
Table A-28 describeAssemblyInstances options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
false |
none |
A comma-separated list of assembly instance IDs. |
Identifiers of one or more assembly instances to be described. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Table A-28 shows the command options for describeAssemblyUsers.
Table A-29 describeAssemblyUsers options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
false |
none |
A string representing the name of the assembly. |
Specifies the assembly whose users will be described. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Table A-30 shows the command options for describeCatalog.
Table A-30 describeCatalog options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
l |
false |
N/A |
N/A |
Lists information with maximum detail. Included for compatibility only. |
|
|
n |
false |
None. |
Name of an appliance or assembly. Nested appliances or assemblies are referred to with slash ('/'), for example: |
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. |
Details for this command follow.
Details for this command follow.
Table A-31 shows the command options for describeDeploymentPlans.
Table A-32 describeDeploymentPlan options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
false |
.* |
Any regular expression. |
Name of an assembly or assemblies, specified as a regular expression. |
|
|
p |
false |
.* |
Any regular expression. |
Name of a plan or plans. It is specified as a regular expression. |
|
|
l |
false |
none |
N/A |
Flag to indicate if the long version of information is required. |
Details for this command follow.
Details for this command follow.
Lists the endpoints of an appliance or assembly. Specify -recurse to list endpoints of an assembly's sub-appliances and sub-assemblies.
Table A-34 shows the command options for describeEndpoints.
Table A-34 describeEndpoints options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
None. |
Name of an appliance or assembly. |
Name of an appliance or assembly whose endpoints will be listed. |
|
|
r |
false |
N/A |
N/A |
If specified, list the endpoints for an assembly's sub-elements instead of endpoints for the assembly itself. |
Details for this command follow.
$ abctl describeRegistrations [-assembly String] [-version String] -connectionName String
Table A-35 shows the command options for describeRegistrations.
Table A-35 describeRegistrations options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
false |
none |
A string representing the name of the assembly. |
The name of an assembly. |
|
|
v |
true |
none |
A string representing the version of the assembly. |
Assembly version. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Table A-36 shows the command options for describeRequests.
Table A-36 describeRequests options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
r |
false |
none |
A string representing the |
The |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
$ abctl describeScalingGroups [-assemblyInstanceId String...] [-scalingGroupId String...] -connectionName String
Table A-37 shows the command options for describeScalingGroups.
Table A-37 describeScalingGroups options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
false |
none |
A string representing the |
The identifier of a previously created assembly instance. |
|
|
s |
true |
none |
A string representing the |
The identifier of a previously created scaling group. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
This command describes one or more tags associated with artifacts maintained by the Deployer.
Table A-38 shows the command options for describeTags.
Table A-38 describeTags options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
-r |
true |
none |
A string specifying the resource id of the resource. |
Specifies the resource for which to get tag information. |
|
|
-t |
false |
none |
A string representing the name of the tag. |
Specifies one or more tags for which to get the values. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Table A-39 shows the command options for describeDeployer.
Table A-39 describeDeployer options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
t |
false |
none |
A string representing the name of the target. |
The name of one or more targets. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Table A-40 shows the command options for describeTargetNames.
Table A-40 describeTargetNames options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
t |
true |
none |
A string representing the type of target. Possible values are |
The type of the target. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Table A-41 shows the command options for describeTargetUsers.
Table A-41 describeTargetUsers options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
t |
true |
none |
A string representing the name of the target. |
The name of the target. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Table A-42 shows the command options for describeTargets.
Table A-42 describeTargets options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
t |
false |
none |
A string representing the name of the target. |
The name of one or more targets. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Table A-43 shows the command options for describeUserTargets.
Table A-43 describeUserTargets options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
u |
true |
none |
A string representing the username of the user. Possible values are |
The username of the user. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Table A-43 shows the command options for describeVnets.
Table A-44 describeVnets options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
i |
false |
none |
A string representing the network ID. |
The network IDs to describe. |
|
|
t |
true |
none |
A string representing the target name. |
The name of a target whose networks will be described. |
Details for this command follow.
$ abctl downloadAssemblyArchive -name String -version String [-fileName Path] -connectionName String
Table A-45 shows the command options for downloadAssemblyArchive.
Table A-45 downloadAssemblyArchive options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
A string representing the name of the assembly. |
The name of the assembly archive. |
|
|
v |
true |
none |
A string representing the version of the assembly. |
The version of the assembly archive. |
|
|
r |
true |
none |
A string representing the new name and/or location of the assembly. |
The new name of the assembly archive. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
$ abctl downloadAssemblyMetadata -name String -version String [-fileName Path] [-generatePlan] -connectionName String
Downloads assembly metadata descriptor from the Deployer. This allows you to determine what is in the assembly without downloading the entire archive.
Table A-46 shows the command options for downloadAssemblyMetadata.
Table A-46 downloadOVF options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
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. |
|
|
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. |
|
|
n |
true |
none |
A string representing the name of the assembly. |
The name of the assembly for which a metadata descriptor will be downloaded. |
|
|
v |
true |
none |
A string representing the version of the assembly. |
Assembly version. |
Details for this command follow.
$ abctl downloadEMAssemblyArchive -name String -version String [-downloadAs String] [-force]
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.
Table A-47 shows the command options for downloadEMAssemblyArchive.
Table A-47 downloadEMAssemblyArchive options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
Assembly archive name. |
Name of assembly archive to download. |
|
|
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. |
|
|
f |
false |
false |
N/A |
If set, overwrites an existing assembly in the catalog that has the same name as the imported assembly. |
|
|
false |
none |
Assembly archive name. |
Name to assign to a downloaded assembly inside the catalog. |
Details for this command follow.
Exports an appliance or assembly to disk so that it can later be imported to another catalog.
Table A-48 shows the command options for export.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
m |
false |
none |
N/A |
Indicates that only the metadata portion of the appliance or assembly will be exported. |
|
|
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. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
|
|
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. |
Here are some command examples.
$ 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.
$ 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.
$ 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.
Details for this command follow.
Details for this command follow.
Table A-50 shows the command options for getTargetType.
Table A-50 getTargetType options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
A string representing the name of the target |
The name of the target. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
Details for this command follow.
Imports an appliance from a specified directory or an assembly from either a specified directory or a specified assembly archive.
Table A-51 shows the command options for import.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
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. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
|
|
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. |
|
|
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. |
Details for this command follow.
$ abctl importExternalTemplate -fromDir Path -name String -platform String [-quiet] [-skipValidation] [-force]
Imports an existing virtual machine template located at the specified directory into the catalog as an external appliance.
Table A-53 shows the command options for importExternalTemplate.
Table A-53 importExternalTemplate options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
|
|
fd |
true |
none |
Directory containing the VM template. |
Path to the directory containing the VM template. |
|
|
n |
true |
none |
A name that will be unique among top-level appliances or assemblies in a catalog. |
If set, the imported template will be saved as the given name in the target catalog. |
|
|
p |
true |
false |
A string representing any valid platform supported by the product. |
Target platform for the imported external appliance. |
|
|
s |
false |
false |
N/A |
If specified, platform-specific validation will not be performed before importing the template. |
|
|
f |
false |
false |
N/A |
If specified, existing top-level appliance or assembly in catalog using the same name as imported external appliance will be overwritten. |
Details for this command follow.
$ abctl introspectCoherenceWeb -wlsHome Path -domainRoot Path -adminUser String [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]
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.
Table A-54 shows the command options for introspectCoherenceWeb.
Table A-54 introspectCoherenceWeb options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
au |
true |
none |
N/A |
Administrative name for the WebLogic Server domain. |
|
|
dr |
true |
none |
N/A |
Full path to the WebLogic Server domain root. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same 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. |
|
|
pkf |
false |
none |
N/A |
Private SSH key file on the local machine. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, the remoteUser and remoteHost must be specified as well. |
|
|
sf |
false |
none |
N/A |
If specified, file sets are not captured for the component during introspection. |
|
|
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. |
|
|
wh |
true |
none |
N/A |
Full path to the WebLogic Server Home, generally |
Details for this command follow.
introspectForms -wlsHome Path -domainRoot Path -adminUser String [-soaGlobalCP Path] [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]
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.
Table A-55 shows the command options for introspectForms.
Table A-55 introspectForms options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
au |
true |
none |
N/A |
Administrative name for the Oracle WebLogic Server domain. |
|
|
dr |
true |
none |
N/A |
Full path to the Oracle WebLogic Server domain root. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same 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. |
|
|
pkf |
false |
none |
N/A |
Private SSH key file on the local machine. |
|
|
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, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the SSH user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
|
|
sgcp |
false |
none |
Location of optional global configuration plan. |
The absolute path to an optional global configuration plan. |
|
|
sf |
false |
none |
N/A |
If specified, file sets are not captured for the component during introspection. |
|
|
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. |
|
|
wh |
true |
none |
WLS Home |
Full path to the Oracle WebLogic Server home (usually, < |
Details for this command follow.
$ abctl introspectGenericProd -productRoots String [-propertyFile Path] [-scriptRootDir Path] [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]
Captures products generically by taking as input the set of product directories to capture, a set of properties that can be modified by the user, and a set of scripts to run on the appliance instance during deployment operations.
Table A-56 shows the command options for introspectGenericProd.
Table A-56 introspectGenericProd options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same 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. |
|
|
pkf |
false |
none |
N/A |
Private SSH key file on the local machine. |
|
|
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. |
|
|
pf |
true |
none |
Properties file containing properties to add to the appliance. |
If the 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 ' These properties are intended for eventual consumption by the scripts captured through the ' 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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, the remoteUser and remoteHost must be specified as well. |
|
|
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: 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 ' 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. |
|
|
sf |
false |
none |
N/A |
If specified, file sets are not captured for the component during introspection. |
|
|
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. |
Details for this command follow.
introspectOHS -oracleInstance Path -componentName String [-name string] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]
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.
Table A-57 shows the command options for introspectOHS.
Table A-57 introspectOHS options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
cn |
true |
none |
N/A |
The name of the Oracle HTTP Server appliance to introspect (for example: |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same 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. |
|
|
oi |
true |
none |
N/A |
The absolute path of the ORACLE_INSTANCE to introspect. |
|
|
pkf |
false |
none |
Location of a private key file. |
Private SSH key file on the local machine. |
|
|
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, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the SSH user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
|
|
sf |
false |
none |
N/A |
If specified, file sets are not captured for the component during introspection. |
|
|
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. |
Here are some command examples.
% 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
%
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. %
Details for this command follow.
introspectOTD -oracleHome Path -oracleInstance Path -configName String [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]
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.
Table A-58 shows the command options for introspectOTD.
Table A-58 introspectOTD options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
cn |
true |
none |
Name of the Oracle Traffic Director configuration. |
Specifies the name of an Oracle Traffic Director configuration which needs to be introspected. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same 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. |
|
|
oh |
true |
none |
The directory where Oracle Traffic Director is installed. |
Specify the absolute path to the directory where Oracle Traffic Director is installed. |
|
|
oi |
true |
none |
N/A |
The absolute path of the ORACLE_INSTANCE to introspect. |
|
|
pkf |
false |
none |
Location of a private key file. |
Private SSH key file on the local machine. |
|
|
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, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the SSH user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
|
|
sf |
false |
none |
N/A |
If specified, file sets are not captured for the component during introspection. |
|
|
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. |
Details for this command follow.
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]
Table A-59 shows the command options for introspectRACDB.
Table A-59 introspectRACDB options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
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. |
|
|
ch |
true |
none |
N/A |
The ORACLE_HOME of the Oracle CRS to be introspected. |
|
|
dh |
true |
none |
N/A |
The ORACLE_HOME of the Oracle RDBMS to be introspected. |
|
|
dun |
false |
value specified for -oracleSid |
N/A |
The global database name of the Oracle RDBMS to be introspected. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same 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 |
|
|
pkf |
false |
none |
N/A |
Private SSH key file on the local machine. |
|
|
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, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the ssh user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
|
|
sdbok |
true |
none |
N/A |
This flag needs to be passed to approve the database reboot. |
|
|
sf |
false |
none |
N/A |
If specified, file sets are not captured for the component during introspection. |
|
|
sdbaun |
false |
none |
N/A |
Database account with SYSDBA privileges. This parameter is required only if OS authentication is disabled for the current database. |
|
|
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. |
Details for this command follow.
introspectReports -wlsHome Path -domainRoot Path -adminUser String [-soaGlobalCP Path] [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]
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.
Table A-62 shows the command options for introspectReports.
Table A-60 introspectReports options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
au |
true |
none |
N/A |
Administrative name for the Oracle WebLogic Server domain. |
|
|
dr |
true |
none |
N/A |
Full path to the Oracle WebLogic Server domain root. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same 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. |
|
|
pkf |
false |
none |
N/A |
Private SSH key file on the local machine. |
|
|
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, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the SSH user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
|
|
sgcp |
false |
none |
Location of optional global configuration plan. |
The absolute path to an optional global configuration plan. |
|
|
sf |
false |
none |
N/A |
If specified, file sets are not captured for the component during introspection. |
|
|
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. |
|
|
wh |
true |
none |
WLS Home |
Full path to the Oracle WebLogic Server home (usually, < |
Details for this command follow.
introspectSIDB -dbHome Path -oracleSid String [-name String] [-force] [-noing] [-remoteHost String] [-remoteUser String] [-remoteWorkingDir Path] -shutdownDBOK String [-remoteCleanup] [-dataFileDir Path] [-flashRecoveryDir Path] [-sudoUser]
Examines single-instance Oracle database (releases 10.2, 11.1, 11.2) configuration and captures metadata.
Table A-61 shows the command options for introspectSIDB.
Table A-61 introspectSIDB options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
dfd |
false |
DB 10.2 release: DB 11.1 and 11.2 release: |
N/A |
The full path of the database files. This parameter is required if your database file directory is different from the default. |
|
|
dh |
true |
none |
N/A |
The ORACLE_HOME of the Oracle RDBMS to be introspected. |
|
|
frd |
false |
DB 10.2 release: DB 11.1 release: DB 11.2 release: |
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. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same 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 |
|
|
os |
true |
none |
N/A |
The SID of the Oracle RDBMS to be introspected. |
|
|
pkf |
false |
none |
N/A |
Private SSH key file on the local machine. |
|
|
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, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the ssh user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
|
|
sdbok |
true |
none |
N/A |
This flag needs to be passed to approve the database reboot. |
|
|
sf |
false |
none |
N/A |
If specified, file sets are not captured for the component during introspection. |
|
|
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. |
Details for this command follow.
introspectSOA -wlsHome Path -domainRoot Path -adminUser String [-soaGlobalCP Path] [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]
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.
Table A-62 shows the command options for introspectSOA.
Table A-62 introspectSOA options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
au |
true |
none |
N/A |
Administrative name for the Oracle WebLogic Server domain. |
|
|
dr |
true |
none |
N/A |
Full path to the Oracle WebLogic Server domain root. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same 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. |
|
|
pkf |
false |
none |
N/A |
Private SSH key file on the local machine. |
|
|
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, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the SSH user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
|
|
sgcp |
false |
none |
Location of optional global configuration plan. |
The absolute path to an optional global configuration plan. |
|
|
sf |
false |
none |
N/A |
If specified, file sets are not captured for the component during introspection. |
|
|
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. |
|
|
wh |
true |
none |
WLS Home |
Full path to the Oracle WebLogic Server home (usually, < |
Details for this command follow.
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]
Examines a single or multiple-machine Oracle Tuxedo domain, and the Oracle Home Directory that it resides on (including add-ons).
Table A-63 shows the command options for introspectTuxedo.
Table A-63 introspectTuxedo options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
acicsah |
false |
none |
N/A |
The absolute path to the ART CICS Application Home. |
|
|
absp |
false |
none |
N/A |
The absolute path to the security_profile for ART Batch. |
|
|
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. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same 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. |
|
|
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. |
|
|
pkf |
false |
none |
N/A |
Private SSH key file on the local machine. |
|
|
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, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the SSH user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
|
|
sgcp |
false |
none |
Location of optional global configuration plan. |
The absolute path to an optional global configuration plan. |
|
|
sf |
false |
none |
N/A |
If specified, file sets are not captured for the component during introspection. |
|
|
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. |
|
|
tnl |
false |
none |
The absolute path to the TNSNAMES.ora file. |
The absolute path to the location of the TNSNAMES.ora file. |
|
|
tuxdir |
true |
none |
N/A |
The absolute path to the TUXDIR to introspect. |
|
|
tuxconfig |
true |
none |
N/A |
The absolute path to the TUXCONFIG file of the application to introspect. |
Details for this command follow.
$ abctl introspectWebCache -oracleInstance Path -componentName String [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]
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.
Table A-64 shows the command options for introspectWebCache.
Table A-64 introspectWebCache options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
cn |
true |
none |
N/A |
The name of the Web Cache component to introspect. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same 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. |
|
|
oi |
true |
none |
N/A |
The absolute path of the ORACLE_INSTANCE to introspect. |
|
|
pkf |
false |
none |
N/A |
Private SSH key file on the local machine. |
|
|
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, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the SSH user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
|
|
sf |
false |
none |
N/A |
If specified, file sets are not captured for the component during introspection. |
|
|
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. |
Here are some command examples.
$ introspectWebCache <WebCache options>
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
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
Details for this command follow.
introspectWLS -wlsHome Path -domainRoot Path -adminUser String [-soaGlobalCP Path] [-name String] [-force] [-skipFileSetCapture] [-remoteHost String] [-remoteUser String] [-sudoUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-privateKeyFile Path]
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.
The CoherenceWeb, SOACoherence, and SOA extensions are available as alias commands.
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.
Inspects and captures Coherence configuration specified within SOA managed server start arguments to enable SOA cluster high availability.
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.
Table A-65 shows the command options for introspectWLS.
Table A-65 introspectWLS options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
au |
true |
none |
N/A |
Administrative name for the WebLogic Server domain. |
|
|
dr |
true |
none |
N/A |
Full path to the WebLogic Server domain root. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same 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. |
|
|
pkf |
false |
none |
N/A |
Private SSH key file on the local machine. |
|
|
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, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the SSH user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
|
|
sf |
false |
none |
N/A |
If specified, file sets are not captured for the component during introspection. |
|
|
sgcp |
false |
none |
Location of optional global configuration plan. |
The absolute path to an optional global configuration plan. |
|
|
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. |
|
|
wh |
true |
none |
WLS Home |
Full path to the Oracle WebLogic Server home (usually, < |
Here are some command examples.
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
%
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
%
% 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. %
$ 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.
Details for this command follow.
$ abctl redeployAssemblyInstance -assemblyInstanceId String -connectionName String [-waitForComplete] [-pollTime String]
Redeploys an assembly instance, and is equivalent to performing an undeployAssemblyInstance followed by a deployAssemblyInstance.
Table A-66 shows the command options for redeployAssemblyInstance.
Table A-66 redeployAssemblyInstance options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
true |
none |
A string representing the |
The identifier of an assembly instance to redeploy. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
pt |
false |
5 |
A string representing the number of seconds. |
Specifies the amount of time to wait for an asynchronous operation to complete successfully. |
|
|
w |
false |
no |
N/A |
Specifies whether to wait for an asynchronous operation to complete successfully. |
Details for this command follow.
$ abctl registerAssemblyArchive -name String [-version String] [-target String] -connectionName String [-waitForComplete] [-pollTime String]
Table A-67 shows the command options for registerAssemblyArchive.
Table A-67 registerAssemblyArchive options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
n |
true |
none |
A string representing the name of the assembly archive. |
The name of the assembly archive. |
|
|
pt |
false |
5 |
A string representing the number of seconds. |
Specifies the amount of time to wait for an asynchronous operation to complete successfully. |
|
|
t |
false |
none |
A string representing the name of the target. |
The name of the target. |
|
|
v |
false |
none |
A string representing the version of the assembly archive. |
The version of the assembly archive. |
|
|
w |
false |
no |
N/A |
Specifies whether to wait for an asynchronous operation to complete successfully. |
Details for this command follow.
$ abctl removeAssemblyUsers -assembly String -user String... -connectionName String
Table A-69 shows the command options for removeAssemblyUsers.
Table A-68 getDefaultTarget options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
false |
none |
A string representing the name of the assembly archive. |
Specifies the assembly to remove users from. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
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. |
Details for this command follow.
Table A-69 shows the command options for removeTargetUsers.
Table A-69 getDefaultTarget options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
t |
true |
none |
A string representing the target to add the user to. |
The target to add the user to. |
|
|
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. |
Details for this command follow.
$ abctl restartAssemblyInstance -assemblyInstanceId String -connectionName String [-waitForComplete] [-pollTime String]
This command restarts an assembly instance, and is equivalent to performing a stopAssemblyInstance followed by a startAssemblyInstance.
Table A-70 shows the command options for restartAssemblyInstance.
Table A-70 restartAssemblyInstance options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
true |
none |
A string representing the |
The identifier of an assembly instance to be restarted. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
t |
false |
5 |
A string representing the number of seconds. |
Specifies the amount of time to wait for an asynchronous operation to complete successfully. |
|
|
w |
false |
no |
N/A |
Specifies whether to wait for an asynchronous operation to complete successfully. |
Details for this command follow.
$ abctl scale -scalingGroupId String -target String -connectionName String [-waitForComplete] [-pollTime String]
Table A-71 shows the command options for scale.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
pt |
false |
5 |
A string representing the number of seconds. |
Specifies the amount of time to wait for an asynchronous operation to complete successfully. |
|
|
s |
true |
none |
A string representing the |
The |
|
|
t |
true |
none |
A string representing the new target. |
The new value to scale to. |
|
|
w |
false |
no |
N/A |
Specifies whether to wait for an asynchronous operation to complete successfully. |
Details for this command follow.
Table A-72 shows the command options for setDefaultTarget.
Table A-72 setDefaultTarget options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
n |
true |
none |
A string representing the name of the target. |
|
Details for this command follow.
$ abctl startAssemblyInstance -assemblyInstanceId String -connectionName String [-waitForComplete] [-pollTime String]
Table A-73 shows the command options for startAssemblyInstance.
Table A-73 startAssemblyInstance options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
true |
none |
A string representing the |
The identifier of an assembly instance to be started. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
pt |
false |
5 |
A string representing the number of seconds. |
Specifies the amount of time to wait for an asynchronous operation to complete successfully. |
|
|
w |
false |
no |
N/A |
Specifies whether to wait for an asynchronous operation to complete successfully. |
Details for this command follow.
$ abctl stopAssemblyInstance -assemblyInstanceId String [-force] -connectionName String [-waitForComplete] [-pollTime String]
Table A-74 shows the command options for stopAssemblyInstance.
Table A-74 stopAssemblyInstance options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
true |
none |
A string representing the assemblyInstanceId. |
The identifier of an assembly instance to be stopped. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
f |
false |
none |
True/false. |
Flag to indicate if local cleanup should be done even if the resource manager is not available. |
|
|
pt |
false |
5 |
A string representing the number of seconds. |
Specifies the amount of time to wait for an asynchronous operation to complete successfully. |
|
|
w |
false |
no |
N/A |
Specifies whether to wait for an asynchronous operation to complete successfully. |
Details for this command follow.
$ abctl undeployAssemblyInstance -assemblyInstanceId String -connectionName String [-waitForComplete] [-pollTime String]
Table A-75 shows the command options for undeployAssemblyInstance.
Table A-75 undeployAssemblyInstance options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
d |
true |
none |
A string representing the |
The identifier of an assembly instance to undeploy. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
pt |
false |
5 |
A string representing the number of seconds. |
Specifies the amount of time to wait for an asynchronous operation to complete successfully. |
|
|
w |
false |
no |
N/A |
Specifies whether to wait for an asynchronous operation to complete successfully. |
Details for this command follow.
$ abctl unregisterAssemblyArchive -name String [-version String] [-target String] -connectionName String [-waitForComplete] [-pollTime String]
Table A-76 shows the command options for unregisterAssemblyArchive.
Table A-76 unregisterAssemblyArchive options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
n |
true |
none |
A string representing the name of the assembly archive. |
The name of the assembly archive. |
|
|
pt |
false |
5 |
A string representing the number of seconds. |
Specifies the amount of time to wait for an asynchronous operation to complete successfully. |
|
|
t |
false |
none |
A string representing the name of the target. |
The name of the target. |
|
|
v |
false |
none |
A string representing the version of the assembly archive. |
The version of the assembly archive. |
|
|
w |
false |
no |
N/A |
Specifies whether to wait for an asynchronous operation to complete successfully. |
Details for this command follow.
$ abctl updateAssemblyArchive -name String -version String -description String -connectionName String
This command updates the description (attributes) of an assembly archive in the Deployer.
Table A-77 shows the command options for updateAssemblyArchive.
Table A-77 updateAssemblyArchive options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
d |
true |
none |
A string representing the description of the assembly archive. |
The description of the assembly archive. |
|
|
n |
true |
none |
A string representing the name of the assembly archive. |
The name of the assembly archive. |
|
|
v |
true |
none |
A string representing the version of the assembly archive. |
The version of the assembly archive. |
Details for this command follow.
Updates one or more property values. This command is enabled for Oracle VM targets, but disabled for Oracle Exalogic. The single target in an Oracle Exalogic installation is preconfigured and cannot be changed.
Table A-78 shows the command options for updateTarget.
Table A-78 updateTarget options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
n |
true |
none |
A string representing the name of the target. |
The name of the target. |
|
|
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. |
Details for this command follow.
$ abctl uploadAssemblyArchive -fileName Path -name String [-description String] -connectionName String
Table A-79 shows the command options for uploadAssemblyArchive.
Table A-79 uploadAssemblyArchive options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
|
|
fn |
true |
none |
A string representing the file path to the assembly archive on disk. |
Uploads an assembly archive to the Deployer. |
|
|
n |
true |
none |
A string representing the name of the assembly archive. |
The name of the assembly archive. |
|
|
d |
false |
none |
A string representing the description of the assembly archive. |
The description of the assembly archive. |
Details for this command follow.
$ abctl uploadAssemblyResources -fileName Path -assemblyName String -version String -connectionName String [-append]
Uploads an assembly resources file to associate with a specific version of an assembly. The resource zip file is uploaded and extracted into the repository.
The uploadAssemblyResources command is controlled by a security policy. A resources file may or may not contain scripts. If the resource file does not contain scripts, a user on the assembly access list can run the command. If the resource file does contain scripts, only the Cloud Admin user is allowed to run the command, to prevent a malicious attack.
When including scripts in the resources files, the lifecycle names that are supported are: pre-deploy, post-deploy, deployer-pre-app-config, deployer-post-app-config, deployer-pre-vm-start, deployer-post-vm-start, deployer-pre-vm-stop, deployer-post-vm-stop, pre-undeploy, post-undeploy. You can create corresponding script folder names.
The following is a sample resource zip file containing scripts:
unzip ../myResources.zip
Archive: ../myResources.zip
creating: disks/
inflating: disks/test1.iso
inflating: disks/test2.iso
creating: scripts.d/
creating: scripts.d/pre-deploy.d/
inflating: scripts.d/pre-deploy.d/00script.sh
inflating: scripts.d/pre-deploy.d/01script.sh
creating: scripts.d/post-deploy.d/
inflating: scripts.d/post-deploy.d/00script.sh
inflating: scripts.d/post-deploy.d/01script.sh
creating: scripts.d/deployer-pre-vm-stop.d/
inflating: scripts.d/deployer-pre-vm-stop.d/00script.sh
inflating: scripts.d/deployer-pre-vm-stop.d/01script.sh
creating: scripts.d/post-undeploy.d/
inflating: scripts.d/post-undeploy.d/00script.sh
inflating: scripts.d/post-undeploy.d/01script.sh
Table A-80 shows the command options for uploadAssemblyResources.
Table A-80 uploadAssemblyResources options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
fn |
true |
none |
A string representing the file path to the assembly resources files on disk. |
Uploads an assembly resources file to the Deployer. |
|
|
n |
true |
none |
A string representing the name of the assembly. |
The name of the assembly. |
|
|
v |
false |
none |
A string representing the assembly version. |
The assembly version. |
|
|
a |
false |
none |
A flag, that if set, appends the assembly resources file upload. |
If set, the assembly resources file upload is appended. |
|
|
c |
true |
none |
A string representing the name of the connection to the Deployer. |
The name of a connection to the Deployer. |
Details for this command follow.
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.
Table A-81 shows the command options for uploadEMAssemblyArchive.
Table A-81 uploadEMAssemblyArchive options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
Top level appliance or assembly in the catalog. |
Name of a top level appliance or assembly in the catalog. |
|
|
d |
false |
none |
Textual description. |
A description of the assembly and assembly archive. |
Details for this command follow.
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.
Table A-82 shows the command options for help.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
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. |
|
|
u |
false |
none |
Not valid when the |
|
|
|
c |
false |
none |
When this flag is specified, the |
|
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
Here are some command examples.
$ 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.
$ 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.importExternalTemplate Imports a VM template as an external appliance. Try "abctl help <command>" for detailed help of a specific command.
$ 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
$ 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.