oracle.oci.oci_network_vtap – Manage a Vtap resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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_network_vtap
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a Vtap resource in Oracle Cloud Infrastructure
For state=present, creates a virtual test access point (VTAP) in the specified compartment.
For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it.
This resource has the following action operations in the oracle.oci.oci_network_vtap_actions module: change_compartment.
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. |
capture_filter_id
string
|
The capture filter's Oracle ID (OCID).
Required for create using state=present.
This parameter is updatable.
|
|
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 containing the `Vtap` resource.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
|
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 . |
|
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
|
display_name
string
|
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create, update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
|
encapsulation_protocol
string
|
|
Defines an encapsulation header type for the VTAP's mirrored traffic.
This parameter is updatable.
|
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
freeform_tags
dictionary
|
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
This parameter is updatable.
|
|
is_vtap_enabled
boolean
|
|
Used to start or stop a `Vtap` resource.
* `TRUE` directs the VTAP to start mirroring traffic. * `FALSE` (Default) directs the VTAP to stop mirroring traffic.
This parameter is updatable.
|
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|
max_packet_size
integer
|
The maximum size of the packets to be included in the filter.
This parameter is updatable.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
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. |
|
source_id
string
|
The OCID of the source point where packets are captured.
Required for create using state=present.
This parameter is updatable.
|
|
source_private_endpoint_ip
string
|
The IP Address of the source private endpoint.
This parameter is updatable.
|
|
source_private_endpoint_subnet_id
string
|
The OCID of the subnet that source private endpoint belongs to.
This parameter is updatable.
|
|
source_type
string
|
|
The source type for the VTAP.
This parameter is updatable.
|
state
string
|
|
The state of the Vtap.
Use state=present to create or update a Vtap.
Use state=absent to delete a Vtap.
|
target_id
string
|
The OCID of the destination resource where mirrored packets are sent.
This parameter is updatable.
|
|
target_ip
string
|
The IP address of the destination resource where mirrored packets are sent.
This parameter is updatable.
|
|
target_type
string
|
|
The target type for the VTAP.
This parameter is updatable.
|
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 |
|
traffic_mode
string
|
|
Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
This parameter is updatable.
|
vcn_id
string
|
The OCID of the VCN containing the `Vtap` resource.
Required for create using state=present.
|
|
vtap_id
string
|
The OCID of the VTAP.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
|
vxlan_network_identifier
integer
|
The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.
This parameter is updatable.
|
|
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create vtap
oci_network_vtap:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
source_id: "ocid1.source.oc1..xxxxxxEXAMPLExxxxxx"
capture_filter_id: "ocid1.capturefilter.oc1..xxxxxxEXAMPLExxxxxx"
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
target_ip: target_ip_example
encapsulation_protocol: VXLAN
vxlan_network_identifier: 56
is_vtap_enabled: true
traffic_mode: DEFAULT
max_packet_size: 56
source_private_endpoint_ip: source_private_endpoint_ip_example
source_private_endpoint_subnet_id: "ocid1.sourceprivateendpointsubnet.oc1..xxxxxxEXAMPLExxxxxx"
target_type: VNIC
source_type: VNIC
- name: Update vtap
oci_network_vtap:
# required
vtap_id: "ocid1.vtap.oc1..xxxxxxEXAMPLExxxxxx"
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
source_id: "ocid1.source.oc1..xxxxxxEXAMPLExxxxxx"
target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
target_ip: target_ip_example
capture_filter_id: "ocid1.capturefilter.oc1..xxxxxxEXAMPLExxxxxx"
encapsulation_protocol: VXLAN
vxlan_network_identifier: 56
is_vtap_enabled: true
traffic_mode: DEFAULT
max_packet_size: 56
source_private_endpoint_ip: source_private_endpoint_ip_example
source_private_endpoint_subnet_id: "ocid1.sourceprivateendpointsubnet.oc1..xxxxxxEXAMPLExxxxxx"
target_type: VNIC
source_type: VNIC
- name: Update vtap using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_network_vtap:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
source_id: "ocid1.source.oc1..xxxxxxEXAMPLExxxxxx"
target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
target_ip: target_ip_example
capture_filter_id: "ocid1.capturefilter.oc1..xxxxxxEXAMPLExxxxxx"
encapsulation_protocol: VXLAN
vxlan_network_identifier: 56
is_vtap_enabled: true
traffic_mode: DEFAULT
max_packet_size: 56
source_private_endpoint_ip: source_private_endpoint_ip_example
source_private_endpoint_subnet_id: "ocid1.sourceprivateendpointsubnet.oc1..xxxxxxEXAMPLExxxxxx"
target_type: VNIC
source_type: VNIC
- name: Delete vtap
oci_network_vtap:
# required
vtap_id: "ocid1.vtap.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete vtap using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_network_vtap:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
vtap
complex
|
on success |
Details of the Vtap resource acted upon by the current operation
Sample:
{'capture_filter_id': 'ocid1.capturefilter.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'encapsulation_protocol': 'VXLAN', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_vtap_enabled': True, 'lifecycle_state': 'PROVISIONING', 'lifecycle_state_details': 'RUNNING', 'max_packet_size': 56, 'source_id': 'ocid1.source.oc1..xxxxxxEXAMPLExxxxxx', 'source_private_endpoint_ip': 'source_private_endpoint_ip_example', 'source_private_endpoint_subnet_id': 'ocid1.sourceprivateendpointsubnet.oc1..xxxxxxEXAMPLExxxxxx', 'source_type': 'VNIC', 'target_id': 'ocid1.target.oc1..xxxxxxEXAMPLExxxxxx', 'target_ip': 'target_ip_example', 'target_type': 'VNIC', 'time_created': '2013-10-20T19:20:30+01:00', 'traffic_mode': 'DEFAULT', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx', 'vxlan_network_identifier': 56}
|
|
capture_filter_id
string
|
on success |
The capture filter's Oracle ID (OCID).
Sample:
ocid1.capturefilter.oc1..xxxxxxEXAMPLExxxxxx
|
|
compartment_id
string
|
on success |
The OCID of the compartment containing the `Vtap` resource.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|
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
|
|
encapsulation_protocol
string
|
on success |
Defines an encapsulation header type for the VTAP's mirrored traffic.
Sample:
VXLAN
|
|
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
|
id
string
|
on success |
The VTAP's Oracle ID (OCID).
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
is_vtap_enabled
boolean
|
on success |
Used to start or stop a `Vtap` resource.
* `TRUE` directs the VTAP to start mirroring traffic. * `FALSE` (Default) directs the VTAP to stop mirroring traffic.
Sample:
True
|
|
lifecycle_state
string
|
on success |
The VTAP's administrative lifecycle state.
Sample:
PROVISIONING
|
|
lifecycle_state_details
string
|
on success |
The VTAP's current running state.
Sample:
RUNNING
|
|
max_packet_size
integer
|
on success |
The maximum size of the packets to be included in the filter.
Sample:
56
|
|
source_id
string
|
on success |
The OCID of the source point where packets are captured.
Sample:
ocid1.source.oc1..xxxxxxEXAMPLExxxxxx
|
|
source_private_endpoint_ip
string
|
on success |
The IP Address of the source private endpoint.
Sample:
source_private_endpoint_ip_example
|
|
source_private_endpoint_subnet_id
string
|
on success |
The OCID of the subnet that source private endpoint belongs to.
Sample:
ocid1.sourceprivateendpointsubnet.oc1..xxxxxxEXAMPLExxxxxx
|
|
source_type
string
|
on success |
The source type for the VTAP.
Sample:
VNIC
|
|
target_id
string
|
on success |
The OCID of the destination resource where mirrored packets are sent.
Sample:
ocid1.target.oc1..xxxxxxEXAMPLExxxxxx
|
|
target_ip
string
|
on success |
The IP address of the destination resource where mirrored packets are sent.
Sample:
target_ip_example
|
|
target_type
string
|
on success |
The target type for the VTAP.
Sample:
VNIC
|
|
time_created
string
|
on success |
The date and time the VTAP was created, in the format defined by RFC3339.
Example: `2020-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
|
traffic_mode
string
|
on success |
Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
Sample:
DEFAULT
|
|
vcn_id
string
|
on success |
The OCID of the VCN containing the `Vtap` resource.
Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
|
|
vxlan_network_identifier
integer
|
on success |
The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.
Sample:
56
|
Authors¶
Oracle (@oracle)