oracle.oci.oci_database_management_tablespace_facts – Fetches details about one or multiple Tablespace resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple Tablespace resources in Oracle Cloud Infrastructure

  • Gets the list of tablespaces for the specified managedDatabaseId.

  • If tablespace_name is specified, the details of a single Tablespace will be returned.

Requirements

The below requirements are needed on the host that executes this module.

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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
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.
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.
managed_database_id
string / required
The OCID of the Managed Database.
name
string
A filter to return only resources that match the entire name.
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.
sort_by
string
    Choices:
  • TIMECREATED
  • NAME
The field to sort information by. Only one sortOrder can be used. The default sort order for 'TIMECREATED' is descending and the default sort order for 'NAME' is ascending. The 'NAME' sort order is case-sensitive.
sort_order
string
    Choices:
  • ASC
  • DESC
The option to sort information in ascending ('ASC') or descending ('DESC') order. Ascending order is the default order.
tablespace_name
string
The name of the tablespace.
Required to get a specific tablespace.
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

Examples

- name: Get a specific tablespace
  oci_database_management_tablespace_facts:
    # required
    tablespace_name: tablespace_name_example
    managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"

- name: List tablespaces
  oci_database_management_tablespace_facts:
    # required
    managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    sort_by: TIMECREATED
    sort_order: ASC

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
tablespaces
complex
on success
List of Tablespace resources

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}]
 
allocated_size_kb
float
on success
The allocated tablespace size in KB.

Sample:
10
 
allocation_type
string
on success
The type of extent allocation in effect for the tablespace.

Sample:
SYSTEM
 
block_size_bytes
float
on success
The tablespace block size.

Sample:
10
 
compress_for
string
on success
The operation type for which default compression is enabled.

Sample:
BASIC
 
datafiles
complex
on success
A list of the data files associated with the tablespace.

   
allocated_size_kb
float
on success
The allocated file size in KB.

Sample:
10
   
free_space_kb
float
on success
The free space available in the data file in KB.

Sample:
10
   
increment_by
float
on success
The number of blocks used as auto-extension increment.

Sample:
10
   
instance_id
float
on success
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.

Sample:
10
   
is_auto_extensible
boolean
on success
Indicates whether the data file is auto-extensible.

Sample:
True
   
lost_write_protect
string
on success
The lost write protection status of the file.

Sample:
ENABLED
   
max_size_kb
float
on success
The maximum file size in KB.

Sample:
10
   
name
string
on success
The filename (including the path) of the data file or temp file.

Sample:
name_example
   
online_status
string
on success
The online status of the file.

Sample:
SYSOFF
   
shared
string
on success
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.

Sample:
SHARED
   
status
string
on success
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.

Sample:
AVAILABLE
   
used_percent_allocated
float
on success
The percentage of used space out of the total allocated space in the file.

Sample:
1.2
   
used_percent_available
float
on success
The percentage of used space out of the maximum available space in the file.

Sample:
1.2
   
used_space_kb
float
on success
The total space used in the data file in KB.

Sample:
10
   
user_size_kb
float
on success
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.

Sample:
10
 
default_cell_memory
string
on success
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.

Sample:
default_cell_memory_example
 
default_in_memory
string
on success
Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in the tablespace.

Sample:
ENABLED
 
default_in_memory_compression
string
on success
Indicates the default compression level for the IM column store for the tablespace.

Sample:
NO_MEMCOMPRESS
 
default_in_memory_distribute
string
on success
Indicates how the IM column store is distributed by default for the tablespace in an Oracle Real Application Clusters (Oracle RAC) environment.

Sample:
AUTO
 
default_in_memory_duplicate
string
on success
Indicates the duplicate setting for the IM column store in an Oracle RAC environment.

Sample:
NO_DUPLICATE
 
default_in_memory_priority
string
on success
Indicates the default priority for In-Memory Column Store (IM column store) population for the tablespace.

Sample:
LOW
 
default_in_memory_service
string
on success
Indicates how the IM column store is populated on various instances by default for the tablespace.

Sample:
DEFAULT
 
default_in_memory_service_name
string
on success
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.

Sample:
default_in_memory_service_name_example
 
default_index_compression
string
on success
Indicates whether default index compression is enabled or disabled.

Sample:
ENABLED
 
default_table_compression
string
on success
Indicates whether default table compression is enabled or disabled.

Sample:
ENABLED
 
extent_management
string
on success
Indicates whether the extents in the tablespace are Locally managed or Dictionary managed.

Sample:
LOCAL
 
free_space_kb
float
on success
The free space available in the tablespace in KB.

Sample:
10
 
index_compress_for
string
on success
The operation type for which default index compression is enabled.

Sample:
ADVANCED_LOW
 
is_bigfile
boolean
on success
Indicates whether the tablespace is a Bigfile tablespace or a Smallfile tablespace.

Sample:
True
 
is_chunk_tablespace
boolean
on success
Indicates whether this is a chunk tablespace.

Sample:
True
 
is_default
boolean
on success
Indicates whether this is the default tablespace.

Sample:
True
 
is_encrypted
boolean
on success
Indicates whether the tablespace is encrypted.

Sample:
True
 
is_force_logging
boolean
on success
Indicates whether the tablespace is under Force Logging mode.

Sample:
True
 
is_plugged_in
boolean
on success
Indicates whether the tablespace is plugged in.

Sample:
True
 
logging
string
on success
The default logging attribute.

Sample:
LOGGING
 
lost_write_protect
string
on success
The lost write protection setting for the tablespace.

Sample:
ENABLED
 
max_size_kb
float
on success
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.

Sample:
10
 
name
string
on success
The name of the tablespace.

Sample:
name_example
 
predicate_evaluation
string
on success
Indicates whether predicates are evaluated by Host or by Storage.

Sample:
HOST
 
retention
string
on success
Indicates whether undo retention guarantee is enabled for the tablespace.

Sample:
GUARANTEE
 
segment_space_management
string
on success
Indicates whether the free and used segment space in the tablespace is managed using free lists (MANUAL) or bitmaps (AUTO).

Sample:
MANUAL
 
shared
string
on success
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.

Sample:
SHARED
 
status
string
on success
The status of the tablespace.

Sample:
ONLINE
 
temp_group
string
on success
The temporary tablespace group.

Sample:
temp_group_example
 
type
string
on success
The type of tablespace.

Sample:
UNDO
 
used_percent_allocated
float
on success
The percentage of used space out of the total allocated space in the tablespace.

Sample:
1.2
 
used_percent_available
float
on success
The percentage of used space out of the maximum available space in the tablespace.

Sample:
1.2
 
used_space_kb
float
on success
The total space used by the tablespace in KB.

Sample:
10
 
user_size_kb
float
on success
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.

Sample:
10


Authors

  • Oracle (@oracle)