Try SpotterManage a VnicAttachment 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 and delete a VnicAttachment resource in Oracle Cloud Infrastructure
For I(state=present), creates a secondary VNIC and attaches it to the specified instance. For more information about secondary VNICs, see L(Virtual Network Interface Cards (VNICs),https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).
- name: Create vnic_attachment
oci_compute_vnic_attachment:
# required
create_vnic_details:
# optional
assign_public_ip: true
assign_private_dns_record: true
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
hostname_label: hostname_label_example
nsg_ids: [ "nsg_ids_example" ]
private_ip: private_ip_example
skip_source_dest_check: true
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
vlan_id: "ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx"
instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
nic_index: 56
- name: Delete vnic_attachment
oci_compute_vnic_attachment:
# required
vnic_attachment_id: "ocid1.vnicattachment.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete vnic_attachment using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_compute_vnic_attachment:
# required
display_name: display_name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
state:
choices:
- present
- absent
default: present
description:
- The state of the VnicAttachment.
- Use I(state=present) to create a VnicAttachment.
- Use I(state=absent) to delete a VnicAttachment.
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
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
nic_index:
description:
- Which physical network interface card (NIC) the VNIC will use. Defaults to 0. Certain
bare metal instance shapes have two active physical NICs (0 and 1). If you add a
secondary VNIC to one of these instances, you can specify which NIC the VNIC will
use. For more information, see L(Virtual Network Interface Cards (VNICs),https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).
type: int
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
instance_id:
description:
- The OCID of the instance.
- Required for create using I(state=present).
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
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, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is 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
wait_timeout:
description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most
of the services but some services might have a longer wait timeout.
type: int
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment.
- Required for create using I(state=present).
- Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
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
vnic_attachment_id:
aliases:
- id
description:
- The OCID of the VNIC attachment.
- Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
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
create_vnic_details:
description:
- ''
- Required for create using I(state=present).
suboptions:
assign_private_dns_record:
description:
- Whether the VNIC should be assigned a DNS record. If set to false, there will
be no DNS record registration for the VNIC. If set to true, the DNS record will
be registered. The default value is true.
- If you specify a `hostnameLabel`, then `assignPrivateDnsRecord` must be set
to true.
type: bool
assign_public_ip:
description:
- Whether the VNIC should be assigned a public IP address. Defaults to whether
the subnet is public or private. If not set and the VNIC is being created in
a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the L(Subnet,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Subnet/)),
then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic`
= false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic`
= true, an error is returned.
- '**Note:** This public IP address is associated with the primary private IP
on the VNIC. For more information, see L(IP Addresses,https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm).'
- '**Note:** There''s a limit to the number of L(public IPs,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/PublicIp/)
a VNIC or instance can have. If you try to create a secondary VNIC with an assigned
public IP for an instance that has already reached its public IP limit, an error
is returned. For information about the public IP limits, see L(Public IP Addresses,https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).'
- 'Example: `false`'
- If you specify a `vlanId`, then `assignPublicIp` must be set to false. See L(Vlan,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Vlan).
type: bool
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"}}`'
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.
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"}`'
type: dict
hostname_label:
description:
- The hostname for the VNIC's primary private IP. Used for DNS. The value is the
hostname portion of the primary 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). The value appears in the
L(Vnic,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Vnic/)
object and also the L(PrivateIp,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/PrivateIp/)
object returned by L(ListPrivateIps,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps)
and L(GetPrivateIp,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).
- For more information, see L(DNS in Your Virtual Cloud Network,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
- When launching an instance, use this `hostnameLabel` instead of the deprecated
`hostnameLabel` in L(LaunchInstanceDetails,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails).
If you provide both, the values must match.
- 'Example: `bminstance1`'
- If you specify a `vlanId`, the `hostnameLabel` cannot be specified. VNICs on
a VLAN can not be assigned a hostname. See L(Vlan,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Vlan).
type: str
nsg_ids:
description:
- A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
For more information about NSGs, see L(NetworkSecurityGroup,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).
- If a `vlanId` is specified, the `nsgIds` cannot be specified. The `vlanId` indicates
that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs
in the VLAN belong to the NSGs that are associated with the VLAN. See L(Vlan,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Vlan).
elements: str
type: list
private_ip:
description:
- A private IP address of your choice to assign to the VNIC. 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. This is the VNIC's *primary* private
IP address. The value appears in the L(Vnic,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Vnic/)
object and also the L(PrivateIp,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/PrivateIp/)
object returned by L(ListPrivateIps,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps)
and L(GetPrivateIp,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).
- If you specify a `vlanId`, the `privateIp` cannot be specified. See L(Vlan,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Vlan).
- 'Example: `10.0.3.3`'
type: str
skip_source_dest_check:
description:
- Whether the source/destination check is disabled on the VNIC. Defaults to `false`,
which means the check is performed. For information about why you would skip
the source/destination check, see L(Using a Private IP as a Route Target,https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).
- If you specify a `vlanId`, the `skipSourceDestCheck` cannot be specified because
the source/destination check is always disabled for VNICs in a VLAN. See L(Vlan,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Vlan).
- 'Example: `true`'
type: bool
subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the subnet to create the VNIC in. When launching an instance, use this `subnetId`
instead of the deprecated `subnetId` in L(LaunchInstanceDetails,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails).
At least one of them is required; if you provide both, the values must match.
- If you are an Oracle Cloud VMware Solution customer and creating a secondary
VNIC in a VLAN instead of a subnet, provide a `vlanId` instead of a `subnetId`.
If you provide both a `vlanId` and `subnetId`, the request fails.
type: str
vlan_id:
description:
- Provide this attribute only if you are an Oracle Cloud VMware Solution customer
and creating a secondary VNIC in a VLAN. The value 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).
- Provide a `vlanId` instead of a `subnetId`. If you provide both a `vlanId` and
`subnetId`, the request fails.
type: str
type: dict
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
vnic_attachment:
contains:
availability_domain:
description:
- The availability domain of the instance.
- 'Example: `Uocm:PHX-AD-1`'
returned: on success
sample: Uocm:PHX-AD-1
type: str
compartment_id:
description:
- The OCID of the compartment the VNIC attachment is in, which is the same compartment
the instance is in.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
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
id:
description:
- The OCID of the VNIC attachment.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
instance_id:
description:
- The OCID of the instance.
returned: on success
sample: ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_state:
description:
- The current state of the VNIC attachment.
returned: on success
sample: ATTACHING
type: str
nic_index:
description:
- Which physical network interface card (NIC) the VNIC uses. Certain bare metal
instance shapes have two active physical NICs (0 and 1). If you add a secondary
VNIC to one of these instances, you can specify which NIC the VNIC will use.
For more information, see L(Virtual Network Interface Cards (VNICs),https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).
returned: on success
sample: 56
type: int
subnet_id:
description:
- The OCID of the subnet to create the VNIC in.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
time_created:
description:
- The date and time the VNIC attachment 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:
- The OCID of the VLAN to create the VNIC in. Creating the VNIC in a VLAN (instead
of a subnet) is possible only if you are an Oracle Cloud VMware Solution customer.
See L(Vlan,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Vlan).
- An error is returned if the instance already has a VNIC attached to it from
this VLAN.
returned: on success
sample: ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx
type: str
vlan_tag:
description:
- The Oracle-assigned VLAN tag of the attached VNIC. Available after the attachment
process is complete.
- However, if the VNIC belongs to a VLAN as part of the Oracle Cloud VMware
Solution, the `vlanTag` value is instead the value of the `vlanTag` attribute
for the VLAN. See L(Vlan,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Vlan).
- 'Example: `0`'
returned: on success
sample: 56
type: int
vnic_id:
description:
- The OCID of the VNIC. Available after the attachment process is complete.
returned: on success
sample: ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- Details of the VnicAttachment resource acted upon by the current operation
returned: on success
sample:
availability_domain: Uocm:PHX-AD-1
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
display_name: display_name_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
instance_id: ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx
lifecycle_state: ATTACHING
nic_index: 56
subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
time_created: '2013-10-20T19:20:30+01:00'
vlan_id: ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx
vlan_tag: 56
vnic_id: ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx
type: complex