Try SpotterFetches details about one or multiple IpSecConnection resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple IpSecConnection resources in Oracle Cloud Infrastructure
Lists the IPSec connections for the specified compartment. You can filter the results by DRG or CPE.
If I(ipsc_id) is specified, the details of a single IpSecConnection will be returned.
- name: Get a specific ip_sec_connection
oci_network_ip_sec_connection_facts:
# required
ipsc_id: "ocid1.ipsc.oc1..xxxxxxEXAMPLExxxxxx"
- name: List ip_sec_connections
oci_network_ip_sec_connection_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
drg_id: "ocid1.drg.oc1..xxxxxxEXAMPLExxxxxx"
cpe_id: "ocid1.cpe.oc1..xxxxxxEXAMPLExxxxxx"
cpe_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the CPE.
type: str
drg_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the DRG.
type: str
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
ipsc_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the IPSec connection.
- Required to get a specific ip_sec_connection.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
display_name:
description: Use I(display_name) along with the other options to return only resources
that match the given display name exactly.
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment.
- Required to list multiple ip_sec_connections.
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
ip_sec_connections:
contains:
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment containing the IPSec connection.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
cpe_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the L(Cpe,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/iaas/latest/Cpe/)
object.
returned: on success
sample: ocid1.cpe.oc1..xxxxxxEXAMPLExxxxxx
type: str
cpe_local_identifier:
description:
- Your identifier for your CPE device. Can be either an IP address or a hostname
(specifically, the fully qualified domain name (FQDN)). The type of identifier
here must correspond to the value for `cpeLocalIdentifierType`.
- If you don't provide a value when creating the IPSec connection, the `ipAddress`
attribute for the L(Cpe,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Cpe/)
object specified by `cpeId` is used as the `cpeLocalIdentifier`.
- For information about why you'd provide this value, see L(If Your CPE Is Behind
a NAT Device,https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/overviewIPsec.htm#nat).
- 'Example IP address: `10.0.3.3`'
- 'Example hostname: `cpe.example.com`'
returned: on success
sample: cpe_local_identifier_example
type: str
cpe_local_identifier_type:
description:
- The type of identifier for your CPE device. The value here must correspond
to the value for `cpeLocalIdentifier`.
returned: on success
sample: IP_ADDRESS
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid
entering confidential information.
returned: on success
sample: display_name_example
type: str
drg_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the DRG.
returned: on success
sample: ocid1.drg.oc1..xxxxxxEXAMPLExxxxxx
type: str
freeform_tags:
description:
- 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 L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The IPSec connection's Oracle ID (L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_state:
description:
- The IPSec connection's current state.
returned: on success
sample: PROVISIONING
type: str
static_routes:
description:
- Static routes to the CPE. The CIDR must not be a multicast address or class
E address.
- Used for routing a given IPSec tunnel's traffic only if the tunnel is using
static routing. If you configure at least one tunnel to use static routing,
then you must provide at least one valid static route. If you configure both
tunnels to use BGP dynamic routing, you can provide an empty list for the
static routes.
- The CIDR can be either IPv4 or IPv6. IPv6 addressing is supported for all
commercial and government regions. See L(IPv6 Addresses,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
- 'Example: `10.0.1.0/24`'
- 'Example: `2001:db8::/32`'
returned: on success
sample: []
type: list
time_created:
description:
- The date and time the IPSec connection was created, in the format defined
by L(RFC3339,https://tools.ietf.org/html/rfc3339).
- 'Example: `2016-08-25T21:10:29.600Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- List of IpSecConnection resources
returned: on success
sample:
- compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
cpe_id: ocid1.cpe.oc1..xxxxxxEXAMPLExxxxxx
cpe_local_identifier: cpe_local_identifier_example
cpe_local_identifier_type: IP_ADDRESS
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
drg_id: ocid1.drg.oc1..xxxxxxEXAMPLExxxxxx
freeform_tags:
Department: Finance
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
lifecycle_state: PROVISIONING
static_routes: []
time_created: '2013-10-20T19:20:30+01:00'
type: complex