Class LaunchDbSystemBase

Parameters for provisioning a bare metal, virtual machine, or Exadata DB system.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Inheritance
object
LaunchDbSystemBase
LaunchDbSystemDetails
LaunchDbSystemFromBackupDetails
LaunchDbSystemFromDatabaseDetails
LaunchDbSystemFromDbSystemDetails
Inherited Members
Namespace: Oci.DatabaseService.Models
Assembly: OCI.DotNetSDK.Database.dll
Syntax
[JsonConverter(typeof(LaunchDbSystemBaseModelConverter))]
public class LaunchDbSystemBase

Properties

AvailabilityDomain

Declaration
[Required(ErrorMessage = "AvailabilityDomain is required.")]
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }
Property Value
Type Description
string

The availability domain where the DB system is located.
Remarks

Required

BackupNetworkNsgIds

Declaration
[JsonProperty(PropertyName = "backupNetworkNsgIds")]
public List<string> BackupNetworkNsgIds { get; set; }
Property Value
Type Description
List<string>

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.

BackupSubnetId

Declaration
[JsonProperty(PropertyName = "backupSubnetId")]
public string BackupSubnetId { get; set; }
Property Value
Type Description
string

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.

ClusterName

Declaration
[JsonProperty(PropertyName = "clusterName")]
public string ClusterName { get; set; }
Property Value
Type Description
string

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.

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment the DB system belongs in.
Remarks

Required

CpuCoreCount

Declaration
[Required(ErrorMessage = "CpuCoreCount is required.")]
[JsonProperty(PropertyName = "cpuCoreCount")]
public int? CpuCoreCount { get; set; }
Property Value
Type Description
int?

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
Remarks

Required

DataCollectionOptions

Declaration
[JsonProperty(PropertyName = "dataCollectionOptions")]
public DataCollectionOptions DataCollectionOptions { get; set; }
Property Value
Type Description
DataCollectionOptions

DataStoragePercentage

Declaration
[JsonProperty(PropertyName = "dataStoragePercentage")]
public int? DataStoragePercentage { get; set; }
Property Value
Type Description
int?

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.

DbSystemOptions

Declaration
[JsonProperty(PropertyName = "dbSystemOptions")]
public DbSystemOptions DbSystemOptions { get; set; }
Property Value
Type Description
DbSystemOptions

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

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

Domain

Declaration
[JsonProperty(PropertyName = "domain")]
public string Domain { get; set; }
Property Value
Type Description
string

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.

FaultDomains

Declaration
[JsonProperty(PropertyName = "faultDomains")]
public List<string> FaultDomains { get; set; }
Property Value
Type Description
List<string>

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 {@link #listFaultDomains(ListFaultDomainsRequest) listFaultDomains} operation in the Identity and Access Management Service API.
Example: FAULT-DOMAIN-1

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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

Hostname

Declaration
[Required(ErrorMessage = "Hostname is required.")]
[JsonProperty(PropertyName = "hostname")]
public string Hostname { get; set; }
Property Value
Type Description
string

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

Required

InitialDataStorageSizeInGB

Declaration
[JsonProperty(PropertyName = "initialDataStorageSizeInGB")]
public int? InitialDataStorageSizeInGB { get; set; }
Property Value
Type Description
int?

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.

KmsKeyId

Declaration
[JsonProperty(PropertyName = "kmsKeyId")]
public string KmsKeyId { get; set; }
Property Value
Type Description
string

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

KmsKeyVersionId

Declaration
[JsonProperty(PropertyName = "kmsKeyVersionId")]
public string KmsKeyVersionId { get; set; }
Property Value
Type Description
string

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.

NodeCount

Declaration
[JsonProperty(PropertyName = "nodeCount")]
public int? NodeCount { get; set; }
Property Value
Type Description
int?

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

NsgIds

Declaration
[JsonProperty(PropertyName = "nsgIds")]
public List<string> NsgIds { get; set; }
Property Value
Type Description
List<string>

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.

PrivateIp

Declaration
[JsonProperty(PropertyName = "privateIp")]
public string PrivateIp { get; set; }
Property Value
Type Description
string

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.

SecurityAttributes

Declaration
[JsonProperty(PropertyName = "securityAttributes")]
public Dictionary<string, Dictionary<string, object>> SecurityAttributes { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}

Shape

Declaration
[Required(ErrorMessage = "Shape is required.")]
[JsonProperty(PropertyName = "shape")]
public string Shape { get; set; }
Property Value
Type Description
string

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 {@link #listDbSystemShapes(ListDbSystemShapesRequest) listDbSystemShapes} operation.
Remarks

Required

SparseDiskgroup

Declaration
[JsonProperty(PropertyName = "sparseDiskgroup")]
public bool? SparseDiskgroup { get; set; }
Property Value
Type Description
bool?

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

SshPublicKeys

Declaration
[Required(ErrorMessage = "SshPublicKeys is required.")]
[JsonProperty(PropertyName = "sshPublicKeys")]
public List<string> SshPublicKeys { get; set; }
Property Value
Type Description
List<string>

The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
Remarks

Required

StorageVolumePerformanceMode

Declaration
[JsonProperty(PropertyName = "storageVolumePerformanceMode")]
[JsonConverter(typeof(StringEnumConverter))]
public LaunchDbSystemBase.StorageVolumePerformanceModeEnum? StorageVolumePerformanceMode { get; set; }
Property Value
Type Description
LaunchDbSystemBase.StorageVolumePerformanceModeEnum?

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

SubnetId

Declaration
[Required(ErrorMessage = "SubnetId is required.")]
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }
Property Value
Type Description
string

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

Required

TimeZone

Declaration
[JsonProperty(PropertyName = "timeZone")]
public string TimeZone { get; set; }
Property Value
Type Description
string

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