oracle.oci.oci_apigateway_gateway_actions – Perform actions on a Gateway resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.5.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_apigateway_gateway_actions.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a Gateway resource in Oracle Cloud Infrastructure
For action=change_compartment, changes the gateway compartment.
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 |
|---|---|---|
|
action
string
/ required
|
|
The action to perform on the Gateway.
|
|
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
/ required
|
The OCID of the compartment in which the resource is created.
|
|
|
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. |
|
|
gateway_id
string
/ required
|
The ocid of the gateway.
aliases: id |
|
|
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. |
|
|
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
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Perform action change_compartment on gateway
oci_apigateway_gateway_actions:
# required
gateway_id: "ocid1.gateway.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 | |||
|---|---|---|---|---|---|
|
gateway
complex
|
on success |
Details of the Gateway resource acted upon by the current operation
Sample:
{'ca_bundles': [{'ca_bundle_id': 'ocid1.cabundle.oc1..xxxxxxEXAMPLExxxxxx', 'certificate_authority_id': 'ocid1.certificateauthority.oc1..xxxxxxEXAMPLExxxxxx', 'type': 'CA_BUNDLE'}], 'certificate_id': 'ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'endpoint_type': 'PUBLIC', 'freeform_tags': {'Department': 'Finance'}, 'hostname': 'hostname_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ip_addresses': [{'ip_address': 'ip_address_example'}], 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'network_security_group_ids': [], 'response_cache_details': {'authentication_secret_id': 'ocid1.authenticationsecret.oc1..xxxxxxEXAMPLExxxxxx', 'authentication_secret_version_number': 56, 'connect_timeout_in_ms': 56, 'is_ssl_enabled': True, 'is_ssl_verify_disabled': True, 'read_timeout_in_ms': 56, 'send_timeout_in_ms': 56, 'servers': [{'host': 'host_example', 'port': 56}], 'type': 'EXTERNAL_RESP_CACHE'}, 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
|
|||
|
ca_bundles
complex
|
on success |
An array of CA bundles that should be used on the Gateway for TLS validation.
|
|||
|
ca_bundle_id
string
|
on success |
The OCID of the resource.
Sample:
ocid1.cabundle.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
certificate_authority_id
string
|
on success |
The OCID of the resource.
Sample:
ocid1.certificateauthority.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
type
string
|
on success |
Type of the CA bundle
Sample:
CA_BUNDLE
|
|||
|
certificate_id
string
|
on success |
The OCID of the resource.
Sample:
ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
compartment_id
string
|
on success |
The OCID of the compartment in which the resource is created.
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 |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Example: `My new resource`
Sample:
display_name_example
|
|||
|
endpoint_type
string
|
on success |
Gateway endpoint type. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be accessible on a private IP address on the subnet.
Example: `PUBLIC` or `PRIVATE`
Sample:
PUBLIC
|
|||
|
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'}
|
|||
|
hostname
string
|
on success |
The hostname for APIs deployed on the gateway.
Sample:
hostname_example
|
|||
|
id
string
|
on success |
The OCID of the resource.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
ip_addresses
complex
|
on success |
An array of IP addresses associated with the gateway.
|
|||
|
ip_address
string
|
on success |
An IP address.
Sample:
ip_address_example
|
|||
|
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 gateway.
Sample:
CREATING
|
|||
|
network_security_group_ids
list
/ elements=string
|
on success |
An array of Network Security Groups OCIDs associated with this API Gateway.
|
|||
|
response_cache_details
complex
|
on success |
|
|||
|
authentication_secret_id
string
|
on success |
The OCID of the Oracle Vault Service secret resource.
Sample:
ocid1.authenticationsecret.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
authentication_secret_version_number
integer
|
on success |
The version number of the authentication secret to use.
Sample:
56
|
|||
|
connect_timeout_in_ms
integer
|
on success |
Defines the timeout for establishing a connection with the Response Cache.
Sample:
56
|
|||
|
is_ssl_enabled
boolean
|
on success |
Defines if the connection should be over SSL.
Sample:
True
|
|||
|
is_ssl_verify_disabled
boolean
|
on success |
Defines whether or not to uphold SSL verification.
Sample:
True
|
|||
|
read_timeout_in_ms
integer
|
on success |
Defines the timeout for reading data from the Response Cache.
Sample:
56
|
|||
|
send_timeout_in_ms
integer
|
on success |
Defines the timeout for transmitting data to the Response Cache.
Sample:
56
|
|||
|
servers
complex
|
on success |
The set of cache store members to connect to. At present only a single server is supported.
|
|||
|
host
string
|
on success |
Hostname or IP address (IPv4 only) where the cache store is running.
Sample:
host_example
|
|||
|
port
integer
|
on success |
The port the cache store is exposed on.
Sample:
56
|
|||
|
type
string
|
on success |
Type of the Response Cache.
Sample:
EXTERNAL_RESP_CACHE
|
|||
|
subnet_id
string
|
on success |
The OCID of the subnet in which related resources are created.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
time_created
string
|
on success |
The time this resource was created. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
|||
|
time_updated
string
|
on success |
The time this resource was last updated. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
|||
Authors¶
Oracle (@oracle)