oracle.oci.oci_stack_monitoring_associated_resources_facts – Fetches details about one or multiple AssociatedResources resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_stack_monitoring_associated_resources_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple AssociatedResources resources in Oracle Cloud Infrastructure
List all associated resources recursively up-to a specified level, for the monitored resources of type specified.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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 ). |
|
association_types
list
/ elements=string
|
Association types filter to be searched for finding associated resources.
|
|
auth_purpose
string
|
|
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
|
|
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
|
Compartment Identifier OCID.
|
|
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 . |
|
display_name
string
|
Use display_name along with the other options to return only resources that match the given display name exactly.
|
|
exclude_fields
list
/ elements=string
|
Partial response refers to an optimization technique offered by the RESTful web APIs, to return all the information except the fields requested to be excluded (excludeFields) by the client. In this mechanism, the client sends the exclude field names as the query parameters for an API to the server, and the server trims down the default response content by removing the fields that are not required by the client. The parameter controls which fields to exlude and to return and should be a query string parameter called "excludeFields" of an array type, provide the values as enums, and use collectionFormat.
|
|
fields
list
/ elements=string
|
Partial response refers to an optimization technique offered by the RESTful web APIs, to return only the information (fields) required by the client. In this mechanism, the client sends the required field names as the query parameters for an API to the server, and the server trims down the default response content by removing the fields that are not required by the client. The parameter controls which fields to return and should be a query string parameter called "fields" of an array type, provide the values as enums, and use collectionFormat.
|
|
limit_level
integer
|
The field which determines the depth of hierarchy while searching for associated resources. Possible values - 0 for all levels. And positive number to indicate different levels. Default value is 1, which indicates 1st level associations.
|
|
name
string
|
Use name along with the other options to return only resources that match the given name exactly.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
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. |
|
resource_id
string
|
Monitored resource identifier for which the associated resources should be fetched. Either resourceId or resourceType should be provided.
|
|
resource_type
string
|
A filter to return associated resources that match resources of type. Either resourceId or resourceType should be provided.
|
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: List associated_resources
oci_stack_monitoring_associated_resources_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
resource_type: resource_type_example
resource_id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
limit_level: 56
association_types: [ "association_types_example" ]
fields: [ "fields_example" ]
exclude_fields: [ "exclude_fields_example" ]
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
associated_resources
complex
|
on success |
List of AssociatedResources resources
Sample:
[{'associated_resources': [{'association': {}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'external_id': 'ocid1.external.oc1..xxxxxxEXAMPLExxxxxx', 'host_name': 'host_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'management_agent_id': 'ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'type': 'type_example'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'external_id': 'ocid1.external.oc1..xxxxxxEXAMPLExxxxxx', 'host_name': 'host_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'management_agent_id': 'ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'type': 'type_example'}]
|
||
associated_resources
complex
|
on success |
List of associated monitored resources.
|
||
association
dictionary
|
on success |
Association details of the resource.
|
||
compartment_id
string
|
on success |
Compartment Identifier OCID.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
display_name
string
|
on success |
Monitored resource display name.
Sample:
display_name_example
|
||
external_id
string
|
on success |
External resource is any OCI resource identifier OCID which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and OCI compute instance.
Sample:
ocid1.external.oc1..xxxxxxEXAMPLExxxxxx
|
||
host_name
string
|
on success |
Monitored Resource Host Name.
Sample:
host_name_example
|
||
id
string
|
on success |
Monitored resource identifier OCID.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_state
string
|
on success |
The current state of the monitored resource.
Sample:
CREATING
|
||
management_agent_id
string
|
on success |
Management Agent Identifier OCID.
Sample:
ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx
|
||
name
string
|
on success |
Monitored Resource Name.
Sample:
name_example
|
||
type
string
|
on success |
Monitored Resource Type.
Sample:
type_example
|
||
compartment_id
string
|
on success |
Compartment Identifier OCID.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
display_name
string
|
on success |
Monitored resource display name.
Sample:
display_name_example
|
||
external_id
string
|
on success |
External resource is any OCI resource identifier OCID which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and OCI compute instance.
Sample:
ocid1.external.oc1..xxxxxxEXAMPLExxxxxx
|
||
host_name
string
|
on success |
Monitored Resource Host Name.
Sample:
host_name_example
|
||
id
string
|
on success |
Monitored resource identifier OCID.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_state
string
|
on success |
The current state of the monitored resource.
Sample:
CREATING
|
||
management_agent_id
string
|
on success |
Management Agent Identifier OCID.
Sample:
ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx
|
||
name
string
|
on success |
Monitored Resource Name.
Sample:
name_example
|
||
type
string
|
on success |
Monitored Resource Type.
Sample:
type_example
|
Authors¶
Oracle (@oracle)