oracle.oci.oci_waas_http_redirect_facts – Fetches details about one or multiple HttpRedirect resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.14.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_waas_http_redirect_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple HttpRedirect resources in Oracle Cloud Infrastructure
Gets a list of HTTP Redirects.
If http_redirect_id is specified, the details of a single HttpRedirect 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. This number is generated when the compartment is created.
Required to list multiple http_redirects.
|
|
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
list
/ elements=string
|
Filter redirects using a display name.
aliases: name |
|
http_redirect_id
string
|
The OCID of the HTTP Redirect.
Required to get a specific http_redirect.
aliases: id |
|
lifecycle_state
list
/ elements=string
|
|
Filter redirects using a list of lifecycle states.
|
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 the results of the List query.
|
sort_order
string
|
|
The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `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 |
|
time_created_greater_than_or_equal_to
string
|
A filter that matches redirects created on or after the specified date and time.
|
|
time_created_less_than
string
|
A filter that matches redirects created before the specified date-time. Default to 1 day before now.
|
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 http_redirect
oci_waas_http_redirect_facts:
# required
http_redirect_id: "ocid1.httpredirect.oc1..xxxxxxEXAMPLExxxxxx"
- name: List http_redirects
oci_waas_http_redirect_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
sort_order: ASC
sort_by: id
display_name: [ "display_name_example" ]
lifecycle_state: [ "CREATING" ]
time_created_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
time_created_less_than: 2013-10-20T19:20:30+01:00
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
http_redirects
complex
|
on success |
List of HttpRedirect resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'domain': 'domain_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'response_code': 56, 'target': {'host': 'host_example', 'path': 'path_example', 'port': 56, 'protocol': 'HTTP', 'query': 'query_example'}, 'time_created': '2013-10-20T19:20:30+01:00'}]
|
||
compartment_id
string
|
on success |
The OCID of the HTTP Redirect's 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. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
display_name
string
|
on success |
The user-friendly name of the HTTP Redirect. The name can be changed and does not need to be unique.
Sample:
display_name_example
|
||
domain
string
|
on success |
The domain from which traffic will be redirected.
Sample:
domain_example
|
||
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
||
id
string
|
on success |
The OCID of the HTTP Redirect.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_state
string
|
on success |
The current lifecycle state of the HTTP Redirect.
Sample:
CREATING
|
||
response_code
integer
|
on success |
The response code returned for the redirect to the client. For more information, see RFC 7231.
Sample:
56
|
||
target
complex
|
on success |
The redirect target object including all the redirect data.
|
||
host
string
|
on success |
The host portion of the redirect.
Sample:
host_example
|
||
path
string
|
on success |
The path component of the target URL (e.g., "/path/to/resource" in "https://target.example.com/path/to/resource?redirected"), which can be empty, static, or request-copying, or request-prefixing. Use of \ is not permitted except to escape a following \, {, or }. An empty value is treated the same as static "/". A static value must begin with a leading "/", optionally followed by other path characters. A request-copying value must exactly match "{path}", and will be replaced with the path component of the request URL (including its initial "/"). A request-prefixing value must start with "/" and end with a non-escaped "{path}", which will be replaced with the path component of the request URL (including its initial "/"). Only one such replacement token is allowed.
Sample:
path_example
|
||
port
integer
|
on success |
Port number of the target destination of the redirect, default to match protocol
Sample:
56
|
||
protocol
string
|
on success |
The protocol used for the target, http or https.
Sample:
HTTP
|
||
query
string
|
on success |
The query component of the target URL (e.g., "?redirected" in "https://target.example.com/path/to/resource?redirected"), which can be empty, static, or request-copying. Use of \ is not permitted except to escape a following \, {, or }. An empty value results in a redirection target URL with no query component. A static value must begin with a leading "?", optionally followed by other query characters. A request-copying value must exactly match "{query}", and will be replaced with the query component of the request URL (including a leading "?" if and only if the request URL includes a query component).
Sample:
query_example
|
||
time_created
string
|
on success |
The date and time the policy was created, expressed in RFC 3339 timestamp format.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)