oci_vcn_facts – Fetches details about one or multiple Vcn resources in Oracle Cloud Infrastructure¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Fetches details about one or multiple Vcn resources in Oracle Cloud Infrastructure
Lists the virtual cloud networks (VCNs) in the specified compartment.
If vcn_id is specified, the details of a single Vcn will be returned.

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 -		The OCID of the compartment. Required to list multiple vcns.
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 -		A filter to return only resources that match the given display name exactly. aliases: name
lifecycle_state -	Choices: PROVISIONING AVAILABLE TERMINATING TERMINATED	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
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.
sort_by -	Choices: TIMECREATED DISPLAYNAME	The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sort_order -	Choices: ASC DESC	The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.
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
vcn_id -		The OCID of the VCN. Required to get a specific vcn. 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 ¶

- name: List vcns
  oci_vcn_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx

- name: Get a specific vcn
  oci_vcn_facts:
    vcn_id: ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx

Return Values ¶

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

Key		Returned	Description
vcns complex		on success	List of Vcn resources Sample: [{'freeform_tags': {'Department': 'Finance'}, 'dns_label': 'vcn1', 'lifecycle_state': 'PROVISIONING', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'cidr_block': '172.16.0.0/16', 'default_security_list_id': 'ocid1.defaultsecuritylist.oc1..xxxxxxEXAMPLExxxxxx', 'default_route_table_id': 'ocid1.defaultroutetable.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'default_dhcp_options_id': 'ocid1.defaultdhcpoptions.oc1..xxxxxxEXAMPLExxxxxx', 'vcn_domain_name': 'vcn1.oraclevcn.com', 'time_created': '2016-08-25T21:10:29.600Z'}]
	cidr_block string	on success	The CIDR IP address block of the VCN. Example: `172.16.0.0/16` Sample: 172.16.0.0/16
	compartment_id string	on success	The OCID of the compartment containing the VCN. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	default_dhcp_options_id string	on success	The OCID for the VCN's default set of DHCP options. Sample: ocid1.defaultdhcpoptions.oc1..xxxxxxEXAMPLExxxxxx
	default_route_table_id string	on success	The OCID for the VCN's default route table. Sample: ocid1.defaultroutetable.oc1..xxxxxxEXAMPLExxxxxx
	default_security_list_id string	on success	The OCID for the VCN's default security list. Sample: ocid1.defaultsecuritylist.oc1..xxxxxxEXAMPLExxxxxx
	defined_tags dictionary	on success	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}` Sample: {'Operations': {'CostCenter': 'US'}}
	display_name string	on success	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Sample: display_name_example
	dns_label string	on success	A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter. The value cannot be changed. The absence of this parameter means the Internet and VCN Resolver will not work for this VCN. For more information, see DNS in Your Virtual Cloud Network. Example: `vcn1` Sample: vcn1
	freeform_tags dictionary	on success	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 Resource Tags. Example: `{"Department": "Finance"}` Sample: {'Department': 'Finance'}
	id string	on success	The VCN's Oracle ID (OCID). Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	lifecycle_state string	on success	The VCN's current state. Sample: PROVISIONING
	time_created string	on success	The date and time the VCN was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` Sample: 2016-08-25 21:10:29.600000+00:00
	vcn_domain_name string	on success	The VCN's domain name, which consists of the VCN's DNS label, and the `oraclevcn.com` domain. For more information, see DNS in Your Virtual Cloud Network. Example: `vcn1.oraclevcn.com` Sample: vcn1.oraclevcn.com

Status ¶

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

Authors¶

Manoj Meda (@manojmeda)
Mike Ross (@mross22)
Nabeel Al-Saber (@nalsaber)

Hint

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

oci_vcn_facts – Fetches details about one or multiple Vcn resources in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶