oracle.oci.oci_service_mesh_access_policy_facts – Fetches details about one or multiple AccessPolicy resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple AccessPolicy resources in Oracle Cloud Infrastructure

  • Returns a list of AccessPolicy objects.

  • If access_policy_id is specified, the details of a single AccessPolicy will be returned.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
access_policy_id
string
Unique AccessPolicy identifier.
Required to get a specific access_policy.

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
    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
The ID of the compartment in which to list resources.
Required to list multiple access_policies.
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.
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
A filter to return only resources that match the life cycle state given.
mesh_id
string
Unique Mesh identifier.
name
string
A filter to return only resources that match the entire name given.
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
    Choices:
  • id
  • timeCreated
  • name
The field to sort by. Only one sort order may be provided. Default order for 'timeCreated' is descending. Default order for 'name' is ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'ASC' or '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

Examples

- name: Get a specific access_policy
  oci_service_mesh_access_policy_facts:
    # required
    access_policy_id: "ocid1.accesspolicy.oc1..xxxxxxEXAMPLExxxxxx"

- name: List access_policies
  oci_service_mesh_access_policy_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    sort_order: ASC
    sort_by: id
    mesh_id: "ocid1.mesh.oc1..xxxxxxEXAMPLExxxxxx"
    lifecycle_state: CREATING

Return Values

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

Key Returned Description
access_policies
complex
on success
List of AccessPolicy resources

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.
Returned for get operation

   
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)