oracle / oracle.oci / 5.0.0 / module / oci_database_management_tablespace Manage a Tablespace resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_management_tablespace (5.0.0) — module
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections: - name: oracle.oci version: 5.0.0
This module allows the user to create and update a Tablespace resource in Oracle Cloud Infrastructure
For I(state=present), creates a tablespace within the Managed Database specified by managedDatabaseId.
This resource has the following action operations in the M(oracle.oci.oci_database_management_tablespace_actions) module: add_data_files, drop, remove_data_file, resize_data_file.
- 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
name: description: - The name of the tablespace. It must be unique within a database. required: true type: str type: choices: - PERMANENT - TEMPORARY description: - The type of tablespace. - This parameter is updatable. type: str state: choices: - present default: present description: - The state of the Tablespace. - Use I(state=present) to create or update a Tablespace. required: false type: str key_by: description: 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. elements: str type: list region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str status: choices: - READ_ONLY - READ_WRITE description: - The status of the tablespace. - This parameter is updatable. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str file_size: description: - The size of each data file or temp file. - This parameter is updatable. suboptions: size: description: - Storage size number in bytes, kilobytes, megabytes, gigabytes, or terabytes. required: true type: float unit: choices: - BYTES - KILOBYTES - MEGABYTES - GIGABYTES - TERABYTES description: - 'Storage size unit: bytes, kilobytes, megabytes, gigabytes, or terabytes.' type: str type: dict data_files: description: - The list of data files or temp files created for the tablespace. elements: str type: list file_count: description: - The number of data files or temp files created for the tablespace. This is for Oracle Managed Files only. type: int is_bigfile: description: - 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. type: bool is_default: description: - Specifies whether the tablespace is the default tablespace. - This parameter is updatable. type: bool cert_bundle: description: - 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. type: str is_reusable: description: - Specifies whether Oracle can reuse the data file or temp file. Reuse is only allowed when the file name is provided. type: bool auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str force_create: default: false description: 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 I(key_by). type: bool is_encrypted: description: - Indicates whether the tablespace is encrypted. type: bool default_compress: choices: - NO_COMPRESS - BASIC_COMPRESS description: - The default compression of data for all tables created in the tablespace. type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str extent_management: choices: - AUTOALLOCATE - UNIFORM description: - Specifies how the extents of the tablespace should be managed. type: str credential_details: description: - '' required: true suboptions: password: description: - The database user's password encoded using BASE64 scheme. - Required when tablespace_admin_credential_type is 'PASSWORD' type: str password_secret_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. - Required when tablespace_admin_credential_type is 'SECRET' type: str role: choices: - NORMAL - SYSDBA description: - The role of the database user. required: true type: str tablespace_admin_credential_type: choices: - PASSWORD - SECRET description: - The type of the credential for tablespace administration tasks. required: true type: str username: description: - The user to connect to the database. required: true type: str type: dict is_auto_extensible: description: - Specifies whether the data file or temp file can be extended automatically. - This parameter is updatable. type: bool segment_management: choices: - AUTO - MANUAL description: - Specifies whether tablespace segment management should be automatic or manual. type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str extent_uniform_size: description: - The size of the extent when the tablespace is managed with uniform extents of a specific size. suboptions: size: description: - Storage size number in bytes, kilobytes, megabytes, gigabytes, or terabytes. required: true type: float unit: choices: - BYTES - KILOBYTES - MEGABYTES - GIGABYTES - TERABYTES description: - 'Storage size unit: bytes, kilobytes, megabytes, gigabytes, or terabytes.' type: str type: dict managed_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Managed Database. required: true type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auto_extend_max_size: description: - The maximum disk space allowed for automatic extension of the data files or temp files. - This parameter is updatable. suboptions: size: description: - Storage size number in bytes, kilobytes, megabytes, gigabytes, or terabytes. required: true type: float unit: choices: - BYTES - KILOBYTES - MEGABYTES - GIGABYTES - TERABYTES description: - 'Storage size unit: bytes, kilobytes, megabytes, gigabytes, or terabytes.' type: str type: dict config_file_location: description: - 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. type: str encryption_algorithm: description: - The name of the encryption algorithm to be used for tablespace encryption. type: str auto_extend_next_size: description: - The size of the next increment of disk space to be allocated automatically when more extents are required. - This parameter is updatable. suboptions: size: description: - Storage size number in bytes, kilobytes, megabytes, gigabytes, or terabytes. required: true type: float unit: choices: - BYTES - KILOBYTES - MEGABYTES - GIGABYTES - TERABYTES description: - 'Storage size unit: bytes, kilobytes, megabytes, gigabytes, or terabytes.' type: str type: dict is_max_size_unlimited: description: - Specifies whether the disk space of the data file or temp file can be limited. - This parameter is updatable. type: bool block_size_in_kilobytes: description: - Block size for the tablespace. type: int api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str realm_specific_endpoint_template_enabled: description: - 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. type: bool
tablespace: contains: allocated_size_kb: description: - The allocated tablespace size in KB. returned: on success sample: 10 type: float allocation_type: description: - The type of extent allocation in effect for the tablespace. returned: on success sample: SYSTEM type: str block_size_bytes: description: - The tablespace block size. returned: on success sample: 10 type: float compress_for: description: - The operation type for which default compression is enabled. returned: on success sample: BASIC type: str datafiles: contains: allocated_size_kb: description: - The allocated file size in KB. returned: on success sample: 10 type: float free_space_kb: description: - The free space available in the data file in KB. returned: on success sample: 10 type: float increment_by: description: - The number of blocks used as auto-extension increment. returned: on success sample: 10 type: float instance_id: description: - Instance ID of the instance to which the temp file belongs. This column has a NULL value for temp files that belong to shared tablespaces. returned: on success sample: 10 type: float is_auto_extensible: description: - Indicates whether the data file is auto-extensible. returned: on success sample: true type: bool lost_write_protect: description: - The lost write protection status of the file. returned: on success sample: ENABLED type: str max_size_kb: description: - The maximum file size in KB. returned: on success sample: 10 type: float name: description: - The filename (including the path) of the data file or temp file. returned: on success sample: name_example type: str online_status: description: - The online status of the file. returned: on success sample: SYSOFF type: str shared: description: - Type of tablespace this file belongs to. If it's for a shared tablespace, for a local temporary tablespace for RIM (read-only) instances, or for local temporary tablespace for all instance types. returned: on success sample: SHARED type: str status: description: - The status of the file. INVALID status is used when the file number is not in use, for example, a file in a tablespace that was removed. returned: on success sample: AVAILABLE type: str used_percent_allocated: description: - The percentage of used space out of the total allocated space in the file. returned: on success sample: 1.2 type: float used_percent_available: description: - The percentage of used space out of the maximum available space in the file. returned: on success sample: 1.2 type: float used_space_kb: description: - The total space used in the data file in KB. returned: on success sample: 10 type: float user_size_kb: description: - The size of the file available for user data in KB. The actual size of the file minus the USER_BYTES value is used to store file- related metadata. returned: on success sample: 10 type: float description: - A list of the data files associated with the tablespace. returned: on success type: complex default_cell_memory: description: - This specifies the default value for the CELLMEMORY attribute that tables created in the tablespace will inherit unless the behavior is overridden explicitly. This column is intended for use with Oracle Exadata. returned: on success sample: default_cell_memory_example type: str default_in_memory: description: - Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in the tablespace. returned: on success sample: ENABLED type: str default_in_memory_compression: description: - Indicates the default compression level for the IM column store for the tablespace. returned: on success sample: NO_MEMCOMPRESS type: str default_in_memory_distribute: description: - Indicates how the IM column store is distributed by default for the tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. returned: on success sample: AUTO type: str default_in_memory_duplicate: description: - Indicates the duplicate setting for the IM column store in an Oracle RAC environment. returned: on success sample: NO_DUPLICATE type: str default_in_memory_priority: description: - Indicates the default priority for In-Memory Column Store (IM column store) population for the tablespace. returned: on success sample: LOW type: str default_in_memory_service: description: - Indicates how the IM column store is populated on various instances by default for the tablespace. returned: on success sample: DEFAULT type: str default_in_memory_service_name: description: - Indicates the service name for the service on which the IM column store should be populated by default for the tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. returned: on success sample: default_in_memory_service_name_example type: str default_index_compression: description: - Indicates whether default index compression is enabled or disabled. returned: on success sample: ENABLED type: str default_table_compression: description: - Indicates whether default table compression is enabled or disabled. returned: on success sample: ENABLED type: str extent_management: description: - Indicates whether the extents in the tablespace are Locally managed or Dictionary managed. returned: on success sample: LOCAL type: str free_space_kb: description: - The free space available in the tablespace in KB. returned: on success sample: 10 type: float index_compress_for: description: - The operation type for which default index compression is enabled. returned: on success sample: ADVANCED_LOW type: str is_bigfile: description: - Indicates whether the tablespace is a Bigfile tablespace or a Smallfile tablespace. returned: on success sample: true type: bool is_chunk_tablespace: description: - Indicates whether this is a chunk tablespace. returned: on success sample: true type: bool is_default: description: - Indicates whether this is the default tablespace. returned: on success sample: true type: bool is_encrypted: description: - Indicates whether the tablespace is encrypted. returned: on success sample: true type: bool is_force_logging: description: - Indicates whether the tablespace is under Force Logging mode. returned: on success sample: true type: bool is_plugged_in: description: - Indicates whether the tablespace is plugged in. returned: on success sample: true type: bool logging: description: - The default logging attribute. returned: on success sample: LOGGING type: str lost_write_protect: description: - The lost write protection setting for the tablespace. returned: on success sample: ENABLED type: str max_size_kb: description: - The maximum tablespace size in KB. If the tablespace contains any data files with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its data files is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only data files with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all data files in the tablespace. returned: on success sample: 10 type: float name: description: - The name of the tablespace. returned: on success sample: name_example type: str predicate_evaluation: description: - Indicates whether predicates are evaluated by Host or by Storage. returned: on success sample: HOST type: str retention: description: - Indicates whether undo retention guarantee is enabled for the tablespace. returned: on success sample: GUARANTEE type: str segment_space_management: description: - Indicates whether the free and used segment space in the tablespace is managed using free lists (MANUAL) or bitmaps (AUTO). returned: on success sample: MANUAL type: str shared: description: - Indicates whether the tablespace is for shared tablespace, or for local temporary tablespace for leaf (read-only) instances, or for local temporary tablespace for all instance types. returned: on success sample: SHARED type: str status: description: - The status of the tablespace. returned: on success sample: ONLINE type: str temp_group: description: - The temporary tablespace group. returned: on success sample: temp_group_example type: str type: description: - The type of tablespace. returned: on success sample: UNDO type: str used_percent_allocated: description: - The percentage of used space out of the total allocated space in the tablespace. returned: on success sample: 1.2 type: float used_percent_available: description: - The percentage of used space out of the maximum available space in the tablespace. returned: on success sample: 1.2 type: float used_space_kb: description: - The total space used by the tablespace in KB. returned: on success sample: 10 type: float user_size_kb: description: - The size of the tablespace available for user data in KB. The difference between tablespace size and user data size is used for storing metadata. returned: on success sample: 10 type: float description: - Details of the Tablespace resource acted upon by the current operation returned: on success sample: allocated_size_kb: 10 allocation_type: SYSTEM block_size_bytes: 10 compress_for: BASIC datafiles: - allocated_size_kb: 10 free_space_kb: 10 increment_by: 10 instance_id: 10 is_auto_extensible: true lost_write_protect: ENABLED max_size_kb: 10 name: name_example online_status: SYSOFF shared: SHARED status: AVAILABLE used_percent_allocated: 1.2 used_percent_available: 1.2 used_space_kb: 10 user_size_kb: 10 default_cell_memory: default_cell_memory_example default_in_memory: ENABLED default_in_memory_compression: NO_MEMCOMPRESS default_in_memory_distribute: AUTO default_in_memory_duplicate: NO_DUPLICATE default_in_memory_priority: LOW default_in_memory_service: DEFAULT default_in_memory_service_name: default_in_memory_service_name_example default_index_compression: ENABLED default_table_compression: ENABLED extent_management: LOCAL free_space_kb: 10 index_compress_for: ADVANCED_LOW is_bigfile: true is_chunk_tablespace: true is_default: true is_encrypted: true is_force_logging: true is_plugged_in: true logging: LOGGING lost_write_protect: ENABLED max_size_kb: 10 name: name_example predicate_evaluation: HOST retention: GUARANTEE segment_space_management: MANUAL shared: SHARED status: ONLINE temp_group: temp_group_example type: UNDO used_percent_allocated: 1.2 used_percent_available: 1.2 used_space_kb: 10 user_size_kb: 10 type: complex