oci_virtual_circuit_public_prefix_facts – Fetches details of one or more OCI Virtual Circuit Public Prefixes

New in version 2.5.

Synopsis

  • Fetches details of all Virtual Circuit Public Prefixes of a specified Virtual Circuit.

Requirements

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

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_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_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
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.
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.
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
verification_state
-
    Choices:
  • IN_PROGRESS
  • COMPLETED
  • FAILED
A filter to return only resources that match the given verification state.
virtual_circuit_id
-
Identifier of the Virtual Circuit whose Public Prefixes needs to be fetched.

aliases: id

Examples

# Note: These examples do not set authentication details.
# Fetch All Virtual Circuit Public Prefixes of a specific Virtual Circuit
- name: Fetch All Virtual Circuit Public Prefixes of a specific Virtual Circuit
  oci_virtual_circuit_public_prefix_facts:
      virtual_circuit_id: 'ocid1.virtualcircuit.oc1.iad.xxxxxEXAMPLExxxxx'


# Fetch All Virtual Circuit Public Prefixes of a specific Virtual Circuit, filtered by
# verification state
- name: Fetch All Virtual Circuits under a specific compartment, filtered by display name and lifecycle state
  oci_virtual_circuit_public_prefix_facts:
      virtual_circuit_id: 'ocid1.virtualcircuit.oc1.iad.xxxxxEXAMPLExxxxx'
      verification_state: 'COMPLETED'

Return Values

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

Key Returned Description
oci_virtual_circuit_public_prefixes
complex
 success
Attributes of the Fetched Virtual Circuit Public Prefixes.

Sample:
[{'cidr_block': '10.0.0.20/31', 'verification_state': 'COMPLETED'}]
  cidr_block
string
 always
Publix IP prefix (CIDR) that the customer specified.

Sample:
10.0.0.21/31
  verification_state
string
 always
Oracle must verify that the customer owns the public IP prefix before traffic for that prefix can flow across the virtual circuit. Verification can take a few business days. IN_PROGRESS means Oracle is verifying the prefix. COMPLETED means verification succeeded. FAILED means verification failed and traffic for this prefix will not flow across the connection.

Sample:
COMPLETED


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.