oci_public_ip - Manage public IPs in OCI¶
New in version 2.5.
Synopsis¶
- This module allows the user to create, delete and update public IPs in OCI.
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 to contain the public IP. For ephemeral public IPs, you must set this to the private IP's compartment OCID. Required to create a public IP.
|
|
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 . |
defined_tags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
|
|
display_name |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
aliases: name |
|
force_create
bool |
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
freeform_tags |
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
|
|
key_by |
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
|
|
lifetime |
|
Defines when the public IP is deleted and released back to the Oracle Cloud Infrastructure public IP pool. Required to create a public IP.
|
private_ip_id |
The OCID of the private IP to assign the public IP to. Required for an ephemeral public IP because it must always be assigned to a private IP (specifically a primary private IP). Optional for a reserved public IP. If you don't provide it, the public IP is created but not assigned to a private IP.
|
|
public_ip_id |
The OCID of the public IP. Required to delete or update a public IP.
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. |
|
state |
|
Create or update a public IP with state=present. Use state=absent to delete a public IP.
|
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 |
|
wait
bool |
|
Whether to wait for create or delete operation to complete.
|
wait_timeout |
Default: 1200
|
Time, in seconds, to wait when wait=yes.
|
wait_until |
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.
|
Notes¶
Note
- For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create a public IP with lifetime as RESERVED
oci_public_ip:
compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
display_name: ansible_public_ip
lifetime: RESERVED
- name: Create a public IP with lifetime as EPHEMERAL
oci_public_ip:
compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
display_name: ansible_public_ip
lifetime: EPHEMERAL
private_ip_id: ocid1.privateip.oc1.iad.xxxxxEXAMPLExxxxx
- name: Assign a reserved public IP to a private IP
oci_public_ip:
id: ocid1.publicip.oc1.iad.xxxxxEXAMPLExxxxx
private_ip_id: ocid1.privateip.oc1.iad.xxxxxEXAMPLExxxxx
- name: Unassign a reserved public IP from a private IP by passing an empty string
oci_public_ip:
id: ocid1.publicip.oc1.iad.xxxxxEXAMPLExxxxx
private_ip_id: ""
- name: Delete a public IP
oci_public_ip:
id: ocid1.publicip.oc1.iad.xxxxxEXAMPLExxxxx
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
public_ip
dict
|
On successful create, delete & update operation |
Information about the public IP
Sample:
{'lifecycle_state': 'AVAILABLE', 'availability_domain': None, 'display_name': 'ansible_public_ip', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'time_created': '2018-06-22T15:25:25.569000+00:00', 'lifetime': 'RESERVED', 'scope': 'REGION', 'private_ip_id': None, 'ip_address': '129.213.14.148', 'id': 'ocid1.publicip.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.