oracle.oci.oci_service_mesh_virtual_deployment_facts – Fetches details about one or multiple VirtualDeployment 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_service_mesh_virtual_deployment_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple VirtualDeployment resources in Oracle Cloud Infrastructure
Returns a list of VirtualDeployments.
If virtual_deployment_id is specified, the details of a single VirtualDeployment 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 ID of the compartment in which to list resources.
Required to list multiple virtual_deployments.
|
|
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 . |
|
lifecycle_state
string
|
|
A filter to return only resources that match the life cycle state given.
|
name
string
|
A filter to return only resources that match the entire name given.
|
|
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 'timeCreated' is descending. Default order for 'name' is ascending.
|
sort_order
string
|
|
The sort order to use, either 'ASC' or 'DESC'.
|
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 |
|
virtual_deployment_id
string
|
Unique VirtualDeployment identifier.
Required to get a specific virtual_deployment.
aliases: id |
|
virtual_service_id
string
|
Unique VirtualService identifier.
|
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 virtual_deployment
oci_service_mesh_virtual_deployment_facts:
# required
virtual_deployment_id: "ocid1.virtualdeployment.oc1..xxxxxxEXAMPLExxxxxx"
- name: List virtual_deployments
oci_service_mesh_virtual_deployment_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
name: name_example
sort_order: ASC
sort_by: id
virtual_service_id: "ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_state: CREATING
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
virtual_deployments
complex
|
on success |
List of VirtualDeployment resources
Sample:
[{'access_logging': {'is_enabled': True}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'listeners': [{'idle_timeout_in_ms': 56, 'port': 56, 'protocol': 'HTTP', 'request_timeout_in_ms': 56}], 'name': 'name_example', 'service_discovery': {'hostname': 'hostname_example', 'type': 'DNS'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'virtual_service_id': 'ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx'}]
|
||
access_logging
complex
|
on success |
Returned for get operation
|
||
is_enabled
boolean
|
on success |
Determines if the logging configuration is enabled.
Sample:
True
|
||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
description
string
|
on success |
Description of the resource. It can be changed after creation. Avoid entering confidential information.
Example: `This is my new resource`
Sample:
description_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. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||
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 a Failed state.
Sample:
lifecycle_details_example
|
||
lifecycle_state
string
|
on success |
The current state of the Resource.
Sample:
CREATING
|
||
listeners
complex
|
on success |
The listeners for the virtual deployment
Returned for get operation
|
||
idle_timeout_in_ms
integer
|
on success |
The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
Sample:
56
|
||
port
integer
|
on success |
Port in which virtual deployment is running.
Sample:
56
|
||
protocol
string
|
on success |
Type of protocol used in virtual deployment.
Sample:
HTTP
|
||
request_timeout_in_ms
integer
|
on success |
The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
Sample:
56
|
||
name
string
|
on success |
A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information.
Example: `My unique resource name`
Sample:
name_example
|
||
service_discovery
complex
|
on success |
Returned for get operation
|
||
hostname
string
|
on success |
The hostname of the virtual deployments.
Sample:
hostname_example
|
||
type
string
|
on success |
Type of service discovery.
Sample:
DNS
|
||
system_tags
dictionary
|
on success |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
||
time_created
string
|
on success |
The time when this resource was created in an RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The time when this resource was updated in an RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
virtual_service_id
string
|
on success |
The OCID of the virtual service in which this virtual deployment is created.
Sample:
ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)