Class Vtap

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 {@link CaptureFilter} contains a set of {@link #captureFilterRuleDetails(CaptureFilterRuleDetailsRequest) captureFilterRuleDetails} governing what traffic a VTAP mirrors.

Inheritance

object

Vtap

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CoreService.Models

Assembly: OCI.DotNetSDK.Core.dll

Syntax

public class Vtap

Properties

CaptureFilterId

Declaration

[Required(ErrorMessage = "CaptureFilterId is required.")]
[JsonProperty(PropertyName = "captureFilterId")]
public string CaptureFilterId { get; set; }

Property Value

Type	Description
string	The capture filter's Oracle ID (OCID).

Remarks

Required

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment containing the `Vtap` resource.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

EncapsulationProtocol

Declaration

[JsonProperty(PropertyName = "encapsulationProtocol")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Vtap.EncapsulationProtocolEnum? EncapsulationProtocol { get; set; }

Property Value

Type	Description
Vtap.EncapsulationProtocolEnum?	Defines an encapsulation header type for the VTAP's mirrored traffic.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The VTAP's Oracle ID (OCID).

Remarks

Required

IsVtapEnabled

Declaration

[JsonProperty(PropertyName = "isVtapEnabled")]
public bool? IsVtapEnabled { get; set; }

Property Value

Type Description

Type	Description
bool?	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.

bool?

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.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Vtap.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Vtap.LifecycleStateEnum?	The VTAP's administrative lifecycle state.

Remarks

Required

LifecycleStateDetails

Declaration

[JsonProperty(PropertyName = "lifecycleStateDetails")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Vtap.LifecycleStateDetailsEnum? LifecycleStateDetails { get; set; }

Property Value

Type	Description
Vtap.LifecycleStateDetailsEnum?	The VTAP's current running state.

MaxPacketSize

Declaration

[JsonProperty(PropertyName = "maxPacketSize")]
public int? MaxPacketSize { get; set; }

Property Value

Type	Description
int?	The maximum size of the packets to be included in the filter.

SourceId

Declaration

[Required(ErrorMessage = "SourceId is required.")]
[JsonProperty(PropertyName = "sourceId")]
public string SourceId { get; set; }

Property Value

Type	Description
string	The OCID of the source point where packets are captured.

Remarks

Required

SourcePrivateEndpointIp

Declaration

[JsonProperty(PropertyName = "sourcePrivateEndpointIp")]
public string SourcePrivateEndpointIp { get; set; }

Property Value

Type	Description
string	The IP Address of the source private endpoint.

SourcePrivateEndpointSubnetId

Declaration

[JsonProperty(PropertyName = "sourcePrivateEndpointSubnetId")]
public string SourcePrivateEndpointSubnetId { get; set; }

Property Value

Type	Description
string	The OCID of the subnet that source private endpoint belongs to.

SourceType

Declaration

[JsonProperty(PropertyName = "sourceType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Vtap.SourceTypeEnum? SourceType { get; set; }

Property Value

Type	Description
Vtap.SourceTypeEnum?	The source type for the VTAP.

TargetId

Declaration

[JsonProperty(PropertyName = "targetId")]
public string TargetId { get; set; }

Property Value

Type	Description
string	The OCID of the destination resource where mirrored packets are sent.

TargetIp

Declaration

[JsonProperty(PropertyName = "targetIp")]
public string TargetIp { get; set; }

Property Value

Type	Description
string	The IP address of the destination resource where mirrored packets are sent.

TargetType

Declaration

[JsonProperty(PropertyName = "targetType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Vtap.TargetTypeEnum? TargetType { get; set; }

Property Value

Type	Description
Vtap.TargetTypeEnum?	The target type for the VTAP.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z

TrafficMode

Declaration

[JsonProperty(PropertyName = "trafficMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Vtap.TrafficModeEnum? TrafficMode { get; set; }

Property Value

Type	Description
Vtap.TrafficModeEnum?	Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT

VcnId

Declaration

[Required(ErrorMessage = "VcnId is required.")]
[JsonProperty(PropertyName = "vcnId")]
public string VcnId { get; set; }

Property Value

Type	Description
string	The OCID of the VCN containing the `Vtap` resource.

Remarks

Required

VxlanNetworkIdentifier

Declaration

[JsonProperty(PropertyName = "vxlanNetworkIdentifier")]
public long? VxlanNetworkIdentifier { get; set; }

Property Value

Type	Description
long?	The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.