Try SpotterFetches details about one or multiple VnicAttachment resources 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.0Fetches details about one or multiple VnicAttachment resources in Oracle Cloud Infrastructure
Lists the VNIC attachments in the specified compartment. A VNIC attachment resides in the same compartment as the attached instance. The list can be filtered by instance, VNIC, or availability domain.
If I(vnic_attachment_id) is specified, the details of a single VnicAttachment will be returned.
- name: Get a specific vnic_attachment
oci_compute_vnic_attachment_facts:
# required
vnic_attachment_id: "ocid1.vnicattachment.oc1..xxxxxxEXAMPLExxxxxx"
- name: List vnic_attachments
oci_compute_vnic_attachment_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
availability_domain: Uocm:PHX-AD-1
instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx"
vnic_id: "ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx"
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
vnic_id:
description:
- The OCID of the VNIC.
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
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.
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:
description: Use I(display_name) along with the other options to return only resources
that match the given display name exactly.
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment.
- Required to list multiple vnic_attachments.
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 to get a specific vnic_attachment.
type: str
availability_domain:
description:
- The name of the availability domain.
- 'Example: `Uocm:PHX-AD-1`'
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
vnic_attachments:
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:
- List of VnicAttachment resources
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