[ aws . odb ]

get-cloud-vm-cluster

Description

Returns information about the specified VM cluster.

See also: AWS API Documentation

Synopsis

  get-cloud-vm-cluster
--cloud-vm-cluster-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--cloud-vm-cluster-id (string)

The unique identifier of the VM cluster.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

cloudVmCluster -> (structure)

The VM cluster.

cloudVmClusterId -> (string)

The unique identifier of the VM cluster.

displayName -> (string)

The user-friendly name for the VM cluster.

status -> (string)

The current status of the VM cluster.

statusReason -> (string)

Additional information about the status of the VM cluster.

cloudVmClusterArn -> (string)

The Amazon Resource Name (ARN) of the VM cluster.

cloudExadataInfrastructureId -> (string)

The unique identifier of the Exadata infrastructure that this VM cluster belongs to.

clusterName -> (string)

The name of the Grid Infrastructure (GI) cluster.

cpuCoreCount -> (integer)

The number of CPU cores enabled on the VM cluster.

dataCollectionOptions -> (structure)

The set of diagnostic collection options enabled for the VM cluster.

isDiagnosticsEventsEnabled -> (boolean)

Indicates whether diagnostic collection is enabled for the VM cluster.

isHealthMonitoringEnabled -> (boolean)

Indicates whether health monitoring is enabled for the VM cluster.

isIncidentLogsEnabled -> (boolean)

Indicates whether incident logs are enabled for the cloud VM cluster.

dataStorageSizeInTBs -> (double)

The size of the data disk group, in terabytes (TB), that’s allocated for the VM cluster.

dbNodeStorageSizeInGBs -> (integer)

The amount of local node storage, in gigabytes (GB), that’s allocated for the VM cluster.

dbServers -> (list)

The list of database servers for the VM cluster.

(string)

diskRedundancy -> (string)

The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

giVersion -> (string)

The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.

hostname -> (string)

The host name for the VM cluster.

iormConfigCache -> (structure)

The ExadataIormConfig cache details for the VM cluster.

dbPlans -> (list)

An array of IORM settings for all the database in the Exadata DB system.

(structure)

The IORM configuration settings for the database.

dbName -> (string)

The database name. For the default DbPlan, the dbName is default .

flashCacheLimit -> (string)

The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.

share -> (integer)

The relative priority of this database.

lifecycleDetails -> (string)

Additional information about the current lifecycleState.

lifecycleState -> (string)

The current state of IORM configuration for the Exadata DB system.

objective -> (string)

The current value for the IORM objective. The default is AUTO.

isLocalBackupEnabled -> (boolean)

Indicates whether database backups to local Exadata storage is enabled for the VM cluster.

isSparseDiskgroupEnabled -> (boolean)

Indicates whether the VM cluster is configured with a sparse disk group.

lastUpdateHistoryEntryId -> (string)

The Oracle Cloud ID (OCID) of the last maintenance update history entry.

licenseModel -> (string)

The Oracle license model applied to the VM cluster.

listenerPort -> (integer)

The port number configured for the listener on the VM cluster.

memorySizeInGBs -> (integer)

The amount of memory, in gigabytes (GB), that’s allocated for the VM cluster.

nodeCount -> (integer)

The number of nodes in the VM cluster.

ocid -> (string)

The OCID of the VM cluster.

ociResourceAnchorName -> (string)

The name of the OCI resource anchor for the VM cluster.

ociUrl -> (string)

The HTTPS link to the VM cluster in OCI.

domain -> (string)

The domain of the VM cluster.

scanDnsName -> (string)

The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.

scanDnsRecordId -> (string)

The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.

scanIpIds -> (list)

The OCID of the SCAN IP addresses that are associated with the VM cluster.

(string)

shape -> (string)

The hardware model name of the Exadata infrastructure that’s running the VM cluster.

sshPublicKeys -> (list)

The public key portion of one or more key pairs used for SSH access to the VM cluster.

(string)

storageSizeInGBs -> (integer)

The amount of local node storage, in gigabytes (GB), that’s allocated to the VM cluster.

systemVersion -> (string)

The operating system version of the image chosen for the VM cluster.

createdAt -> (timestamp)

The date and time when the VM cluster was created.

timeZone -> (string)

The time zone of the VM cluster.

vipIds -> (list)

The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle’s Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.

(string)

odbNetworkId -> (string)

The unique identifier of the ODB network for the VM cluster.

percentProgress -> (float)

The amount of progress made on the current operation on the VM cluster, expressed as a percentage.

computeModel -> (string)

The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.