Fusion Middleware Documentation
Advanced Search


Using Oracle Virtual Assembly Builder
Close Window

Table of Contents

Show All | Collapse

A Command Line Reference

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

A.1 Commands

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

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

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

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

Table A-1 Available Commands by Installation Type

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

Section A.1.1, "addAssemblyUsers"

Yes

Yes

Yes

Section A.1.2, "addTargetUser"

Yes

Yes

Yes

Section A.1.3, "addToAssembly"

No

Yes

Yes

Section A.1.4, "bindAssemblyFileSetDefinition"

No

Yes

Yes

Section A.1.5, "bindInput"

No

Yes

Yes

Section A.1.6, "bindInterface"

No

Yes

Yes

Section A.1.7, "captureFileSets"

No

Yes

Yes

Section A.1.8, "clearAssemblyPasswords"

No

Yes

Yes

Section A.1.9, "connectEndpoints"

No

Yes

Yes

Section A.1.10, "copy"

No

Yes

Yes

Section A.1.11, "copyAssemblyArchive"

No

Yes

Yes

Section A.1.12, "createAssembly"

No

Yes

Yes

Section A.1.13, "createAssemblyArchive"

No

Yes

Yes

Section A.1.14, "createAssemblyFileSetDefinition"

No

Yes

Yes

Section A.1.15, "createAssemblyInstance"

Yes

Yes

Yes

Section A.1.16, "createDeployerConnection"

Yes

Yes

Yes

Section A.1.17, "createEMConnection"

No

Yes

Yes

Section A.1.18, "createExternalResources"

No

Yes

Yes

Section A.1.19, "createInterface"

No

Yes

Yes

Section A.1.20, "createNativeFileSetDefinition"

No

Yes

Yes

Section A.1.21, "createNFSFileSetDefinition"

No

Yes

Yes

Section A.1.22, "createRAWFileSetDefinition"

No

Yes

Yes

Section A.1.23, "createTags"

Yes

Yes

Yes

Section A.1.24, "createTarget"

Yes

Yes

Yes

Section A.1.25, "createTemplate"

No

Yes

Yes

Section A.1.26, "createVnet"

No

Yes

Yes

Section A.1.27, "delete"

No

Yes

Yes

Section A.1.28, "deleteAssemblyArchive"

Yes

Yes

Yes

Section A.1.29, "deleteAssemblyInstance"

Yes

Yes

Yes

Section A.1.30, "deleteAssemblyResources"

Yes

Yes

Yes

Section A.1.31, "deleteDeployerConnection"

Yes

Yes

Yes

Section A.1.32, "deleteDeploymentPlan"

Yes

Yes

Yes

Section A.1.33, "deleteEMAssemblyArchive"

No

Yes

Yes

Section A.1.34, "deleteEMConnection"

No

Yes

Yes

Section A.1.35, "deleteFailedApplianceInstances"

Yes

Yes

Yes

Section A.1.36, "deleteFileSetDefinition"

No

Yes

Yes

Section A.1.37, "deleteInterface"

No

Yes

Yes

Section A.1.38, "deleteLogEvents"

Yes

Yes

Yes

Section A.1.39, "deleteRequests"

Yes

Yes

Yes

Section A.1.40, "deleteTags"

Yes

Yes

Yes

Section A.1.41, "deleteTarget"

Yes

Yes

Yes

Section A.1.42, "deleteVnet"

No

Yes

Yes

Section A.1.43, "deployAssemblyInstance"

Yes

Yes

Yes

Section A.1.44, "describeApplianceInstanceMetrics"

Yes

Yes

Yes

Section A.1.45, "describeApplianceInstances"

Yes

Yes

Yes

Section A.1.47, "describeAssemblyArchives"

Yes

Yes

Yes

Section A.1.48, "describeAssemblyInstances"

Yes

Yes

Yes

Section A.1.49, "describeAssemblyResources"

Yes

Yes

Yes

Section A.1.50, "describeAssemblyUsers"

Yes

Yes

Yes

Section A.1.51, "describeAssemblyVnets"

No

Yes

Yes

Section A.1.52, "describeCatalog"

No

Yes

Yes

Section A.1.53, "describeDeployer"

Yes

Yes

Yes

Section A.1.54, "describeDeployerConnections"

Yes

Yes

Yes

Section A.1.55, "describeDeploymentPlans"

No

Yes

Yes

Section A.1.56, "describeEMAssemblyArchives"

No

Yes

Yes

Section A.1.57, "describeEMConnection"

No

Yes

Yes

Section A.1.58, "describeEndpoints"

No

Yes

Yes

Section A.1.59, "describeFileSetDefinitions"

No

Yes

Yes

Section A.1.60, "describeInterfaces"

No

Yes

Yes

Section A.1.61, "describeLogEvents"

No

Yes

Yes

Section A.1.62, "describePlugins"

No

Yes

Yes

Section A.1.63, "describeRegistrations"

Yes

Yes

Yes

Section A.1.64, "describeRequests"

Yes

Yes

Yes

Section A.1.65, "describeResources"

Yes

Yes

Yes

Section A.1.66, "describeScalingGroups"

Yes

Yes

Yes

Section A.1.67, "describeTags"

Yes

Yes

Yes

Section A.1.68, "describeTargetConfigurations"

Yes

Yes

Yes

Section A.1.69, "describeTargetNames"

Yes

Yes

Yes

Section A.1.70, "describeTargetUsers"

Yes

Yes

Yes

Section A.1.71, "describeTargets"

Yes

Yes

Yes

Section A.1.72, "describeUserTargets"

Yes

Yes

Yes

Section A.1.73, "describeVnets"

Yes

Yes

Yes

Section A.1.74, "disablePlugin"

No

Yes

Yes

Section A.1.75, "downloadAssemblyArchive"

Yes

Yes

Yes

Section A.1.76, "downloadAssemblyMetadata"

Yes

Yes

Yes

Section A.1.77, "downloadAssemblyResources"

Yes

Yes

Yes

Section A.1.78, "downloadDeploymentPlan"

Yes

Yes

Yes

Section A.1.79, "downloadEMAssemblyArchive"

No

Yes

Yes

Section A.1.80, "enablePlugin"

No

Yes

Yes

Section A.1.81, "encryptProperties"

No

Yes

Yes

Section A.1.82, "encryptProperty"

No

Yes

Yes

Section A.1.83, "export"

No

Yes

Yes

Section A.1.84, "findPlugins"

No

Yes

Yes

Section A.1.85, "getCatalogProperty"

No

Yes

Yes

Section A.1.86, "getDefaultTarget"

Yes

Yes

Yes

Section A.1.87, "getTargetType"

Yes

Yes

Yes

Section A.1.88, "help"

Yes

Yes

Yes

Section A.1.89, "import"

No

Yes

Yes

Section A.1.90, "installPlugins"

No

Yes

Yes

Section A.1.91, "introspectCoherenceWeb"

No

Yes

Yes

Section A.1.92, "introspectForms"

No

Yes

Yes

Section A.1.93, "introspectGenericProd"

No

Yes

Yes

Section A.1.94, "introspectOHS"

No

Yes

Yes

Section A.1.95, "introspectOTD"

No

Yes

Yes

Section A.1.96, "introspectRACDB"

No

Yes

Yes

Section A.1.97, "introspectReports"

No

Yes

Yes

Section A.1.98, "introspectSIDB"

No

Yes

Yes

Section A.1.99, "introspectSOA"

No

Yes

Yes

Section A.1.100, "introspectTuxedo"

No

Yes

Yes

Section A.1.101, "introspectWLS"

No

Yes

Yes

Section A.1.102, "redeployAssemblyInstance"

Yes

Yes

Yes

Section A.1.103, "registerAssemblyArchive"

Yes

Yes

Yes

Section A.1.104, "removeAssemblyUsers"

Yes

Yes

Yes

Section A.1.105, "removePlugin"

No

Yes

Yes

Section A.1.106, "removeTargetUsers"

Yes

Yes

Yes

Section A.1.107, "renameExternalResource"

No

Yes

Yes

Section A.1.108, "restartAssemblyInstance"

Yes

Yes

Yes

Section A.1.109, "resumeAssemblyInstance"

Yes

Yes

Yes

Section A.1.110, "scale"

Yes

Yes

Yes

Section A.1.111, "scaleDown"

Yes

Yes

Yes

Section A.1.112, "setCatalogProperty"

No

Yes

Yes

Section A.1.113, "setDefaultTarget"

Yes

Yes

Yes

Section A.1.114, "startAssemblyInstance"

Yes

Yes

Yes

Section A.1.115, "stopAssemblyInstance"

Yes

Yes

Yes

Section A.1.116, "suspendAssemblyInstance"

Yes

Yes

Yes

Section A.1.117, "unbindAssemblyFileSetDefinition"

No

Yes

Yes

Section A.1.118, "undeployAssemblyInstance"

Yes

Yes

Yes

Section A.1.119, "unregisterAssemblyArchive"

Yes

Yes

Yes

Section A.1.120, "updateAssemblyArchive"

Yes

Yes

Yes

Section A.1.121, "updateDeployerConfig"

Yes

Yes

Yes

Section A.1.122, "updateTarget"

Yes

Yes

Yes

Section A.1.123, "uploadAssemblyArchive"

Yes

Yes

Yes

Section A.1.124, "uploadAssemblyResources"

Yes

Yes

Yes

Section A.1.125, "uploadDeploymentPlan"

Yes

Yes

Yes

Section A.1.126, "uploadEMAssemblyArchive"

No

Yes

Yes

Section A.1.127, "validateAssemblyArchiveResources"

Yes

Yes

Yes

Section A.1.128, "validateAssemblyInstanceResources"

Yes

Yes

Yes

Section A.1.129, "verifyEMConnection"

No

Yes

Yes

Section A.1.130, "version"

Yes

Yes

Yes


A.1.1 addAssemblyUsers

Details for this command follow.

A.1.1.1 Synopsis

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

A.1.1.2 Description

Adds one or more users to an assembly.

A.1.1.3 Options

Table A-2 shows the command options for addAssemblyUsers.

Table A-2 addAssemblyUsers options

Name Alias Req'd Default Values Possible Values Description

-assembly

a

true

none

A string representing the name of the assembly.

Specifies the assembly to which to add users

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-user

u

true

none

A string representing the username(s) to add.

Specifies one or more users to add to an assembly.


A.1.1.4 Examples

Here are some command examples.

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

A.1.2 addTargetUser

Details for this command follow.

A.1.2.1 Synopsis

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

A.1.2.2 Description

Adds a user to a target.

A.1.2.3 Options

Table A-3 shows the command options for addTargetUser.

Table A-3 addTargetUser options

Name Alias Req'd Default Values Possible Values Description

-user

u

true

none

A string representing the username of the user.

The username of the user.

-target

t

true

none

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

The target to which a user is being added.

-properties

p

false

none

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

The properties to apply to the user.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.2.4 Examples

Here are some command examples.

A.1.2.4.1 Adding Several Users to an Assembly
$ abctl addTargetUser -user Username -target Targetname -connectionName MyDeployerConnection

A.1.3 addToAssembly

Details for this command follow.

A.1.3.1 Synopsis

$ abctl addToAssembly -name String -into String

A.1.3.2 Description

Adds an existing appliance or atomic assembly to another existing assembly.

Sharing is continued when you add an assembly to another assembly. That is, templates and file sets in the original assembly are shared with the new nested assembly.

A.1.3.3 Options

Table A-4 shows the command options for addToAssembly.

Table A-4 addToAssembly options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

The name of an existing appliance or atomic assembly.

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

-into

i

true

none

The name of a non-atomic assembly.

The name of an existing assembly to populate.


A.1.3.4 Examples

Here are some command examples.

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

A.1.4 bindAssemblyFileSetDefinition

Details for this command follow.

A.1.4.1 Synopsis

$ abctl bindAssemblyFileSetDefinition -name String -to String

A.1.4.2 Description

Binds an assembly file set definition to an appliance. This appliance must be nested within the assembly containing that file set definition. Binding it to one appliance in an atomic assembly binds it to all appliances in that atomic assembly.

A.1.4.3 Options

Table A-5 shows the command options for bindAssemblyFileSetDefinition.

Table A-5 bindAssemblyFileSetDefinition options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

Name of assembly file set definition.

-to

t

true

none

N/A

Path to nested appliance.


A.1.4.4 Examples

Here are some command examples.

A.1.4.4.1 Bind Assembly File Set Definition
% abctl bindAssemblyFileSetDefinition -name middleware -to mySite/ohs1
 

A.1.5 bindInput

Details for this command follow.

A.1.5.1 Synopsis

$ abctl bindInput -name String -appliance String -interface String

A.1.5.2 Description

Binds an existing appliance input to one of the existing network interfaces of the appliance. Specify the interface name "INADDR_ANY" to cause the input to be bound to all available interfaces rather than any specific network interface.

A.1.5.3 Options

Table A-6 shows the command options for bindInput.

Table A-6 bindInput options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

The name of the input to bind.

-appliance

a

true

none

N/A

The name of an existing appliance.

-interface

i

true

none

N/A

The name of the interface to which to bind the input, or "INADDR_ANY".


A.1.5.4 Examples

Here are some command examples.

A.1.5.4.1 Bind Input
% abctl bindInput -name myInput -appliance mySite/myOhs -interface interface-1

A.1.6 bindInterface

Details for this command follow.

A.1.6.1 Synopsis

$ abctl bindInterface -name String -appliance String -vnet String

A.1.6.2 Description

Binds an existing appliance network interface to one of the existing Vnets of the containing assembly.

A.1.6.3 Options

Table A-7 shows the command options for bindInterface.

Table A-7 bindInterface options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

The name of the interface to bind.

-appliance

a

true

none

N/A

The name of an existing appliance. The appliance must be contained in an assembly.

-vnet

v

true

none

N/A

The name of the network to which to bind the interface.


A.1.6.4 Examples

Here are some command examples.

A.1.6.4.1 Bind Interface
% abctl bindInterface -name myInterface -appliance mySite/myOhs -vnet vnet-1

A.1.7 captureFileSets

Details for this command follow.

A.1.7.1 Synopsis

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

A.1.7.2 Description

Creates file sets for the specified appliance or assembly.

A.1.7.3 Options

Table A-10 shows the command options for captureFileSets.

Table A-8 captureFileSets options

Name Alias Req'd Default Values Possible Values Description

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-sudoUser

su

false

none

User name of sudo user.

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

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

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

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

-remoteCleanup

rc

false

none

N/A

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

-privateKeyFile

pkf

false

~/.ssh/id_rsa

Location of a private key file.

Private SSH key file on the local machine.

-quiet

q

false

none

N/A

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

-name

n

true

Derived directory name prefixed by component type name.

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

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

-force

f

false

none

N/A

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


A.1.7.4 Examples

Here are some command examples.

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

A.1.8 clearAssemblyPasswords

Details for this command follow.

A.1.8.1 Synopsis

$ abctl clearAssemblyPasswords -name String

A.1.8.2 Description

Clears all passwords for a top-level non-atomic assembly and its child appliances and assemblies, such that all passwords must be provided within the deployment plan. Removes all user and template passwords (does not pertain to system property passwords since they are not reflected in the deployment plan). Optional passwords that have no value at the time the command is executed are still not required to be provided in the deployment plan. Optional passwords that have a value at the time the command is executed are set to required and their value unset.

This command does not alter any deployment plans. You must specify passwords in the deployment plan prior to deployment. If you do not provide values in the deployment plan, the deployment plan validation fails.

A.1.8.3 Options

Table A-9 shows the command options for clearAssemblyPasswords.

Table A-9 clearAssemblyPasswords options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Name of a top-level assembly.

Name of a top-level assembly from which to remove passwords.


A.1.8.4 Examples

Here are some command examples.

A.1.8.4.1 clearAssemblyPasswords
% abctl clearAssemblyPasswords -name myWlsAssembly

A.1.9 connectEndpoints

Details for this command follow.

A.1.9.1 Synopsis

$ abctl connectEndpoints -from String -fromOutput String -to String -toInput String [-force]

A.1.9.2 Description

Creates a new connection between an appliance output and an appliance input. The protocols of the output and input must match. The owners of the output and input are not required to be direct siblings. If you specify non-sibling endpoints, the command either locatea existing assembly-level endpoints to use, or automatically creates them as needed to make a valid connection.

A.1.9.3 Options

Table A-10 shows the command options for connectEndpoints.

Table A-10 connectEndpoints options

Name Alias Req'd Default Values Possible Values Description

-from

fr

true

none

<asssembly>/<appliance>

An appliance output to be connected to an appliance input.

-fromOutput

fout

true

none

A name.

The name of the appliance-level output to connect from.

-to

t

true

none

<asssembly>/<appliance>

An appliance input to be connected to an appliance output.

-toInput

tin

true

none

A name.

The name of the appliance-level input to connect to.

-force

f

false

none

N/A

If -force is set, allows certain connection commands to succeed which would otherwise fail. Specifically it allows an existing connection for a given output to be reconnected to a different input. This flag can force an input change, but not an output change. The command still fails if both input and output are unchanged.


A.1.9.4 Examples

Here are some command examples.

A.1.9.4.1 Create new connection
# Creates a new connection
% abctl connectEndpoints -from mySite/ohs1 -fromOutput EMRegistration -to mySite/wls1/managed1 -toInput Default

Successfully connected from mySite/ohs1:EMRegistration to mySite/wls1/managed1:Default. 
A.1.9.4.2 Failure when output is already connected
# Command fails because the output is already connected.
% abctl connectEndpoints -from mySite/ohs1 -fromOutput EMRegistration -to mySite/wls1/AdminServer -toInput Default
A.1.9.4.3 Success when using the -force option
# Command succeeds because the -force option is used. 
./abctl connectEndpoints -from mySite/ohs1 -fromOutput EMRegistration -to mySite/wls1/AdminServer -toInput Default -force

Successfully connected from mySite/ohs1:EMRegistration to mySite/wls1/AdminServer:Default. 
A.1.9.4.4 Failure when output and input are already connected to each other
# Command fails because the output and input are already connected to each other.
% abctl connectEndpoints -from mySite/ohs1 -fromOutput EMRegistration -to mySite/wls1/AdminServer -toInput Default -force

A.1.10 copy

Details for this command follow.

A.1.10.1 Synopsis

$ abctl copy -name String -copyTo String

A.1.10.2 Description

Copy an introspected component - that is, an appliance or an atomic assembly. Appliances inside an atomic assembly may not be copied. External resources may not be copied. The copy is placed at the root of the catalog. Sharing of any captured file sets and/or created virtual machine templates is broken, which means new copies of those things are made as well.

A.1.10.3 Options

Table A-11 shows the command options for copy.

Table A-11 copy options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

Name of an appliance or assembly in the catalog.

-copyto

ct

true

none

N/A

The name to use for the new copy of the appliance.


A.1.10.4 Examples

Here are some command examples.

A.1.10.4.1 Copy
% abctl copy -name mySite/myWls -copyTo wls2

A.1.11 copyAssemblyArchive

Details for this command follow.

A.1.11.1 Synopsis

$ abctl copyAssemblyArchive -fileName Path -assemblyName String -connectionName String [-description String]

A.1.11.2 Description

Copies an assembly archive to a Deployer repository. The Deployer copies the assembly archive directly from the specified filesystem location. The specified path must be readable by the Deployer.

A.1.11.3 Options

Table A-12 shows the command options for copyAssemblyArchive.

Table A-12 copyAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-fileName

fn

false

none

A path to the assembly archive file.

The file name of the assembly archive to copy.

-assemblyName

an, n, name

true

none

A string representing the name of the assembly.

The name of the assembly.

-description

d

false

none

A string representing the description of the assembly.

Assembly description.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.11.4 Examples

Here are some command examples.

A.1.11.4.1 Copy Assembly Archive
% abctl copyAssemblyArchive -fileName=c:/mySite.ova -assemblyName TheAssembly -connectionName myConnection

A.1.12 createAssembly

Details for this command follow.

A.1.12.1 Synopsis

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

A.1.12.2 Description

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

A.1.12.3 Options

Table A-13 shows the command options for createAssembly.

Table A-13 createAssembly options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Name of the new assembly.

Name of a new assembly to be created.

-defaultNetwork

dn

false

none

Name of the default vNet.

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

-force

f

false

none

N/A

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

-description

d

false

Name of assembly.

N/A

Descriptive text about the assembly.


A.1.12.4 Examples

Here are some command examples.

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

A.1.13 createAssemblyArchive

Details for this command follow.

A.1.13.1 Synopsis

$ abctl createAssemblyArchive -name String -platform String [-force] [-quiet] [-certificateFile Path] [-keyFile Path]

A.1.13.2 Description

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

Optionally, an assembly archive may be signed, allowing the Deployer to verify its integrity. To sign the archive, specify the -certificateFile and -keyFile options and respond to the command prompt for the key passphrase.

A.1.13.3 Options

Table A-16 shows the command options for createAssemblyArchive.

Table A-14 createAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Name of a top-level (not nested) assembly.

A top-level assembly.

-platform

p

true

none

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

Target platform for which the assembly archive is built.

-force

f

false

false

N/A

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

-quiet

q

false

none

N/A

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

-certificateFile

c

false

none

N/A

PEM encoded X509 certificate file for archive signing.

-keyFile

k

false

none

N/A

PEM encoded RSA private key file for archive signing.


A.1.13.4 Examples

Here are some command examples.

A.1.13.4.1 Creating an Assembly Archive
$ abctl createAssemblyArchive -name myWlsAssembly -platform OVM

A.1.14 createAssemblyFileSetDefinition

Details for this command follow.

A.1.14.1 Synopsis

$ abctl createAssemblyFileSetDefinition -name String -assembly String -mountPoint Path [-mountType String] [-mountOptions String] [-quotaNumber Numeric] [-quotaUnit String]

A.1.14.2 Description

Creates an Assembly file set definition on the specified assembly. This assembly must be top-level and non-atomic.

A.1.14.3 Options

Table A-15 shows the command options for createAssemblyFileSetDefinition.

Table A-15 createAssemblyFileSetDefinition options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

Name of assembly file set definition. By default this will be the name of the mounted volume and the simple name of the .iso file (uploaded within Assembly Resource) that will populate that volume.

-assembly

a

true

none

N/A

Name of top-level, non-atomic assembly.

-mountPoint

mp

true

none

N/A

Directory location where volume will be mounted. Must be an absolute path.

-mountType

mt

false

NFS

Specifies type of mount.

.Specifies type of mount.

-mountOptions

mo

false

oracle

N/A

Specifies mounting options.

-quotaNumber

qn

false

none

N/A

Specifies numeric value of the maximum size this volume can occupy.

-quotaUnit

qu

false

none

Megabytes, Gigabytes, Terabytes

Specifies units associated with the quotaNumber parameter.


A.1.14.4 Examples

Here are some command examples.

A.1.14.4.1 Create Assembly File Set Definition
% abctl createAssemblyFileSetDefinition -name foo -assembly mySite -mountPoint /work/webtier_mt

A.1.15 createAssemblyInstance

Details for this command follow.

A.1.15.1 Synopsis

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

A.1.15.2 Description

Creates an assembly instance for an assembly.

A.1.15.3 Options

Table A-16 shows the command options for createAssemblyInstance.

Table A-16 createAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-deploymentPlan

dp

true

none

A file path to the assembly deployment plan on disk.

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

-name

n

true

none

A string representing the name of the assembly.

The name of the assembly.

-version

v

true

none

A string representing the version of the assembly.

Assembly version.

-target

t

false

none

A string representing the name of the target.

The name of the target.

-connectionName

c

true

none

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

The name of a connection to the Deployer Web Service.


A.1.15.4 Examples

Here are some command examples.

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

A.1.16 createDeployerConnection

Details for this command follow.

A.1.16.1 Synopsis

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

A.1.16.2 Description

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

A.1.16.3 Options

Table A-17 shows the command options for createDeployerConnection.

Table A-17 createDeployerConnection options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the Deployer connection.

The name of the Deployer connection.

-url

u

true

none

A string representing the URL of the Deployer Web service.

The URL of the Deployer.

-username

un

true

none

A string representing the username.

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

-noReviewCert

nr

false

none

N/A

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


A.1.16.4 Examples

Here are some command examples.

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

A.1.17 createEMConnection

Details for this command follow.

A.1.17.1 Synopsis

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

A.1.17.2 Description

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

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

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

A.1.17.3 Options

Table A-18 shows the command options for createEMConnection.

Table A-18 createEMConnection options

Name Alias Req'd Default Values Possible Values Description

-connectionURL

c

true

none

Hostname:port.

URL for connecting to EM Software Library.

-connectionUser

cu

true

none

Valid EM Software Library User.

User for EM Software Library.

-namedHostCredential

n

true

none

Valid Named Host Credential.

Named Host Credential.

-remoteUser

ru

true

none

Valid SSH user.

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

-sshPort

s

false

none

Valid SSH port number.

SSH port for EM Software Library machine.

-privateKeyFile

pkf

false

none

~/.ssh/id_rsa, id_rsa

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

-remoteWorkingDir

rwd

true

none

/scratch,/home/mydir

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

-remoteEmAgentHost

 

false

none

Hostname or IP address, without http:// or port.

Specify in scenarios where the EM webpage/Web service is on a different machine than where the agent resides.


A.1.17.4 Examples

Here are some command examples.

A.1.17.4.1 createEMConnection
$ abctl createEmConnection -connectionURL emMachine:7791 -connectionUser admin -namedHostCredential hostCredential -remoteUser mySshUser -remoteWorkingDir /scratch/myovas -sshPort 23 -privateKeyFile ~/.ssh/id_rsa -remoteEmAgentHost assemblyarchives.reside.here

A.1.18 createExternalResources

Details for this command follow.

A.1.18.1 Synopsis

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

A.1.18.2 Description

Creates and connects external resources for each of an appliance's or assembly's unconnected outputs. Optionally, specify an individual output for which you want to create an external resource, and a name for the external resource.

Do not specify -name to search the top level assembly for an existing external reference that is compatible with the output. When found, a connection is established to the existing external resource instead of creating another external resource with the same properties. You can override this behavior by specifying a name of an external resource that does not yet exist.

Specify -name to search the top level assembly for an existing external resource with the specified name. When found, a connection is established to the existing external resource instead of creating another external resource. If you use an existing external resource that does not contain a compatible appliance input, a new appliance input is added to the existing external resource. You can override this behavior by specifying a name of an external resource that does not yet exist.

Recursion, creating external resources for each of an assembly's sub-elements, occurs automatically (the -recurse option is no longer necessary) , except when naming a specific appliance output.

Note:

Wiring an output to an input on the same appliance is supported.

A.1.18.3 Options

Table A-19 shows the command options for createExternalResources.

Table A-19 createExternalResources options

Name Alias Req'd Default Values Possible Values Description

-from

fr

true

none

Appliance or assembly name.

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

-fromOutput

fout

false

none

Appliance output or assembly output name.

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

-name

n

false

none

New external resource name.

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

-recurse

r

false

none

N/A

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


A.1.18.4 Examples

Here are some command examples.

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

A.1.19 createInterface

Details for this command follow.

A.1.19.1 Synopsis

$ abctl createInterface -name String -appliance String [-default]

A.1.19.2 Description

Creates a new physical network interface on the specified appliance.

A.1.19.3 Options

Table A-20 shows the command options for createInterface.

Table A-20 createInterface options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

The name of the new interface to create.

-appliance

a

true

none

N/A

The name of an existing appliance.

-default

d

true

none

N/A

If set, the new interface will be marked as the default interface for the appliance.


A.1.19.4 Examples

Here are some command examples.

A.1.19.4.1 Create Interface
% abctl createInterface -name myInterface -appliance mySite/myOhs -default

A.1.20 createNativeFileSetDefinition

Details for this command follow.

A.1.20.1 Synopsis

$ abctl createNativeFileSetDefinition -name String -appliance String [-shared] -rootDirectory Path [-excludes String...] [-noCapture] [-osOwner String] [-osGroup String] [-freeSpaceNumber Numeric] [-freeSpaceUnit String]

A.1.20.2 Description

Creates a Native file set definition and adds it to a top-level or nested appliance. Use this command to define a "local Linux" or "shared Linux" file set.

A.1.20.3 Options

Table A-21 shows the command options for createNativeFileSetDefinition.

Table A-21 createNativeFileSetDefinition options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

Name of the file set definition.

-appliance

a

true

none

N/A

Name of top-level or nested appliance in which definition is being added.

-rootDirectory

rd

true

none

N/A

Top-level directory for all files included in the file set. Path must be absolute.

-excludes

e

false

none

N/A

One or more files and/or directories to be excluded from file set. Paths must be relative to the rootDirectory location.

-shared

s

false

false

N/A

Specifies whether file set will be stored on a 'shared' file system. Omitting this parameter allows the file set to be stored on the local file system.

-noCapture

nc

false

false

N/A

Indicates whether source files of this definition should be included when capturing file sets. Without this argument, the definition's file set will be captured.

-osOwner

oo

false

oracle

N/A

Owner name to be assigned files in assembly instance.

-osGroup

og

false

oracle

N/A

Group name to be assigned files in assembly instance.

-freeSpaceNumber

fsn

false

Percent

Gigabytes, Megabytes, Percent

Specifies numeric value of extra space to be allocated when the file set is staged.

Note: The default ('50 Percent') applies when neither free space parameter is specified. When one of these Free Space parameters is provided in command then the other is required.

-freeSpaceUnit

fsu

false

50

N/A

Specifies units associated with the freeSpaceNumber parameter. It must be specified if and only if the freeSpaceNumber parameter is used.


A.1.20.4 Examples

Here are some command examples.

A.1.20.4.1 Create Native File Set Definition
% abctl createNativeFileSetDefinition -name OhsOracleHome -appliance mySite/ohs1 -shared -rootDirectory /scratch/aime1/middleware -excludes wlserver_10.3 jrockit* jdk* user_projects

A.1.21 createNFSFileSetDefinition

Details for this command follow.

A.1.21.1 Synopsis

$ abctl createNFSFileSetDefinition -name String -appliance String -rootDirectory Path [-excludes String...] [-noCapture] [-osOwner String] [-osGroup String]

A.1.21.2 Description

Creates an NFS file set definition and adds it to a top-level or nested appliance.

A.1.21.3 Options

Table A-22 shows the command options for createNativeFileSetDefinition.

Table A-22 createNFSFileSetDefinition options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

Name of the file set definition.

-appliance

a

true

none

N/A

Name of top-level or nested appliance in which definition is being added.

-rootDirectory

rd

true

none

N/A

Top-level directory for all files included in the file set. Path must be absolute.

-excludes

e

false

none

N/A

One or more files and/or directories to be excluded from file set. Paths must be relative to the rootDirectory location.

-noCapture

nc

false

false

N/A

Indicates whether source files of this definition should be included when capturing file sets. Without this argument, the definition's file set will be captured.

-osOwner

oo

false

oracle

N/A

Owner name to be assigned files in assembly instance.

-osGroup

og

false

oracle

N/A

Group name to be assigned files in assembly instance.


A.1.21.4 Examples

Here are some command examples.

A.1.21.4.1 Create NFS File Set Definition
% abctl createNFSFileSetDefinition -name OhsOracleHome -appliance mySite/ohs1 \-rootDirectory /work/perl-scripts

A.1.22 createRAWFileSetDefinition

Details for this command follow.

A.1.22.1 Synopsis

$ abctl createRAWFileSetDefinition -name String -appliance String -rootDirectory Path [-osOwner String] [-osGroup String] [-freeSpaceNumber Numeric] [-freeSpaceUnit String]

A.1.22.2 Description

Creates a RAW file set definition and adds it to a top-level or nested appliance.

A.1.22.3 Options

Table A-23 shows the command options for createRAWFileSetDefinition.

Table A-23 createRAWFileSetDefinition options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

Name of the file set definition.

-appliance

a

true

none

N/A

Name of top-level or nested appliance in which definition is being added.

-rootDirectory

rd

true

none

N/A

Top-level directory for all files included in the file set. Path must be absolute.

-osOwner

oo

false

oracle

N/A

Owner name to be assigned files in assembly instance.

-osGroup

og

false

oracle

N/A

Group name to be assigned files in assembly instance.

-freeSpaceNumber

fsn

false

Percent

Gigabytes, Megabytes, Percent

Specifies numeric value of extra space to be allocated when the file set is staged.

Note: The default ('50 Percent') applies when neither free space parameter is specified. When one of these Free Space parameters is provided in command then the other is required.

-freeSpaceUnit

fsu

false

50

N/A

Specifies units associated with the freeSpaceNumber parameter. It must be specified if and only if the freeSpaceNumber parameter is used.


A.1.22.4 Examples

Here are some command examples.

A.1.22.4.1 Create RAW File Set Definition
% abctl createRAWFileSetDefinition -name DbHome -appliance mySite/db1 -rootDirectory /work/dbms

A.1.23 createTags

Details for this command follow.

A.1.23.1 Synopsis

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

A.1.23.2 Description

Creates one or more tags for a resource.

A.1.23.3 Options

Table A-24 shows the command options for createTags.

Table A-24 createTags options

Name Alias Req'd Default Values Possible Values Description

-tag

t

true

none

A set of name=value pairs specifying the tags.

Specifies one or more tags to tag a resource with.

-resource

r

true

none

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

Specifies one or more resources to apply a tag to.

-connectionName

c

true

none

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

The name of a connection to the Deployer Web Service.


A.1.23.4 Examples

Here are some command examples.

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

A.1.24 createTarget

Details for this command follow.

A.1.24.1 Synopsis

$ abctl createTarget -name String -type String -connectionName String [-properties String...] [-default]

A.1.24.2 Description

Creates a deployment target. This command is enabled for Oracle VM targets.

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]

A.1.24.3 Oracle VM Configuration

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".

A.1.24.4 Options

Table A-25 shows the command options for createTarget.

Table A-25 createTarget options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the target.

The name of the target.

-type

t

true

none

A string representing the type of target. Possible value is ovm.

The type of assembly instance target.

-properties

p

false

none

A string representing property=value pairs to set on the target.

The properties to set on the target.

-default

d

false

false

N/A

If set, indicates that this target is the default target.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.24.5 Examples

Here are some command examples.

A.1.24.5.1 Create Target
$ abctl createTarget -name MyTarget -type OVM -properties ovm.poolName=my_pool ovm.vmOperationTimeout=1200 ovm.vmmversion=3.0 ovm.user=admin ovm.pwd ovm.url=tcps://my.host.com:54322 -connectionName myDeployerConn

A.1.25 createTemplate

Details for this command follow.

A.1.25.1 Synopsis

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

A.1.25.2 Description

Creates an appliance template for a given appliance or assembly.

A.1.25.3 Options

Table A-26 shows the command options for createTemplate.

Table A-26 createTemplate options

Name Alias Req'd Default Values Possible Values Description

-baseImage

bi

false

The following is the order of precedence for base image detection:

  1. The location specified by the -baseImage flag

  2. $AB_INSTANCE/templates/baseImage/OVM/OEL (for OVM)

  3. $ORACLE_HOME/templates/baseImage/OVM/OEL (for OVM)

Path to a valid base image.

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

-force

f

false

false

N/A

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

-name

n

true

none

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

Name of an appliance or assembly in the catalog.

-platform

p

true

none

OVM

Target platform for which the appliance template is built.

-quiet

q

false

false

N/A

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

-validateBaseImage

v

false

none

N/A

If -validateBaseImage is set, changes operation from creating a template to validating the base image.

Does not prompt for a template password. The validation output is more verbose.


A.1.25.4 Examples

Examples for this command follow.

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

A.1.26 createVnet

Details for this command follow.

A.1.26.1 Synopsis

$ abctl createVnet -name String -assembly String

A.1.26.2 Description

Creates a new Vnet within the specified assembly.

A.1.26.3 Options

Table A-27 shows the command options for createVnet.

Table A-27 createVnet options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

The name of the new Vnet to create.

-assembly

a

true

none

N/A

The name of an existing top-level assembly.


A.1.26.4 Examples

Here are some command examples.

A.1.26.4.1 Create Vnet
% abctl createVnet -name myVnet -assembly mySite

A.1.27 delete

Details for this command follow.

A.1.27.1 Synopsis

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

A.1.27.2 Description

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

A.1.27.3 Options

Table A-28 shows the command options for delete.

Table A-28 delete options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Name of the top-level appliance or assembly.

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

-archiveOnly

o

false

none

N/A

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


A.1.27.4 Examples

Here are some command examples.

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

A.1.28 deleteAssemblyArchive

Details for this command follow.

A.1.28.1 Synopsis

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

A.1.28.2 Description

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

A.1.28.3 Options

Table A-29 shows the command options for deleteAssemblyArchive.

Table A-29 deleteAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the assembly.

Name of an assembly in the Deployer repository.

-version

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 repository.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.28.4 Examples

Here are some command examples.

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

A.1.29 deleteAssemblyInstance

Details for this command follow.

A.1.29.1 Synopsis

$ abctl deleteAssemblyInstance -assemblyInstanceId String -connectionName String

A.1.29.2 Description

Deletes an assembly instance.

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

A.1.29.3 Options

Table A-30 shows the command options for deleteAssemblyInstance.

Table A-30 deleteAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

d

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to be deleted.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.29.4 Examples

Here are some command examples.

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

A.1.30 deleteAssemblyResources

Details for this command follow.

A.1.30.1 Synopsis

$ abctl deleteAssemblyResources -assemblyName String -connectionName String [-version String] [-fileName String...]

A.1.30.2 Description

Deletes an assembly resources file for an existing assembly.

A.1.30.3 Options

Table A-31 shows the command options for deleteAssemblyResources.

Table A-31 deleteAssemblyResources options

Name Alias Req'd Default Values Possible Values Description

-assemblyName

n

true

none

A string representing the name of the assembly.

The name of the assembly.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-version

v

false

none

A string representing the assembly version.

The assembly version.

-fileName

fn

true

none

A string representing the file path to the assembly resources files on disk.

Uploads an assembly resources file to the Deployer.


A.1.30.4 Examples

Here are some command examples.

A.1.30.4.1 Deleting an Assembly Resources File
$ abctl deleteAssemblyResources -assemblyName FOO -version 1

A.1.31 deleteDeployerConnection

Details for this command follow.

A.1.31.1 Synopsis

$ abctl deleteDeployerConnection [-name] String

A.1.31.2 Description

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

A.1.31.3 Options

Table A-32 shows the command options for deleteDeployerConnection.

Table A-32 deleteDeployerConnection options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the Deployer connection.

The name of the Deployer connection.


A.1.31.4 Examples

Here are some command examples.

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

A.1.32 deleteDeploymentPlan

Details for this command follow.

A.1.32.1 Synopsis

$ abctl deleteDeploymentPlan -assemblyName String -planName String -connectionName String [-version String]

A.1.32.2 Description

Deletes a deployment plan from an existing assembly.

A.1.32.3 Options

Table A-33 shows the command options for deleteDeploymentPlan.

Table A-33 deleteDeploymentPlan options

Name Alias Req'd Default Values Possible Values Description

-assemblyName

n

true

none

A string representing the name of the assembly.

The name of the assembly.

-planName

p

true

none

A string representing the name of the deployment plan.

The name of the deployment plan.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-version

v

false

none

A string representing the assembly version.

The assembly version.


A.1.32.4 Examples

Here are some command examples.

A.1.32.4.1 Delete Deployment Plan
$ abctl deleteDeploymentPlan -assemblyName FOO -version 1 -planName FOO

A.1.33 deleteEMAssemblyArchive

Details for this command follow.

A.1.33.1 Synopsis

$ abctl deleteEMAssemblyArchive -name String -version String

A.1.33.2 Description

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

A.1.33.3 Options

Table A-34 shows the command options for deleteEMAssemblyArchive.

Table A-34 deleteEMAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Name of assembly archive

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

-version

v

true

none

1.0, 1.2, 2.0, etc.

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


A.1.33.4 Examples

Here is a command example.

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

A.1.34 deleteEMConnection

Details for this command follow.

A.1.34.1 Synopsis

$ abctl deleteEMConnection

A.1.34.2 Description

Deletes the connection to the EM Software Library.

A.1.34.3 Options

None.

A.1.34.4 Examples

Here are some command examples.

A.1.34.4.1 Deleting an EM Connection
$ abctl deleteEMConnection 

A.1.35 deleteFailedApplianceInstances

Details for this command follow.

A.1.35.1 Synopsis

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

A.1.35.2 Description

Deletes one or more appliance instances in the failed state.

A.1.35.3 Options

Table A-35 shows the command options for deleteFailedApplianceInstances.

Table A-35 deleteFailedApplianceInstances options

Name Alias Req'd Default Values Possible Values Description

-applianceId

a

true

none

A string representing the ID of the appliance.

The ID of the appliance.

-applianceInstanceIds

ai

true

none

A string representing the IDs of the appliances.

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

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.35.4 Examples

Here is a command example.

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

A.1.36 deleteFileSetDefinition

Details for this command follow.

A.1.36.1 Synopsis

$ abctl deleteFileSetDefinition -name String -appliance String

A.1.36.2 Description

Deletes a file set definition from a top-level or nested appliance.

A.1.36.3 Options

Table A-36 shows the command options for deleteFileSetDefinition.

Table A-36 deleteFileSetDefinition options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

Name of the file set definition.

-appliance

a

true

none

N/A

Name of top-level or nested appliance in which definition is being added.


A.1.36.4 Examples

Here are some command examples.

A.1.36.4.1 Delete File Set Definition
% abctl deleteFileSetDefinition -name OhsOracleHome -appliance mySite/ohs1

A.1.37 deleteInterface

Details for this command follow.

A.1.37.1 Synopsis

$ abctl deleteInterface -name String -appliance String

A.1.37.2 Description

Deletes an existing physical network interface from the specified appliance.

A.1.37.3 Options

Table A-37 shows the command options for deleteInterface.

Table A-37 deleteInterface options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

The name of the interface to delete.

-appliance

a

true

none

N/A

The name of an existing appliance.


A.1.37.4 Examples

Here are some command examples.

A.1.37.4.1 Delete Interface
% abctl deleteInterface -name myInterface -appliance mySite/myOhs

A.1.38 deleteLogEvents

Details for this command follow.

A.1.38.1 Synopsis

$ abctl deleteLogEvents -connectionName String [-user String] [-assemblyInstanceId String] [-afterTime String] [-beforeTime String]

A.1.38.2 Description

Deletes log events based on specified input criteria.

A.1.38.3 Options

Table A-38 shows the command options for deleteLogEvents.

Table A-38 deleteLogEvents options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the user name.

Specifies the user name to query upon.

-user

u

false

none

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

The name of a connection to the Deployer.

-assemblyInstanceId

a

false

none

A string representing the assemblyInstanceId.

Specifies the identifier of the assembly instance to query upon.

-afterTime

at

false

none

A string representing the start time.

Specifies the start time of the log event query time frame.

-beforeTime

bt

false

none

A string representing the end time.

Specifies the end time of the log event query time frame.


A.1.38.4 Examples

Here are some command examples.

A.1.38.4.1 Delete Log Events
$ abctl deleteLogEvents -user ovab -assemblyInstanceId MyId -afterTime 2012-03-01 -beforeTime 2012-03-19

A.1.39 deleteRequests

Details for this command follow.

A.1.39.1 Synopsis

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

A.1.39.2 Description

Deletes one or more previously completed requests.

A.1.39.3 Options

Table A-100 shows the command options for deleteRequests.

Table A-39 deleteRequests options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-requestId

d

false

none

A string representing the requestId.

The requestId of a previously completed request.


A.1.39.4 Examples

Here are some command examples.

A.1.39.4.1 Delete Requests
$ abctl deleteRequests

A.1.40 deleteTags

Details for this command follow.

A.1.40.1 Synopsis

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

A.1.40.2 Description

This command deletes one or more tags for a resource.

A.1.40.3 Options

Table A-40 shows the command options for deleteTags.

Table A-40 deleteTags options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-resource

r

true

none

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

Specifies one or more resources to remove a tag from.

-tag

t

true

none

A set of name=value pairs specifying the tags.

Specifies one or more tags to remove from a resource.


A.1.40.4 Examples

Here are some command examples.

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

A.1.41 deleteTarget

Details for this command follow.

A.1.41.1 Synopsis

$ abctl deleteTarget -name String -connectionName String

A.1.41.2 Description

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

A.1.41.3 Options

Table A-41 shows the command options for deleteTarget.

Table A-41 deleteTarget options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the target.

The name of the target.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.41.4 Examples

Here are some command examples.

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

A.1.42 deleteVnet

Details for this command follow.

A.1.42.1 Synopsis

$ abctl 

A.1.42.2 Description

Deletes an existing Vnet from the specified assembly.

A.1.42.3 Options

Table A-42 shows the command options for deleteVnet.

Table A-42 deleteVnet options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

The name of the existing Vnet to delete.

-assembly

a

true

none

N/A

The name of an existing top-level assembly.


A.1.42.4 Examples

Here are some command examples.

A.1.42.4.1 Delete Vnet
% abctl deleteVnet -name myVnet -assembly mySite

A.1.43 deployAssemblyInstance

Details for this command follow.

A.1.43.1 Synopsis

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

A.1.43.2 Description

This command deploys an assembly archive.

A.1.43.3 Options

Table A-43 shows the command options for deployAssemblyInstance.

Table A-43 deployAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to be deployed.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-waitForComplete

w

false

no

N/A

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

-pollTime

pt

false

5

A string representing the number of seconds.

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


A.1.43.4 Examples

Here are some command examples.

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

A.1.44 describeApplianceInstanceMetrics

Details for this command follow.

A.1.44.1 Synopsis

$ abctl describeApplianceInstanceMetrics -applianceInstanceId String -connectionName String [-average] [-begin String] [-end String] [-metric String...]

$ abctl describeApplianceInstanceMetrics -assemblyInstanceId String -appliancePath String -connectionName String [-average] [-begin String] [-end String] [-metric String...]

A.1.44.2 Description

Describes vserver metrics based on specified input criteria.

A.1.44.3 Options

Table A-44 shows the command options for describeApplianceInstanceMetrics.

Table A-44 describeApplianceInstanceMetrics options

Name Alias Req'd Default Values Possible Values Description

-applianceInstanceId

aii

true *

none

A string representing the applianceId.

One or more applianceIds.

* Only one of the following may be specified: applianceInstanceId, assemblyInstanceId.

-assemblyInstanceId

as

true *

none

A string representing the assemblyInstanceId.

One or more assemblyInstanceIds.

* Only one of the following may be specified: applianceInstanceId, assemblyInstanceId.

-appliancePath

ap

true *

none

A string representing the appliancePath.

The appliance path of an assembly instance to query upon.

* Must be specified when specifying one of the following: assemblyInstanceId

-average

a

false

none

N/A

If specified, the metrics will be averaged.

-begin

b

false

none

A string representing the start time.

Specify the start time to query the metrics.

-end

e

false

none

A string representing the end time.

Specify the end time to query the metrics.

-metric

m

false

none

A set of vserver metrics.

Specify one or more metric to query.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.44.4 Examples

Here are some command examples.

A.1.44.4.1 Describe Appliance Instance Metrics for a Specified assemblyInstanceId
$ abctl describeApplianceInstanceMetrics -assemblyInstanceId myId -appliancePath myPath -connectionName myConnection -metric cpu memory
A.1.44.4.2 Describe Appliance Instance Metrics for a Specified applianceInstanceId
$ abctl describeApplianceInstanceMetrics -applianceInstanceId myId -connectionName myConnection -metric cpu memory

A.1.45 describeApplianceInstances

Details for this command follow.

A.1.45.1 Synopsis

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

A.1.45.2 Description

Describes one or more deployed instances of an assembly.

A.1.45.3 Options

Table A-45 shows the command options for describeApplianceInstances.

Table A-45 describeApplianceInstances options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

as

false

none

A string representing the assemblyInstanceId.

One or more assemblyInstanceIds.

-applianceInstanceId

ap

false

none

A string representing the applianceId.

One or more applianceIds.

-applianceIndex

ai

false

none

A string representing the instanceId.

One or more instanceIds.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.45.4 Examples

Here are some command examples.

A.1.45.4.1 Describe Appliance Instances
$ abctl describeApplianceInstances

A.1.46 describeApplianceMetrics

Details for this command follow.

A.1.46.1 Synopsis

$ abctl describeApplianceMetrics

A.1.46.2 Description

Describes metrics for the appliance.

The "memory" value displayed is not the *free* memory of an appliance instance's VM, but rather the total memory on the VM, which does not change during the lifespan of the VM.

A.1.46.3 Options

Table A-46 shows the command options for describeApplianceMetrics.

Table A-46 describeApplianceMetrics options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

as

false

none

A string representing the assemblyInstanceId.

One or more assemblyInstanceIds.

-applianceInstanceId

ap

false

none

A string representing the applianceId.

One or more applianceIds.

-applianceIndex

ai

false

none

A string representing the instanceId.

One or more instanceIds.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.46.4 Examples

Here are some command examples.

A.1.46.4.1 Describe Appliance Metrics
$ abctl describeApplianceMetrics

A.1.47 describeAssemblyArchives

Details for this command follow.

A.1.47.1 Synopsis

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

A.1.47.2 Description

Describes one or more assembly archives in the Deployer.

A.1.47.3 Options

Table A-47 shows the command options for describeAssemblyArchives.

Table A-47 describeAssemblyArchives options

Name Alias Req'd Default Values Possible Values Description

-assembly

a

false

none

A list of the assemblies to describe.

Specifies the assemblies to describe.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.47.4 Examples

Here are some command examples.

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

A.1.48 describeAssemblyInstances

Details for this command follow.

A.1.48.1 Synopsis

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

A.1.48.2 Description

Describes one or more assembly instances.

A.1.48.3 Options

Table A-48 shows the command options for describeAssemblyInstances.

Table A-48 describeAssemblyInstances options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

false

none

A comma-separated list of assembly instance IDs.

Identifiers of one or more assembly instances to be described.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.48.4 Examples

Here are some command examples.

A.1.48.4.1 Describe Assembly Instances
$ abctl describeAssemblyInstances

A.1.49 describeAssemblyResources

Details for this command follow.

A.1.49.1 Synopsis

$ abctl describeAssemblyResources -assemblyName String -connectionName String [-version String]

A.1.49.2 Description

Describe assembly resources for an existing assembly

A.1.49.3 Options

Table A-49 shows the command options for describeAssemblyResources.

Table A-49 describeAssemblyResources options

Name Alias Req'd Default Values Possible Values Description

-assemblyName

n

true

none

A string representing the name of the assembly.

The name of the assembly.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-version

v

false

none

A string representing the assembly version.

The assembly version.


A.1.49.4 Examples

Here are some command examples.

A.1.49.4.1 Describe Assembly Resources
$ abctl describeAssemblyResources -assemblyName FOO -version 1

A.1.50 describeAssemblyUsers

Details for this command follow.

A.1.50.1 Synopsis

$ abctl describeAssemblyUsers -assembly String -connectionName String

A.1.50.2 Description

This command describes one or more users of an assembly.

A.1.50.3 Options

Table A-48 shows the command options for describeAssemblyUsers.

Table A-50 describeAssemblyUsers options

Name Alias Req'd Default Values Possible Values Description

-assembly

a

false

none

A string representing the name of the assembly.

Specifies the assembly whose users will be described.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.50.4 Examples

Here are some command examples.

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

A.1.51 describeAssemblyVnets

Details for this command follow.

A.1.51.1 Synopsis

$ abctl describeAssemblyVnets -name String

A.1.51.2 Description

Describes the logical Vnets defined in a top-level assembly.

A.1.51.3 Options

Table A-51 shows the command options for describeAssemblyVnets.

Table A-51 describeAssemblyInstances options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Name of an assembly.

Name of a top-level, non-atomic assembly whose Vnets are listed.


A.1.51.4 Examples

Here are some command examples.

A.1.51.4.1 Describe Assembly Instances
$ abctl describeAssemblyVnets -name mySite

A.1.52 describeCatalog

Details for this command follow.

A.1.52.1 Synopsis

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

A.1.52.2 Description

Lists appliances and assemblies in the catalog, and display file set information.

A.1.52.3 Options

Table A-52 shows the command options for describeCatalog.

Table A-52 describeCatalog options

Name Alias Req'd Default Values Possible Values Description

-long

l

false

N/A

N/A

Lists information with maximum detail. Included for compatibility only.

-name

n

false

None.

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

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


A.1.52.4 Examples

Here are some command examples.

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

A.1.53 describeDeployer

Details for this command follow.

A.1.53.1 Synopsis

$ abctl describeDeployer -connectionName String

A.1.53.2 Description

Describes a Deployer instance.

A.1.53.3 Options

Table A-53 shows the command options for describeDeployer.

Table A-53 describeDeployer options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.53.4 Examples

Here are some command examples.

A.1.53.4.1 Describe Deployer
$ abctl describeDeployer

A.1.54 describeDeployerConnections

Details for this command follow.

A.1.54.1 Synopsis

$ abctl describeDeployerConnections

A.1.54.2 Description

Describes the configured Deployer connections.

A.1.54.3 Options

None.

A.1.54.4 Examples

Here are some command examples.

A.1.54.4.1 Describe Deployer Connections
$ abctl describeDeployerConnections

A.1.55 describeDeploymentPlans

Details for this command follow.

A.1.55.1 Synopsis

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

A.1.55.2 Description

Describes the available deployment plans.

A.1.55.3 Options

Table A-53 shows the command options for describeDeploymentPlans.

Table A-54 describeDeploymentPlan options

Name Alias Req'd Default Values Possible Values Description

-name

n

false

.*

Any regular expression.

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

-plan

p

false

.*

Any regular expression.

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

-long

l

false

none

N/A

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


A.1.55.4 Examples

Here are some command examples.

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

A.1.56 describeEMAssemblyArchives

Details for this command follow.

A.1.56.1 Synopsis

$ abctl describeEMAssemblyArchives [-name nameOfAssemblyArchive]

A.1.56.2 Description

Describes assembly archives in the EM Software Library.

A.1.56.3 Options

Table A-53 shows the command options for describeEMAssemblyArchives.

Table A-55 describeEMAssemblyArchives options

Name Alias Req'd Default Values Possible Values Description

-name

n

false

.*

Existing assembly archive names.

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


A.1.56.4 Examples

Here are some command examples.

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

A.1.57 describeEMConnection

Details for this command follow.

A.1.57.1 Synopsis

$ abctl describeEMConnection

A.1.57.2 Description

Describes the configured EM Software Library connection.

A.1.57.3 Options

None.

A.1.57.4 Examples

Here are some command examples.

A.1.57.4.1 Describe EM Connection
$ abctl describeEMConnection

A.1.58 describeEndpoints

Details for this command follow.

A.1.58.1 Synopsis

$ abctl describeEndpoints -name String [-recurse]

A.1.58.2 Description

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

A.1.58.3 Options

Table A-56 shows the command options for describeEndpoints.

Table A-56 describeEndpoints options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

None.

Name of an appliance or assembly.

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

-recurse

r

false

N/A

N/A

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


A.1.58.4 Examples

Here are some command examples.

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

A.1.59 describeFileSetDefinitions

Details for this command follow.

A.1.59.1 Synopsis

$ abctl describeFileSetDefinitions [-name] String

A.1.59.2 Description

Describes the file set definitions of an appliance or assembly.

A.1.59.3 Options

Table A-57 shows the command options for describeFileSetDefinitions.

Table A-57 describeFileSetDefinitions options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

None.

Element name or path.

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


A.1.59.4 Examples

Here are some command examples.

A.1.59.4.1 Describe File Set Definitions
$ abctl describeFileSetDefinitions -name myOhs

$ abctl describeFileSetDefinitions -name /mySite/wls1/AdminServer

A.1.60 describeInterfaces

Details for this command follow.

A.1.60.1 Synopsis

$ abctl describeInterfaces -name String [-recurse]

A.1.60.2 Description

Lists the physical and virtual interfaces of an appliance or assembly.

A.1.60.3 Options

Table A-56 shows the command options for describeInterfaces.

Table A-58 describeInterfaces options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

None.

Name of an appliance or assembly.

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


A.1.60.4 Examples

Here are some command examples.

A.1.60.4.1 Describe Interfaces
$ abctl describeInterfaces -name mySite/ohs1

Interfaces in mySite/ohs1
----------------------------------------------------------------------------------
  Element      | Name            | Type    | Vnet  | Description
----------------------------------------------------------------------------------
/mySite/ohs1 | iface-1 (default)| Physical | vnet-1 | default appliance interface
/mySite/ohs1 | iface-1/vface-1  | Virtual  | vnet-1 | virtual interface for iface-1
/mySite/ohs1 | iface-1/vface-2  | Virtual  | vnet-1 | another virtual interface
----------------------------------------------------------------------------------

A.1.61 describeLogEvents

Details for this command follow.

A.1.61.1 Synopsis

$ abctl describeLogEvents -connectionName String [-user String] [-assemblyInstanceId String] [-afterTime String] [-beforeTime String]

A.1.61.2 Description

Describe log events based on specified input criteria. For time related parameters, the only supported formats are yyyy-MM-dd'T'HH:mm:ss.SSS, yyyy-MMdd'T'HH:mm:ss and yyyy-MM-dd.

A.1.61.3 Options

Table A-59 shows the command options for describeLogEvents.

Table A-59 describeLogEvents options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

A string representing the user name.

Specifies the user name to query upon.

-user

u

false

none

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

The name of a connection to the Deployer.

-assemblyInstanceId

a

false

none

A string representing the assemblyInstanceId.

Specifies the identifier of the assembly instance to query upon.

-afterTime

at

false

none

A string representing the start time.

Specifies the start time of the log event query time frame.

-beforeTime

bt

false

none

A string representing the end time.

Specifies the end time of the log event query time frame.


A.1.61.4 Examples

Here are some command examples.

A.1.61.4.1 Describe Log Events
$ abctl describeLogEvents -user ovab -assemblyInstanceId MyId -afterTime 2012-03-01 -beforeTime 2012-03-19

A.1.62 describePlugins

Details for this command follow.

A.1.62.1 Synopsis

$ abctl describePlugins [-long]

A.1.62.2 Description

Lists the set of installed introspector plug-ins and extensions including their status and various other details.

A.1.62.3 Options

Table A-60 shows the command options for describePlugins.

Table A-60 describePlugins options

Name Alias Req'd Default Values Possible Values Description

-long

l

false

N/A

N/A

Lists all attributes of all plug-ins in long format (maximum detail).


A.1.62.4 Examples

Here are some command examples.

A.1.62.4.1 Describe Plug-ins
$ abctl describePlugins

A.1.63 describeRegistrations

Details for this command follow.

A.1.63.1 Synopsis

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

A.1.63.2 Description

This command describes one or more assembly registrations.

A.1.63.3 Options

Table A-61 shows the command options for describeRegistrations.

Table A-61 describeRegistrations options

Name Alias Req'd Default Values Possible Values Description

-assembly

a

false

none

A string representing the name of the assembly.

The name of an assembly.

-version

v

true

none

A string representing the version of the assembly.

Assembly version.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.63.4 Examples

Here are some command examples.

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

A.1.64 describeRequests

Details for this command follow.

A.1.64.1 Synopsis

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

A.1.64.2 Description

This command describes one or more previously issued asynchronous requests.

A.1.64.3 Options

Table A-62 shows the command options for describeRequests.

Table A-62 describeRequests options

Name Alias Req'd Default Values Possible Values Description

-requestId

r

false

none

A string representing the requestId.

The requestId of a previously issued asynchronous request.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.64.4 Examples

Here are some command examples.

A.1.64.4.1 Describe Requests
$ abctl describeRequests

A.1.65 describeResources

Details for this command follow.

A.1.65.1 Synopsis

$ abctl describeResources -tag String... -connectionName String

A.1.65.2 Description

Describe assembly archive resources based on specified tags.

A.1.65.3 Options

Table A-63 shows the command options for describeResources.

Table A-63 describeResources options

Name Alias Req'd Default Values Possible Values Description

-tag

t

true

none

A set of tag names associated with assembly archive resources.

Specifies one or more tags with which the queried assembly archive resources are associated.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.65.4 Examples

Here are some command examples.

A.1.65.4.1 Describe Resources
$ abctl describeResources -tag tag1 tag2 -connectionName MyConnection

A.1.66 describeScalingGroups

Details for this command follow.

A.1.66.1 Synopsis

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

A.1.66.2 Description

Describes one or more scaling groups.

A.1.66.3 Options

Table A-64 shows the command options for describeScalingGroups.

Table A-64 describeScalingGroups options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

false

none

A string representing the assemblyInstanceId.

The identifier of a previously created assembly instance.

-scalingGroupId

s

false

none

A string representing the scalingGroupId.

The identifier of a previously created scaling group.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.66.4 Examples

Here are some command examples.

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

A.1.67 describeTags

Details for this command follow.

A.1.67.1 Synopsis

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

A.1.67.2 Description

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

A.1.67.3 Options

Table A-65 shows the command options for describeTags.

Table A-65 describeTags options

Name Alias Req'd Default Values Possible Values Description

-resource

-r

true

none

A string specifying the resource id of the resource.

Specifies the resource for which to get tag information.

-tag

-t

false

none

A string representing the name of the tag.

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

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.67.4 Examples

Here are some command examples.

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

A.1.68 describeTargetConfigurations

Details for this command follow.

A.1.68.1 Synopsis

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

A.1.68.2 Description

This command describes one or more target configurations.

A.1.68.3 Options

Table A-66 shows the command options for describeTargetConfigurations.

Table A-66 describeDeployer options

Name Alias Req'd Default Values Possible Values Description

-target

t

false

none

A string representing the name of the target.

The name of one or more targets.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.68.4 Examples

Here are some command examples.

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

A.1.69 describeTargetNames

Details for this command follow.

A.1.69.1 Synopsis

$ abctl describeTargetNames -type String -connectionName String

A.1.69.2 Description

Lists the names of the targets of the type specified.

A.1.69.3 Options

Table A-67 shows the command options for describeTargetNames.

Table A-67 describeTargetNames options

Name Alias Req'd Default Values Possible Values Description

-type

t

true

none

A string representing the type of target. Possible value is ovm.

The type of the target.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.69.4 Examples

Here are some command examples.

A.1.69.4.1 Describe Target Names
$ abctl describeTargetNames

A.1.70 describeTargetUsers

Details for this command follow.

A.1.70.1 Synopsis

$ abctl describeTargetUsers -target String -connectionName String

A.1.70.2 Description

Lists the users of the specified target.

A.1.70.3 Options

Table A-68 shows the command options for describeTargetUsers.

Table A-68 describeTargetUsers options

Name Alias Req'd Default Values Possible Values Description

-target

t

true

none

A string representing the name of the target.

The name of the target.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.70.4 Examples

Here are some command examples.

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

A.1.71 describeTargets

Details for this command follow.

A.1.71.1 Synopsis

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

A.1.71.2 Description

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

A.1.71.3 Options

Table A-69 shows the command options for describeTargets.

Table A-69 describeTargets options

Name Alias Req'd Default Values Possible Values Description

-target

t

false

none

A string representing the name of the target.

The name of one or more targets.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.71.4 Examples

Here are some command examples.

A.1.71.4.1 Describe Targets
$ abctl describeTargets

A.1.72 describeUserTargets

Details for this command follow.

A.1.72.1 Synopsis

$ abctl describeUserTargets -user String -connectionName String

A.1.72.2 Description

This command describes one or more types of deployment targets.

A.1.72.3 Options

Table A-70 shows the command options for describeUserTargets.

Table A-70 describeUserTargets options

Name Alias Req'd Default Values Possible Values Description

-user

u

true

none

A string representing the username of the user.

The username of the user.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.72.4 Examples

Here are some command examples.

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

A.1.73 describeVnets

Details for this command follow.

A.1.73.1 Synopsis

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

A.1.73.2 Description

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

A.1.73.3 Options

Table A-70 shows the command options for describeVnets.

Table A-71 describeVnets options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-id

i

false

none

A string representing the network ID.

The network IDs to describe.

-target

t

true

none

A string representing the target name.

The name of a target whose networks will be described.


A.1.73.4 Examples

Here are some command examples.

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

A.1.74 disablePlugin

Details for this command follow.

A.1.74.1 Synopsis

$ abctl disablePlugin -pluginName String

A.1.74.2 Description

Disables the specified plug-in or extension and recursively any child extensions.

A.1.74.3 Options

Table A-72 shows the command options for disablePlugin.

Table A-72 disablePlugin options

Name Alias Req'd Default Values Possible Values Description

-pluginName

pn

true

none

N/A

A single plug-in name.


A.1.74.4 Examples

Here are some command examples.

A.1.74.4.1 Disable Plug-in
$ abctl disablePlugin -pn WLS

A.1.75 downloadAssemblyArchive

Details for this command follow.

A.1.75.1 Synopsis

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

A.1.75.2 Description

This command downloads an assembly archive from the Deployer repository.

A.1.75.3 Options

Table A-73 shows the command options for downloadAssemblyArchive.

Table A-73 downloadAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the assembly.

The name of the assembly archive.

-version

v

true

none

A string representing the version of the assembly.

The version of the assembly archive.

-fileName

r

true

none

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

The new name of the assembly archive.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.75.4 Examples

Here are some command examples.

A.1.75.4.1 Download Assembly Archive
$ abctl downloadAssemblyArchive -name MyAssembly -version 1 RenamedAssembly.ova

A.1.76 downloadAssemblyMetadata

Details for this command follow.

A.1.76.1 Synopsis

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

A.1.76.2 Description

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

A.1.76.3 Options

Table A-74 shows the command options for downloadAssemblyMetadata.

Table A-74 downloadAssemblyMetadata options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-fileName

fn

false

none

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

The new name of the OVF.

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

-generatePlan

g

false

none

N/A

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

-name

n

true

none

A string representing the name of the assembly.

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

-version

v

true

none

A string representing the version of the assembly.

Assembly version.


A.1.76.4 Examples

Here are some command examples.

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

A.1.77 downloadAssemblyResources

Details for this command follow.

A.1.77.1 Synopsis

$ abctl downloadAssemblyResources -assemblyName String -version String -connectionName String [-fileName Path]

A.1.77.2 Description

Downloads an assembly resources file from the Deployer repository.

A.1.77.3 Options

Table A-75 shows the command options for downloadAssemblyResources.

Table A-75 downloadAssemblyResources options

Name Alias Req'd Default Values Possible Values Description

-assemblyName

n

true

none

A string representing the name of the assembly.

The name of the assembly.

-version

v

true

none

A string representing the assembly version.

The assembly version.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-fileName

fn

false

none

An absolute or relative path to a file where the assembly archive is to be written.

The file name where the assembly archive is saved. If omitted, the assembly archive is saved as "<assemblyname>_resources_<version>.zip" in the archive directory. You may specify an absolute or relative path to a file.


A.1.77.4 Examples

Here are some command examples.

A.1.77.4.1 Download Assembly Resources File
$ abctl downloadAssemblyResources -assemblyName MyAssembly -version 1 -connectionName MyConnection
 

A.1.78 downloadDeploymentPlan

Details for this command follow.

A.1.78.1 Synopsis

$ abctl downloadDeploymentPlan -assemblyInstanceId String -connectionName String [-fileName Path] [-display downloadDeploymentPlan] -assemblyName String -version String -planName String -connectionName String [-fileName Path] [-display]

A.1.78.2 Description

Downloads a deployment plan from an existing deployment.

A.1.78.3 Options

Table A-76 shows the command options for downloadDeploymentPlan.

Table A-76 downloadDeploymentPlan options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-fileName

fn

false

none

An absolute or relative path to a file where the deployment plan is to be written.

The file name where the deployment plan is to be written. If omitted, the plan is saved as "Plan.xml" in the current working directory. You may specify an absolute or relative path to a file.

-display

ds

false

none

N/A

If set, show the deployment plan contents after download.

-assemblyName

an

true

none

A string representing the name of the assembly.

The name of the assembly.

-version

v

true

none

A string representing the assembly version.

The assembly version.

-planName

pn

true

none

A string representing the name of the deployment plan.

The name of the deployment plan.


A.1.78.4 Examples

Here are some command examples.

A.1.78.4.1 Download Deployment Plan
$ abctl downloadDeploymentPlan -assemblyName FOO -version 1 -planName FOO

A.1.79 downloadEMAssemblyArchive

Details for this command follow.

A.1.79.1 Synopsis

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

A.1.79.2 Description

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

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

A.1.79.3 Options

Table A-77 shows the command options for downloadEMAssemblyArchive.

Table A-77 downloadEMAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Assembly archive name.

Name of assembly archive to download.

-version

v

true

none

A string representing the version of the assembly archive.

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

-force

f

false

false

N/A

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

-downloadAs

 

false

none

Assembly archive name.

Name to assign to a downloaded assembly inside the catalog.


A.1.79.4 Examples

Here is a command example.

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

A.1.80 enablePlugin

Details for this command follow.

A.1.80.1 Synopsis

$ abctl enablePlugin [-pluginName] String [-recurse]

A.1.80.2 Description

Enables the specified introspector plug-in or extension.

A.1.80.3 Options

Table A-78 shows the command options for enablePlugin.

Table A-78 enablePlugin options

Name Alias Req'd Default Values Possible Values Description

-pluginName

pn

true

none

N/A

A single plug-in name.

-recurse

r

false

none

N/A

If specified, also enables all possible child extensions recursively.


A.1.80.4 Examples

Here are some command examples.

A.1.80.4.1 Enable Plug-in
$ abctl enablePlugin -pn WLS -recurse 

A.1.81 encryptProperties

Details for this command follow.

A.1.81.1 Synopsis

$ abctl encryptProperties -propertyNames String... [-outputFile Path]

A.1.81.2 Description

Encrypts one or more values that are obtained by securely prompting without echoing. The encrypted values can either be printed to the screen or appended to a specified file. This command is intended for use when constructing property files used in conjunction with script-based facilities.

A.1.81.3 Options

Table A-79 shows the command options for encryptProperties.

Table A-79 encryptProperties options

Name Alias Req'd Default Values Possible Values Description

-pluginName

pn

false

none

A set of one or more space-separated property names.

Allows for the prompting of multiple values referenced by name.

-outputFile

of

false *

none

Path to a file that may or may not exist.

The output file where the specified properties and encrypted values should be written. If the file does not exist then it will be created. If the file exists then all new properties will be appended to the file and any pre-existing properties will be updated.

May only be specified when specifying propertyNames.


A.1.81.4 Examples

Here are some command examples.

A.1.81.4.1 Encrypt Properties
$ abctl encryptProperties

A.1.82 encryptProperty

Details for this command follow.

A.1.82.1 Synopsis

$ abctl encrypt

A.1.82.2 Description

Prompts for a value and returns the encrypted form. The original value is not displayed to the screen.

A.1.82.3 Options

None.

A.1.82.4 Examples

Here are some command examples.

A.1.82.4.1 Encrypt Property
$ abctl encryptProperty

A.1.83 export

Details for this command follow.

A.1.83.1 Synopsis

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

A.1.83.2 Description

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

A.1.83.3 Options

Table A-80 shows the command options for export.

Table A-80 export options

Name Alias Req'd Default Values Possible Values Description

-metadataOnly

m

false

none

N/A

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

-name

n

true

none

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

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

-quiet

q

false

none

N/A

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

-toDir

td

true

none

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

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


A.1.83.4 Examples

Here are some command examples.

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

A.1.84 findPlugins

Details for this command follow.

A.1.84.1 Synopsis

$ abctl findPlugins -productRoot Path [-remoteHost String] [-remoteUser String] [-privateKeyFile Path] [-long]

A.1.84.2 Description

Lists the set of introspector plug-ins and extensions from a product home that you can install into OVAB.

A.1.84.3 Passwords

You may be prompted to enter a value for the password for the remote SSH user when you execute the command.

A.1.84.4 Options

Table A-81 shows the command options for findPlugins.

Table A-81 findPlugins options

Name Alias Req'd Default Values Possible Values Description

-productRoot

pr

true

none

Path.

Full path to the base directory of the product installation. For Oracle product installations, this can be either an ORACLE_HOME or one directory below an ORACLE_HOME to search multiple ORACLE_HOME.

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-long

l

false

N/A

N/A

Lists all attributes of all plug-ins in long format (maximum detail).


A.1.84.5 Examples

Here are some command examples.

A.1.84.5.1 Find Plug-ins
$ abctl findPlugins

A.1.85 getCatalogProperty

Details for this command follow.

A.1.85.1 Synopsis

$ abctl getCatalogProperty -containerAddress String [-name String]

A.1.85.2 Description

This command enable getting certain property values within the catalog metadata. Not all properties in the catalog are gettable, and only some of these are settable (see setCatalogProperty).

A.1.85.3 Options

Table A-82 shows the command options for getCatalogProperty.

Table A-82 getCatalogProperty options

Name Alias Req'd Default Values Possible Values Description

-containerAddress

c

true

none

A variable number of arguments.

Takes a variable number of arguments to specify a single container (such as an assembly, appliance, vnet, or physical interface) within the catalog's metadata hierarchy. It comprises a series of 'steps' one would take for navigating down through this hierarchy, starting from the root (catalog) level.

The argument follows a Unix-like syntax although it does not refer to an actual directory path. It always begin with a slash ("/") character.

For instance, to specify the Resource Requirements of the AdminServer appliance of a Weblogic server named wls1 of an assembly named "mySite", the container address is: /assemblies/mySite/assemblies/wls1/appliances/AdminServer/resource-requirements

-name

c

false

none

A string representing the name of a single property.

Specifies a single property in the output. This is useful primarily to enable a script to extract (scrape) a specific value from stdout. If the name parameter is omitted, all properties and child containers of the specified container are displayed.


A.1.85.4 Examples

Here are some command examples.

A.1.85.4.1 Get Catalog Property (all properties and child containers of the specified container)
$ abctl getCatalogProperty -containerAddress /assemblies/mySite

 dr-  assemblies
  dr-  appliances
  dr-  vnets
 
  -r-  assembly-id: LxVX9hK8CpZYW
  -r-  atomic: false
  -r-  capture-id: KxVX9hK8CpZYW
  -r-  default-network-name: vnet-1
  -rw  dependence:
  -rw  description: mySite
  -r-  name: mySite
  -r-  version: 1.0.0

The codes listed at the start of each line are useful for understanding options available for subsequent commands:

dr-   denotes a child container. You can append this 'directory' to the current container address, which affects navigating down to another container level.
 
 -r-   denotes a read-only property. You cannot update this property with the setCatalogProperty command.
 
 -rw   denotes a writeable property. You can update this property through the setCatalogProperty command.

Based on the output of the previous usage example, the following commands are expected to be valid:

$ abctl getCatalogProperty -containerAddress /assemblies/mySite/assemblies
$ abctl getCatalogProperty -containerAddress /assemblies/mySite/appliances
$ abctl getCatalogProperty -containerAddress /assemblies/mySite/vnets
 
$ abctl getCatalogProperty -containerAddress /assemblies/mySite -name assembly-id
$ abctl getCatalogProperty -containerAddress /assemblies/mySite -name atomic
$ abctl getCatalogProperty -containerAddress /assemblies/mySite -name capture-id
$ abctl getCatalogProperty -containerAddress /assemblies/mySite -name default-network-name
$ abctl getCatalogProperty -containerAddress /assemblies/mySite -name dependence
$ abctl getCatalogProperty -containerAddress /assemblies/mySite -name description
$ abctl getCatalogProperty -containerAddress /assemblies/mySite -name name
$ abctl getCatalogProperty -containerAddress /assemblies/mySite -name version
$ abctl setCatalogProperty -containerAddress /assemblies/mySite -name dependence -value ""
$ abctl setCatalogProperty -containerAddress /assemblies/mySite -name description -value "New description value"

A.1.86 getDefaultTarget

Details for this command follow.

A.1.86.1 Synopsis

$ abctl getDefaultTarget -connectionName String

A.1.86.2 Description

This command returns the default target.

A.1.86.3 Options

Table A-83 shows the command options for getDefaultTarget.

Table A-83 getDefaultTarget options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.86.4 Examples

Here are some command examples.

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

A.1.87 getTargetType

Details for this command follow.

A.1.87.1 Synopsis

$ abctl getTargetType -name String -connectionName String

A.1.87.2 Description

This command returns the type of the target.

A.1.87.3 Options

Table A-84 shows the command options for getTargetType.

Table A-84 getTargetType options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

A string representing the name of the target

The name of the target.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.87.4 Examples

Here are some command examples.

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

A.1.88 help

Details for this command follow.

A.1.88.1 Synopsis

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

A.1.88.2 Description

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

A.1.88.3 Options

Table A-85 shows the command options for help.

Table A-85 help options

Name Alias Req'd Default Values Possible Values Description

-command

c

false

none

Any command of this utility.

Specifies the command for which Help should be printed.

-usage

u

false

none

N/A

Print only an option summary of the specified command.


A.1.88.4 Examples

Here is an example.

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

A.1.89 import

Details for this command follow.

A.1.89.1 Synopsis

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

A.1.89.2 Description

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

A.1.89.3 Options

Table A-85 shows the command options for import.

Table A-86 import options

Name Alias Req'd Default Values Possible Values Description

-from

fr

true

none

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

Path to a valid export location or assembly archive file.

-quiet

q

false

none

N/A

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

-importAs

ia

false

none

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

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

-force

f

false

false

N/A

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


A.1.89.4 Examples

Here are some command examples.

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

A.1.90 installPlugins

Details for this command follow.

A.1.90.1 Synopsis

$ abctl installPlugins -productRoot Path [-pluginNames String...] [-remoteHost String] [-remoteUser String] [-privateKeyFile Path]

A.1.90.2 Description

Installs one or more plug-ins and extensions from a product home.

A.1.90.3 Passwords

You may be prompted to enter a value for the password for the remote SSH user when you execute the command.

A.1.90.4 Options

Table A-87 shows the command options for installPlugins.

Table A-87 installPlugins options

Name Alias Req'd Default Values Possible Values Description

-pluginNames

pn

true

none

N/A

One or more plug-in names separated by spaces.

-productRoot

pr

true

none

Path.

Full path to the base directory of the product installation. For Oracle product installations, this can be either an ORACLE_HOME or one directory below an ORACLE_HOME to search multiple ORACLE_HOME.

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.


A.1.90.5 Examples

Here are some command examples.

A.1.90.5.1 Install Plug-ins
$ abctl installPlugins

A.1.91 introspectCoherenceWeb

Details for this command follow.

A.1.91.1 Synopsis

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

A.1.91.2 Description

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

A.1.91.3 Options

Table A-88 shows the command options for introspectCoherenceWeb.

Table A-88 introspectCoherenceWeb options

Name Alias Req'd Default Values Possible Values Description

-adminUser

au

true

none

N/A

Administrative name for the WebLogic domain.

-description

d

false

none

N/A

Description of the appliance or assembly being introspected.

-domainRoot

dr

true

none

N/A

Full path to the WebLogic domain root.

-force

f

false

none

N/A

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

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

none

N/A

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

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

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

-skipFileSetCapture

sf

false

none

N/A

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

-sudoUser

su

false

none

User name of sudo user.

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

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

-wlsHome

wh

true

none

N/A

Full path to the WebLogic home directory, generally <middleware home>/wlserver.


A.1.91.4 Examples

Here is a command example.

A.1.91.4.1 Basic Introspection of a Coherence Appliance

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

$ abctl introspectCoherenceWeb -name myIntrospection <Coherence options>

A.1.92 introspectForms

Details for this command follow.

A.1.92.1 Synopsis

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

A.1.92.2 Description

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

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

A.1.92.3 Options

Table A-89 shows the command options for introspectForms.

Table A-89 introspectForms options

Name Alias Req'd Default Values Possible Values Description

-adminUser

au

true

none

N/A

Administrative name for the Oracle WebLogic Server domain.

-description

d

false

none

N/A

Description of the appliance or assembly being introspected.

-domainRoot

dr

true

none

N/A

Full path to the Oracle WebLogic Server domain root.

-force

f

false

none

N/A

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

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

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

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

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

-soaGlobalCP

sgcp

false

none

Location of optional global configuration plan.

The absolute path to an optional global configuration plan.

-skipFileSetCapture

sf

false

none

N/A

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

-sudoUser

su

false

none

User name of sudo user.

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

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

-wlsHome

wh

true

none

WLS Home

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


A.1.92.4 Examples

Here are some command examples.

A.1.92.4.1 Basic Introspection

This is a basic introspection of a Forms appliance.

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

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

% abctl introspectForms -name myIntrospection <Forms options>

A.1.93 introspectGenericProd

Details for this command follow.

A.1.93.1 Synopsis

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

A.1.93.2 Description

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.

A.1.93.3 Options

Table A-90 shows the command options for introspectGenericProd.

Table A-90 introspectGenericProd options

Name Alias Req'd Default Values Possible Values Description

-description

d

false

none

N/A

Description of the appliance or assembly being introspected.

-force

f

false

none

N/A

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

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-productRoots

pr

true

none

The colon-separated list of product directories to capture.

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

-propertyFile

pf

true

none

Properties file containing properties to add to the appliance.

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

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

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

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

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

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

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

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

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

-remoteCleanup

rc

false

none

N/A

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

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

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

-scriptRootDir

srd

false

none

The top level directory containing the script subdirectories.

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

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

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

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

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

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

-skipFileSetCapture

sf

false

none

N/A

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

-sudoUser

su

false

none

User name of sudo user.

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

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


A.1.93.4 Examples

Here is a command example.

A.1.93.4.1 Basic Introspection of Appliance "GenericProd"

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

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

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

$ abctl introspectGenericProd -name myIntrospection <GenericProd options>

A.1.94 introspectOHS

Details for this command follow.

A.1.94.1 Synopsis

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

A.1.94.2 Description

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

A.1.94.3 Options

Table A-91 shows the command options for introspectOHS.

Table A-91 introspectOHS options

Name Alias Req'd Default Values Possible Values Description

-componentName

cn

true

none

N/A

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

-description

d

false

none

N/A

Description of the appliance or assembly being introspected.

-force

f

false

none

N/A

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

-name

n

false

Derived directory name prefixed by component type name

Any name not previously used within the catalog

Specifies a name by which the introspection output is stored.

-oracleInstance

oi

true

none

N/A

The absolute path of the ORACLE_INSTANCE to introspect.

-privateKeyFile

pkf

false

none

Location of a private key file.

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

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

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-remoteWorkingDir

rwd

false

/tmp/abRemote

N/A

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

-skipFileSetCapture

sf

false

none

N/A

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

-sudoUser

su

false

none

User name of sudo user.

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

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


A.1.94.4 Examples

Here are some command examples.

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

bad -oracleInstance value

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

A.1.95 introspectOTD

Details for this command follow.

A.1.95.1 Synopsis

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

A.1.95.2 Description

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

A.1.95.3 Options

Table A-92 shows the command options for introspectOTD.

Table A-92 introspectOTD options

Name Alias Req'd Default Values Possible Values Description

-configName

cn

true

none

Name of the Oracle Traffic Director configuration.

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

-description

d

false

none

N/A

Description of the appliance or assembly being introspected.

-force

f

false

none

N/A

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

-name

n

false

Derived directory name prefixed by component type name

Any name not previously used within the catalog

Specifies a name by which the introspection output is stored.

-oracleHome

oh

true

none

The directory where Oracle Traffic Director is installed.

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

-oracleInstance

oi

true

none

N/A

The absolute path of the ORACLE_INSTANCE to introspect.

-privateKeyFile

pkf

false

none

Location of a private key file.

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

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

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-remoteWorkingDir

rwd

false

/tmp/abRemote

N/A

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

-skipFileSetCapture

sf

false

none

N/A

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

-sudoUser

su

false

none

User name of sudo user.

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

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


A.1.95.4 Examples

Here are some command examples.

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

A.1.96 introspectRACDB

Details for this command follow.

A.1.96.1 Synopsis

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

A.1.96.2 Description

Examines CRS and RAC Database configuration and captures metadata.

A.1.96.3 Options

Table A-93 shows the command options for introspectRACDB.

Table A-93 introspectRACDB options

Name Alias Req'd Default Values Possible Values Description

-asmHome

ch

false

none

N/A

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

-crsHome

ch

true

none

N/A

The ORACLE_HOME of the Oracle CRS to be introspected.

-dbHome

dh

true

none

N/A

The ORACLE_HOME of the Oracle RDBMS to be introspected.

-description

d

false

none

N/A

Description of the appliance or assembly being introspected.

-globalDbName

dun

false

value specified for -oracleSid

N/A

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

-force

f

false

none

N/A

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

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

none

N/A

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

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

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

-shutdownDBOK

sdbok

true

none

N/A

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

-skipFileSetCapture

sf

false

none

N/A

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

-sysDBAUserName

sdbaun

false

none

N/A

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

-sudoUser

su

false

none

User name of sudo user.

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

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


A.1.96.4 Examples

Here are some command examples.

A.1.96.4.1 Basic Introspection

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

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

A.1.97 introspectReports

Details for this command follow.

A.1.97.1 Synopsis

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

A.1.97.2 Description

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

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

A.1.97.3 Options

Table A-96 shows the command options for introspectReports.

Table A-94 introspectReports options

Name Alias Req'd Default Values Possible Values Description

-adminUser

au

true

none

N/A

Administrative name for the Oracle WebLogic Server domain.

-description

d

false

none

N/A

Description of the appliance or assembly being introspected.

-domainRoot

dr

true

none

N/A

Full path to the Oracle WebLogic Server domain root.

-force

f

false

none

N/A

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

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

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

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

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

-soaGlobalCP

sgcp

false

none

Location of optional global configuration plan.

The absolute path to an optional global configuration plan.

-skipFileSetCapture

sf

false

none

N/A

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

-sudoUser

su

false

none

User name of sudo user.

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

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

-wlsHome

wh

true

none

WLS Home

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


A.1.97.4 Examples

Here are some command examples.

A.1.97.4.1 Basic Introspection

This is a basic introspection of a Reports appliance.

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

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

% abctl introspectReports -name myIntrospection <Reports options>

A.1.98 introspectSIDB

Details for this command follow.

A.1.98.1 Synopsis

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

A.1.98.2 Description

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

A.1.98.3 Options

Table A-95 shows the command options for introspectSIDB.

Table A-95 introspectSIDB options

Name Alias Req'd Default Values Possible Values Description

-dataFileDir

dfd

false

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

DB 11.1 and 11.2 release: $ORACLE_BASE/oradata

N/A

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

-dbHome

dh

true

none

N/A

The ORACLE_HOME of the Oracle RDBMS to be introspected.

-description

d

false

none

N/A

Description of the appliance or assembly being introspected.

-flashRecoveryDir

frd

false

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

DB 11.1 release: $ORACLE_BASE/flash_recovery_area

DB 11.2 release: $ORACLE_BASE/recovery_area

N/A

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

-force

f

false

none

N/A

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

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored

-oracleSid

os

true

none

N/A

The SID of the Oracle RDBMS to be introspected.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

none

N/A

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

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

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

-shutdownDBOK

sdbok

true

none

N/A

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

-skipFileSetCapture

sf

false

none

N/A

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

-sudoUser

su

false

none

User name of sudo user.

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

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


A.1.98.4 Examples

Here are some command examples.

A.1.98.4.1 Basic Introspection

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

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

A.1.99 introspectSOA

Details for this command follow.

A.1.99.1 Synopsis

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

A.1.99.2 Description

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

A.1.99.3 Options

Table A-96 shows the command options for introspectSOA.

Table A-96 introspectSOA options

Name Alias Req'd Default Values Possible Values Description

-adminUser

au

true

none

N/A

Administrative name for the WebLogic domain.

-description

d

false

none

N/A

Description of the appliance or assembly being introspected.

-domainRoot

dr

true

none

N/A

Full path to the WebLogic domain root.

-force

f

false

none

N/A

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

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

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

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

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

-soaGlobalCP

sgcp

false

none

Location of optional global configuration plan.

The absolute path to an optional global configuration plan.

-skipFileSetCapture

sf

false

none

N/A

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

-sudoUser

su

false

none

User name of sudo user.

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

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

-wlsHome

wh

true

none

WebLogic Home

Full path to the WebLogic home directory (usually, <middleware home>/wlserver).


A.1.99.4 Examples

Here are some command examples.

A.1.99.4.1 Basic Introspection

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

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

A.1.100 introspectTuxedo

Details for this command follow.

A.1.100.1 Synopsis

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

A.1.100.2 Description

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

A.1.100.3 Options

Table A-97 shows the command options for introspectTuxedo.

Table A-97 introspectTuxedo options

Name Alias Req'd Default Values Possible Values Description

-artCICSBatchHome

acicsah

false

none

N/A

The absolute path to the ART CICS Application Home.

-artBatchSecurityProfile

absp

false

none

N/A

The absolute path to the security_profile for ART Batch.

-description

d

false

none

N/A

Description of the appliance or assembly being introspected.

-environmentScript

es

false

none

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

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

-force

f

false

none

N/A

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

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-oracleClientDir

ocd

false

none

The absolute path to the Oracle Database Client software.

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

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

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

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

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

-soaGlobalCP

sgcp

false

none

Location of optional global configuration plan.

The absolute path to an optional global configuration plan.

-skipFileSetCapture

sf

false

none

N/A

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

-sudoUser

su

false

none

User name of sudo user.

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

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

-tnsNamesLocation

tnl

false

none

The absolute path to the TNSNAMES.ora file.

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

-TUXDIR

tuxdir

true

none

N/A

The absolute path to the TUXDIR to introspect.

-TUXCONFIG

tuxconfig

true

none

N/A

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


A.1.100.4 Examples

Here are some command examples.

A.1.100.4.1 Basic Introspection

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

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

A.1.101 introspectWLS

Details for this command follow.

A.1.101.1 Synopsis

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

A.1.101.2 Description

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

A.1.101.3 Extensions

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

A.1.101.4 CoherenceWeb Extension Description

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

A.1.101.5 SOACoherence Extension Description

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

A.1.101.6 SOA Extension Description

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

A.1.101.7 Options

Table A-98 shows the command options for introspectWLS.

Table A-98 introspectWLS options

Name Alias Req'd Default Values Possible Values Description

-adminUser

au

true

none

N/A

Administrative name for the WebLogic domain.

-description

d

false

none

N/A

Description of the appliance or assembly being introspected.

-domainRoot

dr

true

none

N/A

Full path to the WebLogic domain root directory.

-force

f

false

none

N/A

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

-name

n

false

Derived directory name prefixed by component type name.

Any name not already used within the catalog.

Specifies a name by which the introspection output is stored.

-privateKeyFile

pkf

false

none

N/A

Private SSH key file on the local machine.

-remoteCleanup

rc

false

false

N/A

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

-remoteHost

rh

false

none

N/A

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

-remoteUser

ru

false

none

N/A

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

-remoteWorkingDir

rwd

false

/tmp/abRemote_<remote user name>

N/A

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

-skipFileSetCapture

sf

false

none

N/A

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

-soaGlobalCP

sgcp

false

none

Location of optional global configuration plan.

The absolute path to an optional global configuration plan.

-sudoUser

su

false

none

User name of sudo user.

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

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

-wlsHome

wh

true

none

WebLogic Home

Full path to the WebLogic home directory (usually, <middleware home>/wlserver).


A.1.101.8 Examples

Here are some command examples.

A.1.101.8.1 Successful Introspection:

local execution with use of all options

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

local execution with all defaults and short names

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

A.1.102 redeployAssemblyInstance

Details for this command follow.

A.1.102.1 Synopsis

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

A.1.102.2 Description

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

A.1.102.3 Options

Table A-99 shows the command options for redeployAssemblyInstance.

Table A-99 redeployAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to redeploy.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-pollTime

pt

false

5

A string representing the number of seconds.

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

-waitForComplete

w

false

no

N/A

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


A.1.102.4 Examples

Here are some command examples.

A.1.102.4.1 Redeploy Deployment
$ abctl redeployAssemblyInstance -assemblyInstanceId MyId

A.1.103 registerAssemblyArchive

Details for this command follow.

A.1.103.1 Synopsis

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

A.1.103.2 Description

Registers an assembly archive in the Deployer.

A.1.103.3 Options

Table A-100 shows the command options for registerAssemblyArchive.

Table A-100 registerAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-name

n

true

none

A string representing the name of the assembly archive.

The name of the assembly archive.

-pollTime

pt

false

5

A string representing the number of seconds.

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

-target

t

false

none

A string representing the name of the target.

The name of the target.

-version

v

false

none

A string representing the version of the assembly archive.

The version of the assembly archive.

-waitForComplete

w

false

no

N/A

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


A.1.103.4 Examples

Here are some command examples.

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

A.1.104 removeAssemblyUsers

Details for this command follow.

A.1.104.1 Synopsis

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

A.1.104.2 Description

Removes one or more users from an assembly.

A.1.104.3 Options

Table A-103 shows the command options for removeAssemblyUsers.

Table A-101 getDefaultTarget options

Name Alias Req'd Default Values Possible Values Description

-assembly

a

false

none

A string representing the name of the assembly archive.

Specifies the assembly to remove users from.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-user

u

true

none

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

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


A.1.104.4 Examples

Here are some command examples.

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

A.1.105 removePlugin

Details for this command follow.

A.1.105.1 Synopsis

$ abctl removePlugin [-pluginName] String

A.1.105.2 Description

Recursively removes the specified plug-in or extension and any child extensions.

A.1.105.3 Options

Table A-102 shows the command options for removePlugin.

Table A-102 removePlugins options

Name Alias Req'd Default Values Possible Values Description

-pluginName

pn

true

none

N/A

A single plug-in name.


A.1.105.4 Examples

Here are some command examples.

A.1.105.4.1 Remove Plug-in
$ abctl removePlugin WLS

A.1.106 removeTargetUsers

Details for this command follow.

A.1.106.1 Synopsis

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

A.1.106.2 Description

This command removes a user from the target.

A.1.106.3 Options

Table A-103 shows the command options for removeTargetUsers.

Table A-103 getDefaultTarget options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-target

t

true

none

A string representing the target to add the user to.

The target to add the user to.

-user

u

true

none

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

The usernames of the users to remove from the target.


A.1.106.4 Examples

Here are some command examples.

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

A.1.107 renameExternalResource

Details for this command follow.

A.1.107.1 Synopsis

$ abctl renameExternalResource -currentName String -newName String -assembly String

A.1.107.2 Description

Renames the specified external resource. Only external resources can be renamed.

A.1.107.3 Options

Table A-104 shows the command options for renameExternalResource.

Table A-104 renameExternalResource options

Name Alias Req'd Default Values Possible Values Description

-currentName

cn

true

none

N/A

The name of the external resource to be renamed.

-newName

nn

true

none

N/A

The new name for the external resource.

-assembly

as

true

none

N/A

The assembly containing the external resource to be renamed.


A.1.107.4 Examples

Here are some command examples.

A.1.107.4.1 Rename External Resource
% abctl renameExternalResource -assembly mySite -currentName jdbc0 -newName myDatabase

A.1.108 restartAssemblyInstance

Details for this command follow.

A.1.108.1 Synopsis

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

A.1.108.2 Description

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

A.1.108.3 Options

Table A-105 shows the command options for restartAssemblyInstance.

Table A-105 restartAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to be restarted.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-pollTime

t

false

5

A string representing the number of seconds.

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

-waitForComplete

w

false

no

N/A

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


A.1.108.4 Examples

Here are some command examples.

A.1.108.4.1 Restart Deployment
$ abctl restartAssemblyInstance -assemblyInstanceId MyId

A.1.109 resumeAssemblyInstance

Details for this command follow.

A.1.109.1 Synopsis

$ abctl resumeAssemblyInstance -assemblyInstanceId String -connectionName String [-waitForComplete] [-pollTime Numeric]

A.1.109.2 Description

This command resumes a suspended assembly instance.

A.1.109.3 Options

Table A-106 shows the command options for resumeAssemblyInstance.

Table A-106 resumeAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-waitForComplete

w

false

no

N/A

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

-pollTime

pt

false

5

A string representing the number of seconds.

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


A.1.109.4 Examples

Here are some command examples.

A.1.109.4.1 Resume Assembly Instance
$ abctl resumeAssemblyInstance -assemblyInstanceId MyId

A.1.110 scale

Details for this command follow.

A.1.110.1 Synopsis

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

A.1.110.2 Description

Scales a scaling group to a new size.

A.1.110.3 Options

Table A-107 shows the command options for scale.

Table A-107 scale options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-pollTime

pt

false

5

A string representing the number of seconds.

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

-scalingGroupId

s

true

none

A string representing the scalingGroupId.

The scalingGroupId of a scalingGroup.

-target

t

true

none

A string representing the new target.

The new value to scale to.

-waitForComplete

w

false

no

N/A

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


A.1.110.4 Examples

Here are some command examples.

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

A.1.111 scaleDown

Details for this command follow.

A.1.111.1 Synopsis

$ abctl scaleDown -applianceInstanceIds String -target String -connectionName String [-waitForComplete]

A.1.111.2 Description

Scales the specified appliance instance IDs to a new size.

A.1.111.3 Options

Table A-108 shows the command options for scaleDown.

Table A-108 scaleDown options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-target

t

true

none

A string representing the new target.

The new value to scale to.

-waitForComplete

w

false

no

N/A

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


A.1.111.4 Examples

Here are some command examples.

A.1.111.4.1 Scale Down
$ abctl scaleDown -applianceInstanceIds BNbV9P5Td-deployAssembly:deployAssembly/prod0/1 -connectionName adminConn -waitForComplete

A.1.112 setCatalogProperty

Details for this command follow.

A.1.112.1 Synopsis

$ abctl setCatalogProperty -containerAddress String -name String -value String

A.1.112.2 Description

This command allows a property value to be updated within the catalog metadata. Not all properties in the catalog are are settable.

A.1.112.3 Options

Table A-109 shows the command options for setCatalogProperty.

Table A-109 setCatalogProperty options

Name Alias Req'd Default Values Possible Values Description

-containerAddress

c

true

none

A variable number of arguments.

Takes a variable number of arguments to specify a single container (such as an assembly, appliance, vnet, or physical interface) within the catalog's metadata hierarchy. It comprises a series of 'steps' one would take for navigating down through this hierarchy, starting from the root (catalog) level.

The argument follows a Unix-like syntax although it does not refer to an actual directory path. It always begin with a slash ("/") character.

For instance, to specify the Resource Requirements of the AdminServer appliance of a Weblogic server named wls1 of an assembly named "mySite", the container address is: /assemblies/mySite/assemblies/wls1/appliances/AdminServer/resource-requirements

-name

n

true

none

A string representing the name of a single property.

Specifies a single property in the output. This is useful primarily to enable a script to extract (scrape) a specific value from stdout. If the name parameter is omitted, all properties and child containers of the specified container are displayed.

-value

v

true

none

A string representing the value to be assigned.

Specifies a string representation of the value to be assigned to the property being updated.

Assigning an empty string ("") clears the current value, regardless of the property type.

For security reasons, passwords cannot be entered directly in the command itself. To assign a new value to a password property, specify a non-blank value (such as "xxx") to activate password prompting. Assigning an empty string ("") clears the password without prompting.


A.1.112.4 Examples

Here are some command examples.

A.1.112.4.1 Set Catalog Property
$ abctl setCatalogProperty -ca /appliances/ohs1/resource-requirements -name memory-mb -value 2048Successfully set property memory-mb
A.1.112.4.2 Clearing a Property Value
$ abctl setCatalogProperty -ca /assemblies/wls1/appliances/AdminServer/inputs/Default -name port -value ""Successfully set property port
A.1.112.4.3 Setting a Password Property
$ abctl setCatalogProperty -ca /assemblies/wls1/user-properties -name admin-password -value xxx Enter password for property admin-password : Enter same passord to confirm : Successfully set property admin-password.

A.1.113 setDefaultTarget

Details for this command follow.

A.1.113.1 Synopsis

$ abctl setDefaultTarget -name String -connectionName String

A.1.113.2 Description

This command sets a target as the default.

A.1.113.3 Options

Table A-110 shows the command options for setDefaultTarget.

Table A-110 setDefaultTarget options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-name

n

true

none

A string representing the name of the target.

The name of the target.


A.1.113.4 Examples

Here are some command examples.

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

A.1.114 startAssemblyInstance

Details for this command follow.

A.1.114.1 Synopsis

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

A.1.114.2 Description

Starts an assembly instance.

A.1.114.3 Options

Table A-111 shows the command options for startAssemblyInstance.

Table A-111 startAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to be started.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-pollTime

pt

false

5

A string representing the number of seconds.

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

-waitForComplete

w

false

no

N/A

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


A.1.114.4 Examples

Here are some command examples.

A.1.114.4.1 Start Assembly Instance
$ abctl startAssemblyInstance

A.1.115 stopAssemblyInstance

Details for this command follow.

A.1.115.1 Synopsis

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

A.1.115.2 Description

This command stops a deployment for an assembly instance.

A.1.115.3 Options

Table A-112 shows the command options for stopAssemblyInstance.

Table A-112 stopAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to be stopped.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-force

f

false

none

True/false.

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

-pollTime

pt

false

5

A string representing the number of seconds.

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

-waitForComplete

w

false

no

N/A

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


A.1.115.4 Examples

Here are some command examples.

A.1.115.4.1 Stop Assembly Instance
$ abctl stopAssemblyInstance

A.1.116 suspendAssemblyInstance

Details for this command follow.

A.1.116.1 Synopsis

$ abctl suspendAssemblyInstance -assemblyInstanceId String -connectionName String [-waitForComplete] [-pollTime Numeric]

A.1.116.2 Description

This command suspends an assembly instance.

A.1.116.3 Options

Table A-113 shows the command options for resumeAssemblyInstance.

Table A-113 suspendAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-waitForComplete

w

false

no

N/A

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

-pollTime

pt

false

5

A string representing the number of seconds.

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


A.1.116.4 Examples

Here are some command examples.

A.1.116.4.1 Suspend Assembly Instance
$ abctl suspendAssemblyInstance -assemblyInstanceId MyId

A.1.117 unbindAssemblyFileSetDefinition

Details for this command follow.

A.1.117.1 Synopsis

$ abctl unbindAssemblyFileSetDefinition -name String -from String

A.1.117.2 Description

Unbinds an assembly file set definition from an appliance. Unbinding it from one appliance in an atomic assembly unbinds it from all appliances in that atomic assembly.

A.1.117.3 Options

Table A-114 shows the command options for unbindAssemblyFileSetDefinition.

Table A-114 unbindAssemblyFileSetDefinition options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

N/A

Name of file set definition on top level, non-atomic assembly.

-from

fr

true

none

N/A

Path to nested appliance.


A.1.117.4 Examples

Here are some command examples.

A.1.117.4.1 Bind Assembly File Set Definition
% abctl unbindAssemblyFileSetDefinition -name middleware -from mySite/ohs1

A.1.118 undeployAssemblyInstance

Details for this command follow.

A.1.118.1 Synopsis

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

A.1.118.2 Description

Undeploys an assembly instance.

A.1.118.3 Options

Table A-115 shows the command options for undeployAssemblyInstance.

Table A-115 undeployAssemblyInstance options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

d

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to undeploy.

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-pollTime

pt

false

5

A string representing the number of seconds.

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

-waitForComplete

w

false

no

N/A

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


A.1.118.4 Examples

Here are some command examples.

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

A.1.119 unregisterAssemblyArchive

Details for this command follow.

A.1.119.1 Synopsis

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

A.1.119.2 Description

This command unregisters an assembly from the Deployer.

A.1.119.3 Options

Table A-116 shows the command options for unregisterAssemblyArchive.

Table A-116 unregisterAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-name

n

true

none

A string representing the name of the assembly archive.

The name of the assembly archive.

-pollTime

pt

false

5

A string representing the number of seconds.

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

-target

t

false

none

A string representing the name of the target.

The name of the target.

-version

v

false

none

A string representing the version of the assembly archive.

The version of the assembly archive.

-waitForComplete

w

false

no

N/A

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


A.1.119.4 Examples

Here are some command examples.

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

A.1.120 updateAssemblyArchive

Details for this command follow.

A.1.120.1 Synopsis

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

A.1.120.2 Description

Updates the description (attributes) of an assembly archive in the Deployer.

A.1.120.3 Options

Table A-117 shows the command options for updateAssemblyArchive.

Table A-117 updateAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-description

d

true

none

A string representing the description of the assembly archive.

The description of the assembly archive.

-name

n

true

none

A string representing the name of the assembly archive.

The name of the assembly archive.

-version

v

true

none

A string representing the version of the assembly archive.

The version of the assembly archive.


A.1.120.4 Examples

Here are some command examples.

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

A.1.121 updateDeployerConfig

Details for this command follow.

A.1.121.1 Synopsis

$ abctl updateDeployerConfig -properties String... [-domainRoot Path]

A.1.121.2 Description

Updates the configuration of the deployer. Configuration properties supported are: ovab.webserver.url and ovab.directory.

A.1.121.3 Options

Table A-118 shows the command options for updateDeployerConfig.

Table A-118 updateDeployerConfig options

Name Alias Req'd Default Values Possible Values Description

-properties

p

true

none

A string representing the properties and values to update.

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

-domainRoot

dr

false

none

A string representing the root directory of the Deployer domain.

The root directory of the Deployer domain.


A.1.121.4 Examples

Here are some command examples.

A.1.121.4.1 Update Deployer Configuration
$ abctl updateDeployerConfig -properties ovab.webserver.url=http://localhost:7001 ovab.directory=c:/files

A.1.122 updateTarget

Details for this command follow.

A.1.122.1 Synopsis

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

A.1.122.2 Description

Updates one or more property values. This command is enabled for Oracle VM targets.

A.1.122.3 Options

Table A-119 shows the command options for updateTarget.

Table A-119 updateTarget options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-name

n

true

none

A string representing the name of the target.

The name of the target.

-properties

p

false

none

A string representing the properties and values to update.

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


A.1.122.4 Examples

Here are some command examples.

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

A.1.123 uploadAssemblyArchive

Details for this command follow.

A.1.123.1 Synopsis

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

A.1.123.2 Description

Uploads an assembly archive to Oracle Virtual Assembly Builder Deployer.

A.1.123.3 Options

Table A-120 shows the command options for uploadAssemblyArchive.

Table A-120 uploadAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-connectionName

c

true

none

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

The name of a connection to the Deployer.

-fileName

fn

true

none

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

Uploads an assembly archive to the Deployer.

-name

n

true

none

A string representing the name of the assembly archive.

The name of the assembly archive.

-description

d

false

none

A string representing the description of the assembly archive.

The description of the assembly archive.


A.1.123.4 Examples

Here are some command examples.

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

A.1.124 uploadAssemblyResources

Details for this command follow.

A.1.124.1 Synopsis

$ abctl uploadAssemblyResources -fileName Path -assemblyName String -version String -connectionName String [-append]

A.1.124.2 Description

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 CloudAdmin 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

A.1.124.3 Options

Table A-121 shows the command options for uploadAssemblyResources.

Table A-121 uploadAssemblyResources options

Name Alias Req'd Default Values Possible Values Description

-fileName

fn

true

none

A string representing the file path to the assembly resources files on disk.

Uploads an assembly resources file to the Deployer.

-assemblyName

n

true

none

A string representing the name of the assembly.

The name of the assembly.

-version

v

false

none

A string representing the assembly version.

The assembly version.

-append

a

false

none

A flag, that if set, appends the assembly resources file upload.

If set, the assembly resources file upload is appended.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.124.4 Examples

Here are some command examples.

A.1.124.4.1 Upload Assembly Resources File
$ abctl uploadAssemblyResources -assemblyName myAssembly -version 1 -fileName resources.zip -connectionName myConnection

Upload File Size: 2,708
100% Complete
Assembly resources zip has been uploaded to associate with assembly myAssembly, version 1.

A.1.125 uploadDeploymentPlan

Details for this command follow.

A.1.125.1 Synopsis

$ abctl uploadDeploymentPlan -fileName Path -assemblyName String -version String -planName String -connectionName String

A.1.125.2 Description

Uploads a deployment plan for an existing assembly.

A.1.125.3 Options

Table A-122 shows the command options for uploadDeploymentPlan.

Table A-122 uploadDeploymentPlan options

Name Alias Req'd Default Values Possible Values Description

-fileName

fn

true

none

A path to the deployment plan file.

The file name of the deployment plan to upload.

-assemblyName

an

true

none

A string representing the name of the assembly.

The name of the assembly.

-version

v

true

none

A string representing the assembly version.

The assembly version.

-planName

pn

true

none

A string representing the name of the deployment plan.

The name of the deployment plan.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.125.4 Examples

Here are some command examples.

A.1.125.4.1 Upload Deployment Plan
$ abctl 

A.1.126 uploadEMAssemblyArchive

Details for this command follow.

A.1.126.1 Synopsis

$ abctl uploadEMAssemblyArchive -name String -[description String]

A.1.126.2 Description

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

A.1.126.3 Options

Table A-123 shows the command options for uploadEMAssemblyArchive.

Table A-123 uploadEMAssemblyArchive options

Name Alias Req'd Default Values Possible Values Description

-name

n

true

none

Top level appliance or assembly in the catalog.

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

-description

d

false

none

Textual description.

A description of the assembly and assembly archive.


A.1.126.4 Examples

Here is a command example.

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

A.1.127 validateAssemblyArchiveResources

Details for this command follow.

A.1.127.1 Synopsis

$ abctl validateAssemblyArchiveResources -metaDataFilePath String -deploymentPlan String -targetName String -connectionName String

A.1.127.2 Description

Validates whether an assembly will deploy successfully based on resource requirements.

A.1.127.3 Options

Table A-124 shows the command options for validateAssemblyArchiveResources.

Table A-124 validateAssemblyArchiveResources options

Name Alias Req'd Default Values Possible Values Description

-metaDataFilePath

m

true

none

A string representing path to an assembly metadata file.

A path to an assembly metadata file.

-deploymentPlan

d

true

none

A string representing path to an assembly deployment plan.

A path to an assembly deployment plan.

-targetName

t

true

none

A string representing a target to check resources against.

The target to check resources against.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.127.4 Examples

Here are some command examples.

A.1.127.4.1 Validate Assembly Archive Resources
$ abctl validateAssemblyArchiveResources -assemblyName MyAssembly -assemblyVersion 1 -metaDataFilePath c:/MyAssembly.ovf -deploymentPlan c:/MyPlan.xml -targetName MyTarget

A.1.128 validateAssemblyInstanceResources

Details for this command follow.

A.1.128.1 Synopsis

$ abctl validateAssemblyInstanceResources -assemblyInstanceId String -connectionName String

A.1.128.2 Description

Validates whether an assembly instance will deploy successfully based on resource requirements.

A.1.128.3 Options

Table A-125 shows the command options for validateAssemblyInstanceResources.

Table A-125 validateAssemblyArchiveResources options

Name Alias Req'd Default Values Possible Values Description

-assemblyInstanceId

a

true

none

A string representing the assemblyInstanceId.

The identifier of an assembly instance to be deleted.

-connectionName

c

true

none

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

The name of a connection to the Deployer.


A.1.128.4 Examples

Here are some command examples.

A.1.128.4.1 Validate Assembly Instance Resources
$ abctl validateAssemblyInstanceResources -assemblyInstanceId MyId

A.1.129 verifyEMConnection

Details for this command follow.

A.1.129.1 Synopsis

$ abctl verifyEMConnection -connectionURL String -connectionUser String -namedHostCredential String -remoteUser String -remoteWorkingDir Path [-sshPort Numeric] [-privateKeyFile Path] [-fullVerification]

A.1.129.2 Description

Verifies a connection to an Enterprise Manager Software Library. The default command validates the connection to EM. The -fullVerification option attempts to upload and download a test assembly archive.

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

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

A.1.129.3 Options

Table A-126 shows the command options for verifyEMConnection.

Table A-126 verifyEMConnection options

Name Alias Req'd Default Values Possible Values Description

-connectionURL

c

true

none

Hostname:port.

URL for connecting to EM Software Library.

-connectionUser

cu

true

none

Valid EM Software Library User.

User for EM Software Library.

-namedHostCredential

n

true

none

Valid Named Host Credential.

Named Host Credential.

-remoteUser

ru

true

none

Valid SSH user.

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

-remoteWorkingDir

rwd

true

none

/scratch,/home/mydir

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

-sshPort

s

false

none

Valid SSH port number.

SSH port for EM Software Library machine.

-privateKeyFile

pkf

false

none

~/.ssh/id_rsa, id_rsa

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

-fullVerification

fv

false

none

 

When this flag is specified, the command attempts to upload and download a test assembly archive.


A.1.129.4 Examples

Here are some command examples.

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

A.1.130 version

Details for this command follow.

A.1.130.1 Synopsis

$ abctl version

A.1.130.2 Description

Displays the Oracle Virtual Assembly Builder specification version.

A.1.130.3 Example

$ abctl version

A.2 Help

Details for this command follow.

A.2.1 Synopsis

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

A.2.2 Description

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

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

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

A.2.3 Options

Table A-127 shows the command options for help.

Table A-127 help options

Name Alias Req'd Default Values Possible Values Description

-command

c

false

none

Name of a command.

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

-usage

u

false

none

 

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

-category

c

false

none

 

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

-quiet

q

false

none

N/A

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


A.2.4 Examples

Here are some command examples.

A.2.4.1 No Arguments

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

A.2.4.2 Specifying Help on a Category of Commands

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

A.2.4.3 Help with a -command parameter specified

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

...

EXAMPLES
 
abctl captureFileSets -name myOhs -force

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

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