oracle.oci.oci_service_mesh_ingress_gateway_actions – Perform actions on an IngressGateway resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_ingress_gateway_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on an IngressGateway resource in Oracle Cloud Infrastructure

  • For action=change_compartment, moves a IngressGateway resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • change_compartment
The action to perform on the IngressGateway.
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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
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
The OCID of the compartment.
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.
ingress_gateway_id
string / required
Unique IngressGateway identifier.

aliases: id
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.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Perform action change_compartment on ingress_gateway
  oci_service_mesh_ingress_gateway_actions:
    # required
    ingress_gateway_id: "ocid1.ingressgateway.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
ingress_gateway
complex
on success
Details of the IngressGateway resource acted upon by the current operation

Sample:
{'access_logging': {'is_enabled': True}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'freeform_tags': {'Department': 'Finance'}, 'hosts': [{'hostnames': [], 'listeners': [{'port': 56, 'protocol': 'HTTP', 'tls': {'client_validation': {'subject_alternate_names': [], 'trusted_ca_bundle': {'ca_bundle_id': 'ocid1.cabundle.oc1..xxxxxxEXAMPLExxxxxx', 'secret_name': 'secret_name_example', 'type': 'OCI_CERTIFICATES'}}, 'mode': 'DISABLED', 'server_certificate': {'certificate_id': 'ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx', 'secret_name': 'secret_name_example', 'type': 'OCI_CERTIFICATES'}}}], 'name': 'name_example'}], 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'mesh_id': 'ocid1.mesh.oc1..xxxxxxEXAMPLExxxxxx', 'mtls': {'certificate_id': 'ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx', 'maximum_validity': 56}, 'name': 'name_example', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
access_logging
complex
on success

   
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'}
 
hosts
complex
on success
Array of hostnames and their listener configuration that this gateway will bind to.

   
hostnames
list / elements=string
on success
Hostnames of the host. Applicable only for HTTP and TLS_PASSTHROUGH listeners. Wildcard hostnames are supported in the prefix form. Examples of valid hostnames are "www.example.com", "*.example.com", "*.com".

   
listeners
complex
on success
The listeners for the ingress gateway.

     
port
integer
on success
Port on which ingress gateway is listening.

Sample:
56
     
protocol
string
on success
Type of protocol used.

Sample:
HTTP
     
tls
complex
on success

       
client_validation
complex
on success

         
subject_alternate_names
list / elements=string
on success
A list of alternate names to verify the subject identity in the certificate presented by the client.

         
trusted_ca_bundle
complex
on success

           
ca_bundle_id
string
on success
The OCID of the CA Bundle resource.

Sample:
ocid1.cabundle.oc1..xxxxxxEXAMPLExxxxxx
           
secret_name
string
on success
Name of the secret. For Kubernetes this will be the name of an opaque Kubernetes secret with key ca.crt. For other platforms the secret must be mounted at: /etc/oci/secrets/${secretName}/ca.crt

Sample:
secret_name_example
           
type
string
on success
Type of certificate.

Sample:
OCI_CERTIFICATES
       
mode
string
on success
DISABLED: Connection can only be plaintext. PERMISSIVE: Connection can be either plaintext or TLS/mTLS. If the clientValidation.trustedCaBundle property is configured for the listener, mTLS is performed and the client's certificates are validated by the gateway. TLS: Connection can only be TLS. MUTUAL_TLS: Connection can only be MTLS.

Sample:
DISABLED
       
server_certificate
complex
on success

         
certificate_id
string
on success
The OCID of the leaf certificate resource.

Sample:
ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx
         
secret_name
string
on success
Name of the secret. For Kubernetes this is the name of the Kubernetes secret of type tls. For other platforms the secrets must be mounted at: /etc/oci/secrets/${secretName}/tls.{key,crt}

Sample:
secret_name_example
         
type
string
on success
Type of certificate.

Sample:
OCI_CERTIFICATES
   
name
string
on success
A user-friendly name for the host. The name must be unique within the same ingress gateway. This name can be used in the ingress gateway route table resource to attach a route to this host.
Example: `MyExampleHost`

Sample:
name_example
 
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
 
mesh_id
string
on success
The OCID of the service mesh in which this ingress gateway is created.

Sample:
ocid1.mesh.oc1..xxxxxxEXAMPLExxxxxx
 
mtls
complex
on success

   
certificate_id
string
on success
The OCID of the certificate resource that will be used for mTLS authentication with other virtual services in the mesh.

Sample:
ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx
   
maximum_validity
integer
on success
The number of days the mTLS certificate is valid. This value should be less than the Maximum Validity Duration for Certificates (Days) setting on the Certificate Authority associated with this Mesh. The certificate will be automatically renewed after 2/3 of the validity period, so a certificate with a maximum validity of 45 days will be renewed every 30 days.

Sample:
56
 
name
string
on success
A user-friendly name. The name has to be unique within the same service mesh and cannot be changed after creation. Avoid entering confidential information.
Example: `My unique resource name`

Sample:
name_example
 
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


Authors

  • Oracle (@oracle)