oracle.oci.oci_service_mesh_access_policy – Manage an AccessPolicy 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_service_mesh_access_policy
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete an AccessPolicy resource in Oracle Cloud Infrastructure
For state=present, creates a new AccessPolicy.
This resource has the following action operations in the oracle.oci.oci_service_mesh_access_policy_actions module: change_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 | ||
---|---|---|---|---|
access_policy_id
string
|
Unique AccessPolicy identifier.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
|||
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.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
|||
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 . |
|||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
|||
description
string
|
Description of the resource. It can be changed after creation. Avoid entering confidential information.
Example: `This is my new resource`
This parameter is updatable.
|
|||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
||
freeform_tags
dictionary
|
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
|
|||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|||
mesh_id
string
|
The OCID of the service mesh in which this access policy is created.
Required for create using state=present.
|
|||
name
string
|
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`
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
|||
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. |
|||
rules
list
/ elements=dictionary
|
List of applicable rules
Required for create using state=present.
This parameter is updatable.
|
|||
action
string
/ required
|
|
Action for the traffic between the source and the destination.
|
||
destination
dictionary
/ required
|
||||
hostnames
list
/ elements=string
|
The hostnames of the external service. Only applicable for HTTP and HTTPS protocols. Wildcard hostnames are supported in the prefix form. Examples of valid hostnames are "www.example.com", "*.example.com", "*.com", "*". Hostname "*" can be used to allow all hosts.
Applicable when type is 'EXTERNAL_SERVICE'
|
|||
ingress_gateway_id
string
|
The OCID of the ingress gateway resource.
Required when type is 'INGRESS_GATEWAY'
|
|||
ip_addresses
list
/ elements=string
|
The ipAddresses of the external service in CIDR notation. Only applicable for TCP protocol. All requests matching the given CIDR notation will pass through. In case a wildcard CIDR "0.0.0.0/0" is provided, the same port cannot be used for a virtual service communication.
Applicable when type is 'EXTERNAL_SERVICE'
|
|||
ports
list
/ elements=integer
|
Ports exposed by an external service. If left empty all ports will be allowed.
Applicable when type is 'EXTERNAL_SERVICE'
|
|||
protocol
string
|
|
Protocol of the external service
Applicable when type is 'EXTERNAL_SERVICE'
|
||
type
string
/ required
|
|
Traffic type of the target.
|
||
virtual_service_id
string
|
The OCID of the virtual service resource.
Required when type is 'VIRTUAL_SERVICE'
|
|||
source
dictionary
/ required
|
||||
hostnames
list
/ elements=string
|
The hostnames of the external service. Only applicable for HTTP and HTTPS protocols. Wildcard hostnames are supported in the prefix form. Examples of valid hostnames are "www.example.com", "*.example.com", "*.com", "*". Hostname "*" can be used to allow all hosts.
Applicable when type is 'EXTERNAL_SERVICE'
|
|||
ingress_gateway_id
string
|
The OCID of the ingress gateway resource.
Required when type is 'INGRESS_GATEWAY'
|
|||
ip_addresses
list
/ elements=string
|
The ipAddresses of the external service in CIDR notation. Only applicable for TCP protocol. All requests matching the given CIDR notation will pass through. In case a wildcard CIDR "0.0.0.0/0" is provided, the same port cannot be used for a virtual service communication.
Applicable when type is 'EXTERNAL_SERVICE'
|
|||
ports
list
/ elements=integer
|
Ports exposed by an external service. If left empty all ports will be allowed.
Applicable when type is 'EXTERNAL_SERVICE'
|
|||
protocol
string
|
|
Protocol of the external service
Applicable when type is 'EXTERNAL_SERVICE'
|
||
type
string
/ required
|
|
Traffic type of the target.
|
||
virtual_service_id
string
|
The OCID of the virtual service resource.
Required when type is 'VIRTUAL_SERVICE'
|
|||
state
string
|
|
The state of the AccessPolicy.
Use state=present to create or update an AccessPolicy.
Use state=absent to delete an AccessPolicy.
|
||
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: Create access_policy
oci_service_mesh_access_policy:
# required
name: name_example
mesh_id: "ocid1.mesh.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
rules:
- # required
action: ALLOW
source:
# required
type: EXTERNAL_SERVICE
# optional
hostnames: [ "hostnames_example" ]
ip_addresses: [ "ip_addresses_example" ]
ports: [ "ports_example" ]
protocol: HTTP
destination:
# required
type: EXTERNAL_SERVICE
# optional
hostnames: [ "hostnames_example" ]
ip_addresses: [ "ip_addresses_example" ]
ports: [ "ports_example" ]
protocol: HTTP
# optional
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update access_policy
oci_service_mesh_access_policy:
# required
access_policy_id: "ocid1.accesspolicy.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
rules:
- # required
action: ALLOW
source:
# required
type: EXTERNAL_SERVICE
# optional
hostnames: [ "hostnames_example" ]
ip_addresses: [ "ip_addresses_example" ]
ports: [ "ports_example" ]
protocol: HTTP
destination:
# required
type: EXTERNAL_SERVICE
# optional
hostnames: [ "hostnames_example" ]
ip_addresses: [ "ip_addresses_example" ]
ports: [ "ports_example" ]
protocol: HTTP
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update access_policy using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_service_mesh_access_policy:
# required
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
rules:
- # required
action: ALLOW
source:
# required
type: EXTERNAL_SERVICE
# optional
hostnames: [ "hostnames_example" ]
ip_addresses: [ "ip_addresses_example" ]
ports: [ "ports_example" ]
protocol: HTTP
destination:
# required
type: EXTERNAL_SERVICE
# optional
hostnames: [ "hostnames_example" ]
ip_addresses: [ "ip_addresses_example" ]
ports: [ "ports_example" ]
protocol: HTTP
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete access_policy
oci_service_mesh_access_policy:
# required
access_policy_id: "ocid1.accesspolicy.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete access_policy using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_service_mesh_access_policy:
# required
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
access_policy
complex
|
on success |
Details of the AccessPolicy resource acted upon by the current operation
Sample:
{'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', 'mesh_id': 'ocid1.mesh.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'rules': [{'action': 'ALLOW', 'destination': {'hostnames': [], 'ingress_gateway_id': 'ocid1.ingressgateway.oc1..xxxxxxEXAMPLExxxxxx', 'ip_addresses': [], 'ports': [], 'protocol': 'HTTP', 'type': 'ALL_VIRTUAL_SERVICES', 'virtual_service_id': 'ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx'}, 'source': {'hostnames': [], 'ingress_gateway_id': 'ocid1.ingressgateway.oc1..xxxxxxEXAMPLExxxxxx', 'ip_addresses': [], 'ports': [], 'protocol': 'HTTP', 'type': 'ALL_VIRTUAL_SERVICES', 'virtual_service_id': 'ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx'}}], 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
|
|||
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
|
|||
mesh_id
string
|
on success |
The OCID of the service mesh in which this access policy is created.
Sample:
ocid1.mesh.oc1..xxxxxxEXAMPLExxxxxx
|
|||
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
|
|||
rules
complex
|
on success |
List of applicable rules.
|
|||
action
string
|
on success |
Action for the traffic between the source and the destination.
Sample:
ALLOW
|
|||
destination
complex
|
on success |
|
|||
hostnames
list
/ elements=string
|
on success |
The hostnames of the external service. Only applicable for HTTP and HTTPS protocols. Wildcard hostnames are supported in the prefix form. Examples of valid hostnames are "www.example.com", "*.example.com", "*.com", "*". Hostname "*" can be used to allow all hosts.
|
|||
ingress_gateway_id
string
|
on success |
The OCID of the ingress gateway resource.
Sample:
ocid1.ingressgateway.oc1..xxxxxxEXAMPLExxxxxx
|
|||
ip_addresses
list
/ elements=string
|
on success |
The ipAddresses of the external service in CIDR notation. Only applicable for TCP protocol. All requests matching the given CIDR notation will pass through. In case a wildcard CIDR "0.0.0.0/0" is provided, the same port cannot be used for a virtual service communication.
|
|||
ports
list
/ elements=string
|
on success |
Ports exposed by an external service. If left empty all ports will be allowed.
|
|||
protocol
string
|
on success |
Protocol of the external service
Sample:
HTTP
|
|||
type
string
|
on success |
Traffic type of the target.
Sample:
ALL_VIRTUAL_SERVICES
|
|||
virtual_service_id
string
|
on success |
The OCID of the virtual service resource.
Sample:
ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx
|
|||
source
complex
|
on success |
|
|||
hostnames
list
/ elements=string
|
on success |
The hostnames of the external service. Only applicable for HTTP and HTTPS protocols. Wildcard hostnames are supported in the prefix form. Examples of valid hostnames are "www.example.com", "*.example.com", "*.com", "*". Hostname "*" can be used to allow all hosts.
|
|||
ingress_gateway_id
string
|
on success |
The OCID of the ingress gateway resource.
Sample:
ocid1.ingressgateway.oc1..xxxxxxEXAMPLExxxxxx
|
|||
ip_addresses
list
/ elements=string
|
on success |
The ipAddresses of the external service in CIDR notation. Only applicable for TCP protocol. All requests matching the given CIDR notation will pass through. In case a wildcard CIDR "0.0.0.0/0" is provided, the same port cannot be used for a virtual service communication.
|
|||
ports
list
/ elements=string
|
on success |
Ports exposed by an external service. If left empty all ports will be allowed.
|
|||
protocol
string
|
on success |
Protocol of the external service
Sample:
HTTP
|
|||
type
string
|
on success |
Traffic type of the target.
Sample:
ALL_VIRTUAL_SERVICES
|
|||
virtual_service_id
string
|
on success |
The OCID of the virtual service resource.
Sample:
ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx
|
|||
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)