oracle.oci.oci_compute_vnic_attachment_facts – Fetches details about one or multiple VnicAttachment resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.14.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_compute_vnic_attachment_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches 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 vnic_attachment_id is specified, the details of a single VnicAttachment will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_user
string
|
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
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
string
|
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
string
|
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
string
|
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_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
auth_type
string
|
|
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. |
availability_domain
string
|
The name of the availability domain.
Example: `Uocm:PHX-AD-1`
|
|
cert_bundle
string
|
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.
|
|
compartment_id
string
|
The OCID of the compartment.
Required to list multiple vnic_attachments.
|
|
config_file_location
string
|
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
string
|
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 . |
|
display_name
string
|
Use display_name along with the other options to return only resources that match the given display name exactly.
|
|
instance_id
string
|
The OCID of the instance.
|
|
region
string
|
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. |
|
tenancy
string
|
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_attachment_id
string
|
The OCID of the VNIC attachment.
Required to get a specific vnic_attachment.
aliases: id |
|
vnic_id
string
|
The OCID of the VNIC.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- 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"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
vnic_attachments
complex
|
on success |
List of VnicAttachment resources
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'}]
|
|
availability_domain
string
|
on success |
The availability domain of the instance.
Example: `Uocm:PHX-AD-1`
Sample:
Uocm:PHX-AD-1
|
|
compartment_id
string
|
on success |
The OCID of the compartment the VNIC attachment is in, which is the same compartment the instance is in.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
display_name
string
|
on success |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
|
id
string
|
on success |
The OCID of the VNIC attachment.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
instance_id
string
|
on success |
The OCID of the instance.
Sample:
ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx
|
|
lifecycle_state
string
|
on success |
The current state of the VNIC attachment.
Sample:
ATTACHING
|
|
nic_index
integer
|
on success |
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).
Sample:
56
|
|
subnet_id
string
|
on success |
The OCID of the subnet to create the VNIC in.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
|
time_created
string
|
on success |
The date and time the VNIC attachment was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
|
vlan_id
string
|
on success |
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 Vlan.
An error is returned if the instance already has a VNIC attached to it from this VLAN.
Sample:
ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx
|
|
vlan_tag
integer
|
on success |
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 Vlan.
Example: `0`
Sample:
56
|
|
vnic_id
string
|
on success |
The OCID of the VNIC. Available after the attachment process is complete.
Sample:
ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)