capture_filters

Creates, updates, deletes, gets or lists a capture_filters resource.

Overview

Name	`capture_filters`
Type	Resource
Id	`oci.network.capture_filters`

Fields

The following fields are returned by SELECT queries:

get
list

The VTAP capture filter was retrieved.

Name	Datatype	Description
`id`	`string`	The capture filter's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)).
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capture filter.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
`displayName`	`string`	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
`filterType`	`string`	Indicates which service will use this capture filter (VTAP)
`freeformTags`	`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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`lifecycleState`	`string`	The capture filter's current administrative state. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED)
`timeCreated`	`string (date-time)`	The date and time the capture filter was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2021-08-25T21:10:29.600Z`
`vtapCaptureFilterRules`	`array`	The set of rules governing what traffic a VTAP mirrors.

A capture filter contains a set of [rules](#/en/iaas/latest/datatypes/CaptureFilterRuleDetails) governing what traffic is mirrored for a [VTAP](#/en/iaas/latest/Vtap) or captured for a [VCN Flow Log](/iaas/Content/Network/Concepts/vcn-flow-logs.htm). The capture filter is created with no rules defined, and it must have at least one rule to mirror traffic for the VTAP or collect VCN flow logs.

Name	Datatype	Description
`id`	`string`	The capture filter's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)).
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capture filter.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
`displayName`	`string`	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
`filterType`	`string`	Indicates which service will use this capture filter (VTAP)
`freeformTags`	`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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`lifecycleState`	`string`	The capture filter's current administrative state. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED)
`timeCreated`	`string (date-time)`	The date and time the capture filter was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2021-08-25T21:10:29.600Z`
`vtapCaptureFilterRules`	`array`	The set of rules governing what traffic a VTAP mirrors.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`captureFilterId`, `region`	`opc-request-id`	Gets information about the specified VTAP capture filter.
`list`	`select`	`compartmentId`, `region`	`limit`, `page`, `opc-request-id`, `sortBy`, `sortOrder`, `displayName`, `lifecycleState`	Lists the capture filters in the specified compartment.<br />
`create`	`insert`	`region`, `compartmentId`, `filterType`	`opc-retry-token`, `opc-request-id`	Creates a virtual test access point (VTAP) capture filter in the specified compartment.<br /><br />For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains<br />the VTAP. For more information about compartments and access control, see<br />[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).<br />For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).<br /><br />You may optionally specify a display name for the VTAP, otherwise a default is provided.<br />It does not have to be unique, and you can change it.<br />
`update`	`update`	`captureFilterId`, `region`	`if-match`, `opc-request-id`	Updates the specified VTAP capture filter's display name or tags.<br />
`delete`	`delete`	`captureFilterId`, `region`	`if-match`, `opc-request-id`	Deletes the specified VTAP capture filter. This is an asynchronous operation. The VTAP capture filter's `lifecycleState` will<br />change to TERMINATING temporarily until the VTAP capture filter is completely removed.<br />
`change_compartment`	`exec`	`captureFilterId`, `region`, `compartmentId`	`if-match`, `opc-request-id`, `opc-retry-token`	Moves a capture filter to a new compartment in the same tenancy. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`captureFilterId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the capture filter.
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
`region`	`string`	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
`displayName`	`string`	A filter to return only resources that match the given display name exactly.
`if-match`	`string`	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`lifecycleState`	`string`	A filter to return only resources that match the given capture filter lifecycle state. The state value is case-insensitive.
`limit`	`integer`	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50`
`opc-request-id`	`string`	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc-retry-token`	`string`	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`page`	`string`	For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
`sortBy`	`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.
`sortOrder`	`string`	The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.

`SELECT` examples

get
list

Gets information about the specified VTAP capture filter.

SELECT
id,
compartmentId,
definedTags,
displayName,
filterType,
freeformTags,
lifecycleState,
timeCreated,
vtapCaptureFilterRules
FROM oci.network.capture_filters
WHERE captureFilterId = '{{ captureFilterId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

Lists the capture filters in the specified compartment.

SELECT
id,
compartmentId,
definedTags,
displayName,
filterType,
freeformTags,
lifecycleState,
timeCreated,
vtapCaptureFilterRules
FROM oci.network.capture_filters
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-request-id = '{{ opc-request-id }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND displayName = '{{ displayName }}'
AND lifecycleState = '{{ lifecycleState }}'
;

`INSERT` examples

create
Manifest

Creates a virtual test access point (VTAP) capture filter in the specified compartment. For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the VTAP. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). 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.

INSERT INTO oci.network.capture_filters (
compartmentId,
definedTags,
displayName,
filterType,
freeformTags,
vtapCaptureFilterRules,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ filterType }}' /* required */,
'{{ freeformTags }}',
'{{ vtapCaptureFilterRules }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
filterType,
freeformTags,
lifecycleState,
timeCreated,
vtapCaptureFilterRules
;

# Description fields are for documentation purposes
- name: capture_filters
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the capture_filters resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capture filter.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a
      namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Operations": {"CostCenter": "42"}}`
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A user-friendly name. Does not have to be unique, and it's changeable.
      Avoid entering confidential information.
  - name: filterType
    value: "{{ filterType }}"
    description: |
      Indicates which service will use this capture filter
    valid_values: ['VTAP']
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      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](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: vtapCaptureFilterRules
    description: |
      The set of rules governing what traffic a VTAP mirrors.
    value:
      - destinationCidr: "{{ destinationCidr }}"
        icmpOptions:
          code: {{ code }}
          type: {{ type }}
        protocol: "{{ protocol }}"
        ruleAction: "{{ ruleAction }}"
        sourceCidr: "{{ sourceCidr }}"
        tcpOptions:
          destinationPortRange:
            max: {{ max }}
            min: {{ min }}
          sourcePortRange:
            max: {{ max }}
            min: {{ min }}
        trafficDirection: "{{ trafficDirection }}"
        udpOptions:
          destinationPortRange:
            max: {{ max }}
            min: {{ min }}
          sourcePortRange:
            max: {{ max }}
            min: {{ min }}
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
    description: Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 

`UPDATE` examples

update

Updates the specified VTAP capture filter's display name or tags.

UPDATE oci.network.capture_filters
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
vtapCaptureFilterRules = '{{ vtapCaptureFilterRules }}'
WHERE 
captureFilterId = '{{ captureFilterId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
filterType,
freeformTags,
lifecycleState,
timeCreated,
vtapCaptureFilterRules;

`DELETE` examples

delete

Deletes the specified VTAP capture filter. This is an asynchronous operation. The VTAP capture filter's lifecycleState will change to TERMINATING temporarily until the VTAP capture filter is completely removed.

DELETE FROM oci.network.capture_filters
WHERE captureFilterId = '{{ captureFilterId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;

Lifecycle Methods

change_compartment

Moves a capture filter to a new compartment in the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

EXEC oci.network.capture_filters.change_compartment 
@captureFilterId='{{ captureFilterId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​