| Oracle® Virtual Assembly Builder User's Guide 11g Release 1.1 (11.1.1) Part Number E22514-01 |
|
|
View PDF |
| Oracle® Virtual Assembly Builder User's Guide 11g Release 1.1 (11.1.1) Part Number E22514-01 |
|
|
View PDF |
The following sections contain information about the abctl commands included in Oracle Virtual Assembly Builder.
Section A.3, "Command Quick Reference"
Note:
abctl commands are case-sensitive. You must specify command names, operation names, and attribute names using the appropriate case. For example: the command
deployApp is different from deployapp.The following commands are detailed below:
Details for this command follow.
checkResources [-name string] [-plan string] [-resourceManager string] [-pool string] [-id string] [-appliance string] [-target string]
This command verifies that sufficient resources are available for a deploy or scale operation. To check for sufficient resources for a deploy operation, specify the assembly and resource manager along with an optional pool name and an optional deployment plan. To check for sufficient resources for a scale operation, specify the deployment ID, the appliance, and the target numbers of the virtual machines.
Table A-15 shows the command options for checkResources.
Table A-1 checkResources options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
false |
none |
Path to an appliance within an assembly. For example: /MySubAssembly/MyAppliance |
"/" separated path to an appliance within an assembly. |
|
|
i |
false |
none |
An existing deployment ID. |
ID of the deployment. |
|
|
n |
false |
none |
The name of an existing assembly. |
The name of an existing assembly. |
|
|
p |
false |
none |
The name of an existing plan. |
The name of an existing plan. |
|
|
po |
false |
none |
The name of a configured pool. |
The name of a configured pool. |
|
|
rm |
false |
none |
The name of a configured resource manager. |
The name of a configured resource manager. |
|
|
tg |
false |
none |
The target number of VMs for an appliance. The value must be between the minimum and maximum number of VMs for that appliance. |
The target number of VMs for an appliance. |
Here are some command examples.
abctl checkResources -n mySite -rm locbox-ovmm-22 ---------------------------------------------------------------------------- Appliance | Type | Min | Target | Memory | Disk ---------------------------------------------------------------------------- /db1 | External | --- | --- | --- | --- /jms1 | External | --- | --- | --- | --- /oid1 | External | --- | --- | --- | --- /wlsDomain/AdminServer | WLS | 1 | 1 | 1024 | 2652 /wlsDomain/new_Cluster_1 | WLS | 1 | 2 | 1024 | 2652 /wlsDomain/new_ManagedServer_3 | WLS | 1 | 1 | 1024 | 2652 ------------------------------ | -------- | --- | ------ | ------ | ------ Required | | | | 4096 | 10608 ------------------------------ | -------- | --- | ------ | ------ | ------ Available | | | | 30295 | 927156 Sufficient | | | | Yes | Yes Max Single | | | | --- | --- ----------------------------------------------------------------------------
abctl checkResources -i xy44_3yrz_mySite -a /wlsDomain/new_Cluster_1 -tg 2 ------------------------------------------------------------------------------------------- Appliance | Type | Min | Max | Target | Running | Failed | Memory | Disk ------------------------------------------------------------------------------------------- /wlsDomain/new_Cluster_1 | WLS | 1 | 2 | 2 | 1 | 0 | 1024 | 2652 ------------------------ | ---- | --- | --- | ------ | ------- | ------ | ------ | ------ Required | | | | | | | 1024 | 2652 ------------------------ | ---- | --- | --- | ------ | ------- | ------ | ------ | ------ Available | | | | | | | 27222 | 919201 Sufficient | | | | | | | Yes | Yes Max Single | | | | | | | --- | --- -------------------------------------------------------------------------------------------
Details for this command follow.
$ abctl createTemplate -name string -target string [-quiet] [-baseImage string] [-jrve] [-force]
Table A-2 shows the command options for createTemplate.
Table A-2 createTemplate options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
f |
false |
false |
N/A |
If |
|
|
bi |
false |
If not specified, the command will attempt to locate the base image from |
Path to the valid base image. |
Refers to the path to the valid base image used to create VM templates. |
|
|
v |
false |
none |
N/A |
Creates a template for WebLogic Server assemblies. This option is only applicable for WebLogic Server assemblies. The command will result in an error if this option is set and the template creation target is not a WebLogic Server assembly. |
|
|
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. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
|
|
tg |
true |
none |
OVM |
Target platform for which the VM template is built. |
Examples for this command follow.
$ abctl createTemplate -name myOhs -target OVM Executing createTemplate command. Error: OAB-7389: Failed to create VM template for myOhs. Caused by: OAB-20343: Unable to locate a valid default base image. Action: Specify a base image location, or place a base image in default location. Refer to user guide for detail.
$ abctl createTemplate -name myOhs -target OVM Executing createTemplate command. Error: OAB-7389: Failed to create VM template for myOhs. Caused by: OAB-20119: Appliance myOhs is not packaged yet. Action: Package the appliance first.
$ abctl createTemplate -name myOhs -target OVM Executing createTemplate command. Error: OAB-7389: Failed to create VM template for myOhs. Caused by: OAB-20120: Appliance myOhs already has template for OEL. Action: Use -force flag to override existing template.
$ abctl createTemplate -name myOhs -target OVM
Executing createTemplate command.
Set the root and vnc passwords that will be configured in the template.
Enter root password:
Retype root password:
Enter vnc password:
Retype vnc password:
Step 1 of 2: Creating template for appliance myOhs started.
Step 1 of 6: Copying base image to catalog started.
Step 2 of 6: Copying base image to catalog completed.
Step 3 of 6: Creating AB image started.
Step 4 of 6: Creating AB image completed.
Step 5 of 6: Creating product disk for myOhs_root started.
Step 6 of 6: Creating product disk for myOhs_root completed.
Step 2 of 2: Creating template for appliance myOhs completed.
Successfully created template for myOhs.
Details for this command follow.
Deletes the appliance or assembly with the given name. Only the top-level appliance or assembly can be deleted. Nested appliances or assemblies cannot be deleted using this command. Also, registered appliances or assemblies cannot be deleted.
Here are some command examples.
$ abctl delete -name mySite Executing delete command. Error: OAB-7667: Unable to delete mySite from catalog. Caused by: OAB-7669: Assembly mySite is registered. Action: Unregister mySite first.
$ 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.
Details for this command follow.
$ abctl deploy -name String -resourceManager String [-plan string] [-pool string] [-quiet]
Initiate the deployment of an assembly.
Additional information for each appliance and assembly will be shown if [-long] is set.
Table A-4 shows the command options for deploy.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
.none |
The name of an existing assembly. |
The name of an existing assembly. |
|
|
p |
false |
none |
Name of an existing plan. |
Name of a deployment plan. |
|
|
po |
false |
none |
Name of a configured pool. |
The name of a configured pool. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
|
|
rm |
true |
none |
Name of a configured Resource Manager. |
The name of a configured Resource Manager. |
Here is a command example.
% abctl deploy -n mySite -p plan1 -rm MyResourceManager Appliance | Type | Min | Target ---------------------------------------- /AdminServer | WLS | 1 | 1 /ManagedServer_1 | WLS | 1 | 1 ---------------------------------------- Step 1 of 4 Create Deployment Created Deployment : GqMw_3bzc_mySite_plan1 Step 2 of 4 Stage VMs Staging AdminServer-0 Staged AdminServer-0 Staging ManagedServer_1-0 Staged ManagedServer_1-0 Step 3 of 4 Prepare VMs Preparing AdminServer-0 Prepared AdminServer-0 Preparing ManagedServer_1-0 Prepared ManagedServer_1-0 Step 4 of 4 Start VMs Starting AdminServer-0[jrve6.us.oracle.com] Started AdminServer-0[jrve6.us.oracle.com] Starting ManagedServer_1-0[jrve1.us.oracle.com] Started ManagedServer_1-0[jrve1.us.oracle.com] Assembly mySite has been deployed with deployment id : GqMw_3bzc_mySite_plan1 %
Details for this command follow.
Exports an appliance or assembly to disk so that it can later be imported to another catalog.
Table A-5 shows the command options for export.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
m |
false |
none |
N/A |
If set to true, only the metadata portion is exported, and packages and templates will not be exported. |
|
|
n |
true |
none |
Top level appliance or assembly in the catalog. Nested appliances cannot be exported. |
Name of a top level appliance or assembly in the catalog. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
|
|
td |
true |
none |
A path to a directory. The directory must be empty. A non-existing directory will be created. |
Path to the directory to which a specified appliance or assembly will be exported. If a relative path is given, it will be relative to AB_INSTANCE. |
Here are some command examples.
$ abctl export -name mySite -toDir /tmp/mySite.exp
Executing export to /tmp/mySite.exp.
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.exp.
$ abctl export -name mySite -toDir /tmp/mySite.exp -metadataOnly
Executing export to /tmp/mySite.exp.
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.exp.
$ abctl export -name myOhs -toDir /tmp/non-empty-dir Executing export to /tmp/non-empty-dir. Error: OAB-7443: Failed to export myWls to /tmp/non-empty-dir. Caused by: OAB-09509: Directory is not empty at /tmp/non-empty-dir. Action: Clean up the directory, or choose an empty directory.
Details for this command follow.
Details for this command follow.
Imports from exported appliances or assemblies in the specified directory to the catalog.
Table A-6 shows the command options for import.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
f |
false |
false |
N/A |
If set, overwrites an existing top-level appliance or assembly in the catalog that has the same name as the imported one. |
|
|
fd |
true |
none |
Path to the directory containing the exported copy. |
The directory to which an appliance or assembly is exported. |
|
|
ia |
false |
none |
none |
If set, the imported appliance or assembly will be saved as the given name in the target catalog. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
Here are some command examples.
$ abctl import -fromDir /tmp/foo Error: OAB-7414: Failed to import from /tmp/foo. Caused by: OAB-09504: Directory does not exist at /tmp/foo. Action: Make sure to import from a valid directory.
$ abctl import -fromDir /tmp/foo Error: OAB-7414: Failed to import from /tmp/foo. Caused by: OAB-09505: Failed to read metadata file from /tmp/foo. Action: Make sure to import from a valid directory.
$ abctl import -fromDir /tmp/myWls.exp Executing import from /tmp/myWls.exp. Error: OAB-7414: Failed to import from /tmp/myWls.exp. Caused by: OAB-09513: Catalog already contains assembly myWls. Action: Choose a different name to import it as.
$ abctl import -fromDir /tmp/myWls.exp -force
Executing import from /tmp/myWls.exp.
Step 1 of 2: Copying from source to dest.
Copying: 100% of 288B completed.
Copying: 100% of 1024MB completed.
Copying: 100% of 1024B completed.
Copying: 100% of 1024B completed.
Copying: 100% of 1024B completed.
Step 2 of 2: Copying from source to dest completed.
Successfully imported component from /tmp/myWls.exp.
Details for this command follow.
Imports an existing virtual machine template located at the specified directory into the specified catalog as an external appliance.
Table A-6 shows the command options for importExternalTemplate.
Table A-8 importExternalTemplate options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
f |
false |
false |
N/A |
If set, overwrites an existing top-level appliance or assembly in the catalog that has the same name as the imported one. |
|
|
fd |
true |
none |
Directory containing the VM template. |
Path to the directory containing the VM template. |
|
|
n |
true |
none |
A name that will be unique among top-level appliances or assemblies in a catalog. |
If set, the imported template will be saved as the given name in the target catalog. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
Here are some command examples.
$ abctl importExternalTemplate -fromDir /does/not/exist -name myExternalAppliance Error: OAB-7490: Failed to import template from /does/not/exist. Cause: Specified directory /does/not/exist does not exist. Action: Specify a valid directory where an OVM template can be found.
$ abctl importExternalTemplate -fromDir /my/OVM/template/ -name myExternalAppliance
Executing importExternalTemplate command.
Error: OAB-7490: Failed to import template from /my/OVM/template/.
Caused by: OAB-7495: An appliance {0} already exists in the catalog.
Action: Choose a different name for imported template, or use "-force" to overwrite.
$ abctl importExternalTemplate -fromDir /my/OVM/template/ -name myExternalAppliance -force
Executing importExternalTemplate command.
Set the root and vnc passwords that will be configured in the imported template.
Enter root password:
Retype root password:
Enter vnc password:
Retype vnc password:
Step 1 of 3: Deleting existing appliance myExternalAppliance.
Step 2 of 3: Rehydration started for appliance myExternalAppliance.
Step 3 of 3: Copying external templates to catalog.
Copying: 100% of 1804MB completed.
Copying: 100% of 269B completed.
Successfully imported template.
Details for this command follow.
introspectCoherenceWeb -wlsHome Path -domainRoot Path -adminUser String [-name string] [-force] [-noPackaging] [-remoteHost string] [-remoteUser string] [-remoteWorkingDir path] [-remoteCleanup]
This command is an alias for introspectWLS. It examines the configuration of an installed WebLogic Server domain to determine what must be captured during packaging and what configuration must be changed at deployment. All collected data is stored in the catalog upon successful completion.
Table A-11 shows the command options for introspectCoherenceWeb.
Table A-9 introspectCoherenceWeb options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
au |
true |
none |
N/A |
Administrative name for the WebLogic Server domain. |
|
|
ch |
true |
none |
N/A |
The COHERENCE_HOME of the Coherence instance to be introspected. |
|
|
dr |
true |
none |
N/A |
Full path to the WebLogic Server domain root. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same name. |
|
|
jh |
true |
none |
N/A |
The JAVA_HOME of the Coherence instance to be introspected. |
|
|
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. |
|
|
np |
false |
none |
N/A |
If set, component is not packaged during introspection. |
|
|
pi |
false |
none |
N/A |
The process ID of the Coherence server process. |
|
|
rc |
false |
none |
N/A |
Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, the remoteUser and remoteHost must be specified as well. |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, the remoteUser must be specified as well. |
|
|
ru |
false |
none |
N/A |
Name of the ssh user to use for accessing the remote machine. If set, the remoteHost must be specified as well. |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, the remoteUser and remoteHost must be specified as well. |
|
|
scn |
false |
none |
N/A |
The fully-qualified name of the Coherence main start class. |
|
|
ssn |
false |
none |
N/A |
The name of the Coherence start script. |
|
|
wh |
true |
none |
N/A |
Full path to the WebLogic Server Home, generally |
Details for this command follow.
introspectOHS -oracleInstance Path -componentName String [-name string] [-force] [-noPackaging] [-remoteHost String] [-remoteUser String] [-remoteWorkingDir Path] [-remoteCleanup]
Examines the configuration of an installed OHS component to determine what must be captured during packaging and what configuration must be changed at deployment. All collected data is stored in the catalog upon successful completion.
Table A-10 shows the command options for introspectOHS.
Table A-10 introspectOHS options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
cn |
true |
none |
N/A |
The name of the OHS component to introspect (for example: |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same name. |
|
|
n |
false |
Derived directory name prefixed by component type name |
Any name not previously used within the catalog |
Specifies a name by which the introspection output is stored. |
|
|
np |
false |
none |
N/A |
If set, the component is not packaged during introspection. |
|
|
oi |
true |
none |
N/A |
The absolute path of the ORACLE_INSTANCE to introspect. |
|
|
rc |
false |
false |
N/A |
Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the SSH user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
Here are some command examples.
% abctl introspectOHS -name myOHS -oracleInstance /ora/inst1 -componentName ohs1
Launching introspection of component 'OHS' ...
Step 1 of 5: OHS introspection starting
Step 1 of 4: OHS Httpd Configuration parsed
Step 2 of 4: OHS Httpd configuration transformed
Step 3 of 4: OHS Httpd configuration processed
Step 4 of 4: OHS Httpd configuration written
Step 2 of 5: HTTPD processing completed
Step 1 of 3: OHS OPMN configuration parsed
Step 2 of 3: OHS OPMN configuration processed
Step 3 of 3: OHS OPMN configuration writtend
Step 3 of 5: OPMN XML processing completed
Step 1 of 2: OHS opmnctl script parsed
Step 2 of 2: Appliance updated with ORACLE_HOME
Step 4 of 5: OPMNCTL processing completed
Step 5 of 5: OHS introspection complete
Task is done: DehydrateJob completed
Introspection complete
Storing result in catalog: '/Oracle/IntrospectionCatalog' ...
Introspection stored as 'myohs' in the catalog
%
bad -oracleInstance value
% abctl introspectOHS -oracleInstance /ora/dontexist -componentName foobar Launching introspection of component 'OHS' ... Step 1 of 5: OHS task starting Task is done: DehydrateJob failed with error: The specified Oracle Instance does not exist. Error: Introspection failed Caused by: The specified Oracle Instance does not exist. %
Details for this command follow.
introspectSIDB -dbHome Path -oracleSid String [-name String] [-force] [-noPackaging] [-remoteHost String] [-remoteUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-dataFileDir Path] [-flashRecoveryDir Path] [-dbUniqueName String]
Examines single-instance Oracle database (releases 10.2, 11.1, 11.2) configuration and captures metadata.
Table A-11 shows the command options for introspectSIDB.
Table A-11 introspectSIDB options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
dfd |
false |
DB 10.2 release: DB 11.1 and 11.2 release: |
N/A |
The full path of the database files. This parameter is required if your database file directory is different from the default. |
|
|
dh |
true |
none |
N/A |
The ORACLE_HOME of the Oracle RDBMS to be introspected. |
|
|
dun |
false |
value specified for -oracleSid |
N/A |
The global database unique name. This parameter is required if your datbase unique name is different from the SID. |
|
|
frd |
false |
DB 10.2 release: DB 11.1 release: DB 11.2 release: |
N/A |
The full path of the database flash recovery files. This parameter is required if your recovery area is different from the default. If you do not have a recovery area, you can ignore this parameter. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same name. |
|
|
n |
false |
Derived directory name prefixed by component type name. |
Any name not already used within the catalog. |
Specifies a name by which the introspection output is stored |
|
|
np |
false |
none |
N/A |
If set, the component is not packaged during introspection. |
|
|
os |
true |
none |
N/A |
The SID of the Oracle RDBMS to be introspected. |
|
|
rc |
false |
none |
N/A |
Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the ssh user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
Details for this command follow.
introspectWebCache -oracleInstance Path -componentName String [-name string] [-force] [-noPackaging] [-remoteHost String] [-remoteUser String] [-remoteWorkingDir path] [-remoteCleanup]
Examines the configuration of an installed Web Cache component and records what must be captured during packaging, and what must be configured during deployment. All collected data is stored in the catalog upon successful completion.
Table A-12 shows the command options for introspectWebCache.
Table A-12 introspectWebCache options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
cn |
true |
none |
N/A |
The name of the Web Cache component to introspect. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same name. |
|
|
n |
false |
Derived directory name prefixed by component type name. |
Any name not already used within the catalog. |
Specifies a name by which the introspection output is stored. |
|
|
np |
false |
none |
N/A |
If set, the component is not packaged during introspection. |
|
|
oi |
true |
none |
N/A |
The absolute path of the ORACLE_INSTANCE to introspect. |
|
|
rc |
false |
false |
N/A |
Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the SSH user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
Here are some command examples.
$ introspectWebCache <WebCache options>
abctl introspectWebCache -name webcache -oracleInstance /oracle/instances/instance1 -componentName webcache1 Launching introspection of component 'WebCache' ... Step 1 of 9: Webcache task starting Step 9 of 9: Webcache task complete Task is done: DehydrateJob completed Introspection complete Storing result in catalog ... backup needed Introspection stored as 'webcache' in the catalog
abctl introspectWebCache -name webcache -oracleInstance /bea/Oracle_WT1/instances/instance1/ -componentName webcache2 Launching introspection of component 'WebCache' ... Task is done: DehydrateJob failed with error: Unable to find file: /bea/Oracle_WT1/instances/instance1/config/WebCache/webcache2/webcache.xml Error: Introspection failed Caused by: Unable to find file: /bea/Oracle_WT1/instances/instance1/config/WebCache/webcache2/webcache.xml
Details for this command follow.
introspectWLS -wlsHome Path -domainRoot Path -adminUser String [-name string] [-force] [-noPackaging] [-remoteHost String] [-remoteUser String] [-remoteWorkingDir Path] [-remoteCleanup]
Examines the configuration of an installed WebLogic Server component to determine what must be captured during packaging and what configuration must be changed at deployment. All collected data is stored in the catalog upon successful completion.
Table A-13 shows the command options for introspectWLS.
Table A-13 introspectWLS options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
au |
true |
none |
N/A |
Administrative name for the WebLogic Server domain. |
|
|
dr |
true |
none |
N/A |
Full path to the WebLogic Server domain root. |
|
|
f |
false |
none |
N/A |
Overwrite any introspection in the catalog that exists with the same name. |
|
|
n |
false |
Derived directory name prefixed by component type name. |
Any name not already used within the catalog. |
Specifies a name by which the introspection output is stored. |
|
|
np |
false |
none |
N/A |
If set, the component is not packaged during introspection. |
|
|
rc |
false |
false |
N/A |
Remote clean up flag. When set, the remote working directory will be deleted after the operation. Otherwise the directory will not be modified. If set, |
|
|
rh |
false |
none |
N/A |
Host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
N/A |
Name of the SSH user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
|
N/A |
Path on the remote machine to work out of. If set, |
|
|
wh |
true |
none |
N/A |
Full path to the WebLogic Server home (usually, < |
Here are some command examples.
local execution with use of all options
% abctl introspectWLS -name myWlsCapture \
-wlsHome /ora/mw/wlserver_10.3 -domainRoot /ora/mw/user_projects/domains/MyDomain -adminUser weblogic
Launching introspection of component 'WLS' ...
Step 1 of 3: WLS dehydration starting. Due to domain template creation this may take some time
Step 1 of 15: WlsAssemblyBuilder has started creating the AssemblyBuilder
Step 1 of 2: Capturing Node Manager configuration.
Step 2 of 2: Node Manager capture complete.
Step 12 of 15: Processor: 10 completed
Step 15 of 15: WlsAssemblyBuilder has completed the AssemblyBuilder
Step 2 of 3: WLS Assembly is completed
Step 3 of 3: WLS dehydration completed
Task is done: DehydrateJob completed
Introspection complete
Storing result in catalog: ...
Introspection stored as 'myWlsCapture' in the catalog
%
local execution with all defaults and short names
% abctl introspectWLS -adminUser weblogic -wh /ora/mw/wlserver_10.3 \
-dr /ora/mw/user_projects/domains/MyDomain
Launching introspection of component 'WLS' ...
Step 1 of 3: WLS dehydration starting. Due to domain template creation this may take some time
Step 1 of 15: WlsAssemblyBuilder has started creating the AssemblyBuilder
Step 1 of 2: Capturing Node Manager configuration.
Step 2 of 2: Node Manager capture complete.
Step 12 of 15: Processor: 10 completed
Step 15 of 15: WlsAssemblyBuilder has completed the AssemblyBuilder
Step 2 of 3: WLS Assembly is completed
Step 3 of 3: WLS dehydration completed
Task is done: DehydrateJob completed
Introspection complete
Storing result in catalog: '/ora/ab/catalog' ...
Introspection stored as 'WLS-1256089687424' in the catalog
%
% abctl introspectWLS -domainRoot /ora/mw/user_projects/domains/MyDomain Error: missing required parameter 'wlsHome' Command usage: introspectWLS [-name string] [-remoteHost string] [-remotePort numeric] [-remoteUser string] [-remoteWorkingDir path] -wlsHome path -domainRoot path Try 'abctl help -command introspectWLS' for detailed help of the command. %
$ abctl introspectWLS -adminUser weblogic -wlsHome /scratch/aime1/Oracle/Middleware/wlserver_10.3/ -domainRoot /tmp/foobar -name test Enter 'Admin Password': Launching introspection of component 'WLS' ... Step 1 of 3: Started WLS dehydration (expect delays during domain template creation).. Task is done: Dehydration failed with error: The domainRoot specified does not exist.. Error: OAB-7105: Introspection failed. Caused by: OAB-50005: The domainRoot specified does not exist.
Details for this command follow.
List the appliances and assemblies metadata entries in a catalog.
If -name is specified, and the value for the parameter refers to an appliance, only the information about that appliance will be displayed. If it refers to an assembly, only the components of that assembly will be displayed. If nothing is specified, catalog root level appliances and assemblies will be shown.
Additional information for each appliance and assembly will be shown if [-long] is set.
Table A-14 shows the command options for list.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
false |
none |
Name of appliance or assembly in catalog (can be nested). Nested appliances or assemblies are referred to with a slash (/). For example: |
If not set, all appliances and assemblies in the catalog will be displayed. If the name of an assembly is specified, its sub-appliances and sub-assemblies will be listed in addition to the assembly itself. If the name of an appliance is specified, only that appliance will be listed. |
|
|
l |
false |
none |
N/A |
Lists additional information about the appliance or assembly. |
Here are some command examples.
$ abctl list -l Components in /foo/bar/ab_home/catalog ---------------------------------------------------------------------------- Name | Type | CompType | Packaged? | Template Created? ---------------------------------------------------------------------------- myOhs | appliance | OHS | Yes | Yes(OVM) myWls | assembly (atomic) | WLS | No | No mySite | assembly | --- | Partially | Partially ----------------------------------------------------------------------------
$ abctl list -name myOhs -long Component mhOhs in /foo/bar/ab_home/catalog ---------------------------------------------------------------------------- Name | Type | CompType | Packaged? | Template Created? ---------------------------------------------------------------------------- myOhs | appliance | OHS | Yes | Yes(OVM) ----------------------------------------------------------------------------
Assuming that mySite contains myOhs and myWls. $ abctl list -name mySite -long Components in mySite ---------------------------------------------------------------------------- Name | Type | CompType | Packaged? | Template Created? ---------------------------------------------------------------------------- myOhs | appliance | OHS | Yes | Yes(OVM) myWls | assembly (atomic) | WLS | No | No ----------------------------------------------------------------------------
$ abctl list -name mySite/myWls -long Components in mySite/myWls -------------------------------------------------------------------------- Name | Type | CompType | Packaged? | Template Created? -------------------------------------------------------------------------- AdminServer | appliance | WLS | No | No MS1 | appliance | WLS | No | No Cluster_1 | appliance | WLS | No | No ---------------------------------------------------------------------------
Details for this command follow.
$ abctl listDeployments [-name String] [-plan String] [-resourceManager String] [-pool String] [-id String] [-long]
Table A-15 shows the command options for listDeployments.
Table A-15 listDeployments options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
i |
false |
none |
An existing deployment ID. |
The ID of a deployment. |
|
|
l |
false |
false |
true/false |
Flag to indicate if the long version of information is required. |
|
|
n |
false |
none |
Any regular expression. |
Name of an assembly or assemblies. It is specified as a regular expression. |
|
|
p |
false |
none |
Any regular expression. |
Name of a plan or plans. It is specified as a regular expression. |
|
|
po |
false |
none |
Any regular expression. |
The name of a pool or pools. It is specified as a regular expression. |
|
|
rm |
false |
none |
Any regular expression. |
The name of a configured resource manager, specified as a regular expression. |
Here are some command examples.
% abctl listDeployments ------------------------------------------------------------------------------------------------- Deployment Id |State |Catalog |Assembly|Plan|Resource Manager |Pool ------------------------------------------------------------------------------------------------- GqMw_3bzc_mySite_plan1|Deployed|/catalogs/demoCatalog|mySite |plan1|MyResourceManager| a_pool_1 ------------------------------------------------------------------------------------------------
% abctl listDeployments -l Deployment Id | GqMw_3bzc_mySite_plan1 State | Deployed Catalog | /catalogs/demoCatalog Assembly | mySite Plan | plan1 Resource Manager | MyResourceManager Pool | ha_pool_1 ---------------------------------------------------------------------------------- Appliance | Min | Max | Target | Staged | Running | Failed ---------------------------------------------------------------------------------- /AdminServer | 1 | 1 | 1 | 0 | jrve6.us.oracle.com | 0 /ManagedServer_1 | 1 | 1 | 1 | 0 | jrve1.us.oracle.com | 0 ---------------------------------------------------------------------------------- /oracle_dev/drm/src/dist/ab_
Details for this command follow.
List all the available deployment plans for a given assembly.
If the long option is chosen to display the deployment plans, users can also see all the overrides that have been specified in the deployment plans along with the default values. Users can also see if the deployment plan is valid or not in the STATUS section. If the deployment plan is not valid, a message is displayed with the cause of the error. A case in which the deployment plan may not be valid is when the default value is null in the assembly; it must be overridden in the deployment.
Table A-16 shows the command options for listDeploymentPlans.
Table A-16 listDeploymentPlans options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
l |
false |
none |
true/false |
Long is a flag used to indicate if the long version of information is required. |
|
|
n |
false |
none |
Any regular expression. |
The name of an assembly (or assemblies). It is specified as a regular expression. |
|
|
p |
false |
none |
Any regular expression. |
The name of a plan or plans. It is specified as a regular expression. |
Here are some command examples.
% abctl listDeploymentPlans
---------------------------------------
Assembly | Plan | Description | State
---------------------------------------
mySite | dp1 | Override-1 | Valid
| dp2 | Override-2 | Valid
---------------------------------------
% abctl listDeploymentPlans -p dp1 --------------------------------------- Assembly | Plan | Description | State --------------------------------------- mySite | dp1 | Override-1 | Valid ---------------------------------------
Assembly | mySite
Plan | dp2
Description| Override-2
---------------------------------------------------------------------------------------------------
Name | Type | Component | Property | Def. Val. |Over
| | Type | | |Val.
-------------------------------------------------------------------------------------------------
/myDb | appliance | External | hostname | dscdaa12-vm7 |
| | | | |
/myDomain/AdminServer | appliance | WLS | useTemplate | OEL |
| | | input-Default-DUMMY | dummy-vm5 |
| | | input-Default-port | 7001 |
| | | network0-bridge_name | Null |
| | | network0-instance0-ip_address| Null |12.123.123.12
| | | network0-instance0-mac_address| Null |
| | | resource-cpu-mhz | 1000 |
| | | resource-cpu-number | 1 |
| | | resource-memory | 2048 |1024
| | | scalability-max | 1 |
| | | scalability-min | 1 |
| | | scalability-target | 1 |
| | | template-root-user-password | Null |
| | | vnc-console-password | Null |
| | | | |
/myDomain/Server-0 | appliance | WLS | useTemplate | OEL |
| | | input-Default-port | 7001 |
| | | network0-bridge_name | Null |
| | | network0-instance0-ip_address| Null |12.123.123.34
| | | network0-instance0-mac_address| Null |
| | | resource-cpu-mhz | 1000 |
| | | resource-cpu-number | 1 |
| | | resource-memory | 2048 |1024
| | | scalability-max | 1 |
| | | scalability-min | 1 |
| | | scalability-target | 1 | 1
| | | template-root-user-password | Null |
| | | vnc-console-password | Null |
| | | | |
/myLdap | appliance | External | hostname | dscdaa12-vm5 |
---------------------------------------------------------------------------------------------------
Details for this command follow.
Table A-17 shows the command options for listResourceManagers.
Table A-17 listResourceManagers options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
l |
false |
none |
N/A |
A flag indicating if the long version of information is required. |
|
-pool |
po |
false |
none |
Any regular expression. |
Name of a pool(s). This parameter is specified as a regular expression. |
|
|
rm |
false |
none |
Any regular expression. |
The name of a configured resource manager. It is specified as a regular expression. |
Here are some command examples.
% abctl listResourceManagers
----------------------------------------
Resource Manager | Pool | Default
----------------------------------------
MyResourceManager-1 | pool-1 | true
| pool-2 | false
MyResourceManager-2 | pool-1 | true
| pool-2 | false
----------------------------------------
% abctl listResourceManagers -rm MyResourceManager-1
----------------------------------------
Resource Manager | Pool | Default
----------------------------------------
MyResourceManager-1 | pool-1 | true
| pool-2 | false
----------------------------------------
% abctl listResourceManagers -rm ".*-2"
----------------------------------------
Resource Manager | Pool | Default
----------------------------------------
MyResourceManager-2 | pool-1 | true
| pool-2 | false
----------------------------------------
Long Parameter is % abctl listResourceManagers -rm MyResourceManager-1 -l
Resource Manager | MyResourceManager-1
VMM Version | 2.2
Host | locbox-ovmm-22.us.oracle.com
Port | 8888
Secure Port | 4443
Username | admin
Use Secure Connections | false
VM Operations Timeout | 90
--------------------------------------------------------------------------------------------------
Pool | Default| Network Bridge| Gateway | Netmask | DNS Server Order| DNS Search Order
--------------------------------------------------------------------------------------------------
pool-1| true | xenbr0 | 20.123.123.1| 255.255.255.0| 123.12.123.12 | mycompany.com
| | | | | 123.12.123.34 |
| | xenbr1 | 20.123.123.2| 255.255.255.1| 123.12.123.56 | mycompany.com
| | | | | 123.12.123.78 |
| | | | | |
pool-2| false | xenbr0 | 20.123.123.1| 255.255.255.0| 123.12.123.12 | mycompany.com
| | | | | 123.12.123.34 |
| | xenbr1 | 20.123.123.2| 255.255.255.1| 123.12.123.56 | mycompany.com
| | | | | 123.12.123.78 |
---------------------------------------------------------------------------------------------------
% abctl listResourceManagers -rm MyResourceManager-1 -po pool-1 -l
Resource Manager | MyResourceManager-1
VMM Version | 2.2
Host | locbox-ovmm-22.us.oracle.com
Port | 8888
Secure Port | 4443
Username | admin
Use Secure Connections | false
VM Operations Timeout | 90
---------------------------------------------------------------------------------------------------
Pool | Default | Network Bridge| Gateway | Netmask | DNS Server Order | DNS Search Order
---------------------------------------------------------------------------------------------------
pool-1| true | xenbr0 | 20.123.123.1| 255.255.255.0| 123.12.123.12 | mycompany.com
| | | | | 123.12.123.34 |
| | xenbr1 | 20.123.123.2| 255.255.255.1| 123.12.123.56 | mycompany.com
| | | | | 123.12.123.78 |
---------------------------------------------------------------------------------------------------
%
Details for this command follow.
$ abctl listTemplates [-name String] [-plan String] [-appliance String] [-resourceManager String] [-pool String]
Table A-18 listTemplates options
| Name | Alias | Req'd | Possible Values | Description |
|---|---|---|---|---|
|
|
a |
false |
Any regular expression. |
"/" separated path to an appliance(s) within an assembly. It is specified as a regular expression. |
|
|
n |
false |
Any regular expression. |
Name of an assembly or assemblies. It is specified as a regular expression. |
|
|
p |
false |
Any regular expression. |
Name of the deployment plan(s). It is specified as a regular expression. |
|
|
po |
false |
Any regular expression. |
The name of a pool(s). It is specified as a regular expression. |
|
|
rm |
false |
Any regular expression. |
Name of a configured resource manager. It is specified as a regular expression. |
Here are some command examples.
% abctl listTemplates
-------------------------------------------------------------------------------------------------
Assembly | Plan| Appliance | Template | Resource Manager | Pool | State
-------------------------------------------------------------------------------------------------
mySite | --- | /AdminServer | pPITSr3VkpjwI_OVM_OEL| MyResourceManager| ha_pool_1| Not Reg'd
| | /ManagedServer_1| pPITSr3VkpjwI_OVM_OEL| MyResourceManager| ha_pool_1| Not Reg'd
-------------------------------------------------------------------------------------------------
% abctl listTemplates -p plan.*
---------------------------------------------------------------------------------------------------
Assembly| Plan | Appliance | Template | Resource Manager | Pool | State
---------------------------------------------------------------------------------------------------
mySite | plan1| /AdminServer | pPITSr3VkpjwI_OVM_OEL | MyResourceManager| ha_pool_1| Not Reg'd
| | /ManagedServer_1| pPITSr3VkpjwI_OVM_OEL | MyResourceManager| ha_pool_1| Not Reg'd
| plan2| /AdminServer | pPITSr3VkpjwI_OVM_JRVE| MyResourceManager| ha_pool_1| Not Reg'd
| | /ManagedServer_1| pPITSr3VkpjwI_OVM_JRVE| MyResourceManager| ha_pool_1| Not Reg'd
---------------------------------------------------------------------------------------------------
%
Details for this command follow.
$ abctl package -name String [-remoteHost String] [-remoteUser String] [-remoteWorkingDir Path] [-remoteCleanup] [-quiet] [-force]
Table A-19 shows the command options for package.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
f |
false |
false |
N/A |
If set, existing packages and any virtual machine templates created from it will be overwritten. The operation may fail if there are registered VM templates from an existing package. The flag has no effect if no package or template exists. |
|
|
n |
true |
none |
Name of appliance/assembly to be packaged. Nested appliances or assemblies are referred to with a slash (/). For example: |
To package a non-atomic assembly, its sub-appliances and sub-assemblies must be packaged individually. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
|
|
rc |
false |
N/A |
Remote clean up flag. If set, the remote working directory will be deleted after the operation. Otherwise the directory will not be affected. If set, |
|
|
|
rh |
false |
none |
Any valid hostname. |
The host name or IP address and optional SSH port of the remote machine. If set, |
|
|
ru |
false |
none |
Username |
Name of the SSH user to use for accessing the remote machine. If set, |
|
|
rwd |
false |
/tmp/abRemote_<remote_user> |
Path on the remote machine to work out of. This parameter is only valid when the |
Here are some command examples.
$ abctl package -name myOhs Executing package command. Error: OAB-7359: Unable to package myOhs. Cause: Catalog does not contain myOhs. Action: Check your command; make sure catalog contains named appliance or assembly.
$ abctl package -name myOhs Executing package command. Error: OAB-7359: Unable to package myOhs. Caused by: OAB-20011: Appliance myOhs is already packaged. Action: Use -force to override.
$ abctl package -name mySite Executing package command. Error: OAB-7359: Unable to package mySite. Caused by: non-atomic assembly not allowed
$ abctl package -name myOhs Packaging myOhs Operation Successful
$ abctl package -name myWls
Executing package command.
Step 1 of 2: Packaging assembly myWls started.
Step 1 of 2: Archiving MiddlewareHome started.
Zipping: 100% of 1196MB completed.
Step 2 of 2: Archiving MiddlewareHome completed.
Step 2 of 2: Packaging assembly myWls completed.
Successfully packaged myWls.
$ abctl package -name myOhs -force
Executing package command.
Step 1 of 2: Packaging appliance myOhs started.
Step 1 of 4: Archiving fmwHome started.
Zipping: 100% of 1527MB completed.
Zipping: 100% of 219MB completed.
Step 2 of 4: Archiving fmwHome completed.
Step 3 of 4: Archiving ORACLE_INSTANCE started.
Zipping: 100% of 51MB completed.
Step 4 of 4: Archiving ORACLE_INSTANCE completed.
Step 2 of 2: Packaging appliance myOhs completed.
Successfully packaged myOhs.
$ abctl package -name myOhs -remoteUser jdoe -remoteHost subj17.mycompany.com Enter SSH Password:
Executing package command.
Step 1 of 4: Copy AssemblyBuilder to remote machine.
Step 1: Copying assemblybuilder.zip to remote machine.
Step 2: Copy at 10%
Step 3: Copy at 20%
Step 4: Copy at 30%
Step 5: Copy at 40%
Step 6: Copy at 50%
Step 7: Copy at 60%
Step 8: Copy at 70%
Step 9: Copy at 80%
Step 10: Copy at 90%
Step 11: Copy at 100%
Step 12: Copy of assemblybuilder.zip complete.
Step 13: Copying support scripts.
Step 14: Copy of support scripts complete.
Step 2 of 4: Copy of AssemblyBuilder is complete.
Step 3 of 4: Start remote AssemblyBuilder.
Step 4 of 4: Remote AssemblyBuilder is started and connected.
Step 1 of 2: Packaging appliance myOhs started.
Step 1 of 4: Archiving fmwHome started.
Zipping: 100% of 1520MB completed.
Zipping: 100% of 986MB completed.
Copying: 100% of 125MB completed.
Copying: 100% of 224MB completed.
Step 2 of 4: Archiving fmwHome completed.
Step 3 of 4: Archiving ORACLE_INSTANCE started.
Zipping: 100% of 24MB completed.
Step 4 of 4: Archiving ORACLE_INSTANCE completed.
Step 2 of 2: Packaging appliance myOhs completed.
Copying packages from remote machine.
Copying 100% of 2370MB complete.
Copying packages completed.
Successfully packaged myOhs.
Details for this command follow.
registerTemplates -name String -resourceManager String [-plan String] [-pool String] [-timeout String]
Table A-20 registerTemplates options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
n |
true |
none |
The name of an existing assembly. |
The name of an existing assembly. |
|
|
p |
false |
none |
The name of an existing plan. |
The name of an existing plan. |
|
|
po |
false |
none |
The name of a configured pool. |
The name of a pool(s). It is specified as a regular expression. |
|
|
rm |
true |
none |
The name of a configured resource manager. |
The name of a configured resource manager. |
|
|
to |
false |
0 |
Any positive long number. |
Timeout for the registration operation specified in seconds. |
Details for this command follow.
Table A-21 shows the command options for scaleAppliance.
Table A-21 scaleAppliance options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
true |
none |
Path to an appliance within an assembly (for example: |
"/" separated path to an appliance within an assembly. |
|
|
i |
true |
none |
An existing deployment ID. |
The deployment ID of the deployment. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
|
|
tg |
true |
none |
The target number of VMs for an appliance. The value must be between the minimum and maximum number of VMs for that appliance. |
The target number of VMs for an appliance. |
Here is a command example.
% abctl scaleAppliance –i GqMw_3bzc_mySite_plan1 –a /ManagedServer_1 –tg 2 ----------------------------------------------------------------- Appliance | Type | Min | Max | Target | Running | Failed ----------------------------------------------------------------- /ManagedServer_1 | WLS | 1 | 5 | 1 | 1 | 0 ----------------------------------------------------------------- Staging ManagedServer_1-1 Staged ManagedServer_1-1 Preparing ManagedServer_1-1 Prepared ManagedServer_1-1 Starting ManagedServer_1-1[jrve2.us.oracle.com] Started ManagedServer_1-1[jrve2.us.oracle.com] Scaling the appliance has been completed. Number of new instances started : 1 %
Details for this command follow.
Table A-22 shows the command options for start.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
i |
true |
none |
An existing deployment ID. |
The deployment ID of the deployment. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
Here is a command example.
% abctl start -i GqMw_3bzc_mySite_plan1 ---------------------------------------------- Appliance | Failed | Staged | Running ---------------------------------------------- /AdminServer | 0 | 1 | 0 /ManagedServer_1 | 0 | 1 | 0 ---------------------------------------------- Step 1 of 2 Prepare VMs Preparing AdminServer-0 Prepared AdminServer-0 Preparing ManagedServer_1-0 Prepared ManagedServer_1-0 Step 2 of 2 Start VMs Starting AdminServer-0[jrve6.us.oracle.com] Started AdminServer-0[jrve6.us.oracle.com] Starting ManagedServer_1-0[jrve1.us.oracle.com] Started ManagedServer_1-0[jrve1.us.oracle.com] Successfully started the deployment. %
Details for this command follow.
Table A-23 shows the command options for stop.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
i |
true |
none |
An existing deployment ID. |
The deployment ID of the deployment. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
Here is a command example.
% abctl stop -i GqMw_3bzc_mySite_plan1 ---------------------------------------------- Appliance | Failed | Staged | Running ---------------------------------------------- /AdminServer | 0 | 0 | 1 /ManagedServer_1 | 0 | 0 | 1 ---------------------------------------------- Step 1 of 2 Stop VMs Stopping ManagedServer_1-0 Stopped ManagedServer_1-0 Stopping AdminServer-0 Stopped AdminServer-0 Step 2 of 2 Unprepare VMs Unpreparing ManagedServer_1-0 Unprepared ManagedServer_1-0 Unpreparing AdminServer-0 Unprepared AdminServer-0 Successfully stopped the deployment. %
Details for this command follow.
Table A-24 shows the command options for undeploy.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
i |
true |
none |
An existing deployment ID. |
The deployment ID of the deployment. |
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
Here is a command example.
% abctl undeploy -i GqMw_3bzc_mySite_plan1 ---------------------------------------------- Appliance | Failed | Staged | Running ---------------------------------------------- /AdminServer | 0 | 0 | 1 /ManagedServer_1 | 0 | 0 | 1 ---------------------------------------------- Step 1 of 3 Stop VMs Stopping ManagedServer_1-0 Stopped ManagedServer_1-0 Stopping AdminServer-0 Stopped AdminServer-0 Step 2 of 3 Unprepare VMs Unpreparing ManagedServer_1-0 Unprepared ManagedServer_1-0 Unpreparing AdminServer-0 Unprepared AdminServer-0 Step 3 of 3 Unstage VMs Unstaging ManagedServer_1-0 Unstaged ManagedServer_1-0 Unstaging AdminServer-0 Unstaged AdminServer-0 Successfully undeployed GqMw_3bzc_mySite_plan1. %
Details for this command follow.
$ abctl unregisterTemplates -name String [-resourceManager String] [-pool String] [-all] [-force]
Table A-25 unregisterTemplates options
| Name | Alias | Req'd | Possible Values | Description |
|---|---|---|---|---|
|
|
a |
false |
true/false |
Flag to indicate if all registered instances of the templates must be unregistered. |
|
|
f |
false |
true/false |
Flag to indicate if local cleanup should be done even if the resource manager is not available. |
|
|
n |
true |
Name of an existing assembly. |
Name of an assembly. |
|
|
po |
false |
The name of a configured pool. |
The name of a pool. |
|
|
rm |
false |
Name of a configured resource manager. |
The name of a resource manager. |
Details for this command follow.
With no parameters, 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.
Table A-26 shows the command options for help.
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
false |
none |
Name of a command. |
Name of one of the commands listed when help is invoked without arguments. If specified, then detailed help information about the specified command is provided. |
|
|
u |
false |
none |
Not valid when the |
|
|
|
q |
false |
none |
N/A |
By default, the command shows detailed progress/success messages. If |
Here are some command examples.
$ abctl help Usage: abctl command [options] Command Description ------------------------------------------------------------------------------ package Create a package createVMTemplate Create a VM template deploy Deploy an assembly export Export metadata expunge Clean up the catalog help Print help information import Import metadata introspectSIDB Examine SIDB configuration and capture metadata introspectOHS Examine OHS configuration and capture metadata introspectWLS Examine WLS configuration and capture metadata introspectWebCache Examine WebCache configuration and capture metadata list List catalog entries listConnections List the configured connections listDeploymentPlans List the deployment plans for a given assembly listResourceManagers List the resource managers for a given connection Try "abctl help -command cmd_name" for detailed help of a specific command.
$ abctl help -command package NAME package SYNOPSIS package -name string DESCRIPTION Creates packages for given metadata in the specified catalog OPTIONS Name: catalog Aliases: c Required: false Default value: Possible values: Description: Specifies the absolute path to the catalog Name: name Aliases: n Required: true Possible values: Description: Name of the appliance/assembly metadata EXAMPLES package -name myOhs
Print this Quick Reference for easy access to the commands available for Oracle Virtual Assembly Builder.
Table A-27 Command Quick Reference: Introspection Commands
| Command | Description | Synopsis |
|---|---|---|
|
introspectCoherenceWeb |
This command is an alias for |
|
|
introspectOHS |
Examines the configuration of an installed OHS component to determine what must be captured during packaging and what configuration must be changed at deployment. All collected data is stored in the catalog upon successful completion. |
|
|
introspectSIDB |
Examines single-instance Oracle database (releases 10.2, 11.1, 11.2) configuration and captures metadata. |
|
|
introspectWebCache |
Examines the configuration of an installed WebLogic Server component to determine what must be captured during packaging and what configuration must be changed at deployment. All collected data is stored in the catalog upon successful completion. |
|
|
introspectWLS |
Examines the configuration of an installed WebLogic Server component to determine what must be captured during packaging and what configuration must be changed at deployment. All collected data is stored in the catalog upon successful completion. |
|
Table A-28 Command Quick Reference: Packaging Commands
| Command | Description | Synopsis |
|---|---|---|
|
package |
Create packages for specified appliances or assemblies. |
|
Table A-29 Command Quick Reference: Template Creation Commands
| Command | Description | Synopsis |
|---|---|---|
|
createTemplate |
Create a virtual machine template for a given appliance or assembly. |
|
Table A-30 Command Quick Reference: Resource Pools Management Commands
| Command | Description | Synopsis |
|---|---|---|
|
listResourceManagers |
List the configured resource managers. |
|
Table A-31 Command Quick Reference: Template Registration Commands
| Command | Description | Synopsis |
|---|---|---|
|
listTemplates |
List the registered templates. |
|
|
registerTemplates |
Register templates to a specified resource manager and pool. |
|
|
unregisterTemplates |
Unregister templates from a specified resource manager and pool. |
|
Table A-32 Command Quick Reference: Deployment and Lifecycle Management Commands
| Command | Description | Synopsis |
|---|---|---|
|
checkResources |
This command verifies that sufficient resources are available for a deploy or scale operation. To check for sufficient resources for a deploy operation, specify the assembly and resource manager along with an optional pool name and an optional deployment plan. To check for sufficient resources for a scale operation, specify the deployment ID, the appliance, and the target numbers of the virtual machines. |
|
|
deploy |
Initiate the deployment of an assembly. |
|
|
undeploy |
Undeploy a deployment. |
|
|
listDeployments |
List the deployments. |
|
|
listDeploymentPlans |
Lists all the available deployment plans for a given assembly. |
|
|
start |
Start a specified deployment. |
|
|
stop |
Stops a specified deployment. |
|
|
scaleAppliance |
This command scales appliances in a deployment. |
|
Table A-33 Command Quick Reference: Catalog Operation Commands
| Command | Description | Synopsis |
|---|---|---|
|
list |
List the appliances and assemblies in a catalog. |
|
|
import |
Imports from exported appliances or assemblies in the specified directory to the catalog. |
|
|
importExternalTemplate |
Imports an existing virtual machine template located at the specified directory into the specified catalog as an external appliance. |
|
|
export |
Exports an appliance or assembly to disk so that it can later be imported to another catalog. |
|
|
delete |
Deletes the appliance or assembly with the given name. Only the top-level appliance or assembly can be deleted. Nested appliances or assemblies cannot be deleted using this command. Also, registered appliances or assemblies cannot be deleted. |
|
|
help |
With no parameters, 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 |
|
|
version |
Displays the Oracle Virtual Assembly Builder specification version. |
|
|
 Copyright © 2010, 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|