oracle.oci.oci_analytics_private_access_channel – Manage a PrivateAccessChannel resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.1.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_analytics_private_access_channel
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a PrivateAccessChannel resource in Oracle Cloud Infrastructure
For state=present, create an Private access Channel for the Analytics instance. The operation is long-running and creates a new WorkRequest.
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 | |
---|---|---|---|
analytics_instance_id
string
/ required
|
The OCID of the AnalyticsInstance.
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.
|
||
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 . |
||
display_name
string
|
Display Name of the Private Access Channel.
Required for create using state=present.
This parameter is updatable.
aliases: name |
||
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.
|
|
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.
|
||
network_security_group_ids
list
/ elements=string
|
Network Security Group OCIDs for an Analytics instance.
This parameter is updatable.
|
||
private_access_channel_key
string
|
The unique identifier key of the Private Access Channel.
Required for update using state=present with analytics_instance_id present.
Required for delete using state=absent.
|
||
private_source_dns_zones
list
/ elements=dictionary
|
List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered.
Required for create using state=present.
This parameter is updatable.
|
||
description
string
|
Description of private source dns zone.
|
||
dns_zone
string
/ required
|
Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
|
||
private_source_scan_hosts
list
/ elements=dictionary
|
List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
This parameter is updatable.
|
||
description
string
|
Description of private source scan host zone.
|
||
scan_hostname
string
/ required
|
Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
|
||
scan_port
integer
/ required
|
Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).
|
||
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. |
||
state
string
|
|
The state of the PrivateAccessChannel.
Use state=present to create or update a PrivateAccessChannel.
Use state=absent to delete a PrivateAccessChannel.
|
|
subnet_id
string
|
OCID of the customer subnet connected to private access channel.
Required for create using state=present.
This parameter is updatable.
|
||
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 |
||
vcn_id
string
|
OCID of the customer VCN peered with private access channel.
Required for create using state=present.
This parameter is updatable.
|
||
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 private_access_channel
oci_analytics_private_access_channel:
# required
display_name: display_name_example
vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
private_source_dns_zones:
- # required
dns_zone: dns_zone_example
# optional
description: description_example
analytics_instance_id: "ocid1.analyticsinstance.oc1..xxxxxxEXAMPLExxxxxx"
# optional
private_source_scan_hosts:
- # required
scan_hostname: scan_hostname_example
scan_port: 56
# optional
description: description_example
network_security_group_ids: [ "network_security_group_ids_example" ]
- name: Update private_access_channel
oci_analytics_private_access_channel:
# required
private_access_channel_key: private_access_channel_key_example
analytics_instance_id: "ocid1.analyticsinstance.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
private_source_dns_zones:
- # required
dns_zone: dns_zone_example
# optional
description: description_example
private_source_scan_hosts:
- # required
scan_hostname: scan_hostname_example
scan_port: 56
# optional
description: description_example
network_security_group_ids: [ "network_security_group_ids_example" ]
- name: Delete private_access_channel
oci_analytics_private_access_channel:
# required
private_access_channel_key: private_access_channel_key_example
analytics_instance_id: "ocid1.analyticsinstance.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)