oracle.oci.oci_network_capture_filter_actions – Perform actions on a CaptureFilter resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a CaptureFilter resource in Oracle Cloud Infrastructure

  • For action=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.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • change_compartment
The action to perform on the CaptureFilter.
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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
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 / required
The OCID of the capture filter.

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 / required
The OCID of the destination compartment for the VTAP capture filter move.
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.
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.
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
wait
boolean
    Choices:
  • no
  • yes ←
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.

Examples

- name: Perform action change_compartment on capture_filter
  oci_network_capture_filter_actions:
    # required
    capture_filter_id: "ocid1.capturefilter.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

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)