Show / Hide Table of Contents

Namespace Oci.NetworkfirewallService.Models

Classes

AddressList

List of addresses with a reference name. The value of an entry is a list of IP addresses or prefixes in CIDR notation or FQDNs. The associated key is the identifier by which the IP address list is referenced.

AddressListSummary

Address List Summary in the network firewall policy

AddressListSummaryCollection

Collection of Address Lists in the network firewall policy

Application

A protocol identifier (such as TCP, UDP, or ICMP) and protocol-specific parameters (such as a port range).

ApplicationGroup

A group of applications.

ApplicationGroupSummary

Summary object for application list in the network firewall policy.

ApplicationGroupSummaryCollection

Collection of Application Lists in the network firewall policy

ApplicationModelConverter

ApplicationSummary

Summary object for application element in the network firewall policy.

ApplicationSummaryCollection

Collection of Applications in the network firewall policy

ApplicationSummaryModelConverter

ApplyNetworkFirewallPolicyDetails

Request data required to clone a network firewall policy.

ChangeNetworkFirewallCompartmentDetails

The information to be updated.

ChangeNetworkFirewallPolicyCompartmentDetails

The request details required to move the resource to target compartment.

CloneNetworkFirewallPolicyDetails

Request data required to clone a network firewall policy.

CreateAddressListDetails

The Request for creating the address List

CreateApplicationDetails

Request for creating a application against a policy.

CreateApplicationDetailsModelConverter

CreateApplicationGroupDetails

Request for creating a application list in a policy.

CreateDecryptionProfileDetails

Request for Decryption Profile used on the firewall policy rules.

CreateDecryptionProfileDetailsModelConverter

CreateDecryptionRuleDetails

Request for creating Decryption Rule used in the firewall policy rules. A Decryption Rule is used to define which traffic should be decrypted by the firewall, and how it should do so.

CreateIcmp6ApplicationDetails

Request for ICMP6 Application used on the firewall policy rules.

CreateIcmpApplicationDetails

Request for ICMP Application used on the firewall policy rules.

CreateMappedSecretDetails

The Request for creating the Mapped Secret

CreateMappedSecretDetailsModelConverter

CreateNatRuleDetails

Request for creating Nat Rule used in the firewall policy. A Nat Rule is used to define to which traffic NAT should be applied by the firewall, and how it should do so.

CreateNatRuleDetailsModelConverter

CreateNatV4RuleDetails

Request for creating NATV4 type Nat Rule used in the firewall policy.

CreateNetworkFirewallDetails

The information about new Network Firewall.

CreateNetworkFirewallPolicyDetails

Request data required to create a network firewall policy.

CreateSecurityRuleDetails

Reqeust for creating Security Rule used in the firewall policy rules. Security Rules determine whether to block or allow a session based on traffic attributes, such as the source and destination IP address, protocol/port, and the HTTP(S) target URL.

CreateServiceDetails

Request for creating a service against a policy.

CreateServiceDetailsModelConverter

CreateServiceListDetails

Request for creating a service list in a policy.

CreateSslForwardProxyProfileDetails

Request for creating SSLForwardProxy used on the firewall policy rules.

CreateSslInboundInspectionProfileDetails

Request for creating SSLInboundInspection used on the firewall policy rules.

CreateTcpServiceDetails

Request for TCP Service used on the firewall policy rules.

CreateTunnelInspectionRuleDetails

Request for creating 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 Inspection protocol, the source and destination IP address.

CreateTunnelInspectionRuleDetailsModelConverter

CreateUdpServiceDetails

Request for UDP Service used on the firewall policy rules.

CreateUrlListDetails

The Request for creating the URL List

CreateVaultMappedSecretDetails

The request details to be created in the Vault Mapped Secret for the policy.

CreateVxlanInspectionRuleDetails

Request for creating Vxlan Tunnel Inspection Rule used in the firewall policy rules.

DecryptionProfile

Decryption Profile used on the firewall policy rules.

DecryptionProfileModelConverter

DecryptionProfileSummary

Decryption Profile used on the firewall policy rules.

DecryptionProfileSummaryCollection

Collection of Decryption Profiles in the network firewall policy

DecryptionRule

Decryption Rule used in the firewall policy rules. A Decryption Rule is used to define which traffic should be decrypted by the firewall, and how it should do so.

DecryptionRuleMatchCriteria

Match criteria used in Decryption Rule used on the firewall policy rules.

DecryptionRuleSummary

Summary for Decryption Rule used in the firewall policy rules. A Decryption Rule is used to define which traffic should be decrypted by the firewall, and how it should do so.

DecryptionRuleSummaryCollection

Collection of Decryption Rule Summaries in the network firewall policy

Icmp6Application

ICMP6 Application used on the firewall policy rules.

Icmp6ApplicationSummary

Summary object for ICMP V6 application element in the network firewall policy.

IcmpApplication

ICMP Application used on the firewall policy rules.

IcmpApplicationSummary

Summary object for ICMP application element in the network firewall policy.

MappedSecret

Mapped secret used on the firewall policy rules.

MappedSecretModelConverter

MappedSecretSummary

Mapped secret used on the firewall policy rules.

MappedSecretSummaryCollection

Collection of Mapped Secrets in the network firewall policy

NatConfigurationRequest

Nat Configuration request to use Nat feature on firewall.

NatConfigurationResponse

Nat Configuration response.

NatRule

A Nat Rule is used to define to which traffic NAT should be applied by the firewall.

NatRuleCollection

Collection of Nat Rule Summaries in the network firewall policy

NatRuleMatchCriteria

Match criteria used in NAT Rule used on the firewall policy.

NatRuleModelConverter

NatRuleSummary

Summary of NAT Rules used in the firewall policy. A Nat Rule is used to define which traffic NAT should be applied by the firewall, and how it should do so.

NatRuleSummaryModelConverter

NatV4NatRule

A Nat Rule is used to define to which traffic NAT should be applied by the firewall.

NatV4NatSummary

Request for updating NATV4 type Nat Rule used in the firewall policy.

NetworkFirewall

A network firewall is a security resource that exists in a subnet of your choice and controls incoming and outgoing network traffic based on a set of security rules. Each firewall is associated with a policy. Traffic is routed to and from the firewall from resources such as internet gateways and dynamic routing gateways (DRGs). For more information, see Overview of Network Firewall

NetworkFirewallCollection

A collection of NetworkFirewallSummary items.

NetworkFirewallPolicy

Description of NetworkFirewall Policy.

NetworkFirewallPolicySummary

Summary of the NetworkFirewall Policy.

NetworkFirewallPolicySummaryCollection

Collection of Network Firewall Policies.

NetworkFirewallSummary

Summary of the Network Firewall.

PortRange

A Port Range which can be used for the running service. It uses port information.

RulePosition

An object which defines the position of the rule.

SecurityRule

Security Rule used in the firewall policy rules. Security Rules determine whether to block or allow a session based on traffic attributes, such as the source and destination IP address, protocol/port, and the HTTP(S) target URL.

SecurityRuleMatchCriteria

Criteria to evaluate against network traffic. A match occurs when at least one item in the array associated with each specified property corresponds with the relevant aspect of the traffic.

SecurityRuleSummary

Summary for the Security Rule used in the firewall policy rules. Security Rules determine whether to block or allow a session based on traffic attributes, such as the source and destination IP address, protocol/port, and the HTTP(S) target URL.

SecurityRuleSummaryCollection

Collection of Security Rule Summaries in the network firewall policy

Service

ServiceList

A group of services.

ServiceListSummary

Summary object for service list in the network firewall policy.

ServiceListSummaryCollection

Collection of Service Lists in the network firewall policy

ServiceModelConverter

ServiceSummary

Summary object for service element in the network firewall policy.

ServiceSummaryCollection

Collection of Services in the network firewall policy

SimpleUrlPattern

Pattern describing an http/https URL or set thereof as a concatenation of optional host component and optional path component.
*.example.com will match http://example.com/ and https://foo.example.com/foo?bar.
www.example.com/foo* will match https://www.example.com/foo and http://www.exampe.com/foobar and https://www.example.com/foo/bar?baz, but not http://sub.www.example.com/foo or https://www.example.com/FOO.
*.example.com/foo* will match http://example.com/foo and https://sub2.sub.example.com/foo/bar?baz, but not http://example.com/FOO.

SslForwardProxyProfile

SSLForwardProxy used on the firewall policy rules.

SslInboundInspectionProfile

SSLInboundInspection used on the firewall policy rules.

TcpService

TCP Service used on the firewall policy rules.

TunnelInspectionRule

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 addresses.

TunnelInspectionRuleModelConverter

TunnelInspectionRuleSummary

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.

TunnelInspectionRuleSummaryCollection

Collection of Tunnel Inspection Rule Summaries in the network firewall policy

TunnelInspectionRuleSummaryModelConverter

UdpService

UDP Service used on the firewall policy rules.

UpdateAddressListDetails

The request details to be updated in the address List for the policy.

UpdateAddressListDetailsModelConverter

UpdateApplicationDetails

Request for updating an existing application in context to the network firewall policy.

UpdateApplicationDetailsModelConverter

UpdateApplicationGroupDetails

Request for updating an existing application in context to the network firewall policy.

UpdateDecryptionProfileDetails

Update Request for Decryption Profile used on the firewall policy rules.

UpdateDecryptionProfileDetailsModelConverter

UpdateDecryptionRuleDetails

Request for updating Decryption Rule used in the firewall policy rules. A Decryption Rule is used to define which traffic should be decrypted by the firewall, and how it should do so.

UpdateFqdnAddressListDetails

The request details to be updated in the address List for the policy.

UpdateIcmp6ApplicationDetails

Request for updating ICMP6 Application used on the firewall policy rules.

UpdateIcmpApplicationDetails

Request for updating ICMP Application used on the firewall policy rules.

UpdateIpAddressListDetails

The request details to be updated in the address List for the policy.

UpdateMappedSecretDetails

The request details to be updated in the Mapped Secret for the policy.

UpdateMappedSecretDetailsModelConverter

UpdateNatRuleDetails

Request for updating NAT Rule used in the firewall policy. A Nat Rule is used to define to which traffic NAT should be applied by the firewall, and how it should do so.

UpdateNatRuleDetailsModelConverter

UpdateNatV4RuleDetails

Request for updating NATV4 type Nat Rule used in the firewall policy.

UpdateNetworkFirewallDetails

The information to be updated.

UpdateNetworkFirewallPolicyDetails

The request details to be updated in the firewall policy.

UpdateSecurityRuleDetails

Update Request for Security Rule used in the firewall policy rules. Security Rules determine whether to block or allow a session based on traffic attributes, such as the source and destination IP address, protocol/port, and the HTTP(S) target URL.

UpdateServiceDetails

Request for updating an existing service in context to the network firewall policy.

UpdateServiceDetailsModelConverter

UpdateServiceListDetails

Request for updating an existing service in context to the network firewall policy.

UpdateSslForwardProxyProfileDetails

Update Request for SSLForwardProxy used on the firewall policy rules.

UpdateSslInboundInspectionProfileDetails

Update Request for SSLInboundInspection used on the firewall policy rules.

UpdateTcpServiceDetails

Request for updating TCP Service.

UpdateTunnelInspectionRuleDetails

Update Request for creating 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.

UpdateTunnelInspectionRuleDetailsModelConverter

UpdateUdpServiceDetails

Request for updating UDP Service used on the firewall policy rules.

UpdateUrlListDetails

The request details to be updated in the URL List for the policy.

UpdateVaultMappedSecretDetails

The request details to be updated in the Vault Mapped Secret for the policy.

UpdateVxlanInspectionRuleDetails

Update Request for creating Vxlan Tunnel Inspection Rule used in the firewall policy rules.

UrlList

URL pattern lists of the policy. The value of an entry is a list of URL patterns. The associated key/name is the identifier by which the URL pattern list is referenced.

UrlListSummary

URL List Summary in the network firewall policy

UrlListSummaryCollection

Collection of URL Lists in the network firewall policy

UrlPattern

Pattern describing a URL or set of URLs.

UrlPatternModelConverter

VaultMappedSecret

Mapped secret stored in OCI vault used in the firewall policy rules.

VxlanInspectionRule

Vxlan Tunnel Inspection Rule used on the firewall policy rules.

VxlanInspectionRuleMatchCriteria

Criteria to evaluate against incoming network traffic. A match occurs when at least one item in the array associated with each specified property corresponds with the relevant aspect of the traffic.

VxlanInspectionRuleProfile

Vxlan Inspect profile used in Vxlan Tunnel Inspection Rules.

VxlanInspectionRuleSummary

Vxlan Tunnel Inspection Rule used on the firewall policy rules.

WorkRequest

A description of workrequest status

WorkRequestError

An error encountered while executing a work request.

WorkRequestErrorCollection

Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.

WorkRequestLogEntry

A log message from the execution of a work request.

WorkRequestLogEntryCollection

Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.

WorkRequestResource

A resource created or operated on by a work request.

WorkRequestSummary

A summary of the status of a work request.

WorkRequestSummaryCollection

Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

Enums

ActionType

Possible types of actions.

AddressListType

Type of address List. The accepted values are - * FQDN - An address list which contains Fully Qualified Domain Names as elements. * IP - - An address list which contains IP Addresses as elements.

AppType

Application Type:

  • ICMP - An ICMP application.
  • ICMPv6 - An ICMPv6 support application.

DecryptionActionType

Action:

  • NO_DECRYPT - Matching traffic is not decrypted.
  • DECRYPT - Matching traffic is decrypted with the specified secret according to the specified decryptionProfile.

InspectActionType

Types of Inspect Action on the traffic flow.

  • INSPECT - Inspect the traffic.
  • INSPECT_AND_CAPTURE_LOG - Inspect and capture logs for the traffic.

InspectionType

Type of the secrets mapped based on the policy.

  • SSL_INBOUND_INSPECTION: For Inbound inspection of SSL traffic.
  • SSL_FORWARD_PROXY: For forward proxy certificates for SSL inspection.

LifecycleState

Possible lifecycle states.

MappedSecretType

Types of Mapped Secrets based on the source of data for Mapped Secret.

  • OCI_VAULT : Mapped Secrets with using data from OCI Vaults.

NatType

Action:

  • NATV4 - IPv4 type NAT.

NatV4ActionType

Types of NAT action support for NATv4 type NAT.

  • DIPP_SRC_NAT - Dynamic-ip-port source NAT.

OperationStatus

Possible operation status.

OperationType

Possible operation types.

ServiceType

Possible service types supported for Network Firewall Policy.

SortOrder

Sort orders.

TrafficActionType

Types of Action on the Traffic flow.

  • ALLOW - Allows the traffic.
  • DROP - Silently drops the traffic, e.g. without sending a TCP reset.
  • REJECT - Rejects the traffic, sending a TCP reset to client and/or server as applicable.
  • INSPECT - Inspects traffic for vulnerability as specified in inspection, which may result in rejection.

TrafficInspectionType

Type of inspection to affect the Traffic flow. This is only applicable if action is INSPECT.

  • INTRUSION_DETECTION - Intrusion Detection.
  • INTRUSION_PREVENTION - Intrusion Detection and Prevention. Traffic classified as potentially malicious will be rejected as described in type.

TunnelInspectionProtocol

Types of Tunnel Inspection Protocol to be applied on the traffic.

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

UrlPattern.TypeEnum

WorkRequestResourceMetadataKey

Possible Metadata keys for workRequest resource metadata

In this article
Back to top