oci_subnet_facts – Retrieve facts of subnets¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

This module allows the user to retrieve information of the specified subnet or all the subnets in the specified VCN and the 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 -		The OCID of the compartment. compartment_id is required to retrieve all the subnets in the specified VCN and the specified compartment.
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: PROVISIONING AVAILABLE TERMINATING TERMINATED	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED"
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.
subnet_id -		The OCID of the subnet. subnet_id is required to get a particular subnet's information. Whenever a subnet_id is specified with any other options, information of only the subnet pointed by subnet_id is retrieved.
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. vcn_id is required to retrieve all the subnets in the specified VCN and the specified compartment.

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 subnets in the specified VCN and the specified compartment
  oci_subnet_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    vcn_id: ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx

- name: Get a specific subnet
  oci_subnet_facts:
    subnet_id: ocid1.subnet.oc1.phx.xxxxxEXAMPLExxxxx

Return Values ¶

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

Key		Returned	Description
subnets complex		always	List of subnet details Sample: [{'prohibit_public_ip_on_vnic': True, 'virtual_router_mac': '00:00:17:D1:27:79', 'availability_domain': 'BnQb:PHX-AD-1', 'vcn_id': 'ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx', 'display_name': 'ansible_subnet', 'virtual_router_ip': '10.0.2.1', 'security_list_ids': ['ocid1.securitylist.oc1.phx.xxxxxEXAMPLExxxxx'], 'lifecycle_state': 'AVAILABLE', 'time_created': '2017-11-16T07:25:47.234000+00:00', 'dns_label': 'ansiblesubnet', 'id': 'ocid1.subnet.oc1.phx.xxxxxEXAMPLExxxxx', 'cidr_block': '10.0.1.0/24', 'subnet_domain_name': 'ansiblesubnet.ansiblevcn.oraclevcn.com', 'route_table_id': 'ocid1.routetable.oc1.phx.xxxxxEXAMPLExxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'dhcp_options_id': 'ocid1.dhcpoptions.oc1.phx.xxxxxEXAMPLExxxxx'}]
	availability_domain string	always	The subnet's Availability Domain. Sample: BnQb:PHX-AD-1
	cidr_block string	always	The subnet's CIDR block. Sample: 10.0.1.0/24
	compartment_id string	always	The OCID of the compartment containing the subnet. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
	dhcp_options_id string	always	The OCID of the set of DHCP options associated with the subnet. Sample: ocid1.dhcpoptions.oc1.phx.xxxxxEXAMPLExxxxx
	display_name string	always	Name of the subnet. Sample: ansible_subnet
	dns_label string	always	A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet. Sample: ansiblesubnet
	id string	always	OCID of the subnet. Sample: ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx
	lifecycle_state string	always	The subnet's current state. Sample: AVAILABLE
	prohibit_public_ip_on_vnic boolean	always	Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Sample: True
	route_table_id string	always	The OCID of the route table the subnet is using. Sample: ocid1.routetable.oc1.phx.xxxxxEXAMPLExxxxx
	security_list_ids list of strings	always	OCIDs for the security lists to use for VNICs in this subnet. Sample: ['ocid1.securitylist.oc1.phx.xxxxxEXAMPLExxxxx']
	subnet_domain_name string	always	The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain. Sample: ansiblesubnet.ansiblevcn.oraclevcn.com
	time_created string	always	The date and time the subnet was created, in the format defined by RFC3339. Sample: 2017-11-13 20:22:40.626000+00:00
	vcn_id string	always	The OCID of the VCN the subnet is in. Sample: ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx
	virtual_router_ip string	always	The IP address of the virtual router. Sample: 10.0.1.1
	virtual_router_mac string	always	The MAC address of the virtual router. Sample: 00:00:17:D1:27:79

Status ¶

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

Authors¶

Rohit Chaware (@rohitChaware)

Hint

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

oci_subnet_facts – Retrieve facts of subnets¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶