Vtap¶

class oci.core.models.Vtap(**kwargs)¶

Bases: object

A virtual test access point (VTAP) provides a way to mirror all traffic from a designated source to a selected target in order to facilitate troubleshooting, security analysis, and data monitoring. A VTAP is functionally similar to a test access point (TAP) you might deploy in your on-premises network.

A :class:`CaptureFilter` contains a set of :func:`capture_filter_rule_details` governing what traffic a VTAP mirrors.

Attributes:

`ENCAPSULATION_PROTOCOL_VXLAN`	A constant which can be used with the encapsulation_protocol property of a Vtap.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a Vtap.
`LIFECYCLE_STATE_DETAILS_RUNNING`	A constant which can be used with the lifecycle_state_details property of a Vtap.
`LIFECYCLE_STATE_DETAILS_STOPPED`	A constant which can be used with the lifecycle_state_details property of a Vtap.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a Vtap.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a Vtap.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a Vtap.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Vtap.
`SOURCE_TYPE_AUTONOMOUS_DATA_WAREHOUSE`	A constant which can be used with the source_type property of a Vtap.
`SOURCE_TYPE_DB_SYSTEM`	A constant which can be used with the source_type property of a Vtap.
`SOURCE_TYPE_EXADATA_VM_CLUSTER`	A constant which can be used with the source_type property of a Vtap.
`SOURCE_TYPE_LOAD_BALANCER`	A constant which can be used with the source_type property of a Vtap.
`SOURCE_TYPE_NETWORK_FIREWALL`	A constant which can be used with the source_type property of a Vtap.
`SOURCE_TYPE_SUBNET`	A constant which can be used with the source_type property of a Vtap.
`SOURCE_TYPE_VNIC`	A constant which can be used with the source_type property of a Vtap.
`TARGET_TYPE_IP_ADDRESS`	A constant which can be used with the target_type property of a Vtap.
`TARGET_TYPE_NETWORK_LOAD_BALANCER`	A constant which can be used with the target_type property of a Vtap.
`TARGET_TYPE_VNIC`	A constant which can be used with the target_type property of a Vtap.
`TRAFFIC_MODE_DEFAULT`	A constant which can be used with the traffic_mode property of a Vtap.
`TRAFFIC_MODE_PRIORITY`	A constant which can be used with the traffic_mode property of a Vtap.
`capture_filter_id`	[Required] Gets the capture_filter_id of this Vtap.
`compartment_id`	[Required] Gets the compartment_id of this Vtap.
`defined_tags`	Gets the defined_tags of this Vtap.
`display_name`	Gets the display_name of this Vtap.
`encapsulation_protocol`	Gets the encapsulation_protocol of this Vtap.
`freeform_tags`	Gets the freeform_tags of this Vtap.
`id`	[Required] Gets the id of this Vtap.
`is_vtap_enabled`	Gets the is_vtap_enabled of this Vtap.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Vtap.
`lifecycle_state_details`	Gets the lifecycle_state_details of this Vtap.
`max_packet_size`	Gets the max_packet_size of this Vtap.
`source_id`	[Required] Gets the source_id of this Vtap.
`source_private_endpoint_ip`	Gets the source_private_endpoint_ip of this Vtap.
`source_private_endpoint_subnet_id`	Gets the source_private_endpoint_subnet_id of this Vtap.
`source_type`	Gets the source_type of this Vtap.
`system_tags`	Gets the system_tags of this Vtap.
`target_id`	Gets the target_id of this Vtap.
`target_ip`	Gets the target_ip of this Vtap.
`target_type`	Gets the target_type of this Vtap.
`time_created`	Gets the time_created of this Vtap.
`traffic_mode`	Gets the traffic_mode of this Vtap.
`vcn_id`	[Required] Gets the vcn_id of this Vtap.
`vxlan_network_identifier`	Gets the vxlan_network_identifier of this Vtap.

Methods:

__init__(**kwargs)

Initializes a new Vtap object with values from keyword arguments.

ENCAPSULATION_PROTOCOL_VXLAN = 'VXLAN'¶: A constant which can be used with the encapsulation_protocol property of a Vtap. This constant has a value of “VXLAN”

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a Vtap. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_DETAILS_RUNNING = 'RUNNING'¶: A constant which can be used with the lifecycle_state_details property of a Vtap. This constant has a value of “RUNNING”

LIFECYCLE_STATE_DETAILS_STOPPED = 'STOPPED'¶: A constant which can be used with the lifecycle_state_details property of a Vtap. This constant has a value of “STOPPED”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a Vtap. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a Vtap. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a Vtap. This constant has a value of “TERMINATING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Vtap. This constant has a value of “UPDATING”

SOURCE_TYPE_AUTONOMOUS_DATA_WAREHOUSE = 'AUTONOMOUS_DATA_WAREHOUSE'¶: A constant which can be used with the source_type property of a Vtap. This constant has a value of “AUTONOMOUS_DATA_WAREHOUSE”

SOURCE_TYPE_DB_SYSTEM = 'DB_SYSTEM'¶: A constant which can be used with the source_type property of a Vtap. This constant has a value of “DB_SYSTEM”

SOURCE_TYPE_EXADATA_VM_CLUSTER = 'EXADATA_VM_CLUSTER'¶: A constant which can be used with the source_type property of a Vtap. This constant has a value of “EXADATA_VM_CLUSTER”

SOURCE_TYPE_LOAD_BALANCER = 'LOAD_BALANCER'¶: A constant which can be used with the source_type property of a Vtap. This constant has a value of “LOAD_BALANCER”

SOURCE_TYPE_NETWORK_FIREWALL = 'NETWORK_FIREWALL'¶: A constant which can be used with the source_type property of a Vtap. This constant has a value of “NETWORK_FIREWALL”

SOURCE_TYPE_SUBNET = 'SUBNET'¶: A constant which can be used with the source_type property of a Vtap. This constant has a value of “SUBNET”

SOURCE_TYPE_VNIC = 'VNIC'¶: A constant which can be used with the source_type property of a Vtap. This constant has a value of “VNIC”

TARGET_TYPE_IP_ADDRESS = 'IP_ADDRESS'¶: A constant which can be used with the target_type property of a Vtap. This constant has a value of “IP_ADDRESS”

TARGET_TYPE_NETWORK_LOAD_BALANCER = 'NETWORK_LOAD_BALANCER'¶: A constant which can be used with the target_type property of a Vtap. This constant has a value of “NETWORK_LOAD_BALANCER”

TARGET_TYPE_VNIC = 'VNIC'¶: A constant which can be used with the target_type property of a Vtap. This constant has a value of “VNIC”

TRAFFIC_MODE_DEFAULT = 'DEFAULT'¶: A constant which can be used with the traffic_mode property of a Vtap. This constant has a value of “DEFAULT”

TRAFFIC_MODE_PRIORITY = 'PRIORITY'¶: A constant which can be used with the traffic_mode property of a Vtap. This constant has a value of “PRIORITY”

__init__(**kwargs)¶

Initializes a new Vtap object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

compartment_id (str) – The value to assign to the compartment_id property of this Vtap.
vcn_id (str) – The value to assign to the vcn_id property of this Vtap.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Vtap.
display_name (str) – The value to assign to the display_name property of this Vtap.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Vtap.
id (str) – The value to assign to the id property of this Vtap.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Vtap. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this Vtap. Allowed values for this property are: “RUNNING”, “STOPPED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Vtap.
time_created (datetime) – The value to assign to the time_created property of this Vtap.
source_id (str) – The value to assign to the source_id property of this Vtap.
target_id (str) – The value to assign to the target_id property of this Vtap.
target_ip (str) – The value to assign to the target_ip property of this Vtap.
capture_filter_id (str) – The value to assign to the capture_filter_id property of this Vtap.
encapsulation_protocol (str) – The value to assign to the encapsulation_protocol property of this Vtap. Allowed values for this property are: “VXLAN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
vxlan_network_identifier (int) – The value to assign to the vxlan_network_identifier property of this Vtap.
is_vtap_enabled (bool) – The value to assign to the is_vtap_enabled property of this Vtap.
source_type (str) – The value to assign to the source_type property of this Vtap. Allowed values for this property are: “VNIC”, “SUBNET”, “LOAD_BALANCER”, “DB_SYSTEM”, “EXADATA_VM_CLUSTER”, “AUTONOMOUS_DATA_WAREHOUSE”, “NETWORK_FIREWALL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
traffic_mode (str) – The value to assign to the traffic_mode property of this Vtap. Allowed values for this property are: “DEFAULT”, “PRIORITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
max_packet_size (int) – The value to assign to the max_packet_size property of this Vtap.
target_type (str) – The value to assign to the target_type property of this Vtap. Allowed values for this property are: “VNIC”, “NETWORK_LOAD_BALANCER”, “IP_ADDRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
source_private_endpoint_ip (str) – The value to assign to the source_private_endpoint_ip property of this Vtap.
source_private_endpoint_subnet_id (str) – The value to assign to the source_private_endpoint_subnet_id property of this Vtap.

property capture_filter_id¶

[Required] Gets the capture_filter_id of this Vtap. The capture filter’s Oracle ID (OCID).

Returns: The capture_filter_id of this Vtap.
Return type: str

property compartment_id¶

[Required] Gets the compartment_id of this Vtap. The OCID of the compartment containing the Vtap resource.

Returns: The compartment_id of this Vtap.
Return type: str

property defined_tags¶

Gets the defined_tags of this Vtap. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns: The defined_tags of this Vtap.
Return type: dict(str, dict(str, object))

property display_name¶

Gets the display_name of this Vtap. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns: The display_name of this Vtap.
Return type: str

property encapsulation_protocol¶

Gets the encapsulation_protocol of this Vtap. Defines an encapsulation header type for the VTAP’s mirrored traffic.

Allowed values for this property are: “VXLAN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The encapsulation_protocol of this Vtap.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this Vtap. 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”}

Returns: The freeform_tags of this Vtap.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this Vtap. The VTAP’s Oracle ID (OCID).

Returns: The id of this Vtap.
Return type: str

property is_vtap_enabled¶

Gets the is_vtap_enabled of this Vtap. 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.

Returns: The is_vtap_enabled of this Vtap.
Return type: bool

property lifecycle_state¶

[Required] Gets the lifecycle_state of this Vtap. The VTAP’s administrative lifecycle state.

Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state of this Vtap.
Return type: str

property lifecycle_state_details¶

Gets the lifecycle_state_details of this Vtap. The VTAP’s current running state.

Allowed values for this property are: “RUNNING”, “STOPPED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state_details of this Vtap.
Return type: str

property max_packet_size¶

Gets the max_packet_size of this Vtap. The maximum size of the packets to be included in the filter.

Returns: The max_packet_size of this Vtap.
Return type: int

property source_id¶

[Required] Gets the source_id of this Vtap. The OCID of the source point where packets are captured.

Returns: The source_id of this Vtap.
Return type: str

property source_private_endpoint_ip¶

Gets the source_private_endpoint_ip of this Vtap. The IP Address of the source private endpoint.

Returns: The source_private_endpoint_ip of this Vtap.
Return type: str

property source_private_endpoint_subnet_id¶

Gets the source_private_endpoint_subnet_id of this Vtap. The OCID of the subnet that source private endpoint belongs to.

Returns: The source_private_endpoint_subnet_id of this Vtap.
Return type: str

property source_type¶

Gets the source_type of this Vtap. The source type for the VTAP.

Allowed values for this property are: “VNIC”, “SUBNET”, “LOAD_BALANCER”, “DB_SYSTEM”, “EXADATA_VM_CLUSTER”, “AUTONOMOUS_DATA_WAREHOUSE”, “NETWORK_FIREWALL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The source_type of this Vtap.
Return type: str

property system_tags¶

Gets the system_tags of this Vtap. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { “orcl-cloud”: { “free-tier-retained”: “true” } }

Returns: The system_tags of this Vtap.
Return type: dict(str, dict(str, object))

property target_id¶

Gets the target_id of this Vtap. The OCID of the destination resource where mirrored packets are sent.

Returns: The target_id of this Vtap.
Return type: str

property target_ip¶

Gets the target_ip of this Vtap. The IP address of the destination resource where mirrored packets are sent.

Returns: The target_ip of this Vtap.
Return type: str

property target_type¶

Gets the target_type of this Vtap. The target type for the VTAP.

Allowed values for this property are: “VNIC”, “NETWORK_LOAD_BALANCER”, “IP_ADDRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The target_type of this Vtap.
Return type: str

property time_created¶

Gets the time_created of this Vtap. The date and time the VTAP was created, in the format defined by RFC3339.

Example: 2020-08-25T21:10:29.600Z

Returns: The time_created of this Vtap.
Return type: datetime

property traffic_mode¶

Gets the traffic_mode of this Vtap. Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT

Allowed values for this property are: “DEFAULT”, “PRIORITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The traffic_mode of this Vtap.
Return type: str

property vcn_id¶

[Required] Gets the vcn_id of this Vtap. The OCID of the VCN containing the Vtap resource.

Returns: The vcn_id of this Vtap.
Return type: str

property vxlan_network_identifier¶

Gets the vxlan_network_identifier of this Vtap. The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

Returns: The vxlan_network_identifier of this Vtap.
Return type: int