AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Oracle Database@Amazon Web Services CreateCloudVmCluster API operation.

Syntax

New-ODBCloudVmCluster
-CloudExadataInfrastructureId <String>
-ClusterName <String>
-CpuCoreCount <Int32>
-DataStorageSizeInTBs <Double>
-DbNodeStorageSizeInGBs <Int32>
-DbServer <String[]>
-DisplayName <String>
-GiVersion <String>
-Hostname <String>
-DataCollectionOptions_IsDiagnosticsEventsEnabled <Boolean>
-DataCollectionOptions_IsHealthMonitoringEnabled <Boolean>
-DataCollectionOptions_IsIncidentLogsEnabled <Boolean>
-IsLocalBackupEnabled <Boolean>
-IsSparseDiskgroupEnabled <Boolean>
-LicenseModel <LicenseModel>
-MemorySizeInGBs <Int32>
-OdbNetworkId <String>
-ScanListenerPortTcp <Int32>
-SshPublicKey <String[]>
-SystemVersion <String>
-Tag <Hashtable>
-TimeZone <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonOdbConfig>

Description

Creates a VM cluster on the specified Exadata infrastructure.

Parameters

-ClientConfig <AmazonOdbConfig>
Amazon.PowerShell.Cmdlets.ODB.AmazonOdbClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudExadataInfrastructureId <String>
The unique identifier of the Exadata infrastructure for this VM cluster.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClusterName <String>
A name for the Grid Infrastructure cluster. The name isn't case sensitive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CpuCoreCount <Int32>
The number of CPU cores to enable on the VM cluster.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataCollectionOptions_IsDiagnosticsEventsEnabled <Boolean>
Indicates whether diagnostic collection is enabled for the VM cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataCollectionOptions_IsHealthMonitoringEnabled <Boolean>
Indicates whether health monitoring is enabled for the VM cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataCollectionOptions_IsIncidentLogsEnabled <Boolean>
Indicates whether incident logs are enabled for the cloud VM cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataStorageSizeInTBs <Double>
The size of the data disk group, in terabytes (TBs), to allocate for the VM cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DbNodeStorageSizeInGBs <Int32>
The amount of local node storage, in gigabytes (GBs), to allocate for the VM cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DbServer <String[]>
The list of database servers for the VM cluster. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDbServers
-DisplayName <String>
A user-friendly name for the VM cluster.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GiVersion <String>
A valid software version of Oracle Grid Infrastructure (GI). To get the list of valid values, use the ListGiVersions operation and specify the shape of the Exadata infrastructure.Example: 19.0.0.0
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Hostname <String>
The host name for the VM cluster.Constraints:
  • Can't be "localhost" or "hostname".
  • Can't contain "-version".
  • The maximum length of the combined hostname and domain is 63 characters.
  • The hostname must be unique within the subnet.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsLocalBackupEnabled <Boolean>
Specifies whether to enable database backups to local Exadata storage for the VM cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsSparseDiskgroupEnabled <Boolean>
Specifies whether to create a sparse disk group for the VM cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LicenseModel <LicenseModel>
The Oracle license model to apply to the VM cluster.Default: LICENSE_INCLUDED
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MemorySizeInGBs <Int32>
The amount of memory, in gigabytes (GBs), to allocate for the VM cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OdbNetworkId <String>
The unique identifier of the ODB network for the VM cluster.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScanListenerPortTcp <Int32>
The port number for TCP connections to the single client access name (SCAN) listener.Valid values: 1024–8999 with the following exceptions: 2484, 6100, 6200, 7060, 7070, 7085, and 7879Default: 1521
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Odb.Model.CreateCloudVmClusterResponse). Specifying the name of a property of type Amazon.Odb.Model.CreateCloudVmClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SshPublicKey <String[]>
The public key portion of one or more key pairs used for SSH access to the VM cluster. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSshPublicKeys
-SystemVersion <String>
The version of the operating system of the image for the VM cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
The list of resource tags to apply to the VM cluster. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TimeZone <String>
The time zone for the VM cluster. For a list of valid values for time zone, you can check the options in the console.Default: UTC
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Odb.Model.CreateCloudVmClusterResponse
This cmdlet returns an Amazon.Odb.Model.CreateCloudVmClusterResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z