oracle.oci.oci_database_cloud_exadata_infrastructure_unallocated_resources_facts (5.0.0) — module

Fetches details about a CloudExadataInfrastructureUnallocatedResources resource in Oracle Cloud Infrastructure

| "added in version" 2.9.0 of oracle.oci"

Authors: Oracle (@oracle)

preview | supported by community

Install collection

Install with ansible-galaxy collection install oracle.oci:==5.0.0


Add to requirements.yml

  collections:
    - name: oracle.oci
      version: 5.0.0

Description

Fetches details about a CloudExadataInfrastructureUnallocatedResources resource in Oracle Cloud Infrastructure

Gets unallocated resources information for the specified Cloud Exadata infrastructure.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get a specific cloud_exadata_infrastructure_unallocated_resources
  oci_database_cloud_exadata_infrastructure_unallocated_resources_facts:
    # required
    cloud_exadata_infrastructure_id: "ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    db_servers: [ "db_servers_example" ]

Inputs

    
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

db_servers:
    description:
    - The list of L(OCIDs,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
      of the Db servers.
    elements: str
    type: list

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

cloud_exadata_infrastructure_id:
    aliases:
    - id
    description:
    - The cloud Exadata infrastructure L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
    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

Outputs

cloud_exadata_infrastructure_unallocated_resources:
  contains:
    cloud_autonomous_vm_clusters:
      contains:
        id:
          description:
          - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
            of the Cloud Exadata infrastructure.
          returned: on success
          sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
          type: str
        un_allocated_adb_storage_in_tbs:
          description:
          - Total unallocated autonomous data storage in the Cloud Autonomous VM Cluster
            in TBs.
          returned: on success
          sample: 1.2
          type: float
      description:
      - The list of Cloud Autonomous VM Clusters on the Infrastructure and their associated
        unallocated resources details.
      returned: on success
      type: complex
    cloud_exadata_infrastructure_display_name:
      description:
      - The user-friendly name for the Cloud Exadata infrastructure. The name does
        not need to be unique.
      returned: on success
      sample: cloud_exadata_infrastructure_display_name_example
      type: str
    cloud_exadata_infrastructure_id:
      description:
      - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
        of the Cloud Exadata infrastructure.
      returned: on success
      sample: ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
      type: str
    exadata_storage_in_tbs:
      description:
      - Total unallocated exadata storage in the infrastructure in TBs.
      returned: on success
      sample: 1.2
      type: float
    local_storage_in_gbs:
      description:
      - The minimum amount of unallocated storage available across all nodes in the
        infrastructure.
      returned: on success
      sample: 56
      type: int
    memory_in_gbs:
      description:
      - The minimum amount of unallocated memory available across all nodes in the
        infrastructure.
      returned: on success
      sample: 56
      type: int
    ocpus:
      description:
      - The minimum amount of unallocated ocpus available across all nodes in the
        infrastructure.
      returned: on success
      sample: 56
      type: int
  description:
  - CloudExadataInfrastructureUnallocatedResources resource
  returned: on success
  sample:
    cloud_autonomous_vm_clusters:
    - id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
      un_allocated_adb_storage_in_tbs: 1.2
    cloud_exadata_infrastructure_display_name: cloud_exadata_infrastructure_display_name_example
    cloud_exadata_infrastructure_id: ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
    exadata_storage_in_tbs: 1.2
    local_storage_in_gbs: 56
    memory_in_gbs: 56
    ocpus: 56
  type: complex