oci_ip_sec_connection_facts – Retrieve facts of IPSec connections¶
New in version 2.5.
Synopsis¶
- This module retrieves information of the specified IPSec connection or lists all the IPSec connections in the specified compartment.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.7
- Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
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_OCID 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_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. |
|
compartment_id
-
|
The OCID of the compartment. compartment_id is required to get all the IPSec connections in the 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. |
|
|
cpe_id
-
|
The OCID of the CPE. Use cpe_id with compartment_id to filter the results by CPE.
|
|
|
display_name
string
|
Use display_name along with the other options to return only resources that match the given display name exactly.
|
|
|
drg_id
-
|
The OCID of the DRG. Use drg_id with compartment_id to filter the results by DRG.
|
|
|
ipsc_id
-
|
The OCID of the IPSec connection. ipsc_id is required to get a specific IPSec connection's information.
aliases: id |
|
|
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 |
Notes¶
Note
- For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get all the IPSec connections in a compartment
oci_ip_sec_connection_facts:
compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
- name: Get a specific IPSec connection using its OCID
oci_ip_sec_connection_facts:
ipsc_id: ocid1.ipsecconnection.oc1.phx.xxxxxEXAMPLExxxxx
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|
ip_sec_connections
complex
|
always |
List of IPSec connection details
Sample:
[{'cpe_id': 'ocid1.cpe.oc1.phx.xxxxxEXAMPLExxxxx', 'lifecycle_state': 'AVAILABLE', 'display_name': 'ansible_ip_sec_connection', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'static_routes': ['10.0.1.0/24'], 'defined_tags': {}, 'freeform_tags': {}, 'time_created': '2017-11-13T20:22:40.626000+00:00', 'drg_id': 'ocid1.drg.oc1.phx.xxxxxEXAMPLExxxxx', 'id': 'ocid1.ipsecconnection.oc1.phx.xxxxxEXAMPLExxxxx'}]
|
|
|
compartment_id
string
|
always |
The OCID of the compartment containing the IPSec connection.
Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
|
|
|
cpe_id
string
|
always |
The OCID of the CPE.
Sample:
ocid1.cpe.oc1.phx.xxxxxEXAMPLExxxxx
|
|
|
defined_tags
string
|
always |
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Sample:
{'Operations': {'CostCenter': '42'}}
|
|
|
display_name
string
|
always |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
ansible_ip_sec_connection
|
|
|
drg_id
string
|
always |
The OCID of the DRG.
Sample:
ocid1.ipsecconnection.oc1.phx.xxxxxEXAMPLExxxxx
|
|
|
freeform_tags
string
|
always |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
Sample:
{'Department': 'Finance'}
|
|
|
id
string
|
always |
The IPSec connection's Oracle ID (OCID).
Sample:
ocid1.ipsecconnection.oc1.phx.xxxxxEXAMPLExxxxx
|
|
|
lifecycle_state
string
|
always |
Current state of the IPSec connection.
Sample:
AVAILABLE
|
|
|
static_routes
string
|
always |
Static routes to the CPE. At least one route must be included. The CIDR must not be a multicast address or class E address.
Sample:
['10.0.1.0/24']
|
|
|
time_created
string
|
always |
The date and time the IPSec connection was created, in the format defined by RFC3339.
Sample:
2017-11-13 20:22:40.626000
|
|
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Rohit Chaware (@rohitChaware)
Hint
If you notice any issues in this documentation you can edit this document to improve it.