Try SpotterManage a PrivateIp resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0This module allows the user to create, update and delete a PrivateIp resource in Oracle Cloud Infrastructure
For I(state=present), creates a secondary private IP for the specified VNIC. For more information about secondary private IPs, see L(IP Addresses,https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm).
- name: Create private_ip
oci_network_private_ip:
# optional
ip_address: ip_address_example
vlan_id: "ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx"
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
hostname_label: hostname_label_example
vnic_id: "ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update private_ip
oci_network_private_ip:
# required
private_ip_id: "ocid1.privateip.oc1..xxxxxxEXAMPLExxxxxx"
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
hostname_label: hostname_label_example
vnic_id: "ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update private_ip using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_network_private_ip:
# required
display_name: display_name_example
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
hostname_label: hostname_label_example
vnic_id: "ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx"
- name: Delete private_ip
oci_network_private_ip:
# required
private_ip_id: "ocid1.privateip.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete private_ip using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_network_private_ip:
# required
display_name: display_name_example
state: absent
state:
choices:
- present
- absent
default: present
description:
- The state of the PrivateIp.
- Use I(state=present) to create or update a PrivateIp.
- Use I(state=absent) to delete a PrivateIp.
required: false
type: str
key_by:
description: The list of attributes of this resource which should be used to uniquely
identify an instance of the resource. By default, all the attributes of a resource
are used to uniquely identify a resource.
elements: str
type: list
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
vlan_id:
description:
- Use this attribute only with the Oracle Cloud VMware Solution.
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the VLAN from which the private IP is to be drawn. The IP address, *if supplied*,
must be valid for the given VLAN. See L(Vlan,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Vlan).
type: str
vnic_id:
description:
- The OCID of the VNIC to assign the private IP to. The VNIC and private IP must be
in the same subnet. This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
- This parameter is updatable.
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
ip_address:
description:
- A private IP address of your choice. Must be an available IP address within the
subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private
IP address from the subnet.
- 'Example: `10.0.3.3`'
type: str
cert_bundle:
description:
- The full path to a CA certificate bundle to be used for SSL verification. This will
override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE
variable, if any, is used.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
- This parameter is updatable.
type: dict
display_name:
aliases:
- name
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering
confidential information.
- Required for create, update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is set.
- This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set.
type: str
force_create:
default: false
description: 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 I(key_by).
type: bool
freeform_tags:
description:
- 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 L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
- This parameter is updatable.
type: dict
private_ip_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the private IP or IPv6.
- Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
- Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
type: str
hostname_label:
description:
- 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, `bminstance1`
in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs
in the subnet and comply with L(RFC 952,https://tools.ietf.org/html/rfc952) and
L(RFC 1123,https://tools.ietf.org/html/rfc1123).
- For more information, see L(DNS in Your Virtual Cloud Network,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
- 'Example: `bminstance1`'
- This parameter is updatable.
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- Enable/Disable realm specific endpoint template for service client. By Default,
realm specific endpoint template is disabled. If not set, then the value of the
OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
type: bool
private_ip:
contains:
availability_domain:
description:
- The private IP's availability domain. This attribute will be null if this
is a *secondary* private IP assigned to a VNIC that is in a *regional* subnet.
- 'Example: `Uocm:PHX-AD-1`'
returned: on success
sample: Uocm:PHX-AD-1
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment containing the private IP.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid
entering confidential information.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- 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 L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
hostname_label:
description:
- 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, `bminstance1`
in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be unique across
all VNICs in the subnet and comply with L(RFC 952,https://tools.ietf.org/html/rfc952)
and L(RFC 1123,https://tools.ietf.org/html/rfc1123).
- For more information, see L(DNS in Your Virtual Cloud Network,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
- 'Example: `bminstance1`'
returned: on success
sample: hostname_label_example
type: str
id:
description:
- The private IP's Oracle ID (L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
ip_address:
description:
- The private IP address of the `privateIp` object. The address is within the
CIDR of the VNIC's subnet.
- However, if the `PrivateIp` object is being used with a VLAN as part of the
Oracle Cloud VMware Solution, the address is from the range specified by the
`cidrBlock` attribute for the VLAN. See L(Vlan,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Vlan).
- 'Example: `10.0.3.3`'
returned: on success
sample: ip_address_example
type: str
is_primary:
description:
- Whether this private IP is the primary one on the VNIC. Primary private IPs
are unassigned and deleted automatically when the VNIC is terminated.
- 'Example: `true`'
returned: on success
sample: true
type: bool
subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the subnet the VNIC is in.
- However, if the `PrivateIp` object is being used with a VLAN as part of the
Oracle Cloud VMware Solution, the `subnetId` is null.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
time_created:
description:
- The date and time the private IP was created, in the format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339).
- 'Example: `2016-08-25T21:10:29.600Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
vlan_id:
description:
- Applicable only if the `PrivateIp` object is being used with a VLAN as part
of the Oracle Cloud VMware Solution. The `vlanId` is the L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the VLAN. See L(Vlan,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Vlan).
returned: on success
sample: ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx
type: str
vnic_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the VNIC the private IP is assigned to. The VNIC and private IP must be
in the same subnet. However, if the `PrivateIp` object is being used with
a VLAN as part of the Oracle Cloud VMware Solution, the `vnicId` is null.
returned: on success
sample: ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- Details of the PrivateIp resource acted upon by the current operation
returned: on success
sample:
availability_domain: Uocm:PHX-AD-1
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
freeform_tags:
Department: Finance
hostname_label: hostname_label_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
ip_address: ip_address_example
is_primary: true
subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
time_created: '2013-10-20T19:20:30+01:00'
vlan_id: ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx
vnic_id: ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx
type: complex