TunnelInspectionRuleSummary

class oci.network_firewall.models.TunnelInspectionRuleSummary(**kwargs)

Bases: object

Summary for the Tunnel Inspection Rule used in the firewall policy rules. Tunnel Inspection Rule determines whether tunnel inspection is applied on the traffic based on attributes such as Tunnel Inspect protocol, the source and destination IP address.

Attributes:

ACTION_INSPECT

A constant which can be used with the action property of a TunnelInspectionRuleSummary.

ACTION_INSPECT_AND_CAPTURE_LOG

A constant which can be used with the action property of a TunnelInspectionRuleSummary.

PROTOCOL_VXLAN

A constant which can be used with the protocol property of a TunnelInspectionRuleSummary.

action

Gets the action of this TunnelInspectionRuleSummary.

description

Gets the description of this TunnelInspectionRuleSummary.

name

[Required] Gets the name of this TunnelInspectionRuleSummary.

parent_resource_id

[Required] Gets the parent_resource_id of this TunnelInspectionRuleSummary.

priority_order

[Required] Gets the priority_order of this TunnelInspectionRuleSummary.

protocol

[Required] Gets the protocol of this TunnelInspectionRuleSummary.

Methods:

__init__(**kwargs)

Initializes a new TunnelInspectionRuleSummary object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ACTION_INSPECT = 'INSPECT'

A constant which can be used with the action property of a TunnelInspectionRuleSummary. This constant has a value of “INSPECT”

ACTION_INSPECT_AND_CAPTURE_LOG = 'INSPECT_AND_CAPTURE_LOG'

A constant which can be used with the action property of a TunnelInspectionRuleSummary. This constant has a value of “INSPECT_AND_CAPTURE_LOG”

PROTOCOL_VXLAN = 'VXLAN'

A constant which can be used with the protocol property of a TunnelInspectionRuleSummary. This constant has a value of “VXLAN”

__init__(**kwargs)

Initializes a new TunnelInspectionRuleSummary object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • name (str) – The value to assign to the name property of this TunnelInspectionRuleSummary.

  • protocol (str) – The value to assign to the protocol property of this TunnelInspectionRuleSummary. Allowed values for this property are: “VXLAN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • action (str) – The value to assign to the action property of this TunnelInspectionRuleSummary. Allowed values for this property are: “INSPECT”, “INSPECT_AND_CAPTURE_LOG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • priority_order (int) – The value to assign to the priority_order property of this TunnelInspectionRuleSummary.

  • parent_resource_id (str) – The value to assign to the parent_resource_id property of this TunnelInspectionRuleSummary.

  • description (str) – The value to assign to the description property of this TunnelInspectionRuleSummary.

property action

Gets the action of this TunnelInspectionRuleSummary. Types of Inspect Action on the Traffic flow.

  • INSPECT - Inspect the traffic.

  • INSPECT_AND_CAPTURE_LOG - Inspect and capture logs for the traffic.

Allowed values for this property are: “INSPECT”, “INSPECT_AND_CAPTURE_LOG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The action of this TunnelInspectionRuleSummary.

Return type

str

property description

Gets the description of this TunnelInspectionRuleSummary. The description of the tunnel inspect rule. This field can be used to add additional info.

Returns

The description of this TunnelInspectionRuleSummary.

Return type

str

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property name

[Required] Gets the name of this TunnelInspectionRuleSummary. Name for the Tunnel Inspection Rule, must be unique within the policy.

Returns

The name of this TunnelInspectionRuleSummary.

Return type

str

property parent_resource_id

[Required] Gets the parent_resource_id of this TunnelInspectionRuleSummary. OCID of the Network Firewall Policy this Tunnel Inspection Rule belongs to.

Returns

The parent_resource_id of this TunnelInspectionRuleSummary.

Return type

str

property priority_order

[Required] Gets the priority_order of this TunnelInspectionRuleSummary. The priority order in which this rule should be evaluated

Returns

The priority_order of this TunnelInspectionRuleSummary.

Return type

int

property protocol

[Required] Gets the protocol of this TunnelInspectionRuleSummary. Types of Tunnel Inspection Protocol to be applied on the traffic.

  • VXLAN - VXLAN Tunnel Inspection Protocol will be applied on the traffic.

Allowed values for this property are: “VXLAN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The protocol of this TunnelInspectionRuleSummary.

Return type

str