Try SpotterFetches details about a IormPlan resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about a IormPlan resource in Oracle Cloud Infrastructure
Get the IORM plan from the specific exadata storage server.
- name: Get a specific iorm_plan
oci_database_management_iorm_plan_facts:
# required
external_exadata_storage_server_id: "ocid1.externalexadatastorageserver.oc1..xxxxxxEXAMPLExxxxxx"
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
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
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
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
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
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
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
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
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
external_exadata_storage_server_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Exadata storage server.
required: true
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
iorm_plan:
contains:
db_plan:
contains:
items:
contains:
allocation:
description:
- The resource allocation as a percentage (0-100) within the level.
returned: on success
sample: 56
type: int
asm_cluster:
description:
- Starting with Oracle Exadata System Software release 19.1.0, you can
use the asmcluster attribute to distinguish between databases with
the same name running in different Oracle ASM clusters.
returned: on success
sample: asm_cluster_example
type: str
flash_cache_limit:
description:
- Defines a soft limit for space usage in Exadata Smart Flash Cache.
If the cache is not full, the limit can be exceeded. You specify the
value for flashcachelimit in bytes. You can also use the suffixes
M (megabytes), G (gigabytes), or T (terabytes) to specify larger values.
For example, 300M, 150G, or 1T. The value for flashcachelimit must
be at least 4 MB. The flashcachelimit and flashcachesize attributes
cannot be specified in the same directive. The value for flashcachelimit
cannot be smaller than flashcachemin, if it is specified.
returned: on success
sample: flash_cache_limit_example
type: str
flash_cache_min:
description:
- Specifies a minimum guaranteed space allocation in Exadata Smart Flash
Cache. You specify the value for flashcachemin in bytes. You can also
use the suffixes M (megabytes), G (gigabytes), or T (terabytes) to
specify larger values. For example, 300M, 150G, or 1T. The value for
flashcachemin must be at least 4 MB. In any plan, the sum of all flashcachemin
values cannot exceed the size of Exadata Smart Flash Cache. If flashcachelimit
is specified, then the value for flashcachemin cannot exceed flashcachelimit.
If flashcachesize is specified, then the value for flashcachemin cannot
exceed flashcachesize.
returned: on success
sample: flash_cache_min_example
type: str
flash_cache_size:
description:
- Defines a hard limit for space usage in Exadata Smart Flash Cache.
The limit cannot be exceeded, even if the cache is not full. In an
IORM plan, if the size of Exadata Smart Flash Cache can accommodate
all of the flashcachemin and flashcachesize allocations, then each
flashcachesize definition represents a guaranteed space allocation.
However, starting with Oracle Exadata System Software release 19.2.0
you can use the flashcachesize attribute to over-provision space in
Exadata Smart Flash Cache. Consequently, if the size of Exadata Smart
Flash Cache cannot accommodate all of the flashcachemin and flashcachesize
allocations, then only flashcachemin is guaranteed.
returned: on success
sample: flash_cache_size_example
type: str
is_flash_cache_on:
description:
- Controls use of Exadata Smart Flash Cache by a database. This ensures
that cache space is reserved for mission-critical databases. flashcache=off
is invalid in a directive that contains the flashcachemin, flashcachelimit,
or flashcachesize attributes.
returned: on success
sample: true
type: bool
is_flash_log_on:
description:
- Controls use of Exadata Smart Flash Log by a database. This ensures
that Exadata Smart Flash Log is reserved for mission-critical databases.
returned: on success
sample: true
type: bool
is_pmem_cache_on:
description:
- Controls use of the persistent memory (PMEM) cache by a database.
This ensures that cache space is reserved for mission-critical databases.
pmemcache=off is invalid in a directive that contains the pmemcachemin,
pmemcachelimit, or pmemcachesize attributes.
returned: on success
sample: true
type: bool
is_pmem_log_on:
description:
- Controls use of persistent memory logging (PMEM log) by a database.
This ensures that PMEM log is reserved for mission-critical databases.
returned: on success
sample: true
type: bool
level:
description:
- The allocation level. Valid values are from 1 to 8. Resources are
allocated to level 1 first, and then remaining resources are allocated
to level 2, and so on.
returned: on success
sample: 56
type: int
limit:
description:
- The maximum I/O utilization limit as a percentage of the available
resources.
returned: on success
sample: 56
type: int
name:
description:
- The name of a database or a profile.
returned: on success
sample: name_example
type: str
pmem_cache_limit:
description:
- Defines a soft limit for space usage in the persistent memory (PMEM)
cache. If the cache is not full, the limit can be exceeded. You specify
the value for pmemcachelimit in bytes. You can also use the suffixes
M (megabytes), G (gigabytes), or T (terabytes) to specify larger values.
For example, 300M, 150G, or 1T. The value for pmemcachelimit must
be at least 4 MB. The pmemcachelimit and pmemcachesize attributes
cannot be specified in the same directive. The value for pmemcachelimit
cannot be smaller than pmemcachemin, if it is specified.
returned: on success
sample: pmem_cache_limit_example
type: str
pmem_cache_min:
description:
- Specifies a minimum guaranteed space allocation in the persistent
memory (PMEM) cache.
returned: on success
sample: pmem_cache_min_example
type: str
pmem_cache_size:
description:
- Defines a hard limit for space usage in the persistent memory (PMEM)
cache. The limit cannot be exceeded, even if the cache is not full.
In an IORM plan, if the size of the PMEM cache can accommodate all
of the pmemcachemin and pmemcachesize allocations, then each pmemcachesize
definition represents a guaranteed space allocation. However, you
can use the pmemcachesize attribute to over-provision space in the
PMEM cache. Consequently, if the PMEM cache size cannot accommodate
all of the pmemcachemin and pmemcachesize allocations, then only pmemcachemin
is guaranteed.
returned: on success
sample: pmem_cache_size_example
type: str
role:
description:
- Enables you specify different plan directives based on the Oracle
Data Guard database role.
returned: on success
sample: PRIMARY
type: str
share:
description:
- The relative priority a database in the database plan. A higher share
value implies higher priority and more access to the I/O resources.
Use either share or (level, allocation). All plan directives in a
database plan should use the same setting. Share-based resource allocation
is the recommended method for a database plan.
returned: on success
sample: 56
type: int
type:
description:
- 'Enables you to create a profile, or template, to ease management
and configuration of resource plans in environments with many databases.
type=database: Specifies a directive that applies to a specific database.
If type in not specified, then the directive defaults to the database
type. type=profile: Specifies a directive that applies to a profile
rather than a specific database. To associate a database with an IORM
profile, you must set the database initialization parameter db_performance_profile
to the value of the profile name. Databases that map to a profile
i nherit the settings specified in the profile.'
returned: on success
sample: DATABASE
type: str
description:
- A list of DatabasePlanDirectives.
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
plan_objective:
description:
- The objective of the IORM plan.
returned: on success
sample: AUTO
type: str
plan_status:
description:
- The status of the IORM plan.
returned: on success
sample: ACTIVE
type: str
description:
- IormPlan resource
returned: on success
sample:
db_plan:
items:
- allocation: 56
asm_cluster: asm_cluster_example
flash_cache_limit: flash_cache_limit_example
flash_cache_min: flash_cache_min_example
flash_cache_size: flash_cache_size_example
is_flash_cache_on: true
is_flash_log_on: true
is_pmem_cache_on: true
is_pmem_log_on: true
level: 56
limit: 56
name: name_example
pmem_cache_limit: pmem_cache_limit_example
pmem_cache_min: pmem_cache_min_example
pmem_cache_size: pmem_cache_size_example
role: PRIMARY
share: 56
type: DATABASE
plan_objective: AUTO
plan_status: ACTIVE
type: complex