Show / Hide Table of Contents

Namespace Oci.VnmonitoringService.Models

Classes

AccessDeniedTrafficNode

Defines the configuration of a traffic node to which the user is denied access.

AddDrgRouteDistributionStatementDetails

Details used to add a route distribution statement.

AddDrgRouteDistributionStatementsDetails

Details request to add statements to a route distribution.

AddDrgRouteRuleDetails

Details needed when adding a DRG route rule.

AddDrgRouteRulesDetails

Details used in a request to add static routes to a DRG route table.

AddNetworkSecurityGroupSecurityRulesDetails

AddSecurityRuleDetails

A rule for allowing inbound (INGRESS) or outbound (EGRESS) IP packets.

AddedNetworkSecurityGroupSecurityRules

AdhocGetPathAnalysisDetails

Defines the configuration for getting an ad-hoc path analysis.

AllowedSecurityAction

Defines the security action taken on allowed traffic.

AllowedSecurityActionDetails

Defines details for the security action taken on allowed traffic.

AllowedSecurityConfiguration

Defines the allowed security configuration for the traffic.

AllowedSecurityConfigurationModelConverter

BulkAddVirtualCircuitPublicPrefixesDetails

BulkDeleteVirtualCircuitPublicPrefixesDetails

ChangeDrgAttachmentCompartmentDetails

The configuration details for the move operation.

ChangeFlexTunnelCompartmentDetails

The configuration details for the move operation.

ChangePathAnalyzerTestCompartmentDetails

Details of the new compartmentId for the PathAnalyzerTest resource.

CompartmentInternal

Helper definition required to perform authZ using SPLAT expressions on a Compartment

ComputeInstanceEndpoint

Defines the details required for a COMPUTE_INSTANCE-type Endpoint.

ConnectLocalPeeringGatewaysDetails

Information about the other local peering gateway (LPG).

ConnectRemotePeeringConnectionsDetails

Information about the other remote peering connection (RPC).

Cpe

An object you create when setting up a Site-to-Site VPN between your on-premises network and VCN. The Cpe is a virtual representation of your customer-premises equipment, which is the actual router on-premises at your site at your end of the Site-to-Site VPN IPSec connection. For more information, see Overview of the Networking Service.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

CreateCpeDetails

CreateCrossConnectDetails

CreateCrossConnectGroupDetails

CreateDhcpDetails

CreateDrgAttachmentDetails

CreateDrgDetails

CreateDrgRouteDistributionDetails

Details used to create an import route distribution. You can't create a new export route distribution.

CreateDrgRouteTableDetails

Details used in a request to create a DRG route table.

CreateFlexTunnelBgpSessionDetails

Boarder Gateway Protocol (BGP) fields

CreateFlexTunnelConfigurationDetails

The create details for tunnel configuration.

CreateFlexTunnelConfigurationDetailsModelConverter

CreateFlexTunnelDetails

These details can be included in a request to create a flex tunnel.

CreateGreFlexTunnelConfigurationDetails

The gre tunnel configuration create details.

CreateIPSecConnectionDetails

CreateInternetGatewayDetails

CreateIpv6Details

CreateLocalPeeringGatewayDetails

CreateNetworkSecurityGroupDetails

CreatePathAnalyzerTestDetails

Details used to create a PathAnalyzerTest resource.

CreatePrivateIpDetails

CreatePublicIpDetails

CreateRemotePeeringConnectionDetails

CreateRouteTableDetails

CreateSecurityListDetails

CreateServiceGatewayDetails

CreateSubnetDetails

CreateVcnDetails

CreateVirtualCircuitDetails

CreateVirtualCircuitPublicPrefixDetails

CrossConnect

For use with Oracle Cloud Infrastructure FastConnect. A cross-connect represents a physical connection between an existing network and Oracle. Customers who are colocated with Oracle in a FastConnect location create and use cross-connects. For more information, see FastConnect Overview.
Oracle recommends you create each cross-connect in a {@link CrossConnectGroup} so you can use link aggregation with the connection.
Note: If you're a provider who is setting up a physical connection to Oracle so customers can use FastConnect over the connection, be aware that your connection is modeled the same way as a colocated customer's (with CrossConnect and CrossConnectGroup objects, and so on).
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

CrossConnectGroup

For use with Oracle Cloud Infrastructure FastConnect. A cross-connect group is a link aggregation group (LAG), which can contain one or more {@link CrossConnect}. Customers who are colocated with Oracle in a FastConnect location create and use cross-connect groups. For more information, see FastConnect Overview.
Note: If you're a provider who is setting up a physical connection to Oracle so customers can use FastConnect over the connection, be aware that your connection is modeled the same way as a colocated customer's (with CrossConnect and CrossConnectGroup objects, and so on).
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

CrossConnectLocation

An individual FastConnect location.

CrossConnectMapping

For use with Oracle Cloud Infrastructure FastConnect. Each {@link VirtualCircuit} runs on one or more cross-connects or cross-connect groups. A CrossConnectMapping contains the properties for an individual cross-connect or cross-connect group associated with a given virtual circuit.
The mapping includes information about the cross-connect or cross-connect group, the VLAN, and the BGP peering session.
If you're a customer who is colocated with Oracle, that means you own both the virtual circuit and the physical connection it runs on (cross-connect or cross-connect group), so you specify all the information in the mapping. There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.
If you're a provider, then you own the physical connection that the customer's virtual circuit runs on, so you contribute information about the cross-connect or cross-connect group and VLAN.
Who specifies the BGP peering information in the case of customer connection via provider? If the BGP session goes from Oracle to the provider's edge router, then the provider also specifies the BGP peering information. If the BGP session instead goes from Oracle to the customer's edge router, then the customer specifies the BGP peering information. There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

CrossConnectPortSpeedShape

An individual port speed level for cross-connects.

CrossConnectStatus

The status of the cross-connect.

DefaultDrgRouteTables

The default DRG route table for this DRG. Each network type has a default DRG route table.
You can update a network type to use a different DRG route table, but each network type must have a default DRG route table. You cannot delete a default DRG route table.

DeleteVirtualCircuitPublicPrefixDetails

DeniedSecurityAction

Defines the security action taken on denied traffic.

DeniedSecurityActionDetails

Defines details for the security action taken on denied traffic.

DhcpDnsOption

DHCP option for specifying how DNS (hostname resolution) is handled in the subnets in the VCN. For more information, see DNS in Your Virtual Cloud Network.

DhcpOption

A single DHCP option according to RFC 1533. The two options available to use are {@link DhcpDnsOption} and {@link DhcpSearchDomainOption}. For more information, see DNS in Your Virtual Cloud Network and DHCP Options.

DhcpOptionModelConverter

DhcpOptions

A set of DHCP options. Used by the VCN to automatically provide configuration information to the instances when they boot up. There are two options you can set:

  • {@link DhcpDnsOption}: Lets you specify how DNS (hostname resolution) is handled in the subnets in your VCN.
  • {@link DhcpSearchDomainOption}: Lets you specify a search domain name to use for DNS queries.
    For more information, see DNS in Your Virtual Cloud Network and DHCP Options.
    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

DhcpSearchDomainOption

DHCP option for specifying a search domain name for DNS queries. For more information, see DNS in Your Virtual Cloud Network.

Drg

A dynamic routing gateway (DRG) is a virtual router that provides a path for private network traffic between networks. You use it with other Networking Service components to create a connection to your on-premises network using Site-to-Site VPN or a connection that uses FastConnect. For more information, see Networking Overview.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

DrgAttachment

A DRG attachment serves as a link between a DRG and a network resource. A DRG can be attached to a VCN, IPSec tunnel, remote peering connection, or virtual circuit.
For more information, see Overview of the Networking Service.

DrgAttachmentIdDrgRouteDistributionMatchCriteria

The criteria by which a specific attachment will import routes to the DRG.

DrgAttachmentInfo

The DrgAttachmentInfo resource contains the OCID of the DRG attachment.

DrgAttachmentNetworkCreateDetails

DrgAttachmentNetworkCreateDetailsModelConverter

DrgAttachmentNetworkDetails

DrgAttachmentNetworkDetailsModelConverter

DrgAttachmentNetworkUpdateDetails

DrgAttachmentNetworkUpdateDetailsModelConverter

DrgAttachmentTypeDrgRouteDistributionMatchCriteria

The attachment type from which the DRG will import routes. Routes will be imported from all attachments of this type.

DrgCustomer

The list of IPSEC / FC / RPC info for a given DRG

DrgCustomerResource

The IPSEC / FC / RPC info returned in DrgCustomerResponse

DrgPromotionStatusResponse

The promotion/unpromotion status of a DRG

DrgRouteDistribution

A route distribution establishes how routes get imported into DRG route tables and exported through the DRG attachments.
A route distribution is a list of statements. Each statement consists of a set of matches, all of which must be True for the statement's action to take place. Each statement determines which routes are propagated.
You can assign a route distribution as a route table's import distribution. The statements in an import route distribution specify how how incoming route advertisements through a referenced attachment or all attachments of a certain type are inserted into the route table.
You can assign a route distribution as a DRG attachment's export distribution unless the attachment has the type VCN. Exporting routes through a VCN attachment is unsupported. Export route distribution statements specify how routes in a DRG attachment's assigned table are advertised out through the attachment. When a DRG is created, a route distribution is created with a single ACCEPT statement with match criteria MATCH_ALL. By default, all DRG attachments (except for those of type VCN), are assigned this distribution. You can't create a new export route distribution, one is created for you when the DRG is created.

The two auto-generated DRG route tables (one as the default for VCN attachments, and the other for all other types of attachments) are each assigned an auto generated import route distribution. The default VCN table's import distribution has a single statement with match criteria MATCH_ALL to import routes from each DRG attachment type. The other table's import distribution has a statement to import routes from attachments with the VCN type.
The route distribution is always in the same compartment as the DRG.

DrgRouteDistributionMatchCriteria

The match criteria in a route distribution statement. The match criteria outlines which routes should be imported or exported.

DrgRouteDistributionMatchCriteriaModelConverter

DrgRouteDistributionStatement

A single statement within a route distribution. All match criteria in a statement must be met for the action to take place.

DrgRouteRule

A DRG route rule is a mapping between a destination IP address range and a DRG attachment. The map is used to route matching packets. Traffic will be routed across the attachments using Equal-cost multi-path routing (ECMP) if there are multiple rules with identical destinations and none of the rules conflict.

DrgRouteTable

All routing inside the DRG is driven by the contents of DRG route tables. DRG route tables contain rules which route packets to a particular network destination, represented as a DRG attachment. The routing decision for a packet entering a DRG is determined by the rules in the DRG route table assigned to the attachment-of-entry.
Each DRG attachment can inject routes in any DRG route table, provided there is a statement corresponding to the attachment in the route table's importDrgRouteDistribution. You can also insert static routes into the DRG route tables.
The DRG route table is always in the same compartment as the DRG. There must always be a default DRG route table for each attachment type.

DrgRoutingConfiguration

Identifies the DRG route table and rule that allowed the traffic to be forwarded.

EgressSecurityListConfiguration

Defines the subnet egress security list configuration that allowed the traffic.

EgressSecurityRule

A rule for allowing outbound IP packets.

EgressTrafficSpec

Defines the traffic configuration that leaves the traffic node.

Endpoint

Information describing a source or destination in a PathAnalyzerTest resource.

EndpointModelConverter

FastConnectProviderService

A service offering from a supported provider. For more information, see FastConnect Overview.

FlexTunnel

Flex tunnel will set up a network tunnel between your SD-WAN appliance and DRG, allowing you to establish BGP and advertise routes.

FlexTunnelBgpSession

Boarder Gateway Protocol (BGP) fields.

FlexTunnelBgpStatus

Boarder Gateway Protocol (BGP) session status

FlexTunnelCollection

The list of Flex Tunnels.

FlexTunnelConfiguration

The tunnel configuration of a flex tunnel.

FlexTunnelConfigurationModelConverter

FlexTunnelDrgAttachmentNetworkCreateDetails

Specifies the flex tunnel attachment.

FlexTunnelDrgAttachmentNetworkDetails

Specifies the flex tunnel attached to the DRG.

FlexTunnelRouteSummary

A summary of the routes advertised to and received from the SD-WAN.

FlexTunnelSummary

Summary of FlexTunnel.

ForwardedRoutingAction

Defines the routing actions taken for traffic that is forwarded.

ForwardedRoutingActionDetails

Defines details for the forwarded routing action.

ForwardedRoutingConfiguration

Defines the type of the resource that forwarded traffic.

ForwardedRoutingConfigurationModelConverter

GetPathAnalysisDetails

Defines the configuration for getting a path analysis.

GetPathAnalysisDetailsModelConverter

GetPublicIpByIpAddressDetails

IP address of the public IP.

GetPublicIpByPrivateIpIdDetails

Details of the private IP that the public IP is assigned to.

GreFlexTunnelConfiguration

The gre tunnel configuration details.

IPSecConnection

A connection between a DRG and CPE. This connection consists of multiple IPSec tunnels. Creating this connection is one of the steps required when setting up a Site-to-Site VPN. For more information, see Site-to-Site VPN Overview.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

IPSecConnectionDeviceConfig

Information about the IPSecConnection device configuration.

IPSecConnectionDeviceStatus

Status of the IPSec connection.

IcmpOptions

Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

  • ICMP Parameters
  • ICMPv6 Parameters
    If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 ("Destination Unreachable") code 4 ("Fragmentation Needed and Don't Fragment was Set"). If you need to specify multiple codes for a single type, create a separate security list rule for each.

IcmpProtocolParameters

Defines the configuration for the ICMP protocol parameters.

IcmpTrafficProtocolParameters

Defines the ProtocolParameters configuration for the ICMP protocol.

IndeterminateRoutingAction

Defines the routing action taken on a traffic node where the routing action is INDETERMINATE.

IngressSecurityListConfiguration

Defines the subnet ingress security list configuration that allowed the traffic.

IngressSecurityRule

A rule for allowing inbound IP packets.

InternetDrgAttachmentNetworkCreateDetails

Create details for an "Internet" attachment for a DRG

InternetDrgAttachmentNetworkDetails

Details for an "Internet" attachment for a DRG

InternetDrgAttachmentNetworkUpdateDetails

Update details for an Internet attachment for a DRG.

InternetGateway

Represents a router that connects the edge of a VCN with the Internet. For an example scenario that uses an internet gateway, see Typical Networking Service Scenarios.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

IpAddressEndpoint

Defines the details required for an IP_ADDRESS-type Endpoint.

IpsecTunnelDrgAttachmentNetworkCreateDetails

Specifies the IPSec tunnel attachment.

IpsecTunnelDrgAttachmentNetworkDetails

Specifies the IPSec tunnel attached to the DRG.

Ipv6

An IPv6 is a conceptual term that refers to an IPv6 address and related properties. The IPv6 object is the API representation of an IPv6.
You can create and assign an IPv6 to any VNIC that is in an IPv6-enabled subnet in an IPv6-enabled VCN.
Note: IPv6 addressing is supported for all commercial and government regions. For important details about IPv6 addressing in a VCN, see IPv6 Addresses.

LetterOfAuthority

The Letter of Authority for the cross-connect. You must submit this letter when requesting cabling for the cross-connect at the FastConnect location.

LoadBalancerEndpoint

Defines the details required for a LOAD_BALANCER-type Endpoint.

LoadBalancerListenerEndpoint

Defines the details required for a LOAD_BALANCER_LISTENER-type Endpoint.

LocalPeeringGateway

A local peering gateway (LPG) is an object on a VCN that lets that VCN peer with another VCN in the same region. Peering means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see VCN Peering.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

LoopBackDrgAttachmentNetworkCreateDetails

Specifies the Loopback attachment.

LoopBackDrgAttachmentNetworkDetails

Specifies the loopback attachment on the DRG. A loopback attachment can be used to terminate a virtual circuit that is carrying an IPSec tunnel, routing traffic directly to the IPSec tunnel attachment where the tunnel can terminate.

LoopbackDrgAttachmentNetworkUpdateDetails

Specifies the update details for Loopback attachment.

NetworkLoadBalancerEndpoint

Defines the details required for a NETWORK_LOAD_BALANCER-type Endpoint.

NetworkLoadBalancerListenerEndpoint

Defines the details required for a NETWORK_LOAD_BALANCER_LISTENER-type Endpoint.

NetworkSecurityGroup

A network security group (NSG) provides virtual firewall rules for a specific set of {@link Vnic} in a VCN. Compare NSGs with {@link SecurityList}, which provide virtual firewall rules to all the VNICs in a subnet.
A network security group consists of two items:

  • The set of {@link Vnic} that all have the same security rule needs (for example, a group of Compute instances all running the same application)
  • A set of NSG {@link SecurityRule} that apply to the VNICs in the group
    After creating an NSG, you can add VNICs and security rules to it. For example, when you create an instance, you can specify one or more NSGs to add the instance to (see {@link #createVnicDetails(CreateVnicDetailsRequest) createVnicDetails}). Or you can add an existing instance to an NSG with {@link #updateVnic(UpdateVnicRequest) updateVnic}.
    To add security rules to an NSG, see {@link #addNetworkSecurityGroupSecurityRules(AddNetworkSecurityGroupSecurityRulesRequest) addNetworkSecurityGroupSecurityRules}.
    To list the VNICs in an NSG, see {@link #listNetworkSecurityGroupVnics(ListNetworkSecurityGroupVnicsRequest) listNetworkSecurityGroupVnics}.
    To list the security rules in an NSG, see {@link #listNetworkSecurityGroupSecurityRules(ListNetworkSecurityGroupSecurityRulesRequest) listNetworkSecurityGroupSecurityRules}.
    For more information about network security groups, see Network Security Groups.
    Important: Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure all of the following are set correctly:
  • Any security rules in any NSGs the instance's VNIC belongs to
  • Any {@link SecurityList} associated with the instance's subnet
  • The instance's OS firewall rules
    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

NetworkSecurityGroupVnic

Information about a VNIC that belongs to a network security group.

NetworkingTopology

Defines the representation of a virtual network topology for a region. See Network Visualizer Documentation for more information, including conventions and pictures of symbols.

NoRouteRoutingAction

Defines the routing actions taken on traffic when no route is found.

NoRouteRoutingActionDetails

Defines the routing action taken on traffic flow with no route found.

NsgConfiguration

Defines the network security group configuration that allowed the traffic.

OnPremEndpoint

Defines the details required for an ON_PREM-type Endpoint.

Path

Defines the configuration of the traffic path in PathAnalysisResult.

PathAnalysisWorkRequestResult

Defines the configuration of the path analysis result.

PathAnalyzerTest

Defines the details saved in a PathAnalyzerTest resource. These configuration details are used to run a Network Path Analyzer analysis.

PathAnalyzerTestCollection

The results of a ListPathAnalyzerTests call in the current compartment.

PathAnalyzerTestSummary

Defines the summary of a PathAnalyzerTest resource.

PathTopology

Defines the representation of a virtual network topology for path analysis.

PersistedGetPathAnalysisDetails

Defines the configuration for getting a path analysis using the persisted PathAnalyzerTest resource.

PortRange

PrivateIp

A private IP is a conceptual term that refers to an IPv4 private IP address and related properties. The privateIp object is the API representation of a private IP.
Note: For information about IPv6 addresses, see {@link Ipv6}.
Each instance has a primary private IP that is automatically created and assigned to the primary VNIC during instance launch. If you add a secondary VNIC to the instance, it also automatically gets a primary private IP. You can't remove a primary private IP from its VNIC. The primary private IP is automatically deleted when the VNIC is terminated.
You can add secondary private IPs to a VNIC after it's created. For more information, see the privateIp operations and also IP Addresses.
Note: Only {@link #listPrivateIps(ListPrivateIpsRequest) listPrivateIps} and {@link #getPrivateIp(GetPrivateIpRequest) getPrivateIp} work with primary private IPs. To create and update primary private IPs, you instead work with instance and VNIC operations. For example, a primary private IP's properties come from the values you specify in {@link CreateVnicDetails} when calling either {@link #launchInstance(LaunchInstanceRequest) launchInstance} or {@link #attachVnic(AttachVnicRequest) attachVnic}. To update the hostname for a primary private IP, you use {@link #updateVnic(UpdateVnicRequest) updateVnic}.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

PrivateServiceAccessEndpoint

Defines the details required for an PRIVATE_SERVICE_ACCESS type Endpoint.

ProtocolParameters

Defines the IP protocol parameters for a PathAnalyzerTest resource.

ProtocolParametersModelConverter

PublicIp

A public IP is a conceptual term that refers to a public IP address and related properties. The publicIp object is the API representation of a public IP.
There are two types of public IPs:

  1. Ephemeral
  2. Reserved
    For more information and comparison of the two types, see Public IP Addresses.

QueryOptions

Defines the query options required for a PathAnalyzerTest resource.

RemotePeeringConnection

A remote peering connection (RPC) is an object on a DRG that lets the VCN that is attached to the DRG peer with a VCN in a different region. Peering means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see VCN Peering.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

RemotePeeringConnectionDrgAttachmentNetworkCreateDetails

RemotePeeringConnectionDrgAttachmentNetworkDetails

Specifies the DRG attachment to another DRG.

RemoveDrgRouteDistributionStatementsDetails

Details request to remove statements from a route distribution.

RemoveDrgRouteRulesDetails

Details used in a request to remove static routes from a DRG route table.

RemoveNetworkSecurityGroupSecurityRulesDetails

RouteRule

A mapping between a destination IP address range and a virtual device to route matching packets to (a target).

RouteTable

A collection of RouteRule objects, which are used to route packets based on destination IP to a particular network entity. For more information, see Overview of the Networking Service.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

RoutingAction

Defines the details for routing actions taken on the traffic flow.

RoutingActionModelConverter

SecurityAction

Defines the security action details taken on the traffic.

SecurityActionModelConverter

SecurityList

A set of virtual firewall rules for your VCN. Security lists are configured at the subnet level, but the rules are applied to the ingress and egress traffic for the individual instances in the subnet. The rules can be stateful or stateless. For more information, see Security Lists. Note: Compare security lists to {@link NetworkSecurityGroup}s, which let you apply a set of security rules to a specific set of VNICs instead of an entire subnet. Oracle recommends using network security groups instead of security lists, although you can use either or both together.
Important: Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure both the security lists associated with the instance's subnet and the instance's firewall rules are set correctly.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

SecurityRule

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

Service

An object that represents one or multiple Oracle services that you can enable for a {@link ServiceGateway}. In the User Guide topic Access to Oracle Services: Service Gateway, the term service CIDR label is used to refer to the string that represents the regional public IP address ranges of the Oracle service or services covered by a given Service object. That unique string is the value of the Service object's cidrBlock attribute.

ServiceGateway

Represents a router that lets your VCN privately access specific Oracle services such as Object Storage without exposing the VCN to the public internet. Traffic leaving the VCN and destined for a supported Oracle service (use the {@link #listServices(ListServicesRequest) listServices} operation to find available service CIDR labels) is routed through the service gateway and does not traverse the internet. The instances in the VCN do not need to have public IP addresses nor be in a public subnet. The VCN does not need an internet gateway for this traffic. For more information, see Access to Oracle Services: Service Gateway.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

ServiceIdRequestDetails

ServiceIdResponseDetails

SetDrgPeeringConnectionDetails

StatefulEgressSecurityListConfiguration

Defines the stateful subnet egress security list configuration that allowed the ingress traffic.

StatefulIngressSecurityListConfiguration

Defines the stateful subnet ingress security list configuration that allowed the egress traffic.

StatefulNsgConfiguration

Defines the stateful network security group configuration that allowed the traffic.

StatefulZprConfiguration

Defines the stateful zpr configuration that allowed the traffic.

Subnet

A logical subdivision of a VCN. Each subnet consists of a contiguous range of IP addresses that do not overlap with other subnets in the VCN. Example: 172.16.1.0/24. For more information, seeOverview of the Networking Service andVCNs and Subnets.To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,talk to an administrator. If you're an administrator who needs to write policies to give users access, seeGetting Started with Policies.

SubnetEndpoint

Defines the details required for a SUBNET-type Endpoint.

SubnetTopology

Defines the visualization of a subnet in a VCN. See Network Visualizer Documentation for more information, including conventions and pictures of symbols.

TcpOptions

Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

TcpProtocolParameters

Defines the configuration for TCP protocol parameters.

TcpTrafficProtocolParameters

Defines the TrafficProtocolParameters configuration for the TCP protocol.

Topology

Defines the representation of a virtual network topology.

TopologyAssociatedWithEntityRelationship

Defines the AssociatedWith relationship between virtual network topology entities. An AssociatedWith relationship is defined when there is no obvious contains relationship but entities are still related. For example, a DRG is associated with a VCN because a DRG is not managed by VCN but can be attached to a VCN.

TopologyAssociatedWithRelationshipDetails

Defines association details for an associatedWith relationship.

TopologyContainsEntityRelationship

Defines the contains relationship between virtual network topology entities. A Contains relationship is defined when an entity fully owns, contains or manages another entity. For example, a subnet is contained and managed in the scope of a VCN, therefore a VCN has a contains relationship to a subnet.

TopologyEntityRelationship

Defines the relationship between Virtual Network topology entities.

TopologyEntityRelationshipModelConverter

TopologyModelConverter

TopologyRoutesToEntityRelationship

Defines the routesTo relationship between virtual network topology entities. A RoutesTo relationship is defined when a routing table and a routing rule are used to govern how to route traffic from one entity to another. For example, a DRG might have a routing rule to send certain traffic to an LPG.

TopologyRoutesToRelationshipDetails

Defines route rule details for a routesTo relationship.

TrafficNode

Defines the configuration of the OCI entity that represents a traffic node in PathAnalysisResult.

TrafficNodeModelConverter

TrafficProtocolParameters

Defines the traffic protocol parameters for the traffic in a PathAnalysisResult.

TrafficProtocolParametersModelConverter

TrafficRoute

Defines the traffic route taken in the path in PathAnalysisResult.

TunnelConfig

Specific connection details for an IPSec tunnel.

TunnelStatus

Specific connection details for an IPSec tunnel.

UdpOptions

Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

UdpProtocolParameters

Defines the configuration for UDP protocol parameters.

UdpTrafficProtocolParameters

Defines the TrafficProtocolParameters configuration for the UDP protocol.

UpdateCpeDetails

UpdateCrossConnectDetails

Update a CrossConnect

UpdateCrossConnectGroupDetails

UpdateDhcpDetails

UpdateDrgAttachmentDetails

UpdateDrgDetails

UpdateDrgRouteDistributionDetails

Details used in a request to update a route distribution.
You cannot assign a table to a virtual circuit or IPSec tunnel attachment if there is a static route rule for an RPC attachment.

UpdateDrgRouteDistributionStatementDetails

Route distribution statements to update in the route distribution.

UpdateDrgRouteDistributionStatementsDetails

Details request to update statements in a route distribution.

UpdateDrgRouteRuleDetails

Details used to update a route rule in the DRG route table.

UpdateDrgRouteRulesDetails

Details used to update route rules in a DRG route table.

UpdateDrgRouteTableDetails

Details used in a request to update a DRG route table.
You can't assign a table to a virtual circuit or IPSec tunnel attachment if there is a static route rule for an RPC attachment.

UpdateFlexTunnelBgpSessionDetails

Boarder Gateway Protocol (BGP) fields

UpdateFlexTunnelConfigurationDetails

The update details for tunnel configuration.

UpdateFlexTunnelConfigurationDetailsModelConverter

UpdateFlexTunnelDetails

These details can be included in a request to update a flex tunnel.

UpdateGreFlexTunnelConfigurationDetails

The gre tunnel configuration update details.

UpdateIPSecConnectionDetails

UpdateInternetGatewayDetails

UpdateIpv6Details

UpdateLocalPeeringGatewayDetails

UpdateNetworkSecurityGroupDetails

UpdateNetworkSecurityGroupSecurityRulesDetails

UpdatePathAnalyzerTestDetails

Details to update a PathAnalyzerTest resource.

UpdatePrivateIpDetails

UpdatePublicIpDetails

UpdateRemotePeeringConnectionDetails

UpdateRouteTableDetails

UpdateSecurityListDetails

UpdateSecurityRuleDetails

A rule for allowing inbound (direction= INGRESS) or outbound (direction= EGRESS) IP packets.

UpdateServiceGatewayDetails

UpdateSubnetDetails

UpdateVcnDetails

UpdateVirtualCircuitDetails

UpdateVnicDetails

UpdatedNetworkSecurityGroupSecurityRules

UpgradeStatus

The upgrade status of a DRG.

Vcn

A virtual cloud network (VCN). For more information, see Overview of the Networking Service.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

VcnDrgAttachmentNetworkCreateDetails

Specifies the VCN Attachment

VcnDrgAttachmentNetworkDetails

Specifies details within the VCN.

VcnDrgAttachmentNetworkUpdateDetails

Specifies the update details for the VCN attachment.

VcnRoutingConfiguration

Identifies the VCN route table and rule that allowed the traffic to be forwarded.

VcnTopology

Defines the representation of a virtual network topology for a VCN. See Network Visualizer Documentation for more information, including conventions and pictures of symbols.

VirtualCircuit

For use with Oracle Cloud Infrastructure FastConnect.
A virtual circuit is an isolated network path that runs over one or more physical network connections to provide a single, logical connection between the edge router on the customer's existing network and Oracle Cloud Infrastructure. Private virtual circuits support private peering, and public virtual circuits support public peering. For more information, see FastConnect Overview.
Each virtual circuit is made up of information shared between a customer, Oracle, and a provider (if the customer is using FastConnect via a provider). Who fills in a given property of a virtual circuit depends on whether the BGP session related to that virtual circuit goes from the customer's edge router to Oracle, or from the provider's edge router to Oracle. Also, in the case where the customer is using a provider, values for some of the properties may not be present immediately, but may get filled in as the provider and Oracle each do their part to provision the virtual circuit.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

VirtualCircuitAssociatedTunnelDetails

Detailed private tunnel info associated with the virtual circuit.

VirtualCircuitBandwidthShape

An individual bandwidth level for virtual circuits.

VirtualCircuitDrgAttachmentNetworkCreateDetails

VirtualCircuitDrgAttachmentNetworkDetails

Specifies the virtual circuit attached to the DRG.

VirtualCircuitDrgAttachmentNetworkUpdateDetails

Specifies the update details for the virtual circuit attachment.

VirtualCircuitPublicPrefix

A public IP prefix and its details. With a public virtual circuit, the customer specifies the customer-owned public IP prefixes to advertise across the connection. For more information, see FastConnect Overview.

VisibleTrafficNode

Defines the configuration of a traffic node that is visible to the user.

VlanEndpoint

Defines the details required for a VLAN-type Endpoint.

Vnic

A virtual network interface card. Each VNIC resides in a subnet in a VCN. An instance attaches to a VNIC to obtain a network connection into the VCN through that subnet. Each instance has a primary VNIC that is automatically created and attached during launch. You can add secondary VNICs to an instance after it's launched. For more information, see Virtual Network Interface Cards (VNICs).
Each VNIC has a primary private IP that is automatically assigned during launch. You can add secondary private IPs to a VNIC after it's created. For more information, see {@link #createPrivateIp(CreatePrivateIpRequest) createPrivateIp} and IP Addresses.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

VnicEndpoint

Defines the details required for a VNIC-type Endpoint.

WorkRequest

An asynchronous work request.

WorkRequestError

An error encountered while executing an operation that is tracked by a work request.

WorkRequestErrorCollection

Results of a WorkRequestError search.

WorkRequestLogEntry

A log message from executing an operation that is tracked by a work request.

WorkRequestLogEntryCollection

Results of a WorkRequestLog search.

WorkRequestResource

A resource created or operated on by a work request.

WorkRequestResult

Ephemeral data resulting from an asynchronous operation.

WorkRequestResultCollection

Results of a WorkRequestResult search.

WorkRequestResultModelConverter

WorkRequestSummary

A summary of the status of a work request.

WorkRequestSummaryCollection

Results of a WorkRequest search.

ZprAllowedSecurityAction

Defines the security action taken on zpr allowed traffic.

ZprAllowedSecurityActionDetails

Defines details for the security action taken on zpr allowed traffic.

ZprCidrUnsupportedSecurityAction

Defines the security action taken when zpr cidr policy is not supported.

ZprCidrUnsupportedSecurityActionDetails

Defines details for the security action taken on zpr unsupported traffic.

ZprConfiguration

Defines the subnet ingress security list configuration that allowed the traffic.

ZprDeniedSecurityAction

Defines the security action taken on zpr denied traffic.

ZprDeniedSecurityActionDetails

Defines details for the security action taken on zpr denied traffic.

ZprMissingPolicySecurityAction

Defines the security action taken when tagged resource has missing zpr policy.

ZprNsgUnsupportedSecurityAction

Defines the security action taken when zpr tag based policy is not supported.

ZprNsgUnsupportedSecurityActionDetails

Defines details for the security action taken on zpr unsupported traffic.

ZprPolicy

Defines the zpr policy object.

ZprPolicyNotEvaluatedMissingRouteSecurityAction

Defines the security action taken when zpr policy is not evaluated, due to missing route

ZprPolicyNotEvaluatedSlNsgDeniedSecurityAction

Defines the security action taken when zpr policy is not evaluated, due to denied security or nsg action.

Enums

ActionType

Possible types of actions.

AddDrgRouteDistributionStatementDetails.ActionEnum

AddDrgRouteRuleDetails.DestinationTypeEnum

AddSecurityRuleDetails.DestinationTypeEnum

AddSecurityRuleDetails.DirectionEnum

AddSecurityRuleDetails.SourceTypeEnum

AllowedSecurityConfiguration.TypeEnum

CreateDrgRouteDistributionDetails.DistributionTypeEnum

CreateFlexTunnelConfigurationDetails.TunnelTypeEnum

CreatePublicIpDetails.LifetimeEnum

CreateVirtualCircuitDetails.TypeEnum

CrossConnect.LifecycleStateEnum

CrossConnectGroup.LifecycleStateEnum

CrossConnectStatus.InterfaceStateEnum

CrossConnectStatus.LightLevelIndicatorEnum

DhcpDnsOption.ServerTypeEnum

DhcpOptions.LifecycleStateEnum

Drg.LifecycleStateEnum

DrgAttachment.LifecycleStateEnum

DrgAttachmentNetworkCreateDetails.TypeEnum

DrgAttachmentNetworkDetails.TypeEnum

DrgAttachmentNetworkUpdateDetails.TypeEnum

DrgAttachmentTypeDrgRouteDistributionMatchCriteria.AttachmentTypeEnum

DrgPromotionStatusResponse.DrgPromotionStatusEnum

DrgRouteDistribution.DistributionTypeEnum

DrgRouteDistribution.LifecycleStateEnum

DrgRouteDistributionMatchCriteria.MatchTypeEnum

DrgRouteDistributionStatement.ActionEnum

DrgRouteRule.DestinationTypeEnum

DrgRouteRule.RouteProvenanceEnum

DrgRouteRule.RouteTypeEnum

DrgRouteTable.LifecycleStateEnum

EgressSecurityRule.DestinationTypeEnum

Endpoint.TypeEnum

FastConnectProviderService.PrivatePeeringBgpManagementEnum

FastConnectProviderService.PublicPeeringBgpManagementEnum

FastConnectProviderService.SupportedVirtualCircuitTypesEnum

FastConnectProviderService.TypeEnum

FlexTunnel.LifecycleStateEnum

FlexTunnelBgpStatus.BgpSessionStatusEnum

FlexTunnelBgpStatus.BgpSessionStatusIpv6Enum

FlexTunnelConfiguration.TunnelTypeEnum

FlexTunnelRouteSummary.AdvertiserEnum

ForwardedRoutingConfiguration.TypeEnum

GetPathAnalysisDetails.TypeEnum

IPSecConnection.LifecycleStateEnum

IPSecConnection.TransportTypeEnum

IngressSecurityRule.SourceTypeEnum

InternetGateway.LifecycleStateEnum

Ipv6.LifecycleStateEnum

LetterOfAuthority.CircuitTypeEnum

LocalPeeringGateway.LifecycleStateEnum

LocalPeeringGateway.PeeringStatusEnum

NetworkSecurityGroup.LifecycleStateEnum

OperationStatus

Possible operation status.

OperationType

Possible operation types.

PathAnalyzerTest.LifecycleStateEnum

ProtocolParameters.TypeEnum

PublicIp.LifecycleStateEnum

PublicIp.LifetimeEnum

PublicIp.ScopeEnum

RemotePeeringConnection.LifecycleStateEnum

RemotePeeringConnection.PeeringStatusEnum

RouteRule.DestinationTypeEnum

RouteTable.LifecycleStateEnum

RoutingAction.ActionEnum

RoutingAction.ActionTypeEnum

SecurityAction.ActionEnum

SecurityAction.ActionTypeEnum

SecurityList.LifecycleStateEnum

SecurityRule.DestinationTypeEnum

SecurityRule.DirectionEnum

SecurityRule.SourceTypeEnum

ServiceGateway.LifecycleStateEnum

SortOrder

Allowed sort orders, either 'ASC' for ascending or 'DESC' for descending.

Subnet.LifecycleStateEnum

Topology.TypeEnum

TopologyEntityRelationship.TypeEnum

TopologyRoutesToRelationshipDetails.RouteTypeEnum

TrafficNode.TypeEnum

TrafficProtocolParameters.TypeEnum

TrafficRoute.ReachabilityStatusEnum

TunnelStatus.LifecycleStateEnum

UpdateDrgRouteRuleDetails.DestinationTypeEnum

UpdateFlexTunnelConfigurationDetails.TunnelTypeEnum

UpdateSecurityRuleDetails.DestinationTypeEnum

UpdateSecurityRuleDetails.DirectionEnum

UpdateSecurityRuleDetails.SourceTypeEnum

UpdateVirtualCircuitDetails.ProviderStateEnum

UpgradeStatus.StatusEnum

Vcn.LifecycleStateEnum

VirtualCircuit.BgpManagementEnum

VirtualCircuit.BgpSessionStateEnum

VirtualCircuit.LifecycleStateEnum

VirtualCircuit.ProviderStateEnum

VirtualCircuit.ServiceTypeEnum

VirtualCircuit.TypeEnum

VirtualCircuitAssociatedTunnelDetails.TunnelTypeEnum

VirtualCircuitDrgAttachmentNetworkCreateDetails.ThroughputEnum

VirtualCircuitPublicPrefix.VerificationStateEnum

Vnic.LifecycleStateEnum

WorkRequestResult.ResultTypeEnum

In this article
Back to top