imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-11 07:29:40 +00:00
Code Activity

gcloud: Wed Sep 25 09:51:52 UTC 2024

Browse source
This commit is contained in:
Automated 2024-09-25 09:51:52 +00:00
parent 8ebed5b0f1
commit 0a5b6f11af
202 changed files with 9781 additions and 830 deletions
Download patch file Download diff file Expand all files Collapse all files

276
gcloud/oracle-database/autonomous-databases/create Normal file
View file

@ -0,0 +1,276 @@
NAME
gcloud oracle-database autonomous-databases create - create a new
AutonomousDatabase
SYNOPSIS
gcloud oracle-database autonomous-databases create
(AUTONOMOUS_DATABASE : --location=LOCATION) --cidr=CIDR
--network=NETWORK [--admin-password=ADMIN_PASSWORD] [--async]
[--database=DATABASE] [--display-name=DISPLAY_NAME]
[--labels=[LABELS,...]] [--request-id=REQUEST_ID]
[--properties-db-workload=PROPERTIES_DB_WORKLOAD
--properties-license-type=PROPERTIES_LICENSE_TYPE
: --properties-backup-retention-period-days=PROPERTIES_BACKUP_RETENTION_PERIOD_DAYS --properties-character-set=PROPERTIES_CHARACTER_SET --properties-compute-count=PROPERTIES_COMPUTE_COUNT --properties-cpu-core-count=PROPERTIES_CPU_CORE_COUNT --properties-customer-contacts=[email=EMAIL] --properties-data-storage-size-gb=PROPERTIES_DATA_STORAGE_SIZE_GB --properties-data-storage-size-tb=PROPERTIES_DATA_STORAGE_SIZE_TB --properties-db-edition=PROPERTIES_DB_EDITION --properties-db-version=PROPERTIES_DB_VERSION --properties-is-auto-scaling-enabled --properties-is-storage-auto-scaling-enabled --properties-maintenance-schedule-type=PROPERTIES_MAINTENANCE_SCHEDULE_TYPE --properties-mtls-connection-required --properties-n-character-set=PROPERTIES_N_CHARACTER_SET --properties-private-endpoint-ip=PROPERTIES_PRIVATE_ENDPOINT_IP --properties-private-endpoint-label=PROPERTIES_PRIVATE_ENDPOINT_LABEL --properties-secret-id=PROPERTIES_SECRET_ID --properties-vault-id=PROPERTIES_VAULT_ID]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a new AutonomousDatabase.
EXAMPLES
To create AutonomousDatabase with id my-instance in the location us-east4
with display-name my instance, network
projects/my-project/locations/global/networks/default, location us-east4,
database testadb, admin-password 123Abpassdord, cidr 12.2.0.0/24,
properties-compute-count 2, properties-db-version 19c,
properties-license-type LICENSE_INCLUDED, properties-db-workload DW. run:
$ gcloud oracle-database autonomous-databases create my-instance \
--location=us-east4 --display-name="my instance" \
--network=projects/my-project/locations/global/networks/\
default --cidr=12.2.0.0/24 --location=us-east4 --database=testadb \
--admin-password=123Abpassdord --properties-compute-count=2 \
--properties-db-version=19c \
--properties-license-type=LICENSE_INCLUDED \
--properties-db-workload=DW
POSITIONAL ARGUMENTS
AutonomousDatabase resource - Identifier. The name of the Autonomous
Database resource in the following format:
projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument autonomous_database on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
AUTONOMOUS_DATABASE
ID of the autonomousDatabase or fully qualified identifier for the
autonomousDatabase.
To set the autonomous_database attribute:
▸ provide the argument autonomous_database on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the autonomousDatabase resource.
To set the location attribute:
▸ provide the argument autonomous_database on the command line with
a fully specified name;
▸ provide the argument --location on the command line.
REQUIRED FLAGS
--cidr=CIDR
The subnet CIDR range for the Autonmous Database.
Network resource - The name of the VPC network used by the Autonomous
Database in the following format:
projects/{project}/global/networks/{network} This represents a Cloud
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument --network on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
--network=NETWORK
ID of the network or fully qualified identifier for the network.
To set the network attribute:
▸ provide the argument --network on the command line.
OPTIONAL FLAGS
--admin-password=ADMIN_PASSWORD
The password for the default ADMIN user.
--async
Return immediately, without waiting for the operation in progress to
complete.
--database=DATABASE
The name of the Autonomous Database. The database name must be unique
in the project. The name must begin with a letter and can contain a
maximum of 30 alphanumeric characters.
--display-name=DISPLAY_NAME
The display name for the Autonomous Database. The name does not have to
be unique within your project.
--labels=[LABELS,...]
The labels or tags associated with the Autonomous Database.
KEY
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase
characters, and numbers.
Shorthand Example:
--labels=string=string
JSON Example:
--labels='{"string": "string"}'
File Example:
--labels=path_to_file.(yaml|json)
--request-id=REQUEST_ID
An optional ID to identify the request. This value is used to identify
duplicate requests. If you make a request with the same request ID and
the original request is still in progress or completed, the server
ignores the second request. This prevents clients from accidentally
creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID
is not supported (00000000-0000-0000-0000-000000000000).
The properties of an Autonomous Database.
--properties-db-workload=PROPERTIES_DB_WORKLOAD
The workload type of the Autonomous Database. PROPERTIES_DB_WORKLOAD
must be one of:
ajd
Autonomous JSON Database.
apex
Autonomous Database with the Oracle APEX Application Development
workload type.
dw
Autonomous Data Warehouse database.
oltp
Autonomous Transaction Processing database.
This flag argument must be specified if any of the other arguments in
this group are specified.
--properties-license-type=PROPERTIES_LICENSE_TYPE
The license type used for the Autonomous Database.
PROPERTIES_LICENSE_TYPE must be one of:
bring-your-own-license
Bring your own license
license-included
License included part of offer
This flag argument must be specified if any of the other arguments in
this group are specified.
--properties-backup-retention-period-days=PROPERTIES_BACKUP_RETENTION_PERIOD_DAYS
The retention period for the Autonomous Database. This field is
specified in days, can range from 1 day to 60 days, and has a default
value of 60 days.
--properties-character-set=PROPERTIES_CHARACTER_SET
The character set for the Autonomous Database. The default is
AL32UTF8.
--properties-compute-count=PROPERTIES_COMPUTE_COUNT
The number of compute servers for the Autonomous Database.
--properties-cpu-core-count=PROPERTIES_CPU_CORE_COUNT
The number of CPU cores to be made available to the database.
--properties-customer-contacts=[email=EMAIL]
The list of customer contacts.
email
The email address used by Oracle to send notifications regarding
databases and infrastructure.
Shorthand Example:
--properties-customer-contacts=email=string --properties-customer-contacts=email=string
JSON Example:
--properties-customer-contacts='[{"email": "string"}]'
File Example:
--properties-customer-contacts=path_to_file.(yaml|json)
--properties-data-storage-size-gb=PROPERTIES_DATA_STORAGE_SIZE_GB
The size of the data stored in the database, in gigabytes.
--properties-data-storage-size-tb=PROPERTIES_DATA_STORAGE_SIZE_TB
The size of the data stored in the database, in terabytes.
--properties-db-edition=PROPERTIES_DB_EDITION
The edition of the Autonomous Databases. PROPERTIES_DB_EDITION must
be one of:
enterprise-edition
Enterprise Database Edition
standard-edition
Standard Database Edition
--properties-db-version=PROPERTIES_DB_VERSION
The Oracle Database version for the Autonomous Database.
--properties-is-auto-scaling-enabled
This field indicates if auto scaling is enabled for the Autonomous
Database CPU core count.
--properties-is-storage-auto-scaling-enabled
This field indicates if auto scaling is enabled for the Autonomous
Database storage.
--properties-maintenance-schedule-type=PROPERTIES_MAINTENANCE_SCHEDULE_TYPE
The maintenance schedule of the Autonomous Database.
PROPERTIES_MAINTENANCE_SCHEDULE_TYPE must be one of:
early
An EARLY maintenance schedule patches the database before the
regular scheduled maintenance.
regular
A REGULAR maintenance schedule follows the normal maintenance
cycle.
--properties-mtls-connection-required
This field specifies if the Autonomous Database requires mTLS
connections.
--properties-n-character-set=PROPERTIES_N_CHARACTER_SET
The national character set for the Autonomous Database. The default
is AL16UTF16.
--properties-private-endpoint-ip=PROPERTIES_PRIVATE_ENDPOINT_IP
The private endpoint IP address for the Autonomous Database.
--properties-private-endpoint-label=PROPERTIES_PRIVATE_ENDPOINT_LABEL
The private endpoint label for the Autonomous Database.
--properties-secret-id=PROPERTIES_SECRET_ID
The ID of the Oracle Cloud Infrastructure vault secret.
--properties-vault-id=PROPERTIES_VAULT_ID
The ID of the Oracle Cloud Infrastructure vault.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the oracledatabase/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/oracle/database/docs

79
gcloud/oracle-database/autonomous-databases/delete Normal file
View file

@ -0,0 +1,79 @@
NAME
gcloud oracle-database autonomous-databases delete - delete an
AutonomousDatabase
SYNOPSIS
gcloud oracle-database autonomous-databases delete
(AUTONOMOUS_DATABASE : --location=LOCATION) [--async]
[--request-id=REQUEST_ID] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete an AutonomousDatabase.
EXAMPLES
To delete an AutonomousDatabase with id my-instance in the location
us-east4, run:
$ gcloud oracle-database autonomous-databases delete my-instance \
--location=us-east4
POSITIONAL ARGUMENTS
AutonomousDatabase resource - The name of the resource in the following
format:
projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument autonomous_database on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
AUTONOMOUS_DATABASE
ID of the autonomousDatabase or fully qualified identifier for the
autonomousDatabase.
To set the autonomous_database attribute:
▸ provide the argument autonomous_database on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the autonomousDatabase resource.
To set the location attribute:
▸ provide the argument autonomous_database on the command line with
a fully specified name;
▸ provide the argument --location on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--request-id=REQUEST_ID
An optional ID to identify the request. This value is used to identify
duplicate requests. If you make a request with the same request ID and
the original request is still in progress or completed, the server
ignores the second request. This prevents clients from accidentally
creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID
is not supported (00000000-0000-0000-0000-000000000000).
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the oracledatabase/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/oracle/database/docs

63
gcloud/oracle-database/autonomous-databases/describe Normal file
View file

@ -0,0 +1,63 @@
NAME
gcloud oracle-database autonomous-databases describe - get details of an
AutonomousDatabase
SYNOPSIS
gcloud oracle-database autonomous-databases describe
(AUTONOMOUS_DATABASE : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Get details of an AutonomousDatabase.
EXAMPLES
To get an AutonomousDatabase with id my-instance in the location us-east4,
run:
$ gcloud oracle-database autonomous-databases describe my-instance \
--location=us-east4
POSITIONAL ARGUMENTS
AutonomousDatabase resource - The name of the Autonomous Database in the
following format:
projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument autonomous_database on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
AUTONOMOUS_DATABASE
ID of the autonomousDatabase or fully qualified identifier for the
autonomousDatabase.
To set the autonomous_database attribute:
▸ provide the argument autonomous_database on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the autonomousDatabase resource.
To set the location attribute:
▸ provide the argument autonomous_database on the command line with
a fully specified name;
▸ provide the argument --location on the command line.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the oracledatabase/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/oracle/database/docs

85
gcloud/oracle-database/autonomous-databases/generate-wallet Normal file
View file

@ -0,0 +1,85 @@
NAME
gcloud oracle-database autonomous-databases generate-wallet - generate
wallet for an AutonomousDatabase
SYNOPSIS
gcloud oracle-database autonomous-databases generate-wallet
(AUTONOMOUS_DATABASE : --location=LOCATION) --password=PASSWORD
[--is-regional] [--type=TYPE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Generate wallet for an AutonomousDatabase, Content is base64 encoded zip
archive.
EXAMPLES
To generate wallet for an AutonomousDatabase with id my-instance with
password 123Abpassword, to encrypt the keys inside the wallet in the
location us-east4, run:
$ gcloud oracle-database autonomous-databases generate-wallet \
my-instance --location=us-east4 --password=123Abpassword
POSITIONAL ARGUMENTS
AutonomousDatabase resource - The name of the Autonomous Database in the
following format:
projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument autonomous_database on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
AUTONOMOUS_DATABASE
ID of the autonomousDatabase or fully qualified identifier for the
autonomousDatabase.
To set the autonomous_database attribute:
▸ provide the argument autonomous_database on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the autonomousDatabase resource.
To set the location attribute:
▸ provide the argument autonomous_database on the command line with
a fully specified name;
▸ provide the argument --location on the command line.
REQUIRED FLAGS
--password=PASSWORD
The password used to encrypt the keys inside the wallet. The password
must be a minimum of 8 characters.
OPTIONAL FLAGS
--is-regional
True when requesting regional connection strings in PDB connect info,
applicable to cross-region Data Guard only.
--type=TYPE
The type of wallet generation for the Autonomous Database. The default
value is SINGLE. TYPE must be one of:
all
Used to generate wallet for all databases in the region.
single
Used to generate wallet for a single database.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the oracledatabase/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/oracle/database/docs

35
gcloud/oracle-database/autonomous-databases/help Normal file
View file

@ -0,0 +1,35 @@
NAME
gcloud oracle-database autonomous-databases - manage Autonomous Database
resources
SYNOPSIS
gcloud oracle-database autonomous-databases COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage Autonomous Database resources.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Create a new AutonomousDatabase.
delete
Delete an AutonomousDatabase.
describe
Get details of an AutonomousDatabase.
generate-wallet
Generate wallet for an AutonomousDatabase.
list
List all AutonomousDatabases.
restore
Restore an AutonomousDatabase.

81
gcloud/oracle-database/autonomous-databases/list Normal file
View file

@ -0,0 +1,81 @@
NAME
gcloud oracle-database autonomous-databases list - list all
AutonomousDatabases
SYNOPSIS
gcloud oracle-database autonomous-databases list --location=LOCATION
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List all AutonomousDatabases.
EXAMPLES
To list all AutonomousDatabases in the location us-east4, run:
$ gcloud oracle-database autonomous-databases list \
--location=us-east4
REQUIRED FLAGS
Location resource - The parent value for the Autonomous Database in the
following format: projects/{project}/locations/{location}. This represents
a Cloud resource. (NOTE) Some attributes are not given arguments in this
group but can be set in other ways.
To set the project attribute:
◆ provide the argument --location on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
--location=LOCATION
ID of the location or fully qualified identifier for the location.
To set the location attribute:
▸ provide the argument --location on the command line.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the oracledatabase/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/oracle/database/docs

74
gcloud/oracle-database/autonomous-databases/restore Normal file
View file

@ -0,0 +1,74 @@
NAME
gcloud oracle-database autonomous-databases restore - restore an
AutonomousDatabase
SYNOPSIS
gcloud oracle-database autonomous-databases restore
(AUTONOMOUS_DATABASE : --location=LOCATION) --restore-time=RESTORE_TIME
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Restore an AutonomousDatabase to the state at specified restore-time.
EXAMPLES
To restore an AutonomousDatabase with id my-instance at restore-time
2024-05-01T00:00:00.000Z in the location us-east4 , The restore-time is the
'endTime' property of a backup. run:
$ gcloud oracle-database autonomous-databases restore my-instance \
--location=us-east4 --restore-time=2024-05-01T00:00:00.000Z
POSITIONAL ARGUMENTS
AutonomousDatabase resource - The name of the Autonomous Database in the
following format:
projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument autonomous_database on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
AUTONOMOUS_DATABASE
ID of the autonomousDatabase or fully qualified identifier for the
autonomousDatabase.
To set the autonomous_database attribute:
▸ provide the argument autonomous_database on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the autonomousDatabase resource.
To set the location attribute:
▸ provide the argument autonomous_database on the command line with
a fully specified name;
▸ provide the argument --location on the command line.
REQUIRED FLAGS
--restore-time=RESTORE_TIME
The time and date to restore the database to.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the oracledatabase/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/oracle/database/docs