oracle.oci.oci_devops_deploy_environment_facts – Fetches details about one or multiple DeployEnvironment resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_devops_deploy_environment_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple DeployEnvironment resources in Oracle Cloud Infrastructure
Returns a list of deployment environments.
If deploy_environment_id is specified, the details of a single DeployEnvironment will be returned.
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 ). |
|
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
|
The OCID of the compartment in which to list resources.
|
|
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 . |
|
deploy_environment_id
string
|
Unique environment identifier.
Required to get a specific deploy_environment.
aliases: id |
|
display_name
string
|
A filter to return only resources that match the entire display name given.
aliases: name |
|
lifecycle_state
string
|
|
A filter to return only DeployEnvironments that matches the given lifecycleState.
|
project_id
string
|
unique project identifier
|
|
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. |
|
sort_by
string
|
|
The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered.
|
sort_order
string
|
|
The sort order to use. Use either ascending or descending.
|
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: Get a specific deploy_environment
oci_devops_deploy_environment_facts:
# required
deploy_environment_id: "ocid1.deployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
- name: List deploy_environments
oci_devops_deploy_environment_facts:
# optional
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_state: CREATING
display_name: display_name_example
sort_order: ASC
sort_by: timeCreated
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
deploy_environments
complex
|
on success |
List of DeployEnvironment resources
Sample:
[{'cluster_id': 'ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'compute_instance_group_selectors': {'items': [{'compute_instance_ids': [], 'query': 'query_example', 'region': 'us-phoenix-1', 'selector_type': 'INSTANCE_IDS'}]}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'deploy_environment_type': 'OKE_CLUSTER', 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'function_id': 'ocid1.function.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'network_channel': {'network_channel_type': 'PRIVATE_ENDPOINT_CHANNEL', 'nsg_ids': [], 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}, 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
|
|||
cluster_id
string
|
on success |
The OCID of the Kubernetes cluster.
Returned for get operation
Sample:
ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx
|
|||
compartment_id
string
|
on success |
The OCID of a compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||
compute_instance_group_selectors
complex
|
on success |
Returned for get operation
|
|||
items
complex
|
on success |
A list of selectors for the instance group. Union operator is used for combining the instances selected by each selector.
|
|||
compute_instance_ids
list
/ elements=string
|
on success |
Compute instance OCID identifiers that are members of this group.
|
|||
query
string
|
on success |
Query expression confirming to the OCI Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
Sample:
query_example
|
|||
region
string
|
on success |
Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en- us/iaas/Content/General/Concepts/regions.htm
Sample:
us-phoenix-1
|
|||
selector_type
string
|
on success |
Defines the type of the instance selector for the group.
Sample:
INSTANCE_IDS
|
|||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|||
deploy_environment_type
string
|
on success |
Deployment environment type.
Sample:
OKE_CLUSTER
|
|||
description
string
|
on success |
Optional description about the deployment environment.
Sample:
description_example
|
|||
display_name
string
|
on success |
Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
Sample:
display_name_example
|
|||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
|||
function_id
string
|
on success |
The OCID of the Function.
Returned for get operation
Sample:
ocid1.function.oc1..xxxxxxEXAMPLExxxxxx
|
|||
id
string
|
on success |
Unique identifier that is immutable on creation.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Sample:
lifecycle_details_example
|
|||
lifecycle_state
string
|
on success |
The current state of the deployment environment.
Sample:
CREATING
|
|||
network_channel
complex
|
on success |
Returned for get operation
|
|||
network_channel_type
string
|
on success |
Network channel type.
Sample:
PRIVATE_ENDPOINT_CHANNEL
|
|||
nsg_ids
list
/ elements=string
|
on success |
An array of network security group OCIDs.
|
|||
subnet_id
string
|
on success |
The OCID of the subnet where VNIC resources will be created for private endpoint.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
|||
project_id
string
|
on success |
The OCID of a project.
Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
|
|||
system_tags
dictionary
|
on success |
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
|||
time_created
string
|
on success |
Time the deployment environment was created. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||
time_updated
string
|
on success |
Time the deployment environment was updated. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)