Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SecurityRule

A security rule is one of the items in a NetworkSecurityGroup. It is a virtual firewall rule for the VNICs in the network security group. A rule can be for either inbound ({@code direction}= INGRESS) or outbound ({@code direction}= EGRESS) IP packets.

Properties

Optional description

description: undefined | string

An optional description of your choice for the rule.

Optional destination

destination: undefined | string

Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.

Allowed values:

An IP address range in CIDR notation. For example: {@code 192.168.1.0/24} or {@code 2001:0db8:0123:45::/56} IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).

The {@code cidrBlock} value for a Service, if you're setting up a security rule for traffic destined for a particular {@code Service} through a service gateway. For example: {@code oci-phx-objectstorage}.

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup in the same VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control traffic between VNICs in the same NSG.

Optional destinationType

destinationType: DestinationType

Type of destination for the rule. Required if {@code direction} = {@code EGRESS}.

Allowed values:

{@code CIDR_BLOCK}: If the rule's {@code destination} is an IP address range in CIDR notation.

{@code SERVICE_CIDR_BLOCK}: If the rule's {@code destination} is the {@code cidrBlock} value for a Service (the rule is for traffic destined for a particular {@code Service} through a service gateway).

{@code NETWORK_SECURITY_GROUP}: If the rule's {@code destination} is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup.

direction

direction: Direction

Direction of the security rule. Set to {@code EGRESS} for rules to allow outbound IP packets, or {@code INGRESS} for rules to allow inbound IP packets.

Optional icmpOptions

icmpOptions: model.IcmpOptions

Optional id

id: undefined | string

An Oracle-assigned identifier for the security rule. You specify this ID when you want to update or delete the rule.

Example: {@code 04ABEC}

Optional isStateless

isStateless: undefined | false | true

A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.

Optional isValid

isValid: undefined | false | true

Whether the rule is valid. The value is {@code True} when the rule is first created. If the rule's {@code source} or {@code destination} is a network security group, the value changes to {@code False} if that network security group is deleted.

protocol

protocol: string

The transport protocol. Specify either {@code all} or an IPv4 protocol number as defined in Protocol Numbers. Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").

Optional source

source: undefined | string

Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.

Allowed values:

An IP address range in CIDR notation. For example: {@code 192.168.1.0/24} or {@code 2001:0db8:0123:45::/56} IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).

The {@code cidrBlock} value for a Service, if you're setting up a security rule for traffic coming from a particular {@code Service} through a service gateway. For example: {@code oci-phx-objectstorage}.

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup in the same VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control traffic between VNICs in the same NSG.

Optional sourceType

sourceType: SourceType

Type of source for the rule. Required if {@code direction} = {@code INGRESS}.

{@code CIDR_BLOCK}: If the rule's {@code source} is an IP address range in CIDR notation.

{@code SERVICE_CIDR_BLOCK}: If the rule's {@code source} is the {@code cidrBlock} value for a Service (the rule is for traffic coming from a particular {@code Service} through a service gateway).

{@code NETWORK_SECURITY_GROUP}: If the rule's {@code source} is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup.

Optional tcpOptions

tcpOptions: model.TcpOptions

Optional timeCreated

timeCreated: Date

The date and time the security rule was created. Format defined by RFC3339.

Optional udpOptions

udpOptions: model.UdpOptions

Functions

getDeserializedJsonObj

getJsonObj