Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Properties

captureFilterId

captureFilterId: string

The capture filter's Oracle ID (OCID).

compartmentId

compartmentId: string

The OCID of the compartment containing the {@code Vtap} resource.

Optional definedTags

definedTags: undefined | object

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

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional displayName

displayName: undefined | string

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

Optional encapsulationProtocol

encapsulationProtocol: EncapsulationProtocol

Defines an encapsulation header type for the VTAP's mirrored traffic.

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The VTAP's Oracle ID (OCID).

Optional isVtapEnabled

isVtapEnabled: undefined | false | true

Used to start or stop a {@code Vtap} resource.

{@code TRUE} directs the VTAP to start mirroring traffic. * {@code FALSE} (Default) directs the VTAP to stop mirroring traffic.

lifecycleState

lifecycleState: LifecycleState

The VTAP's administrative lifecycle state.

Optional lifecycleStateDetails

lifecycleStateDetails: LifecycleStateDetails

The VTAP's current running state.

Optional maxPacketSize

maxPacketSize: undefined | number

The maximum size of the packets to be included in the filter. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

sourceId

sourceId: string

The OCID of the source point where packets are captured.

Optional sourcePrivateEndpointIp

sourcePrivateEndpointIp: undefined | string

The IP Address of the source private endpoint.

Optional sourcePrivateEndpointSubnetId

sourcePrivateEndpointSubnetId: undefined | string

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

Optional sourceType

sourceType: SourceType

The source type for the VTAP.

Optional targetId

targetId: undefined | string

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

Optional targetIp

targetIp: undefined | string

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

Optional targetType

targetType: TargetType

The target type for the VTAP.

Optional timeCreated

timeCreated: Date

The date and time the VTAP was created, in the format defined by RFC3339.

Example: {@code 2020-08-25T21:10:29.600Z}

Optional trafficMode

trafficMode: TrafficMode

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

vcnId

vcnId: string

The OCID of the VCN containing the {@code Vtap} resource.

Optional vxlanNetworkIdentifier

vxlanNetworkIdentifier: undefined | number

The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Vtap): object

getJsonObj

  • getJsonObj(obj: Vtap): object