"launch"
********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Creates a new DB system in the specified compartment and availability
domain. The Oracle Database edition that you specify applies to all
the databases on that DB system. The selected edition cannot be
changed.

An initial database is created on the DB system based on the request
parameters you provide and some default options. For detailed
information about default options, see Bare metal and virtual machine
DB system default options.

**Note:** Deprecated for Exadata Cloud Service systems. Use the new
resource model APIs instead.

For Exadata Cloud Service instances, support for this API will end on
May 15th, 2021. See Switching an Exadata DB System to the New Resource
Model and APIs for details on converting existing Exadata DB systems
to the new resource model.

Use the CreateCloudExadataInfrastructure and CreateCloudVmCluster APIs
to provision a new Exadata Cloud Service instance.


Usage
=====

   oci db system launch [OPTIONS]


Required Parameters
===================

--admin-password [text]

A strong password for SYS, SYSTEM, and PDB Admin. The password must be
at least nine characters and contain at least two uppercase, two
lowercase, two numbers, and two special characters. The special
characters must be _, #, or -.

--availability-domain [text]

The availability domain where the DB system is located.

--compartment-id, -c [text]

The OCID of the compartment the DB system  belongs in.

--cpu-core-count [integer]

The number of CPU cores to enable for a bare metal or Exadata DB
system or AMD VMDB Systems. The valid values depend on the specified
shape:

* BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36. -
  BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52. -
  Exadata.Base.48 - Specify a multiple of 2, from 0 to 48. -
  Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84. -
  Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168. -
  Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336. -
  Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92. -
  Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184. -
  Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368. -
  VM.Standard.E4.Flex - Specify any thing from 1 to 64.

This parameter is not used for INTEL virtual machine DB systems
because virtual machine DB systems have a set number of cores for each
shape. For information about the number of cores for a virtual machine
DB system shape, see Virtual Machine DB Systems

--database-edition [text]

The Oracle Database Edition that applies to all the databases on the
DB system. Exadata DB systems and 2-node RAC DB systems require
ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

Accepted values are:

   ENTERPRISE_EDITION, ENTERPRISE_EDITION_EXTREME_PERFORMANCE, ENTERPRISE_EDITION_HIGH_PERFORMANCE, STANDARD_EDITION

--db-name [text]

The database name. It must begin with an alphabetic character and can
contain a maximum of eight alphanumeric characters. Special characters
are not permitted.

--db-version [text]

A valid Oracle database version. To get a list of supported versions,
use the command ‘oci db version list’.

--hostname [text]

The hostname for the DB system. The hostname must begin with an
alphabetic character, and can contain alphanumeric characters and
hyphens (-). The maximum length of the hostname is 16 characters for
bare metal and virtual machine DB systems, and 12 characters for
Exadata DB systems.

The maximum length of the combined hostname and domain is 63
characters.

**Note:** The hostname must be unique within the subnet. If it is not
unique, the DB system will fail to provision.

--shape [text]

The shape of the DB system. The shape determines resources allocated
to the DB system. - For virtual machine shapes, the number of CPU
cores and memory - For bare metal and Exadata shapes, the number of
CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

--ssh-authorized-keys-file [filename]

A file containing one or more public SSH keys to use for SSH access to
the DB System. Use a newline character to separate multiple keys. The
length of the combined keys cannot exceed 10,000 characters.

--subnet-id [text]

The OCID of the subnet the DB system is associated with.

**Subnet Restrictions:** - For bare metal DB systems and for single
node virtual machine DB systems, do not use a subnet that overlaps
with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC DB
systems, do not use a subnet that overlaps with 192.168.128.0/20.

These subnets are used by the Oracle Clusterware private interconnect
on the database instance. Specifying an overlapping subnet will cause
the private interconnect to malfunction. This restriction applies to
both the client subnet and the backup subnet.


Optional Parameters
===================

--auto-backup-enabled [boolean]

If set to true, schedules backups automatically. Default is false.

--auto-backup-window [text]

Specifying a two hour slot when the backup should kick in eg:-
SLOT_ONE,SLOT_TWO. Default is anytime

--auto-full-backup-day [text]

Day of the week the full backup should be applied on the database
system. If no option is selected, the value is null and we will
default to Sunday.

--auto-full-backup-window [text]

Specifying a two hour slot when the full backup should kick in eg:-
SLOT_ONE,SLOT_TWO. Default is anytime

--backup-network-nsg-ids [complex type]

A list of the OCIDs of the network security groups (NSGs) that the
backup network of this DB system belongs to. Setting this to an empty
array after the list is created removes the resource from all NSGs.
For more information about NSGs, see Security Rules. Applicable only
to Exadata systems. This is a complex type whose value must be valid
JSON. The value can be provided as a string on the command line or
passed in as a file using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--backup-subnet-id [text]

The OCID of the backup network subnet the DB system is associated
with. Applicable only to Exadata DB systems.

**Subnet Restrictions:** See the subnet restrictions information for
**subnetId**.

--character-set [text]

The character set for the database. The default is AL32UTF8. Allowed
values are: AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715,
AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768,
AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E,
BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257,
BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5,
CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251,
EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852,
EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851,
EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861,
IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC,
JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601,
KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921,
LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865,
NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866,
SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS,
TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258,
VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9,
WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850,
WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5,
ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS,
ZHT32TRIS.

--cluster-name [text]

The cluster name for Exadata and 2-node RAC virtual machine DB
systems. The cluster name must begin with an alphabetic character, and
may contain hyphens (-). Underscores (_) are not permitted. The
cluster name can be no longer than 11 characters and is not case
sensitive.

--data-storage-percentage [integer]

The percentage assigned to DATA storage (user data and database
files). The remaining percentage is assigned to RECO storage (database
redo logs, archive logs, and recovery manager backups). Specify 80 or
40. The default is 80 percent assigned to DATA storage. Not applicable
for virtual machine DB systems.

--database-software-image-id [text]

The OCID of database software image. This Custom Database Software
Image will be used to create the database instead of Oracle-published
Database Software Images

--db-unique-name [text]

The database unique name. It must be greater than 3 characters, but at
most 30 characters, begin with a letter, and contain only letters,
numbers, and underscores. The first eight characters must also be
unique within a Database Domain and within a Database System or VM
Cluster. In addition, if it is not on a VM Cluster it might either be
identical to the database name or prefixed by the datbase name and
followed by an underscore.

--db-workload [text]

Database workload type. Allowed values are: OLTP, DSS

--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see Resource Tags. This is a complex
type whose value must be valid JSON. The value can be provided as a
string on the command line or passed in as a file using the
file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--disk-redundancy [text]

The type of redundancy configured for the DB system. Normal is 2-way
redundancy, recommended for test and development systems. High is
3-way redundancy, recommended for production systems.

Accepted values are:

   HIGH, NORMAL

--display-name [text]

The user-friendly name for the DB system. The name does not have to be
unique.

--domain [text]

A domain name used for the DB system. If the Oracle-provided Internet
and VCN Resolver is enabled for the specified subnet, the domain name
for the subnet is used (do not provide one). Otherwise, provide a
valid DNS domain name. Hyphens (-) are not permitted.

--fault-domains [complex type]

A Fault Domain is a grouping of hardware and infrastructure within an
availability domain. Fault Domains let you distribute your instances
so that they are not on the same physical hardware within a single
availability domain. A hardware failure or maintenance that affects
one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for
you. To change the Fault Domain for a DB system, terminate it and
launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault
Domains these nodes will be distributed into. The system assigns your
nodes automatically to the Fault Domains you specify so that no Fault
Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in
the Identity and Access Management Service API.

Example:

   FAULT-DOMAIN-1

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--freeform-tags [complex type]

Free-form tags for this resource. Each tag is a simple key-value pair
with no predefined name, type, or namespace. For more information, see
Resource Tags.

Example:

   {"Department": "Finance"}

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--initial-data-storage-size-in-gb [integer]

Size (in GB) of the initial data volume that will be created and
attached to a virtual machine DB system. You can scale up storage
after provisioning, as needed. Note that the total storage size
attached will be more than the amount you specify to allow for
REDO/RECO space and software volume.

--is-diagnostics-events-enabled [boolean]

Enables customer to receive Events service notifications for guest VM
issues

--is-health-monitoring-enabled [boolean]

Enables Oracle to receive diagnostic data and share it with its
operations and support personnel

--is-incident-logs-enabled [boolean]

Enables Oracle to receive Events service notifications for guest VM
issues, collect incident logs and traces

--kms-key-id [text]

The OCID of the key container that is used as the master encryption
key in database transparent data encryption (TDE) operations.

--kms-key-version-id [text]

The OCID of the key container version that is used in database
transparent data encryption (TDE) operations KMS Key can have multiple
key versions. If none is specified, the current key version (latest)
of the Key Id is used for the operation. Autonomous Database
Serverless does not use key versions, hence is not applicable for
Autonomous Database Serverless instances.

--license-model [text]

The Oracle license model that applies to all the databases on the DB
system. The default is LICENSE_INCLUDED.

Accepted values are:

   BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED

--maintenance-window-details [complex type]

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--max-wait-seconds [integer]

The maximum time to wait for the resource to reach the lifecycle state
defined by "--wait-for-state". Defaults to 1200 seconds.

--ncharacter-set [text]

National character set for the database. The default is AL16UTF16.
Allowed values are: AL16UTF16 or UTF8.

--node-count [integer]

The number of nodes to launch for a 2-node RAC virtual machine DB
system. Specify either 1 or 2.

--nsg-ids [complex type]

The list of OCIDs for the network security groups (NSGs) to which this
resource belongs. Setting this to an empty list removes all resources
from all NSGs. For more information about NSGs, see Security Rules.
**NsgIds restrictions:** - A network security group (NSG) is optional
for Autonomous Databases with private access. The nsgIds list can be
empty. This is a complex type whose value must be valid JSON. The
value can be provided as a string on the command line or passed in as
a file using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--pdb-name [text]

Pluggable database name. It must begin with an alphabetic character
and can contain a maximum of eight alphanumeric characters. Special
characters are not permitted. Pluggable database should not be same as
database name.

--private-ip [text]

A private IP address of your choice. Must be an available IP address
within the subnet’s CIDR. If you don’t specify a value, Oracle
automatically assigns a private IP address from the subnet.

--recovery-window-in-days [integer range]

The number of days between the current and the earliest point of
recoverability covered by automatic backups (1 to 60).

--run-immediate-full-backup [boolean]

If set to true, configures automatic full backups in the local region
(the region of the DB system) for the first backup run immediately.

--sparse-diskgroup [boolean]

If true, Sparse Diskgroup is configured for Exadata dbsystem. If
False, Sparse diskgroup is not configured.

--storage-management [text]

Option for storage management for the database system. Allowed values
are: LVM, ASM.

Accepted values are:

   ASM, LVM

--storage-performance [text]

The block storage volume performance level. Valid values are
*BALANCED* and *HIGH_PERFORMANCE*. See Block Volume Performance for
more information.

Accepted values are:

   BALANCED, HIGH_PERFORMANCE

--tde-wallet-password [text]

The optional password to open the TDE wallet. The password must be at
least nine characters and contain at least two uppercase, two
lowercase, two numeric, and two special characters. The special
characters must be _, #, or -.

--time-zone [text]

The time zone to use for the DB system. For details, see DB System
Time Zones.

--vault-id [text]

The OCID of the Oracle Cloud Infrastructure vault.

--wait-for-state [text]

This operation creates, modifies or deletes a resource that has a
defined lifecycle state. Specify this option to perform the action and
then wait until the resource reaches a given lifecycle state. Multiple
states can be specified, returning on the first state. For example, "
--wait-for-state" SUCCEEDED "--wait-for-state" FAILED would return on
whichever lifecycle state is reached first. If timeout is reached, a
return code of 2 is returned. For any other error, a return code of 1
is returned.

Accepted values are:

   AVAILABLE, FAILED, MAINTENANCE_IN_PROGRESS, MIGRATED, NEEDS_ATTENTION, PROVISIONING, TERMINATED, TERMINATING, UPDATING, UPGRADING

--wait-interval-seconds [integer]

Check every "--wait-interval-seconds" to see whether the resource has
reached the lifecycle state defined by "--wait-for-state". Defaults to
30 seconds.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--endpoint", "--generate-full-command-json-input", "
--generate-param-json-input", "--help", "--latest-version", "--max-
retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
"--output", "--profile", "--proxy", "--query", "--raw-output", "--
read-timeout", "--realm-specific-endpoint", "--region", "--release-
info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"


Example using required parameter
================================

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export admin_password=<substitute-value-of-admin_password> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/system/launch.html#cmdoption-admin-password
       export availability_domain=<substitute-value-of-availability_domain> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/system/launch.html#cmdoption-availability-domain
       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/system/launch.html#cmdoption-compartment-id
       export cpu_core_count=<substitute-value-of-cpu_core_count> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/system/launch.html#cmdoption-cpu-core-count
       export database_edition=<substitute-value-of-database_edition> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/system/launch.html#cmdoption-database-edition
       export db_name=<substitute-value-of-db_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/system/launch.html#cmdoption-db-name
       export db_version=<substitute-value-of-db_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/system/launch.html#cmdoption-db-version
       export hostname=<substitute-value-of-hostname> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/system/launch.html#cmdoption-hostname
       export shape=<substitute-value-of-shape> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/system/launch.html#cmdoption-shape
       export ssh_authorized_keys_file=<substitute-value-of-ssh_authorized_keys_file> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/system/launch.html#cmdoption-ssh-authorized-keys-file
       export subnet_id=<substitute-value-of-subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/system/launch.html#cmdoption-subnet-id

       oci db system launch --admin-password $admin_password --availability-domain $availability_domain --compartment-id $compartment_id --cpu-core-count $cpu_core_count --database-edition $database_edition --db-name $db_name --db-version $db_version --hostname $hostname --shape $shape --ssh-authorized-keys-file $ssh_authorized_keys_file --subnet-id $subnet_id
