oci_fault_domain_facts - Retrieve details of fault domains in your tenancy¶
New in version 2.5.
Synopsis¶
- This module retrieves details of all fault domains in your tenancy. Specify the OCID of either the tenancy or another of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_user |
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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 |
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 |
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 |
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_type |
|
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. |
availability_domain
required |
The name of the availibility domain.
|
|
compartment_id
required |
The OCID of the compartment (either the tenancy or another compartment in the tenancy).
|
|
config_file_location |
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 |
Default: DEFAULT
|
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 |
Use name along with the other options to return only resources that match the given name exactly.
|
|
region |
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. |
|
tenancy |
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: Get details of all the fault domains in AD1 in your tenancy
oci_fault_domain_facts:
compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...vm62xq'
availability_domain: "IwGV:US-ASHBURN-AD-2"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
fault_domains
complex
|
on success |
Information about one or more fault domains in your tenancy
Sample:
{'fault_domains': [{'availability_domain': 'IwGV:US-ASHBURN-AD-2', 'id': 'ocid1.faultdomain.oc1..xxxxxEXAMPLExxxxx..4dnw3a', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx..6glmkwq', 'name': 'FAULT-DOMAIN-1'}, {'availability_domain': 'IwGV:US-ASHBURN-AD-2', 'id': 'ocid1.faultdomain.oc1..xxxxxEXAMPLExxxxx..3dsdaa', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx..6glmkwq', 'name': 'FAULT-DOMAIN-2'}, {'availability_domain': 'IwGV:US-ASHBURN-AD-2', 'id': 'ocid1.faultdomain.oc1..xxxxxEXAMPLExxxxx..6ttdaa', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx..6glmkwq', 'name': 'FAULT-DOMAIN-3'}]}
|
|
availability_domain
string
|
always |
The name of the availabilityDomain where the Fault Domain belongs.
Sample:
IwGV:US-ASHBURN-AD-2
|
|
name
string
|
always |
The name of the Fault Domain.
Sample:
FAULT-DOMAIN-1
|
|
compartment_id
string
|
always |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx..6glmkwq
|
|
id
string
|
always |
The OCID of the Fault Domain.
Sample:
ocid1.faultdomain.oc1..xxxxxEXAMPLExxxxx..4dnw3a
|
Status¶
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author¶
- Sivakumar Thyagarajan (@sivakumart)
Hint
If you notice any issues in this documentation you can edit this document to improve it.