oci_vnic – Update a VNIC

New in version 2.5.

Synopsis

  • This module allows the user to update a specified VNIC. To create a primary VNIC, use oci_instance. To create a secondary VNIC and attach it to an instance, use oci_vnic_attachment.

Requirements

The below requirements are needed on the host that executes this module.

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_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
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_type
string
    Choices:
  • api_key ←
  • instance_principal
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
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.
hostname_label
-
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.
name
-
A user-friendly name for the VNIC. Does not have to be unique, and it is changeable.

aliases: display_name
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.
skip_source_dest_check
boolean
    Choices:
  • no ←
  • yes
Determines whether the source/destination check is disabled on the VNIC. Defaults to false, which means the check is performed.
state
-
    Choices:
  • present ←
The state of the VNIC that must be asserted to. When state=present, the VNIC is updated
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_id
- / required
The OCID of the VNIC. Required when a VNIC needs to be updated.

aliases: id

Examples

- name: Update the specified VNIC with a new name
  oci_vnic:
    id: "ocid1.vnicattachment.oc1.phx.xxxxxEXAMPLExxxxx....yicxjzgyhf47fq"
    name: sec-vnic1-to-instance1

- name: Update the specified VNIC with a new hostname_label
  oci_vnic:
    id: "ocid1.vnicattachment.oc1.phx.xxxxxEXAMPLExxxxx....yicxjzgyhf47fq"
    hostname_label: "newhostname"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
vnic
dictionary
On success
Details of the VNIC attachment

Sample:
{'lifecycle_state': 'AVAILABLE', 'availability_domain': 'BnQb:PHX-AD-1', 'display_name': 'my_test_secondary_vnic_name_mod', 'hostname_label': 'ansible-test-45-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...lwbvm62xq', 'subnet_id': 'ocid1.subnet.oc1.phx.xxxxxEXAMPLExxxxx...smpqpaoa', 'is_primary': False, 'time_created': '2017-11-26T16:24:39.642000+00:00', 'public_ip': None, 'skip_source_dest_check': False, 'private_ip': '10.0.0.11', 'mac_address': '00:00:17:00:BC:6A', 'id': 'ocid1.vnic.oc1.phx.xxxxxEXAMPLExxxxx...2beqa'}


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Sivakumar Thyagarajan (@sivakumart)

Hint

If you notice any issues in this documentation you can edit this document to improve it.