oci_virtual_circuit_facts – Fetches details of one or more OCI Virtual Circuits¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Fetches details of a specified OCI Virtual Circuit or all Virtual Circuit in a 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_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.
compartment_id -		Identifier of the compartment under which the specified Virtual Circuit exists
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		Use display_name along with the other options to return only resources that match the given display name exactly.
lifecycle_state -	Choices: PENDING_PROVIDER VERIFYING PROVISIONING PROVISIONED FAILED INACTIVE TERMINATING TERMINATED	A filter to return only resources that match the given lifecycle state.
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
virtual_circuit_id -		Identifier of the Virtual Circuit whose details needs to be fetched. aliases: id

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

# Note: These examples do not set authentication details.
# Fetch All Virtual Circuits under a specific compartment
- name: Fetch All Virtual Circuits under a specific compartment
  oci_virtual_circuit_facts:
      compartment_id: 'ocid1.compartment.oc1.iad.xxxxxEXAMPLExxxxx'


# Fetch All Virtual Circuits under a specific compartment, filtered by
# display name and lifecycle state
- name: Fetch All Virtual Circuits under a specific compartment, filtered by display name and lifecycle state
  oci_virtual_circuit_facts:
      compartment_id: 'ocid1.compartment.oc1.iad.xxxxxEXAMPLExxxxx'
      display_name: 'ansible-virtual-circuit'
      lifecycle_state: 'PROVISIONED'

# Fetch a specific Virtual Circuit
- name: Fetch a specific Virtual Circuit
  oci_virtual_circuit_facts:
      virtual_circuit_id: 'ocid1.virtualcircuit.oc1.iad.xxxxxEXAMPLExxxxx'

Return Values ¶

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

Key		Returned	Description
oci_virtual_circuits complex		success	Attributes of the Fetched Virtual Circuit. Sample: [{'public_prefixes': None, 'provider_state': None, 'bandwidth_shape_name': '10 Gbps', 'provider_service_id': None, 'service_type': 'COLOCATED', 'region': None, 'cross_connect_mappings': [{'oracle_bgp_peering_ip': '169.254.203.201/30', 'bgp_md5_auth_key': None, 'vlan': 105, 'cross_connect_or_cross_connect_group_id': 'ocid1.crossconnectgroup.xxxxxEXAMPLExxxxx', 'customer_bgp_peering_ip': '169.254.203.202/30'}], 'display_name': 'sample-virtual-circuit', 'time_created': '2018-12-15T12:09:34.999000+00:00', 'lifecycle_state': 'PROVISIONED', 'provider_service_name': None, 'gateway_id': None, 'reference_comment': None, 'oracle_bgp_asn': 31898, 'customer_bgp_asn': 5, 'bgp_session_state': 'DOWN', 'provider_name': None, 'bgp_management': 'CUSTOMER_MANAGED', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'type': 'PUBLIC', 'id': 'ocid1.virtualcircuit.oc1..xxxxxEXAMPLExxxxx'}]
	bgp_management string	always	BGP management option. Sample: CUSTOMER_MANAGED
	bgp_session_state string	always	The state of the BGP session associated with the virtual circuit. Sample: UP
	compartment_id string	always	The OCID of the compartment containing the Virtual Circuit. Sample: ocid1.compartment.oc1.iad.xxxxxEXAMPLExxxxx
	cross_connect_mappings list	always	An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit. Sample: [{'oracle_bgp_peering_ip': '10.0.0.19/31', 'bgp_md5_auth_key': None, 'vlan': None, 'cross_connect_or_cross_connect_group_id': None, 'customer_bgp_peering_ip': '10.0.0.18/31'}]
	customer_bgp_asn integer	always	The BGP ASN of the network at the other end of the BGP session from Oracle. If the session is between the customer's edge router and Oracle, the value is the customer's ASN. If the BGP session is between the provider's edge router and Oracle, the value is the provider's ASN. Sample: 10
	display_name string	always	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Sample: ansible-virtual-circuit
	gateway_id string	always	The OCID of the customer's dynamic routing gateway (DRG) that this virtual circuit uses. Applicable only to private virtual circuits. Sample: ocid1.drg..xxxxxEXAMPLExxxxx
	id string	always	Identifier of the Virtual Circuit. Sample: ocid1.virtualcircuit.oc1.iad.xxxxxEXAMPLExxxxx
	lifecycle_state string	always	The current state of the Virtual Circuit. Sample: PROVISIONED
	oracle_bgp_asn integer	always	The Oracle BGP ASN. Sample: 31898
	port_speed_shape_name string	always	The port speed for this cross-connect. Sample: 10 Gbps
	provider_name string	always	Name of the Provider. Sample: Megaport
	provider_service_id string	always	The OCID of the service offered by the provider (if the customer is connecting via a provider). Sample: ocid1.providerservice.oc1..xxxxxEXAMPLExxxxx
	provider_service_name string	always	Name of the Provider Service. Sample: Service
	provider_state string	always	The provider's state in relation to this virtual circuit (if the customer is connecting via a provider). ACTIVE means the provider has provisioned the virtual circuit from their end. INACTIVE means the provider has not yet provisioned the virtual circuit, or has de-provisioned it. Sample: INACTIVE
	public_prefixes list	always	For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. Each prefix must be /31 or less specific. Sample: [{'cidr_block': '10.0.0.10/31'}]
	reference_comment string	always	Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider). Sample: SAMPLE
	region string	always	The Oracle Cloud Infrastructure region where this virtual circuit is located. Sample: phx
	service_type string	always	Provider service type. Sample: COLOCATED
	time_created datetime	always	Date and time when the Virtual Circuit was created, in the format defined by RFC3339 Sample: 2016-08-25 21:10:29.600000+00:00
	type string	always	Whether the virtual circuit supports private or public peering. Sample: PUBLIC

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.

oci_virtual_circuit_facts – Fetches details of one or more OCI Virtual Circuits¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶