oci_vnic_facts - Retrieve details about a specific VNIC¶
New in version 2.5.
Synopsis¶
- This module retrieves details about a specific VNIC.
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. |
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 . |
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_id |
The OCID of the VNIC. 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 a specific VNIC
oci_vnic_facts:
id: 'ocid1.vnic.oc1..xxxxxEXAMPLExxxxx...vm62xq'
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
vnic
complex
|
on success |
Information about a specific VNIC
Sample:
[{'lifecycle_state': 'AVAILABLE', 'availability_domain': 'BnQb:PHX-AD-1', 'display_name': 'my-vnic-1', 'hostname_label': 'myhostname-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...lwbvm62xq', 'subnet_id': 'ocid1.subnet.oc1.phx.xxxxxEXAMPLExxxxx...dusmpqpaoa', 'is_primary': True, 'time_created': '2017-11-26T16:23:29.932000+00:00', 'public_ip': None, 'skip_source_dest_check': False, 'private_ip': '10.0.0.10', 'mac_address': '00:00:17:00:6C:A2', 'id': 'ocid1.vnic.oc1.phx.xxxxxEXAMPLExxxxx...u7ybd56p6a'}]
|
|
lifecycle_state
string
|
always |
The current state of the VNIC.
Sample:
AVAILABLE
|
|
availability_domain
string
|
always |
The Availability Domain of the VNIC
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:
my-vnic1
|
|
compartment_id
string
|
always |
The OCID of the compartment containing the VNIC
Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...vm62xq'
|
|
hostname_label
string
|
always |
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, bminstance-1 in FQDN bminstance-1.subnet123.vcn1.oraclevcn.com). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
Sample:
my-host-1
|
|
subnet_id
string
|
always |
The OCID of the subnet the VNIC is in.
Sample:
ocid1.subnet.oc1.phx.xxxxxEXAMPLExxxxx...pbf7yux45iddusmpqpaoa
|
|
is_primary
boolean
|
always |
Whether the VNIC is the primary VNIC
Sample:
True
|
|
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
|
|
public_ip
string
|
always |
The public IP address of the VNIC, if one is assigned.
Sample:
10.1.2.3
|
|
skip_source_dest_check
string
|
always |
Whether the source/destination check is disabled on the VNIC. Defaults to false, which means the check is performed.
Sample:
True
|
|
private_ip
string
|
always |
The private IP address of the primary privateIp object on the VNIC. The address is within the CIDR of the VNIC's subnet.
Sample:
10.0.3.3
|
|
mac_address
string
|
always |
The MAC address of the VNIC.
Sample:
00:00:17:B6:4D:DD
|
|
id
string
|
always |
The OCID of the VNIC
Sample:
ocid1.vnic.oc1.phx.xxxxxEXAMPLExxxxx...asdadv3qca
|
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.