oracle.oci.oci_limits_limit_definition_facts – Fetches details about one or multiple LimitDefinition resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Includes a list of resource limits that are currently supported. If the ‘areQuotasSupported’ property is true, you can create quota policies on top of this limit at the compartment level.

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.
compartment_id
string / required
The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
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.
name
string
Optional field, filter for a specific resource limit.
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.
service_name
string
The target service name.
sort_by
string
    Choices:
  • name
  • description
The field to sort by.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'. By default, it is ascending.
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: List limit_definitions
  oci_limits_limit_definition_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    service_name: service_name_example
    name: name_example
    sort_by: name
    sort_order: ASC

Return Values

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

Key Returned Description
limit_definitions
complex
on success
List of LimitDefinition resources

Sample:
[{'are_quotas_supported': True, 'description': 'description_example', 'is_deprecated': True, 'is_dynamic': True, 'is_eligible_for_limit_increase': True, 'is_resource_availability_supported': True, 'name': 'name_example', 'scope_type': 'GLOBAL', 'service_name': 'service_name_example'}]
 
are_quotas_supported
boolean
on success
If true, quota policies can be created on top of this resource limit.

Sample:
True
 
description
string
on success
The limit description.

Sample:
description_example
 
is_deprecated
boolean
on success
Indicates if the limit has been deprecated.

Sample:
True
 
is_dynamic
boolean
on success
The limit for this resource has a dynamic value that is based on consumption across all OCI services.

Sample:
True
 
is_eligible_for_limit_increase
boolean
on success
Indicates if the customer can request a limit increase for this resource.

Sample:
True
 
is_resource_availability_supported
boolean
on success
Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.

Sample:
True
 
name
string
on success
The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.

Sample:
name_example
 
scope_type
string
on success
Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.

Sample:
GLOBAL
 
service_name
string
on success
The service name of the limit.

Sample:
service_name_example


Authors

  • Oracle (@oracle)