| Oracle® Virtual Assembly Builder User's Guide 11g Release 1 (11.1.1) Part Number E15835-02 |
|
|
View PDF |
| Oracle® Virtual Assembly Builder User's Guide 11g Release 1 (11.1.1) Part Number E15835-02 |
|
|
View PDF |
The following sections contain information about the abctl commands included in Oracle Virtual Assembly Builder.
Section A.3, "Command Quick Reference"
Note:
asctl 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 [-catalog path] [-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 be completed. To check for resources prior to deployment, the catalog, name, plan, resource manager and pool parameters are used. To check for resources prior to a scale operation, the ID, appliance and target parameters are used. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Table A-13 shows the command options for checkResources.
Table A-1 checkResources options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
all |
false |
none |
By default deployments for only a single catalog are listed. If -allCatalogs is set, the command lists all deployments for all catalogs. This option is not allowed when -catalog is used. |
|
|
|
a |
false |
none |
Path to an appliance within an assembly. For example: /MySubAssembly/MyAppliance |
"/" separated path to an appliance within an assembly. |
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
|
i |
false |
none |
A existing deployment ID. |
ID of the deployment. The id is provided to the user when the deployment is initiated. |
|
|
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 |
true |
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.
Cleans up the catalog by deleting orphaned packages and templates. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Table A-2 shows the command options for cleanup.
Table A-2 cleanup options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
all |
false |
none |
By default deployments for only a single catalog are listed. If -allCatalogs is set, the command lists all deployments for all catalogs. This option is not allowed when -catalog is used. |
|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
Details for this command follow.
$ abctl createTemplate -name string -target string [-guestOsImage path] [-jrve] [-catalog path] [-force] [-wlsOnJRVEImage path] [-quiet]
Create a virtual machine template that can be deployed by the Deployer. The generated template is placed in the templates/cid/platform/ subdirectory in the catalog, where cid refers to the capture ID for the appliance or assembly. The catalog will be located in the following order:
When you run this command, you will be prompted to provide root O/S user and VNC passwords that get configured in the created virtual machine templates.
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Note:
Though root and VNC passwords are required to be provided even when creating Oracle JRockit Virtual Edition based template(s) for a Oracle WebLogic Server assembly, these passwords are not used by Oracle WebLogic Server on Oracle JRockit Virtual Edition template(s).Table A-3 shows the command options for createTemplate.
Table A-3 createTemplate options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
all |
false |
none |
By default deployments for only a single catalog are listed. If -allCatalogs is set, the command lists all deployments for all catalogs. This option is not allowed when -catalog is used. |
|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
|
f |
false |
false |
N/A |
By default, the command errors out if template(s) for the given appliance/assembly already exist. If -force is set, the existing template(s) will be overridden. |
|
-guestOSImage |
gi |
false |
none |
Path to the valid base image |
Refers to the path to the valid base image (for example: System.img), that will be used as the base image. If not set, |
|
-jrve |
v |
false |
none |
N/A |
This option is only applicable for core WebLogic Server assemblies. If set to true and template creation target is a composite assembly, Oracle WebLogic Server On JRockit Virtual Edition template(s) will be created for Oracle WebLogic Server assembly and Guest OS template(s) for all other types of appliances and assemblies. The createTemplate command will result in error if this is set to true and template creation target is a non-core Oracle WebLogic Server assembly or appliance. |
|
-name |
n |
True |
none |
Name of appliance/assembly in catalog. |
Name of the appliance/assembly in the catalog, for example: myOhs, myWls, mySite, and so on. |
|
|
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. |
|
-target |
tg |
True |
none |
Currently OVM only. |
target platform |
|
|
wvi |
false |
none |
Path to the valid WLSVE base Image |
Refers to the path of the valid WLSVE base image: system.img which will be used as the base image for WLSVE templates |
Examples for this command follow.
$ abctl createTemplate -name myOhs -target OVM Error: unable to locate a valid base image at /foo/bar/System.img $
$ abctl createTemplate -name myOhs -target OVM -guestOsImage /foo/bar/System.img Error: invalid base image found at /foo/bar/System.img $
$ abctl createTemplate -name myOhs -target OVM
Bottling appliance myOhs
Cleaning up
/disk/ab_home/catalog/templates/8C5709AA_-4b6a3ea7_1220a22db2d_-8000/OVM/OEL
Copying base template from
/disk/ab_home/config/bottler/templates/OVM/System.img to
/disk/ab_home/catalog/templates/8C5709AA_-4b6a3ea7_1220a22db2d_-8000/OVM/OEL/templates/System.img
Copying base template completed
Building assemblybuilder disk at
/disk/ab_home/catalog/templates/8C5709AA_-4b6a3ea7_1220a22db2d_-8000/OVM/OEL/templates/AB.img
Building assemblybuilder disk completed
Building product disk at
/disk/ab_home/catalog/templates/8C5709AA_-4b6a3ea7_1220a22db2d_-8000/OVM/OEL/templates/myOhs.001.img
Building product disk completed
Building product disk at
/disk/ab_home/catalog/templates/8C5709AA_-4b6a3ea7_1220a22db2d_-8000/OVM/OEL/templates/myOhs.002.img
Building product disk completed
Bottling completed 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. If the appliance or the assembly is registered, it will result in an error. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
This command will delete the metadata for the appliance/assembly. For the packages and templates, it will delete them only if they are not shared by other appliances or assemblies. If deleting packages/bottles fails in the middle of the operation, thereby leaving the catalog in an incomplete state, it will instruct the users to run the cleanup command.
Table A-4 shows the command options for delete.
Table A-4 delete options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
all |
false |
none |
By default deployments for only a single catalog are listed. If -allCatalogs is set, the command lists all deployments for all catalogs. This option is not allowed when -catalog is used. |
|
|
catalog |
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
name |
n |
true |
none |
Name of appliance or assembly in catalog. |
Name of the appliance/assembly in catalog, for example, Only the top-level appliance/assembly will be deleted. Any nested appliances or assemblies cannot be specified. |
Here are some command examples.
$ abctl delete -name mySite Error: mySite is currently deployed. Please shut it down before deleting it. $
$ abctl delete -name myOhs Deleted metadata packages are shared - skipping templates are shared - skipping Done $
Details for this command follow.
$ abctl deploy -name string -resourceManager string [-catalog path] [-plan string] [-pool string] [-quiet]
Initiate a deployment given an assembly, deployment plan, a connection and a resource pool. After the deployment has been completed the user is provided a deployment ID. Users can use the ID to undeploy, start, stop and scale appliances. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Additional information for each appliance and assembly will be shown if [-long] is set.
Table A-5 shows the command options for deploy.
Table A-5 deploy options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
all |
false |
none |
By default deployments for only a single catalog are listed. If -allCatalogs is set, the command lists all deployments for all catalogs. This option is not allowed when -catalog is used. |
|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
|
n |
true |
.none |
The name of an existing assembly. |
Name of the assembly to use for deployment. The name must match one of the names returned using the list command. |
|
|
p |
false |
none |
Name of an deployment plan. |
Name of the deployment plan to be used for deployment. The argument must match one of the names returned using the listDeploymentPlans command. |
|
|
po |
false |
none |
Name of a configured pool. |
The name of a configured pool. This name must match one of the pool names returned from the listResourceManagers command. |
|
|
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. |
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.
Creates a sparse copy of metadata, packages, and templates. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Table A-6 shows the command options for export.
Table A-6 export options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
m |
N/A |
none |
N/A |
If set to true, only the metadata portion is exported, and packages and templates will not be exported. This is useful in case of remote bundling, when existing packages and bottles are irrelevant and do not need to be exported. |
|
|
all |
false |
none |
By default deployments for only a single catalog are listed. If -allCatalogs is set, the command lists all deployments for all catalogs. This option is not allowed when -catalog is used. |
|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
|
n |
true |
none |
Name of appliance or assembly in catalog (can be nested). |
Name of the appliance/assembly in catalog, for example: myOhs, myWls, mySite. |
|
|
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. |
|
|
td |
true |
none |
Valid directory path. |
Exported content will be written to one or more zip files and stored in the directory specified by the -toDir parameter. |
Here are some command examples.
$ abctl export -name myOhs -toDir /tmp/myOhs.exp (some progress message) Successfully exported to /tmp/myOhs.exp $
$ abctl export -name myOhs -toDir /tmp/myOhs.exp - (some progress message) Successfully exported to /tmp/myOhs.exp $
$ ls /tmp/abc my_file.txt $ abctl export -name ohs -toDir /tmp/ohs.exp - Error: OAB-7434: Failed to export ohs to /tmp/ohs.exp Caused by: OAB-09303: Destination directory /tmp/ohs.exp is not empty Action: Clean up destination directory /tmp/ohs.exp, or specify an empty destination directory. $
Details for this command follow.
Imports the exported metadata and associated packages and templates into the target catalog. Directory containing serialized form of metadata and associated artifacts is specified by the -fromDir parameter. A new entry is created in the target catalog for imported metadata. If there is a name collision (for example, the import command attempts to create mySite, and the catalog already has mySite), the operation will fail. Also, if there is a CID collision, the operation fails. To avoid failure due to collisions, the -force and -importAs parameters may be used. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Table A-7 shows the command options for import.
Table A-7 import options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
|
o |
false |
false |
N/A |
If the parameter is specified, any existing metadata and associated packages and templates are overridden. This is to correct a case of name or CID collision. Overriding an existing component can only be done if the existing component can be removed according to the rules of the |
|
|
fd |
yes |
none |
Path to the folder containing zip file(s) of the component to import. |
The path to the folder containing one or more zip files of the component to import. |
|
|
ia |
false |
none |
none |
If set, the imported appliance or assembly will be saved as the given name in target catalog. |
|
|
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. |
Here are some command examples.
$ abctl import -fromDir /tmp/foo Error: OAB-7412: Failed to import from /tmp/foo Cause: Specified directory /tmp/foo does not exist. Action: Specify a valid directory where catalog entry was exported to. $
$ abctl import -fromDir /tmp/abc Error: OAB-7412: Failed to import from /tmp/abc Caused by: OAB-09032: Invalid import source directory /tmp/abc. Cause: Index file not found. Action: Specify a valid directory where catalog entry was exported to. $
Details for this command follow.
introspectDB -oracleHome path -oracleSid string [-catalog path] [-name string] [-force] [-remoteHost string] [-remoteUser string] [-remoteWorkingDir path] [-remoteCleanup] [-dataFileDir path] [-flashRecoveryDir path] [-dbUniqueName string]
Examines the configuration of an installed single-instance Oracle database and records what needs to be configurable post-deployment. All collected data is stored in the catalog upon successful completion. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Table A-8 shows the command options for introspectDB.
Table A-8 introspectDB options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
-dataFileDir |
dfd |
false |
$ORACLE_BASE/datafiles |
The full path of the database files. |
|
|
-dbUniqueName |
dun |
false |
$ORACLE_SID |
The db_unique_name if different from sid. |
|
|
-flashRecoveryDir |
frd |
false |
$ORACLE_BASE/flash_recovery_area |
The full path of the database flash recovery files. |
|
|
-force |
f |
false |
none |
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 |
|
-oracleHome |
oh |
true |
none |
The ORACLE_HOME of the Oracle RDBMS to be introspected. |
|
|
-oracleSid |
os |
true |
none |
The SID of the Oracle RDBMS to be introspected. |
|
|
-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 touched. If set, the remoteUser and remoteHost must be specified as well. |
|
-remoteHost |
rh |
false |
none |
Host name or IP address and optional SSH port of the remote machine. If no port is specified, then the default port is 22 (default SSH port). When a port is specified, a colon (:) must be used to separate the host/address and port (foo.com:22). When specifying an IPv6 address, the address must be enclosed in brackets ( [ ] ) such as: |
|
|
-remoteUser |
ru |
false |
none |
Name of the ssh user to use for accessing the remote machine. This parameter is only valid when the -remoteHost parameter is specified. The command will prompt for a user name if this parameter is omitted during remote introspection. -remoteUser must be specified for remote introspection. Otherwise, an error occurs:Error: OAB-90035: Unable to get SSH SessionCaused by: username must not be null. |
|
|
-remoteWorkingDir |
rwd |
false |
/tmp/ab_work |
Path on the remote machine to work out of. This parameter is only valid when the |
Here are some command examples.
This is a basic introspection of component DB to the default catalog, allowing the introspection process to choose a default capture name within the catalog.
abctl introspectDB -catalog /path/myCatalog -name myDB -oracleHome /path/myOracleHome
% abctl introspectDB -oracleHome /ora/dontexist Launching introspection of component 'DB' ... Step 1 of 6: DB introspection task starting Step 2 of 6: Export Oracle RDBMS Task is done: DehydrateJob failed with error: The specified Oracle Home does not exist. Error: Introspection failed Caused by: The specified Oracle Home does not exist. %
Details for this command follow.
introspectOHS -oracleInstance path -ohsComponentName string [-catalog path] [-name string] [-force] [-remoteHost string] [-remoteUser string] [-remoteWorkingDir path] [-remoteCleanup]
Examines the configuration of a single OHS instance to determine what needs to be captured during bundling and what configuration must be changed at deployment. All collected data is stored in the catalog upon successful completion. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Table A-9 shows the command options for introspectOHS.
Table A-9 introspectOHS options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
-force |
f |
false |
none |
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 |
The absolute path of the Oracle Instance. |
|
|
-ohsComponentName |
ocn |
true |
none |
The name of the OHS component to introspect (for example: |
|
|
-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 touched. If set, the remoteUser and remoteHost must be specified as well. |
|
-remoteHost |
rh |
false |
none |
host name or ip address and optional ssh port of the remote machine. If no port is specified, then the default port is 22 (default SSH port). When a port is specified, a colon (:) must be used to separate the host/address and port (foo.com:22). When specifying an IPv6 address, the address must be enclosed in brackets ( [ ] ) such as: |
|
|
-remoteUser |
ru |
false |
none |
Name of the ssh user to use for accessing the remote machine. This parameter is only valid when the -remoteHost parameter is specified. The command will prompt for a user name if this parameter is omitted during remote introspection. -remoteUser must be specified for remote introspection. Otherwise, an error occurs:Error: OAB-90035: Unable to get SSH SessionCaused by: username must not be null. |
|
|
-remoteWorkingDir |
rwd |
false |
/tmp/ab_work |
Path on the remote machine to work out of. This parameter is only valid when the -remoteHost parameter is specified. |
Here are some command examples.
% abctl introspectOHS -name myOHS -oracleInstance /ora/inst1 -ohsComponentName 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 '<capture-name>' in the catalog
%
bad -oracleInstance value
% abctl introspectOHS -oracleInstance /ora/dontexist -ohsComponentName 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.
introspectWebCache -oracleInstance path -componentName string [-catalog path] [-name string] [-force] [-remoteHost string] [-remoteUser string] [-remoteWorkingDir path] [-remoteCleanup]
Examines the configuration of an installed WebCache component and records what needs to be configurable during future deployments. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Table A-10 shows the command options for introspectWebCache.
Table A-10 introspectWebCache options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
-componentName |
cn |
true |
none |
The name of the web cache component to introspect (for example: |
|
|
-force |
f |
false |
none |
Overwrite any introspection in the catalog that exists with the same name. |
|
|
-name |
n |
false |
derived directory name prefixed by component type name |
any name not already used within the catalog |
Specifies a name by which the introspection output is stored. |
|
-oracleInstance |
oi |
true |
none |
The full path to the Oracle Instance in which the component being introspected is installed. |
|
|
-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 touched. If set, the remoteUser and remoteHost must be specified as well. |
|
-remoteHost |
rh |
false |
none |
Host name or IP address and optional SSH port of the remote machine. If no port is specified, then the default port is 22 (default SSH port). When a port is specified, a colon (:) must be used to separate the host/address and port (foo.com:22). When specifying an IPv6 address, the address must be enclosed in brackets ( [ ] ) such as: |
|
|
-remoteUser |
ru |
false |
none |
Name of the SSH user to use for accessing the remote machine. This parameter is only valid when the -remoteHost parameter is specified. The command will prompt for a user name if this parameter is omitted during remote introspection. -remoteUser must be specified for remote introspection. Otherwise, an error occurs:Error: OAB-90035: Unable to get SSH SessionCaused by: username must not be null. |
|
|
-remoteWorkingDir |
rwd |
false |
/tmp/ab_work |
Path on the remote machine to work out of. This parameter is only valid when the -remoteHost parameter is specified. |
Here are some command examples.
$ introspectWebCache <WebCache options>
abctl introspectWebCache -catalog /tmp/wc -name webcache -oracleInstance /oracle/instances/instance1 -ohsComponentName 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: '/tmp/wc' ... backup needed Introspection stored as 'webcache' in the catalog
abctl introspectWEBCACHE -catalog /tmp/wc -captureName webcache -oracleInstance /bea/Oracle_WT1/instances/instance1/ -ohsComponentName 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 [-catalog path] [-name string] [-remoteHost string] [-remotePort numeric] [-remoteUser string] [-remoteWorkingDir path] -adminUser string -wlsHome path -domainRoot path
Examines the configuration of a single WebLogic domain to determine what needs to be captured during packaging and what configuration needs to be changed at deployment. If the target domain to be introspected resides on multiple nodes, then introspection should be performed only on the machine hosting the WebLogic administration server. All collected data is stored in the catalog upon successful completion. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Table A-11 shows the command options for introspectWLS.
Table A-11 introspectWLS options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
-domainRoot |
dr |
true |
none |
Full path to the WebLogic domain root. In the case of domains that span multiple nodes, introspection should occur against the copy of the domain used by the WebLogic administration server. |
|
|
-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 |
|
-remoteHost |
rh |
false |
none |
Host name or IP address and optional SSH port of the remote machine. If no port is specified, then the default port is 22 (default SSH port). When a port is specified, a colon (:) must be used to separate the host/address and port (foo.com:22). When specifying an IPv6 address, the address must be enclosed in brackets ( [ ] ) such as: |
|
|
-remoteUser |
ru |
false |
none |
Name of the SSH user to use for accessing the remote machine. This parameter is only valid when the -remoteHost parameter is specified. The command will prompt for a user name if this parameter is omitted during remote introspection. -remoteUser must be specified for remote introspection. Otherwise, an error occurs:Error: OAB-90035: Unable to get SSH SessionCaused by: username must not be null. |
|
|
-remoteWorkingDir |
rwd |
false |
/tmp/ab_work |
Path on the remote machine to work out of. This parameter is only valid when the -remoteHost parameter is specified. |
|
|
-wlsHome |
wh |
true |
none |
Full path to the $WLS_HOME. |
|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
Here are some command examples.
local execution with use of all options
% abctl introspectWLS -catalog /tmp/myCatalog -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: '/tmp/myCatalog' ...
Introspection stored as 'myWlsCapture' in the catalog
%
local execution with all defaults and short names
% abctl introspectWLS -adminUser -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 [-catalog path\] [-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 -wh /ora/mw/wlserver_10.3 -dr /ora/mw/dontexist Launching introspection of component 'WLS' ... Step 1 of 3: WLS dehydration starting. Due to domain template creation this may take some time Task is done: DehydrateJob failed with error: Unable to find file: /ora/mw/dontexist/config/config.xml Error: Introspection failed Caused by: Unable to find file: /ora/mw/dontexist/config/config.xml %
Details for this command follow.
List the appliances and assemblies in a catalog. The catalog will be located in the following order:
As set in the -catalog option.
As set in the environment variable $AB_CATALOG_HOME.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_CONFIG_HOME/catalog if $AB_HOME is set.
If no catalog is found, for example, $AB_CATALOG_HOME is set but the directory is not found, or is referring to an invalid catalog, it will display an error message.
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.
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Additional information for each appliance and assembly will be shown if [-long] is set.
Table A-12 shows the command options for list.
Table A-12 list options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
|
n |
false |
none |
Name of appliance or assembly in catalog (can be nested). |
If set to an appliance, only that appliance is displayed. If set to an assembly, only the components of that assembly is displayed. If the catalog cannot find the value, it returns an error. |
|
|
l |
false |
none |
N/A |
By default, the command displays the 'name' and 'type' of each appliance/assembly. If
|
Here are some command examples.
$ export AB_HOME=/foo/bar/ab_home $ ls $AB_HOME/catalog ls: /foo/bar/ab_home/catalog: No such file or directory $ abctl list Error: No component exists at /scratch/dyoon/p4work/ab/drm/src/dist/ab_home/catalog $ ls /foo/bar/catalog xxx.txt <--- not a valid catalog! $ abctl list -catalog /foo/bar/catalog Error: No component exists at /foo/bar/catalog $
$ export AB_HOME=/foo/bar/ab_home $ ls -F $AB_HOME/catalog bundles/ metadata/ templates/ $ ls $AB_HOME/catalog/metadata $ abctl list Error: No component exists at /foo/bar/ab_home/catalog. $
$ export AB_HOME=/foo/bar/ab_home $ ls -F $AB_HOME/catalog bundles/ metadata/ templates/ $ abctl list Components in /foo/bar/ab_home/catalog ------------------------------ Name | Type ------------------------------ myOhs | appliance myWls | assembly (atomic) mySite | assembly ------------------------------ $
$ abctl list -l Components in /foo/bar/ab_home/catalog --------------------------------------------------------------------- Name | Type | CompType | Packaged? | Bottled? --------------------------------------------------------------------- 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? | Bottled? --------------------------------------------------------------------- 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? | Bottled? --------------------------------------------------------------------- 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? | Bottled? ------------------------------------------------------------------ AdminServer | appliance | WLS | No | No MS1 | appliance | WLS | No | No Cluster_1 | appliance | WLS | No | No ------------------------------------------------------------------ $
Details for this command follow.
$ abctl listDeployments [-catalog path] [-allCatalogs] [-name string] [-plan string] [-resourceManager string] [-pool string] [-id string] [-long]
List the active deployments for a given assembly. Returns the IDs of the deployments and their associated state, assembly name, deployment name, connection name and pools name. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Table A-13 shows the command options for listDeployments.
Table A-13 listDeployments options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
|
i |
true |
none |
An existing deployment ID. |
The deployment ID of the deployment. The ID is provided to the user when deployment is initiated. |
|
|
l |
false |
false |
true/false |
This is an optional parameter that can be specified to display additional information. |
|
|
n |
false |
none |
Any valid regular expression. |
Name of the assembly for which the deployments must be listed. This can be a regular expression, matching multiple assemblies. |
|
|
p |
false |
none |
Any valid regular expression. |
Name of the deployment plan. It is specified as a regular expression. |
|
|
po |
false |
none |
Any valid regular expression. |
The name of the pool. It is specified as a regular expression. |
|
|
rm |
true |
none |
Name of a configured resource manager. |
The name of a configured resource manager. |
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 | ha_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. The catalog will be located in the following order:
If the -catalog path option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
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 gets displayed with the cause of the error. A case where the deployment plan may not be valid is that if the default value is null in the assembly, it must be overridden in the deployment.
Table A-14 shows the command options for listDeploymentPlans.
Table A-14 listDeploymentPlans options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
|
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 | Default Value |Overidden Value
| | Type | | |
---------------------------------------------------------------------------------------------------------------
/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-15 shows the command options for listResourceManagers.
Table A-15 listResourceManagers options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
q |
false |
none |
N/A |
A flag indicating if the long version of information is required. |
|
-pool |
po |
false |
none |
Any valid regular expression. |
Name of a pool(s). This parameter is specified as a regular expression. |
|
|
rm |
true |
none |
Name of a configured resource manager. |
The name of a configured resource manager. |
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.
listTemplates [-catalog path] [-name string] [-plan string] [-appliance string] [-resourceManager string] [-pool string]
Table A-16 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. |
|
|
c |
false |
none |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
|
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 |
true |
Name of a configured resource manager. |
Name of a configured resource manager. |
Here are examples.
% abctl listTemplates
-------------------------------------------------------------------------------------------------------------
Assembly | Plan | Appliance | Template | Resource Manager | Pool | State
-------------------------------------------------------------------------------------------------------------
mySite | --- | /AdminServer | pPITSr3VkpjwI_OVM_OEL | MyResourceManager | ha_pool_1 | Not Registered
| | /ManagedServer_1 | pPITSr3VkpjwI_OVM_OEL | MyResourceManager | ha_pool_1 | Not Registered
-------------------------------------------------------------------------------------------------------------
% abctl listTemplates -p plan.*
---------------------------------------------------------------------------------------------------------------
Assembly | Plan | Appliance | Template | Resource Manager | Pool | State
---------------------------------------------------------------------------------------------------------------
mySite | plan1 | /AdminServer | pPITSr3VkpjwI_OVM_OEL | MyResourceManager | ha_pool_1 | Not Registered
| | /ManagedServer_1 | pPITSr3VkpjwI_OVM_OEL | MyResourceManager | ha_pool_1 | Not Registered
| plan2 | /AdminServer | pPITSr3VkpjwI_OVM_JRVE | MyResourceManager | ha_pool_1 | Not Registered
| | /ManagedServer_1 | pPITSr3VkpjwI_OVM_JRVE | MyResourceManager | ha_pool_1 | Not Registered
---------------------------------------------------------------------------------------------------------------
%
Details for this command follow.
$ abctl package -name string [-catalog string] [-force] [-remoteHost string [-remoteUser string]] [-remoteWorkingDir path] [-remoteCleanup] [-quiet]
Create packages (zip archive for appliance roots) for a given assembly or appliance specified by the name. Packages are saved to the catalog_root/bundles/ subdirectory. The catalog root must contain the assembly or appliance with the specified name. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Note:
This command will only work on an appliance or atomic assembly. If you pass a non-atomic assembly value for the-name parameter, the command will error out.
For local packaging, if a component has already had a template created, re-packaging the component will invalidate existing templates. For that reason, if the component has already had a template created, re-bundling by default is not allowed. To re-package anyway, use the -f option. This deletes existing templates for that component. Note that this is only applicable to local packaging. When remote packaging is performed, the operation internally calls 'export -' to the SSH host, which exports the metadata section only. Because there will be no existing templates, this restriction does not apply (and hence -force has no effect).
Table A-17 shows the command options for package.
Table A-17 package options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, bundles/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
|
f |
false |
false |
N/A |
If set, packaging will take place even though the component has already had a template created. Existing templates are deleted. If the component has NOT had a template created, this flag has no effect. |
|
|
n |
true |
none |
Name of appliance/assembly in catalog. Assembly must be atomic. |
Name of the appliance/assembly in catalog, for example: myOhs, myWls, and so on. |
|
|
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. |
|
|
sh |
false |
none |
any valid hostname |
If set, remote packaging is performed on supplied the SSH host. That is, metadata will be exported to the SSH host, and the packaging will take place there. |
|
|
su |
false |
none |
username |
If set, the username will be used for the credential to the SSH host. |
|
-remoteWorkingDir |
rwd |
false |
/tmp/ab_work |
Path on the remote machine to work out of. This parameter is only valid when the -remoteHost parameter is specified. |
|
|
-remoteCleanup |
rc |
false |
N/A |
Clean up flag. If set, the remote working directory will be deleted after the operation. Otherwise the directory will not be touched. |
Here are some command examples.
$ abctl package -name myOhs Error: component myOhs does not exist in the catalog at /foo/bar/ab_home/catalog $
$ abctl package -name myOhs Error: component myOhs has already been bottled. Re-bundling will invalidate existing VM images. Use -force option if you want to continue. $
$ abctl package -name mySite Error: Can not package non-atomic assembly mySite. You must package components of mySite individually. $
$ abctl package -name myOhs Bundling myOhs Operation Successful $
$ abctl package -name myWls Bundling myWls Bundling AdminServer Successfully packaged AdminServer Bundling MS1 Successfully packaged MS1 ... Operation Successful $
Details for this command follow.
registerTemplates -name string -resourceManager string [-catalog path] [-plan string] [-pool string] [-timeout string]
Register templates to a specified resource manager and pool. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Table A-18 registerTemplates options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
c |
false |
none |
Path to catalog root (directory that contains metadata/, packages/, templates/, and so on.). |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
|
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. |
|
|
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-19 shows the command options for scaleAppliance.
Table A-19 scaleAppliance options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
a |
true |
none |
Path to an appliance within an assembly (for example: /MySubAssembly/MyAppliance) |
"/" separated path to an appliance within an assembly. |
|
|
i |
true |
none |
An existing deployment ID. |
The deployment ID of the deployment. The ID is provided to the user when deployment is initiated. |
|
|
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. |
|
|
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 are some command examples.
% 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-20 shows the command options for start.
Table A-20 start options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
i |
true |
none |
An existing deployment ID. |
The deployment ID of the deployment. The ID is provided to the user when deployment is initiated. |
|
|
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. |
Here are some command examples.
% 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-21 shows the command options for stop.
Table A-21 stop options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
i |
true |
none |
An existing deployment ID. |
The deployment ID of the deployment. The ID is provided to the user when deployment is initiated. |
|
|
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. |
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-22 shows the command options for undeploy. The catalog will be located in the following order:
Table A-22 undeploy options
| Name | Alias | Req'd | Default Values | Possible Values | Description |
|---|---|---|---|---|---|
|
|
i |
true |
none |
An existing deployment ID. |
The deployment ID of the deployment. The ID is provided to the user when deployment is initiated. |
|
|
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. |
Here are some command examples.
% 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.
unregisterTemplates -name string [-catalog path] [-plan string] [-resourceManager string] [-pool string] [-all] [-force]
Unregister templates from a specified resource manager and pool. To unregister all registered templates the -all flag can be used. To unregister all registered templates, use the -all flag. To unregister from a specific resource manager and pool, the resource manager and pool options are used. The catalog will be located in the following order:
If the -catalog option is provided, use the specified catalog.
Use the environment variable $AB_CATALOG_HOME if it is set.
Use $AB_CONFIG_HOME/catalog if $AB_CONFIG_HOME is set.
Use $AB_HOME/catalog if $AB_HOME is set.
Table A-23 unregisterTemplates options
| Name | Alias | Req'd | Possible Values | Description |
|---|---|---|---|---|
|
|
a |
false |
true/false |
Flag to indicate if all registered instances of the templates need to be unregistered. |
|
|
c |
false |
none |
Specifies the absolute path to the catalog. If the catalog parameter is not specified on the command line then a default catalog path will be used according to the following rules:
This option is not allowed when -allCatalogs is used. |
|
|
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-24 shows the command options for help.
Table A-24 help options
| 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 -quiet is set, the command turns off verbose mode and shows only one or two progress/success messages. |
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 introspectDB Examine DB 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 [[-catalog] path] -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 -catalog /path/to/catalog -name myOhs $
Print this Quick Reference for easy access to the commands available for Oracle Virtual Assembly Builder.
Table A-25 Command Quick Reference: Introspection Commands
| Command | Description | Synopsis |
|---|---|---|
|
introspectDB |
Examines the configuration of an installed single-instance Oracle database and records what needs to be configurable post deployment. |
introspectDB [-catalog path] [-name string] [-remoteHost string] [-remoteUser string] [-remoteWorkspace path] [-dataFileDir path] [-flashRecoveryDir path][-dbUniqueName dbname] -oracleHome path -path -oracleSid string |
|
introspectOHS |
Examines the configuration of a single OHS instance to determine what needs to be captured during bundling and what configuration must be changed at deployment. All collected data is stored in the catalog upon successful completion. |
introspectOHS [-catalog path] [-name string] [-remoteHost string] [-remoteUser string] [-remoteWorkingDir path] -oracleInstance path -ohsComponentName |
|
introspectWebCache |
Examines the configuration of an installed WebCache component and records what needs to be configurable during future deployments |
introspectWebCache [-catalog path] [-name string] [-remoteHost string] [-remoteUser string] [-remoteWorkingDir path] -oracleInstance path -ohsComponentName |
|
introspectWLS |
Examines the configuration of a single WebLogic domain to determine what needs to be captured during bundling and what configuration needs to be changed at deployment. If the target domain to be introspected resides on multiple nodes, then introspection should be performed only on the machine hosting the WebLogic administration server. All collected data is stored in the catalog upon successful completion. |
introspectWLS [-catalog path] [-name string] [-remoteHost string] [-remotePort numeric] [-remoteUser string] [-remoteWorkingDir path] [adminUser string] -wlsHome path -domainRoot path |
|
introspectDB |
Examines the configuration of an installed single-instance Oracle database and records what needs to be configurable post deployment. |
introspectDB [-catalog path] [-name string] [-remoteHost string] [-remoteUser string] [-remoteWorkspace path] [-dataFileDir path] [-flashRecoveryDir path][-dbUniqueName dbname] -oracleHome path -path -oracleSid string |
Table A-26 Command Quick Reference: Packaging Commands
| Command | Description | Synopsis |
|---|---|---|
|
package |
Create packages (zip archive for appliance roots) for a given assembly or appliance specified by the name. Packages are saved to the catalog_root/bundles/ subdirectory. The catalog root must contain the assembly or appliance with the specified name. |
$ abctl package -name string [-catalog string] [-force] [-remoteHost string [-remoteUser string]] [-remoteWorkingDir path] [-remoteCleanup] [-quiet] |
Table A-27 Command Quick Reference: Template Creation Commands
| Command | Description | Synopsis |
|---|---|---|
|
createTemplate |
Creates a virtual machine template that can be deployed by the Deployer. |
$ abctl createTemplate -name string -target string [-guestOSImage path] [-jrve] [-catalog path] [-force] [-quiet] [-wlsOnJRVEImage path] |
Table A-28 Command Quick Reference: Resource Pools Management Commands
| Command | Description | Synopsis |
|---|---|---|
|
listResourceManagers |
Lists the configured resource managers. |
$ listResourceManagers [-resourceManager string] [-pool string] [-long] |
Table A-29 Command Quick Reference: Template Registration Commands
| Command | Description | Synopsis |
|---|---|---|
|
listTemplates |
Lists templates. |
listTemplates [-catalog path] [-name string] [-plan string] [-appliance string] [-resourceManager string] [-pool string] |
|
registerTemplates |
Register templates to a specified resource manager and pool. |
registerTemplates -name string -resourceManager string [-catalog path] [-plan string] [-pool string] [-timeout string] |
|
unregisterTemplates |
Unregister templates from a specified resource manager and pool. To unregister all registered templates the |
unregisterTemplates -name string [-catalog path] [-plan string] \ [-resourceManager string] [-pool string] [-all] [-force] |
Table A-30 Command Quick Reference: Deployment and Lifecycle Management Commands
| Command | Description | Synopsis |
|---|---|---|
|
checkResources |
Verifies that sufficient resources are available for a deploy or scale operation to be completed. |
checkResources [-catalog path] [-name string] [-plan string] \ [-resourceManager string] [-pool string] [-id string] [-appliance string] \ [-target string] |
|
deploy |
Initiates a deployment given an assembly, deployment plan, a connection and a resource pool. Issues a deployment ID. |
$ abctl deploy -name string -resourceManager string [-catalog path] [-plan string] \ [-pool string] [-quiet] |
|
undeploy |
Initiate an undeployment for the specified deployment ID. |
$ abctl undeploy [-id] string [-quiet] |
|
listDeployments |
Lists the active deployments for a given assembly. Returns the IDs of the deployments and their associated state, assembly name, deployment name, connection name and pools name. |
$ abctl listDeployments [-catalog path] [-allCatalogs] [-name string] [-plan string] [-resourceManager string] [-pool string] [-id string] [-long] |
|
listDeploymentPlans |
Lists all the available deployment plans for a given assembly. |
$ abctl listDeployments [-catalog path] [-allCatalogs] [-name string] [-plan string] [-resourceManager string] [-pool string] [-id string] [-long] |
|
start |
Start a specified deployment. |
$ abctl start [-id] string [-quiet] |
|
stop |
Stops the specified deployment. |
$ abctl stop [-id] string [-quiet] |
|
scaleAppliance |
This command scales appliances in a deployment. |
$ abctl scaleAppliance -id string -appliance string -target string [-quiet] |
Table A-31 Command Quick Reference: Catalog Operation Commands
| Command | Description | Synopsis |
|---|---|---|
|
list |
List the appliances and assemblies in a catalog. |
$ abctl list [-name string] [-catalog path] [-long] |
|
import |
Imports the exported metadata and associated packages and templates into the target catalog. Directory containing serialized form of metadata and associated artifacts is specified by the -fromDir parameter. A new entry is created in the target catalog for imported metadata. If there is a name collision (for example, the import command attempts to create mySite, and the catalog already has mySite), the operation will fail. Also, if there is a CID collision, the operation fails. To avoid failure due to collisions, the -force and -importAs parameters may be used. |
$ abctl import -fromDir path [-importAs string] [-catalog path] [-force] |
|
export |
Creates a sparse copy of metadata, packages, and templates. |
$ abctl export -name string [-toDir path] [-] [-catalog string] |
|
delete |
Deletes the appliance or assembly with the given name. |
$ abctl delete -name string [-catalog string] |
|
cleanup |
Cleans up the catalog by deleting orphaned packages and templates. |
$ abctl cleanup [-catalog path] |
|
help |
With no parameters, help 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. |
$ abctl help [[-command] string] [-usage] |
|
 Copyright © 2010, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|