oracle / oracle.oci / 4.43.0 / module / oci_network_capture_filter Manage a CaptureFilter resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_network_capture_filter (4.43.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.43.0
collections: - name: oracle.oci version: 4.43.0
This module allows the user to create, update and delete a CaptureFilter resource in Oracle Cloud Infrastructure
For I(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 L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the VTAP. For more information about compartments and access control, see L(Overview of the IAM Service,https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see L(Resource Identifiers,https://docs.cloud.oracle.com/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.
This resource has the following action operations in the M(oracle.oci.oci_network_capture_filter_actions) module: change_compartment.
- 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
wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present - absent default: present description: - The state of the CaptureFilter. - Use I(state=present) to create or update a CaptureFilter. - Use I(state=absent) to delete a CaptureFilter. required: false type: str key_by: description: 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. elements: str type: list region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str cert_bundle: description: - 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. type: str filter_type: choices: - VTAP description: - Indicates which service will use this capture filter - Required for create using I(state=present). type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Operations": {"CostCenter": "42"}}`' - This parameter is updatable. type: dict display_name: aliases: - name description: - 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 C(OCI_USE_NAME_AS_IDENTIFIER) is set. - This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str force_create: default: false description: 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 I(key_by). type: bool wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int freeform_tags: 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 L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' - This parameter is updatable. type: dict compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capture filter. - Required for create using I(state=present). - Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str capture_filter_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the capture filter. - Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. - Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str vtap_capture_filter_rules: description: - The set of rules governing what traffic a VTAP mirrors. - This parameter is updatable. elements: dict suboptions: destination_cidr: description: - Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target. type: str icmp_options: description: - '' suboptions: code: description: - The ICMP code (optional). type: int type: description: - The ICMP type. required: true type: int type: dict protocol: description: - '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' type: str rule_action: choices: - INCLUDE - EXCLUDE description: - Include or exclude packets meeting this definition from mirrored traffic. type: str source_cidr: description: - Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target. type: str tcp_options: description: - '' suboptions: destination_port_range: description: - '' suboptions: max: description: - 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. required: true type: int min: description: - The minimum port number, which must not be greater than the maximum port number. required: true type: int type: dict source_port_range: description: - '' suboptions: max: description: - 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. required: true type: int min: description: - The minimum port number, which must not be greater than the maximum port number. required: true type: int type: dict type: dict traffic_direction: choices: - INGRESS - EGRESS description: - The traffic direction the VTAP is configured to mirror. required: true type: str udp_options: description: - '' suboptions: destination_port_range: description: - '' suboptions: max: description: - 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. required: true type: int min: description: - The minimum port number, which must not be greater than the maximum port number. required: true type: int type: dict source_port_range: description: - '' suboptions: max: description: - 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. required: true type: int min: description: - The minimum port number, which must not be greater than the maximum port number. required: true type: int type: dict type: dict type: list realm_specific_endpoint_template_enabled: description: - 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. type: bool
capture_filter: contains: compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capture filter. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Operations": {"CostCenter": "42"}}`' returned: on success sample: Operations: CostCenter: US type: dict display_name: description: - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. returned: on success sample: display_name_example type: str filter_type: description: - Indicates which service will use this capture filter returned: on success sample: VTAP type: str freeform_tags: 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 L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The capture filter's Oracle ID (L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_state: description: - The capture filter's current administrative state. returned: on success sample: PROVISIONING type: str time_created: description: - The date and time the capture filter was created, in the format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339). - 'Example: `2021-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str vtap_capture_filter_rules: contains: destination_cidr: description: - Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target. returned: on success sample: destination_cidr_example type: str icmp_options: contains: code: description: - The ICMP code (optional). returned: on success sample: 56 type: int type: description: - The ICMP type. returned: on success sample: 56 type: int description: - '' returned: on success type: complex protocol: description: - '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' returned: on success sample: protocol_example type: str rule_action: description: - Include or exclude packets meeting this definition from mirrored traffic. returned: on success sample: INCLUDE type: str source_cidr: description: - Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target. returned: on success sample: source_cidr_example type: str tcp_options: contains: destination_port_range: contains: max: description: - 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. returned: on success sample: 56 type: int min: description: - The minimum port number, which must not be greater than the maximum port number. returned: on success sample: 56 type: int description: - '' returned: on success type: complex source_port_range: contains: max: description: - 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. returned: on success sample: 56 type: int min: description: - The minimum port number, which must not be greater than the maximum port number. returned: on success sample: 56 type: int description: - '' returned: on success type: complex description: - '' returned: on success type: complex traffic_direction: description: - The traffic direction the VTAP is configured to mirror. returned: on success sample: INGRESS type: str udp_options: contains: destination_port_range: contains: max: description: - 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. returned: on success sample: 56 type: int min: description: - The minimum port number, which must not be greater than the maximum port number. returned: on success sample: 56 type: int description: - '' returned: on success type: complex source_port_range: contains: max: description: - 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. returned: on success sample: 56 type: int min: description: - The minimum port number, which must not be greater than the maximum port number. returned: on success sample: 56 type: int description: - '' returned: on success type: complex description: - '' returned: on success type: complex description: - The set of rules governing what traffic a VTAP mirrors. returned: on success type: complex description: - Details of the CaptureFilter resource acted upon by the current operation returned: on success 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 type: complex