oracle.oci.oci_database_management_external_exadata_storage_grid_facts (5.0.0) — module

Fetches details about a ExternalExadataStorageGrid 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 ExternalExadataStorageGrid resource in Oracle Cloud Infrastructure

Gets the details for the storage server grid specified by exadataStorageGridId.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get a specific external_exadata_storage_grid
  oci_database_management_external_exadata_storage_grid_facts:
    # required
    external_exadata_storage_grid_id: "ocid1.externalexadatastoragegrid.oc1..xxxxxxEXAMPLExxxxxx"

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

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

display_name:
    description: Use I(display_name) along with the other options to return only resources
      that match the given display name exactly.
    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_grid_id:
    aliases:
    - id
    description:
    - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
      of the Exadata storage grid.
    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

external_exadata_storage_grid:
  contains:
    additional_details:
      description:
      - 'The additional details of the resource defined in `{"key": "value"}` format.
        Example: `{"bar-key": "value"}`'
      returned: on success
      sample: {}
      type: dict
    display_name:
      description:
      - The name of the resource. English letters, numbers, "-", "_" and "." only.
      returned: on success
      sample: display_name_example
      type: str
    exadata_infrastructure_id:
      description:
      - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
        of Exadata infrastructure system.
      returned: on success
      sample: ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
      type: str
    id:
      description:
      - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
        of the Exadata resource.
      returned: on success
      sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
      type: str
    internal_id:
      description:
      - The internal ID.
      returned: on success
      sample: ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
      type: str
    lifecycle_details:
      description:
      - The details of the lifecycle state.
      returned: on success
      sample: lifecycle_details_example
      type: str
    lifecycle_state:
      description:
      - The current lifecycle state of the database resource.
      returned: on success
      sample: CREATING
      type: str
    resource_type:
      description:
      - The type of resource.
      returned: on success
      sample: INFRASTRUCTURE_SUMMARY
      type: str
    server_count:
      description:
      - The number of the storage servers in the Exadata infrastructure.
      returned: on success
      sample: 10
      type: float
    status:
      description:
      - The status of the entity.
      returned: on success
      sample: status_example
      type: str
    storage_servers:
      contains:
        additional_details:
          description:
          - 'The additional details of the resource defined in `{"key": "value"}`
            format. Example: `{"bar-key": "value"}`'
          returned: on success
          sample: {}
          type: dict
        connector_id:
          description:
          - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
            of connector.
          returned: on success
          sample: ocid1.connector.oc1..xxxxxxEXAMPLExxxxxx
          type: str
        cpu_count:
          description:
          - The CPU count of the storage server
          returned: on success
          sample: 10
          type: float
        display_name:
          description:
          - The name of the resource. English letters, numbers, "-", "_" and "." only.
          returned: on success
          sample: display_name_example
          type: str
        id:
          description:
          - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
            of the Exadata resource.
          returned: on success
          sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
          type: str
        internal_id:
          description:
          - The internal ID.
          returned: on success
          sample: ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
          type: str
        ip_address:
          description:
          - The IP address of the storage server.
          returned: on success
          sample: ip_address_example
          type: str
        lifecycle_details:
          description:
          - The details of the lifecycle state.
          returned: on success
          sample: lifecycle_details_example
          type: str
        lifecycle_state:
          description:
          - The current lifecycle state of the database resource.
          returned: on success
          sample: CREATING
          type: str
        make_model:
          description:
          - The make model of the storage server.
          returned: on success
          sample: make_model_example
          type: str
        max_flash_disk_iops:
          description:
          - The maximum flash disk IO operations per second of the storage server
          returned: on success
          sample: 56
          type: int
        max_flash_disk_throughput:
          description:
          - The maximum flash disk IO throughput in MB/s of the storage server
          returned: on success
          sample: 56
          type: int
        max_hard_disk_iops:
          description:
          - The maximum hard disk IO operations per second of the storage server
          returned: on success
          sample: 56
          type: int
        max_hard_disk_throughput:
          description:
          - The maximum hard disk IO throughput in MB/s of the storage server
          returned: on success
          sample: 56
          type: int
        memory_gb:
          description:
          - The storage server memory size in GB
          returned: on success
          sample: 1.2
          type: float
        resource_type:
          description:
          - The type of resource.
          returned: on success
          sample: INFRASTRUCTURE_SUMMARY
          type: str
        status:
          description:
          - The status of the entity.
          returned: on success
          sample: status_example
          type: str
        time_created:
          description:
          - The timestamp of the creation.
          returned: on success
          sample: '2013-10-20T19:20:30+01:00'
          type: str
        time_updated:
          description:
          - The timestamp of the last update.
          returned: on success
          sample: '2013-10-20T19:20:30+01:00'
          type: str
        version:
          description:
          - The version of the resource.
          returned: on success
          sample: version_example
          type: str
      description:
      - A list of monitored Exadata storage server.
      returned: on success
      type: complex
    time_created:
      description:
      - The timestamp of the creation.
      returned: on success
      sample: '2013-10-20T19:20:30+01:00'
      type: str
    time_updated:
      description:
      - The timestamp of the last update.
      returned: on success
      sample: '2013-10-20T19:20:30+01:00'
      type: str
    version:
      description:
      - The version of the resource.
      returned: on success
      sample: version_example
      type: str
  description:
  - ExternalExadataStorageGrid resource
  returned: on success
  sample:
    additional_details: {}
    display_name: display_name_example
    exadata_infrastructure_id: ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
    id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
    internal_id: ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
    lifecycle_details: lifecycle_details_example
    lifecycle_state: CREATING
    resource_type: INFRASTRUCTURE_SUMMARY
    server_count: 10
    status: status_example
    storage_servers:
    - additional_details: {}
      connector_id: ocid1.connector.oc1..xxxxxxEXAMPLExxxxxx
      cpu_count: 10
      display_name: display_name_example
      id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
      internal_id: ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
      ip_address: ip_address_example
      lifecycle_details: lifecycle_details_example
      lifecycle_state: CREATING
      make_model: make_model_example
      max_flash_disk_iops: 56
      max_flash_disk_throughput: 56
      max_hard_disk_iops: 56
      max_hard_disk_throughput: 56
      memory_gb: 1.2
      resource_type: INFRASTRUCTURE_SUMMARY
      status: status_example
      time_created: '2013-10-20T19:20:30+01:00'
      time_updated: '2013-10-20T19:20:30+01:00'
      version: version_example
    time_created: '2013-10-20T19:20:30+01:00'
    time_updated: '2013-10-20T19:20:30+01:00'
    version: version_example
  type: complex