oci_private_ip_facts - Retrieve facts of private IPs

New in version 2.5.

Synopsis

  • This module retrieves information of a specified private IP or lists all the private IPs in a subnet.

Requirements

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

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
    Choices:
  • api_key ←
  • instance_principal
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
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
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.
ip_address
An IP address.
private_ip_id
The OCID of the private IP. private_ip_id is required to get a specific private IP's information.

aliases: id
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.
subnet_id
The OCID of the subnet. Required to list all the private IPs in a subnet.
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
vnic_id
The OCID of the VNIC.

Examples

- name: Get all the private IPs
  oci_private_ip_facts:
    subnet_id: ocid1.subnet.oc1.iad.xxxxxEXAMPLExxxxx

- name: Get a specific private IP
  oci_private_ip_facts:
    private_ip_id: ocid1.privateip.oc1.iad.xxxxxEXAMPLExxxxx

Return Values

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

Key Returned Description
private_ips
complex
always
List of private IP details

Sample:
[{'availability_domain': 'IwGV:US-ASHBURN-AD-1', 'display_name': 'ansible_private_ip', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'hostname_label': 'db', 'subnet_id': 'ocid1.subnet.oc1.iad.xxxxxEXAMPLExxxxx', 'defined_tags': {}, 'freeform_tags': {}, 'time_created': '2018-03-28T18:37:56.190000+00:00', 'vnic_id': 'ocid1.vnic.oc1.iad.xxxxxEXAMPLExxxxx', 'is_primary': False, 'ip_address': '10.0.0.114', 'id': 'ocid1.privateip.oc1.iad.xxxxxEXAMPLExxxxx'}]
  availability_domain
string
always
The private IP's Availability Domain.

Sample:
IwGV:US-ASHBURN-AD-1
  display_name
string
always
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
ansible_private_ip
  compartment_id
string
always
The OCID of the compartment containing the private IP.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  hostname_label
string
always
The hostname for the private IP. Used for DNS. The value is the hostname portion of the private IP's fully qualified domain name (FQDN) (for example, bminstance-1 in FQDN bminstance-1.subnet123.vcn1.oraclevcn.com). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

Sample:
webserver
  subnet_id
string
always
The OCID of the subnet the VNIC is in.

Sample:
ocid1.subnet.oc1.iad.xxxxxEXAMPLExxxxx
  defined_tags
string
always
Defined tags for this resource. Each key is predefined and scoped to a namespace.

Sample:
{'Operations': {'CostCenter': '42'}}
  freeform_tags
string
always
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

Sample:
{'Department': 'Finance'}
  time_created
string
always
The date and time the private IP was created, in the format defined by RFC3339.

Sample:
2018-03-28 18:37:56.190000
  vnic_id
string
always
The OCID of the VNIC the private IP is assigned to. The VNIC and private IP must be in the same subnet.

Sample:
ocid1.vnic.oc1.iad.xxxxxEXAMPLExxxxx
  is_primary
string
always
Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated.

  ip_address
string
always
The private IP address of the privateIp object. The address is within the CIDR of the VNIC's subnet.

Sample:
10.0.0.114
  id
string
always
The private IP's Oracle ID (OCID).

Sample:
ocid1.privateip.oc1.iad.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.