oci_vcn_facts - Retrieve facts of Virtual Cloud Networks(VCNs)¶
New in version 2.5.
Synopsis¶
- This module retrieves information of a specified virtual cloud network(VCN) or lists all the VCNs in the specified compartment.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_user |
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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 |
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 |
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 |
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 |
|
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. compartment_id is required to get all the VCNs in the compartment.
|
|
| config_file_location |
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 |
Default: DEFAULT
|
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 |
Use display_name along with the other options to return only resources that match the given display name exactly.
|
|
| region |
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 |
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. vcn_id is required to get a specific VCN's information.
|
Notes¶
Note
- For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get all the VCNs in a compartment
oci_vcn_facts:
compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
- name: Get a specific VCN using its OCID
oci_vcn_facts:
vcn_id: ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx
- name: Get VCNs in a compartment having the specified display name
oci_vcn_facts:
compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
display_name: 'oci_ansible_vcn'
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|
vcns
complex
|
always |
List of VCN details
Sample:
[{'lifecycle_state': 'AVAILABLE', 'dns_label': 'ansiblevcn', 'display_name': 'ansible_vcn', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'default_dhcp_options_id': 'ocid1.dhcpoptions.oc1.phx.xxxxxEXAMPLExxxxx', 'time_created': '2017-11-13T20:22:40.626000+00:00', 'vcn_domain_name': 'ansiblevcn.oraclevcn.com', 'default_security_list_id': 'ocid1.securitylist.oc1.phx.xxxxxEXAMPLExxxxx', 'cidr_block': '10.0.0.0/16', 'id': 'ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx', 'default_route_table_id': 'ocid1.routetable.oc1.phx.xxxxxEXAMPLExxxxx'}]
|
|
|
lifecycle_state
string
|
always |
Current state of the VCN.
Sample:
AVAILABLE
|
|
|
dns_label
string
|
always |
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.
Sample:
ansiblevcn
|
|
|
display_name
string
|
always |
Name of the VCN.
Sample:
ansible_vcn
|
|
|
compartment_id
string
|
always |
The OCID of the compartment containing the VCN.
Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
|
|
|
default_dhcp_options_id
string
|
always |
The OCID for the VCN's default set of DHCP options.
Sample:
ocid1.dhcpoptions.oc1.phx.xxxxxEXAMPLExxxxx
|
|
|
time_created
string
|
always |
The date and time the VCN was created, in the format defined by RFC3339.
Sample:
2017-11-13 20:22:40.626000
|
|
|
vcn_domain_name
string
|
always |
The VCN's domain name, which consists of the VCN's DNS label, and the oraclevcn.com domain.
Sample:
ansiblevcn.oraclevcn.com
|
|
|
default_security_list_id
string
|
always |
The OCID for the VCN's default security list.
Sample:
ocid1.securitylist.oc1.phx.xxxxxEXAMPLExxxxx
|
|
|
cidr_block
string
|
always |
The CIDR IP address block of the VCN.
Sample:
10.0.0.0/16
|
|
|
id
string
|
always |
OCID of the VCN.
Sample:
ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx
|
|
|
default_route_table_id
string
|
always |
The OCID for the VCN's default route table.
Sample:
ocid1.routetable.oc1.phx.xxxxxEXAMPLExxxxx
|
|
Status¶
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author¶
- Rohit Chaware (@rohitChaware)
Hint
If you notice any issues in this documentation you can edit this document to improve it.