Try SpotterFetches details about a CrossConnectStatus resource 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 a CrossConnectStatus resource in Oracle Cloud Infrastructure
Gets the status of the specified cross-connect.
- name: Get a specific cross_connect_status
oci_network_cross_connect_status_facts:
# required
cross_connect_id: "ocid1.crossconnect.oc1..xxxxxxEXAMPLExxxxxx"
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
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
cross_connect_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the cross-connect.
required: true
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
cross_connect_status:
contains:
cross_connect_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the cross-connect.
returned: on success
sample: ocid1.crossconnect.oc1..xxxxxxEXAMPLExxxxxx
type: str
encryption_status:
description:
- Encryption status of this cross connect.
- 'Possible values: * **UP:** Traffic is encrypted over this cross-connect *
**DOWN:** Traffic is not encrypted over this cross-connect * **CIPHER_MISMATCH:**
The MACsec encryption cipher doesn''t match the cipher on the CPE * **CKN_MISMATCH:**
The MACsec Connectivity association Key Name (CKN) doesn''t match the CKN
on the CPE * **CAK_MISMATCH:** The MACsec Connectivity Association Key (CAK)
doesn''t match the CAK on the CPE'
returned: on success
sample: UP
type: str
interface_state:
description:
- Indicates whether Oracle's side of the interface is up or down.
returned: on success
sample: UP
type: str
light_level_ind_bm:
description:
- The light level of the cross-connect (in dBm).
- 'Example: `14.0`'
returned: on success
sample: 3.4
type: float
light_level_indicator:
description:
- Status indicator corresponding to the light level.
- ' * **NO_LIGHT:** No measurable light * **LOW_WARN:** There''s measurable
light but it''s too low * **HIGH_WARN:** Light level is too high * **BAD:**
There''s measurable light but the signal-to-noise ratio is bad * **GOOD:**
Good light level'
returned: on success
sample: NO_LIGHT
type: str
light_levels_in_d_bm:
description:
- The light levels of the cross-connect (in dBm).
- 'Example: `[14.0, -14.0, 2.1, -10.1]`'
returned: on success
sample: []
type: list
description:
- CrossConnectStatus resource
returned: on success
sample:
cross_connect_id: ocid1.crossconnect.oc1..xxxxxxEXAMPLExxxxxx
encryption_status: UP
interface_state: UP
light_level_ind_bm: 3.4
light_level_indicator: NO_LIGHT
light_levels_in_d_bm: []
type: complex