oracle.oci.oci_network_vtap_facts – Fetches details about one or multiple Vtap resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple Vtap resources in Oracle Cloud Infrastructure
Lists the virtual test access points (VTAPs) in the specified compartment.
If vtap_id is specified, the details of a single Vtap 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. |
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 vtaps.
|
|
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
|
A filter to return only resources that match the given display name exactly.
aliases: name |
|
is_vtap_enabled
boolean
|
|
Indicates whether to list all VTAPs or only running VTAPs.
* When `FALSE`, lists ALL running and stopped VTAPs. * When `TRUE`, lists only running VTAPs (VTAPs where isVtapEnabled = `TRUE`).
|
lifecycle_state
string
|
|
A filter to return only resources that match the given VTAP administrative lifecycle state. The state value is case-insensitive.
|
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. |
|
sort_by
string
|
|
The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
**Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
|
sort_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.
|
source
string
|
The OCID of the VTAP source.
|
|
target_id
string
|
The OCID of the VTAP target.
|
|
target_ip
string
|
The IP address of the VTAP target.
|
|
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 |
|
vcn_id
string
|
The OCID of the VCN.
|
|
vtap_id
string
|
The OCID of the VTAP.
Required to get a specific vtap.
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 a specific vtap
oci_network_vtap_facts:
# required
vtap_id: "ocid1.vtap.oc1..xxxxxxEXAMPLExxxxxx"
- name: List vtaps
oci_network_vtap_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
source: source_example
target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
target_ip: target_ip_example
is_vtap_enabled: true
sort_by: TIMECREATED
sort_order: ASC
display_name: display_name_example
lifecycle_state: PROVISIONING
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
vtaps
complex
|
on success |
List of Vtap resources
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)