oracle.oci.oci_network_service_gateway_actions – Perform actions on a ServiceGateway resource 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_network_service_gateway_actions
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a ServiceGateway resource in Oracle Cloud Infrastructure
For action=attach_service_id, adds the specified Service to the list of enabled Service objects for the specified gateway. You must also set up a route rule with the cidrBlock of the Service as the rule’s destination and the service gateway as the rule’s target. See Route Table. Note: The AttachServiceId operation is an easy way to add an individual Service to the service gateway. Compare it with UpdateServiceGateway, which replaces the entire existing list of enabled Service objects with the list that you provide in the Update call.
For action=change_compartment, moves a service gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
For action=detach_service_id, removes the specified Service from the list of enabled Service objects for the specified gateway. You do not need to remove any route rules that specify this Service object’s cidrBlock as the destination CIDR. However, consider removing the rules if your intent is to permanently disable use of the Service through this service gateway. Note: The DetachServiceId operation is an easy way to remove an individual Service from the service gateway. Compare it with UpdateServiceGateway, which replaces the entire existing list of enabled Service objects with the list that you provide in the Update call. UpdateServiceGateway also lets you block all traffic through the service gateway without having to remove each of the individual Service objects.
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 ServiceGateway.
|
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 to move the service gateway to.
Required for action=change_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 . |
|
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. |
|
service_gateway_id
string
/ required
|
The service gateway's OCID.
aliases: id |
|
service_id
string
|
Required for action=attach_service_id, action=detach_service_id.
|
|
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 attach_service_id on service_gateway
oci_network_service_gateway_actions:
# required
service_gateway_id: "ocid1.servicegateway.oc1..xxxxxxEXAMPLExxxxxx"
service_id: "ocid1.service.oc1..xxxxxxEXAMPLExxxxxx"
action: attach_service_id
- name: Perform action change_compartment on service_gateway
oci_network_service_gateway_actions:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
service_gateway_id: "ocid1.servicegateway.oc1..xxxxxxEXAMPLExxxxxx"
action: change_compartment
- name: Perform action detach_service_id on service_gateway
oci_network_service_gateway_actions:
# required
service_gateway_id: "ocid1.servicegateway.oc1..xxxxxxEXAMPLExxxxxx"
service_id: "ocid1.service.oc1..xxxxxxEXAMPLExxxxxx"
action: detach_service_id
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
service_gateway
complex
|
on success |
Details of the ServiceGateway resource acted upon by the current operation
Sample:
{'block_traffic': True, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'PROVISIONING', 'route_table_id': 'ocid1.routetable.oc1..xxxxxxEXAMPLExxxxxx', 'services': [{'service_id': 'ocid1.service.oc1..xxxxxxEXAMPLExxxxxx', 'service_name': 'service_name_example'}], 'time_created': '2013-10-20T19:20:30+01:00', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx'}
|
||
block_traffic
boolean
|
on success |
Whether the service gateway blocks all traffic through it. The default is `false`. When this is `true`, traffic is not routed to any services, regardless of route rules.
Example: `true`
Sample:
True
|
||
compartment_id
string
|
on success |
The OCID of the compartment that contains the service gateway.
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.
Sample:
display_name_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 service gateway.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_state
string
|
on success |
The service gateway's current state.
Sample:
PROVISIONING
|
||
route_table_id
string
|
on success |
The OCID of the route table the service gateway is using. For information about why you would associate a route table with a service gateway, see Transit Routing: Private Access to Oracle Services.
Sample:
ocid1.routetable.oc1..xxxxxxEXAMPLExxxxxx
|
||
services
complex
|
on success |
List of the Service objects enabled for this service gateway. The list can be empty. You can enable a particular `Service` by using AttachServiceId or UpdateServiceGateway.
|
||
service_id
string
|
on success |
The OCID of the service.
Sample:
ocid1.service.oc1..xxxxxxEXAMPLExxxxxx
|
||
service_name
string
|
on success |
The name of the service.
Sample:
service_name_example
|
||
time_created
string
|
on success |
The date and time the service gateway was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
vcn_id
string
|
on success |
The OCID of the VCN the service gateway belongs to.
Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)