oracle.oci.oci_database_management_tablespace – Manage a Tablespace resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_database_management_tablespace
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create and update a Tablespace resource in Oracle Cloud Infrastructure
For state=present, creates a tablespace within the Managed Database specified by managedDatabaseId.
This resource has the following action operations in the oracle.oci.oci_database_management_tablespace_actions module: add_data_files, drop, remove_data_file, resize_data_file.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
||
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
||
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
||
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file , if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location ). |
||
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
|
auto_extend_max_size
dictionary
|
The maximum disk space allowed for automatic extension of the data files or temp files.
This parameter is updatable.
|
||
size
float
/ required
|
Storage size number in bytes, kilobytes, megabytes, gigabytes, or terabytes.
|
||
unit
string
|
|
Storage size unit: bytes, kilobytes, megabytes, gigabytes, or terabytes.
|
|
auto_extend_next_size
dictionary
|
The size of the next increment of disk space to be allocated automatically when more extents are required.
This parameter is updatable.
|
||
size
float
/ required
|
Storage size number in bytes, kilobytes, megabytes, gigabytes, or terabytes.
|
||
unit
string
|
|
Storage size unit: bytes, kilobytes, megabytes, gigabytes, or terabytes.
|
|
block_size_in_kilobytes
integer
|
Block size for the tablespace.
|
||
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
||
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
||
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location . If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location . |
||
credential_details
dictionary
/ required
|
|||
password
string
|
The database user's password encoded using BASE64 scheme.
Required when tablespace_admin_credential_type is 'PASSWORD'
|
||
password_secret_id
string
|
The OCID of the Secret where the database password is stored.
Required when tablespace_admin_credential_type is 'SECRET'
|
||
role
string
/ required
|
|
The role of the database user.
|
|
tablespace_admin_credential_type
string
/ required
|
|
The type of the credential for tablespace administration tasks.
|
|
username
string
/ required
|
The user to connect to the database.
|
||
data_files
list
/ elements=string
|
The list of data files or temp files created for the tablespace.
|
||
default_compress
string
|
|
The default compression of data for all tables created in the tablespace.
|
|
encryption_algorithm
string
|
The name of the encryption algorithm to be used for tablespace encryption.
|
||
extent_management
string
|
|
Specifies how the extents of the tablespace should be managed.
|
|
extent_uniform_size
dictionary
|
The size of the extent when the tablespace is managed with uniform extents of a specific size.
|
||
size
float
/ required
|
Storage size number in bytes, kilobytes, megabytes, gigabytes, or terabytes.
|
||
unit
string
|
|
Storage size unit: bytes, kilobytes, megabytes, gigabytes, or terabytes.
|
|
file_count
integer
|
The number of data files or temp files created for the tablespace. This is for Oracle Managed Files only.
|
||
file_size
dictionary
|
The size of each data file or temp file.
This parameter is updatable.
|
||
size
float
/ required
|
Storage size number in bytes, kilobytes, megabytes, gigabytes, or terabytes.
|
||
unit
string
|
|
Storage size unit: bytes, kilobytes, megabytes, gigabytes, or terabytes.
|
|
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
|
is_auto_extensible
boolean
|
|
Specifies whether the data file or temp file can be extended automatically.
This parameter is updatable.
|
|
is_bigfile
boolean
|
|
Specifies whether the tablespace is a bigfile or smallfile tablespace. A bigfile tablespace contains only one data file or temp file, which can contain up to approximately 4 billion (232) blocks. A smallfile tablespace is a traditional Oracle tablespace, which can contain 1022 data files or temp files, each of which can contain up to approximately 4 million (222) blocks.
|
|
is_default
boolean
|
|
Specifies whether the tablespace is the default tablespace.
This parameter is updatable.
|
|
is_encrypted
boolean
|
|
Indicates whether the tablespace is encrypted.
|
|
is_max_size_unlimited
boolean
|
|
Specifies whether the disk space of the data file or temp file can be limited.
This parameter is updatable.
|
|
is_reusable
boolean
|
|
Specifies whether Oracle can reuse the data file or temp file. Reuse is only allowed when the file name is provided.
|
|
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
||
managed_database_id
string
/ required
|
The OCID of the Managed Database.
|
||
name
string
/ required
|
The name of the tablespace. It must be unique within a database.
|
||
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
|
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
||
segment_management
string
|
|
Specifies whether tablespace segment management should be automatic or manual.
|
|
state
string
|
|
The state of the Tablespace.
Use state=present to create or update a Tablespace.
|
|
status
string
|
|
The status of the tablespace.
This parameter is updatable.
|
|
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
||
type
string
|
|
The type of tablespace.
This parameter is updatable.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create tablespace
oci_database_management_tablespace:
# required
managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
credential_details:
# required
password: example-password
tablespace_admin_credential_type: PASSWORD
username: username_example
role: NORMAL
name: name_example
# optional
is_bigfile: true
data_files: [ "data_files_example" ]
file_count: 56
is_reusable: true
block_size_in_kilobytes: 56
is_encrypted: true
encryption_algorithm: encryption_algorithm_example
default_compress: NO_COMPRESS
extent_management: AUTOALLOCATE
extent_uniform_size:
# required
size: 3.4
# optional
unit: BYTES
segment_management: AUTO
type: PERMANENT
file_size:
# required
size: 3.4
# optional
unit: BYTES
status: READ_ONLY
is_auto_extensible: true
auto_extend_next_size:
# required
size: 3.4
# optional
unit: BYTES
auto_extend_max_size:
# required
size: 3.4
# optional
unit: BYTES
is_max_size_unlimited: true
is_default: true
- name: Update tablespace
oci_database_management_tablespace:
# required
managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
credential_details:
# required
password: example-password
tablespace_admin_credential_type: PASSWORD
username: username_example
role: NORMAL
name: name_example
# optional
type: PERMANENT
file_size:
# required
size: 3.4
# optional
unit: BYTES
status: READ_ONLY
is_auto_extensible: true
auto_extend_next_size:
# required
size: 3.4
# optional
unit: BYTES
auto_extend_max_size:
# required
size: 3.4
# optional
unit: BYTES
is_max_size_unlimited: true
is_default: true
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)