oracle.oci.oci_network_capture_filter – Manage a CaptureFilter resource 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_capture_filter
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a CaptureFilter resource in Oracle Cloud Infrastructure
For state=present, creates a virtual test access point (VTAP) capture filter in the specified compartment.
For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
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.
This resource has the following action operations in the oracle.oci.oci_network_capture_filter_actions module: change_compartment.
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. |
|||
capture_filter_id
string
|
The OCID of the capture filter.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||||
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 containing the capture filter.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
||||
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 . |
||||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
||||
display_name
string
|
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create, update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
||||
filter_type
string
|
|
Indicates which service will use this capture filter
Required for create using state=present.
|
|||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
|||
freeform_tags
dictionary
|
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"}`
This parameter is updatable.
|
||||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
||||
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. |
||||
state
string
|
|
The state of the CaptureFilter.
Use state=present to create or update a CaptureFilter.
Use state=absent to delete a CaptureFilter.
|
|||
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 |
||||
vtap_capture_filter_rules
list
/ elements=dictionary
|
The set of rules governing what traffic a VTAP mirrors.
This parameter is updatable.
|
||||
destination_cidr
string
|
Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.
|
||||
icmp_options
dictionary
|
|||||
code
integer
|
The ICMP code (optional).
|
||||
type
integer
/ required
|
The ICMP type.
|
||||
protocol
string
|
The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are: * 1 = ICMP * 6 = TCP * 17 = UDP
|
||||
rule_action
string
|
|
Include or exclude packets meeting this definition from mirrored traffic.
|
|||
source_cidr
string
|
Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.
|
||||
tcp_options
dictionary
|
|||||
destination_port_range
dictionary
|
|||||
max
integer
/ required
|
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
|
||||
min
integer
/ required
|
The minimum port number, which must not be greater than the maximum port number.
|
||||
source_port_range
dictionary
|
|||||
max
integer
/ required
|
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
|
||||
min
integer
/ required
|
The minimum port number, which must not be greater than the maximum port number.
|
||||
traffic_direction
string
/ required
|
|
The traffic direction the VTAP is configured to mirror.
|
|||
udp_options
dictionary
|
|||||
destination_port_range
dictionary
|
|||||
max
integer
/ required
|
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
|
||||
min
integer
/ required
|
The minimum port number, which must not be greater than the maximum port number.
|
||||
source_port_range
dictionary
|
|||||
max
integer
/ required
|
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
|
||||
min
integer
/ required
|
The minimum port number, which must not be greater than the maximum port number.
|
||||
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
|||
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create capture_filter
oci_network_capture_filter:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
filter_type: VTAP
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
vtap_capture_filter_rules:
- # required
traffic_direction: INGRESS
# optional
rule_action: INCLUDE
source_cidr: source_cidr_example
destination_cidr: destination_cidr_example
protocol: protocol_example
icmp_options:
# required
type: 56
# optional
code: 56
tcp_options:
# optional
destination_port_range:
# required
max: 56
min: 56
source_port_range:
# required
max: 56
min: 56
udp_options:
# optional
destination_port_range:
# required
max: 56
min: 56
source_port_range:
# required
max: 56
min: 56
freeform_tags: {'Department': 'Finance'}
- name: Update capture_filter
oci_network_capture_filter:
# required
capture_filter_id: "ocid1.capturefilter.oc1..xxxxxxEXAMPLExxxxxx"
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
vtap_capture_filter_rules:
- # required
traffic_direction: INGRESS
# optional
rule_action: INCLUDE
source_cidr: source_cidr_example
destination_cidr: destination_cidr_example
protocol: protocol_example
icmp_options:
# required
type: 56
# optional
code: 56
tcp_options:
# optional
destination_port_range:
# required
max: 56
min: 56
source_port_range:
# required
max: 56
min: 56
udp_options:
# optional
destination_port_range:
# required
max: 56
min: 56
source_port_range:
# required
max: 56
min: 56
freeform_tags: {'Department': 'Finance'}
- name: Update capture_filter using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_network_capture_filter:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
vtap_capture_filter_rules:
- # required
traffic_direction: INGRESS
# optional
rule_action: INCLUDE
source_cidr: source_cidr_example
destination_cidr: destination_cidr_example
protocol: protocol_example
icmp_options:
# required
type: 56
# optional
code: 56
tcp_options:
# optional
destination_port_range:
# required
max: 56
min: 56
source_port_range:
# required
max: 56
min: 56
udp_options:
# optional
destination_port_range:
# required
max: 56
min: 56
source_port_range:
# required
max: 56
min: 56
freeform_tags: {'Department': 'Finance'}
- name: Delete capture_filter
oci_network_capture_filter:
# required
capture_filter_id: "ocid1.capturefilter.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete capture_filter using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_network_capture_filter:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||||
---|---|---|---|---|---|---|
capture_filter
complex
|
on success |
Details of the CaptureFilter resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'filter_type': 'VTAP', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'PROVISIONING', 'time_created': '2013-10-20T19:20:30+01:00', 'vtap_capture_filter_rules': [{'destination_cidr': 'destination_cidr_example', 'icmp_options': {'code': 56, 'type': 56}, 'protocol': 'protocol_example', 'rule_action': 'INCLUDE', 'source_cidr': 'source_cidr_example', 'tcp_options': {'destination_port_range': {'max': 56, 'min': 56}, 'source_port_range': {'max': 56, 'min': 56}}, 'traffic_direction': 'INGRESS', 'udp_options': {'destination_port_range': {'max': 56, 'min': 56}, 'source_port_range': {'max': 56, 'min': 56}}}]}
|
||||
compartment_id
string
|
on success |
The OCID of the compartment containing the capture filter.
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
|
||||
filter_type
string
|
on success |
Indicates which service will use this capture filter
Sample:
VTAP
|
||||
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 capture filter's Oracle ID (OCID).
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
lifecycle_state
string
|
on success |
The capture filter's current administrative state.
Sample:
PROVISIONING
|
||||
time_created
string
|
on success |
The date and time the capture filter was created, in the format defined by RFC3339.
Example: `2021-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||||
vtap_capture_filter_rules
complex
|
on success |
The set of rules governing what traffic a VTAP mirrors.
|
||||
destination_cidr
string
|
on success |
Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.
Sample:
destination_cidr_example
|
||||
icmp_options
complex
|
on success |
|
||||
code
integer
|
on success |
The ICMP code (optional).
Sample:
56
|
||||
type
integer
|
on success |
The ICMP type.
Sample:
56
|
||||
protocol
string
|
on success |
The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are: * 1 = ICMP * 6 = TCP * 17 = UDP
Sample:
protocol_example
|
||||
rule_action
string
|
on success |
Include or exclude packets meeting this definition from mirrored traffic.
Sample:
INCLUDE
|
||||
source_cidr
string
|
on success |
Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.
Sample:
source_cidr_example
|
||||
tcp_options
complex
|
on success |
|
||||
destination_port_range
complex
|
on success |
|
||||
max
integer
|
on success |
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
Sample:
56
|
||||
min
integer
|
on success |
The minimum port number, which must not be greater than the maximum port number.
Sample:
56
|
||||
source_port_range
complex
|
on success |
|
||||
max
integer
|
on success |
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
Sample:
56
|
||||
min
integer
|
on success |
The minimum port number, which must not be greater than the maximum port number.
Sample:
56
|
||||
traffic_direction
string
|
on success |
The traffic direction the VTAP is configured to mirror.
Sample:
INGRESS
|
||||
udp_options
complex
|
on success |
|
||||
destination_port_range
complex
|
on success |
|
||||
max
integer
|
on success |
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
Sample:
56
|
||||
min
integer
|
on success |
The minimum port number, which must not be greater than the maximum port number.
Sample:
56
|
||||
source_port_range
complex
|
on success |
|
||||
max
integer
|
on success |
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
Sample:
56
|
||||
min
integer
|
on success |
The minimum port number, which must not be greater than the maximum port number.
Sample:
56
|
Authors¶
Oracle (@oracle)