oci_vnic_attachment_facts - Retrieve details about one or more VNIC attachments in the specified compartment¶
New in version 2.5.
Synopsis¶
- This module retrieves details about a VNIC attachment, or all VNIC attachments in a specified Compartment in OCI Compute Service. A VNIC attachment resides in the same compartment as the attached instance.
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. |
| availability_domain |
The name of the Availability Domain.
|
|
| compartment_id |
The OCID of the compartment (either the tenancy or another compartment in the tenancy). Required for retrieving information about all VNIC attachments in a Compartment/Tenancy, or a compute instance.
|
|
| 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. |
| display_name |
Use display_name along with the other options to return only resources that match the given display name exactly.
|
|
| instance_id |
The OCID of the instance to which a VNIC attachment is attached to. Required for retrieving information about all VNIC attachments of a compute instance.
|
|
| 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. |
|
| 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 |
|
| vnic_attachment_id |
The OCID of the VNIC attachment. Required for retrieving information about a specific VNIC attachment
aliases: id |
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 details of all the VNIC attachments in a specified compartment
oci_vnic_attachment_facts:
compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...vm62xq'
- name: Get VNIC attachments of a specific instance
oci_vnic_attachment_facts:
compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...vm62xq'
instance_id: 'ocid1.image.oc1.phx.xxxxxEXAMPLExxxxx...lxiggdq'
- name: Get details of a specific VNIC attachment
oci_vnic_attachment_facts:
id: 'ocid1.vnic.oc1..xxxxxEXAMPLExxxxx...vm62asdaxq'
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 |
Information about one or more VNIC attachments
Sample:
[{'lifecycle_state': 'DETACHED', 'availability_domain': 'BnQb:PHX-AD-1', 'display_name': 'sec_vnic_1_for_my_instance', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...wbvm62xq', 'subnet_id': 'ocid1.subnet.oc1.phx.xxxxxEXAMPLExxxxx...smpqpaoa', 'time_created': '2017-11-26T16:24:35.487000+00:00', 'instance_id': 'ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx...qkwr6q', 'vnic_id': 'ocid1.vnic.oc1.phx.xxxxxEXAMPLExxxxx...v2beqa', 'vlan_tag': 41, 'id': 'ocid1.vnicattachment.oc1.phx.xxxxxEXAMPLExxxxx...b3momq'}]
|
|
|
lifecycle_state
string
|
always |
The current state of the VNIC attachment
Sample:
ATTACHED
|
|
|
availability_domain
string
|
always |
The Availability Domain of the instance
Sample:
Uocm:PHX-AD-1
|
|
|
display_name
string
|
always |
A user-friendly name for the image. It does not have to be unique, and it's changeable.
Sample:
sec-vnic1-to-instance1
|
|
|
compartment_id
string
|
always |
The OCID of the compartment the VNIC attachment is in, which is the same compartment the instance is in.
Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...vm62xq'
|
|
|
subnet_id
string
|
always |
The OCID of the VNIC's subnet.
Sample:
ocid1.subnet.oc1.phx.xxxxxEXAMPLExxxxx...5iddusmpqpaoa
|
|
|
time_created
string
|
always |
The date and time the image was created, in the format defined by RFC3339
Sample:
2017-11-20 04:52:54.541000
|
|
|
id
string
|
always |
The OCID of the VNIC attachment
Sample:
ocid1.vnic.oc1.phx.xxxxxEXAMPLExxxxx...asdadv3qca
|
|
|
instance_id
string
|
always |
The OCID of the instance.
Sample:
ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx...asdgrrv3qca
|
|
|
vnic_id
string
|
always |
The OCID of the VNIC. Available after the attachment process is complete.
Sample:
ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx...5iddusmpqpasdadsaoa
|
|
|
vlan_tag
string
|
always |
The Oracle-assigned VLAN tag of the attached VNIC. Available after the attachment process is complete.
|
|
|
nic_index
string
|
always |
The physical network interface card (NIC) the VNIC is using in a bare metal instance.
|
|
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¶
- Sivakumar Thyagarajan (@sivakumart)
Hint
If you notice any issues in this documentation you can edit this document to improve it.