networkloadbalancer.oracle.com/v1beta1¶
APIVersion: networkloadbalancer.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages¶
No customer-visible package currently exposes networkloadbalancer.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| Backend | Namespaced | Sample | - |
| BackendSet | Namespaced | Sample | - |
| Listener | Namespaced | Sample | - |
| NetworkLoadBalancer | Namespaced | Sample | - |
Backend¶
Manage OCI Network Load Balancer backends.
Plural:backendsScope:NamespacedAPIVersion:networkloadbalancer.oracle.com/v1beta1Sample: Sample (config/samples/networkloadbalancer_v1beta1_backend.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
BackendSpec defines the desired state of Backend.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
backendSetName |
The name of the backend set associated with the backend server. Example: example_backend_set |
string |
Yes | - | - |
ipAddress |
The IP address of the backend server. Example: 10.0.0.3 |
string |
No | - | - |
isBackup |
Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false |
boolean |
No | - | - |
isDrain |
Whether the network load balancer should drain this server. Servers marked "isDrain" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated. Example: false |
boolean |
No | - | - |
isOffline |
Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false |
boolean |
No | - | - |
name |
Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1 |
string |
No | - | - |
networkLoadBalancerId |
The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer associated with the backend set and server. | string |
Yes | - | - |
port |
The communication port for the backend server. Example: 8080 |
integer |
Yes | - | - |
targetId |
The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var><unique_ID></var> |
string |
No | - | - |
weight |
The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about network load balancer policies, see Network Load Balancer Policies (https://docs.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: 3 |
integer |
No | - | - |
Status¶
BackendStatus defines the observed state of Backend.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
backendSetName |
The bound backend set name used to address this backend. | string |
No | - | - |
ipAddress |
The IP address of the backend server. Example: 10.0.0.3 |
string |
No | - | - |
isBackup |
Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false |
boolean |
No | - | - |
isDrain |
Whether the network load balancer should drain this server. Servers marked "isDrain" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out. Example: false |
boolean |
No | - | - |
isOffline |
Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false |
boolean |
No | - | - |
name |
A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<var><unique_ID></var>:443 or 10.0.0.3:0 |
string |
No | - | - |
networkLoadBalancerId |
The bound network load balancer OCID used to address this backend. | string |
No | - | - |
port |
The communication port for the backend server. Example: 8080 |
integer |
No | - | - |
status |
- | object |
Yes | - | - |
targetId |
The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var><unique_ID></var> |
string |
No | - | - |
weight |
The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about network load balancing policies, see Network Load Balancer Policies (https://docs.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: 3 |
integer |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
BackendSet¶
Manage OCI Network Load Balancer backend sets.
Plural:backendsetsScope:NamespacedAPIVersion:networkloadbalancer.oracle.com/v1beta1Sample: Sample (config/samples/networkloadbalancer_v1beta1_backendset.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
BackendSetSpec defines the desired state of BackendSet.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
areOperationallyActiveBackendsPreferred |
If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. The new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy. | boolean |
No | - | - |
backends |
An array of backends to be associated with the backend set. | list[object] |
No | - | - |
healthChecker |
BackendSetHealthChecker defines nested fields for BackendSet.HealthChecker. | object |
Yes | - | - |
ipVersion |
IP version associated with the backend set. | string |
No | - | - |
isFailOpen |
If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default. | boolean |
No | - | - |
isInstantFailoverEnabled |
If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy. | boolean |
No | - | - |
isInstantFailoverTcpResetEnabled |
This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. If disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled. | boolean |
No | - | - |
isPreserveSource |
If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default. | boolean |
No | - | - |
name |
A user-friendly name for the backend set that must be unique and cannot be changed. Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information. Example: example_backend_set |
string |
Yes | - | - |
policy |
The network load balancer policy for the backend set. Example: FIVE_TUPLE`` |string` |
Yes | - | - |
Spec.backends[]¶
BackendSetBackend defines nested fields for BackendSet.Backend.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ipAddress |
The IP address of the backend server. Example: 10.0.0.3 |
string |
No | - | - |
isBackup |
Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false |
boolean |
No | - | - |
isDrain |
Whether the network load balancer should drain this server. Servers marked "isDrain" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out. Example: false |
boolean |
No | - | - |
isOffline |
Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false |
boolean |
No | - | - |
name |
A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<var><unique_ID></var>:443 or 10.0.0.3:0 |
string |
No | - | - |
port |
The communication port for the backend server. Example: 8080 |
integer |
Yes | - | - |
targetId |
The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var><unique_ID></var> |
string |
No | - | - |
weight |
The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see Network Load Balancer Policies (https://docs.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: 3 |
integer |
No | - | - |
Spec.healthChecker¶
BackendSetHealthChecker defines nested fields for BackendSet.HealthChecker.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dns |
BackendSetHealthCheckerDns defines nested fields for BackendSet.HealthChecker.Dns. | object |
No | - | - |
intervalInMillis |
The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000 |
integer |
No | - | - |
port |
The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080 |
integer |
No | - | - |
protocol |
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP |
string |
Yes | - | - |
requestData |
Base64 encoded pattern to be sent as UDP or TCP health check probe. | string |
No | - | - |
responseBodyRegex |
A regular expression for parsing the response body from the backend server. Example: ^((?!false).\|\s)*$ |
string |
No | - | - |
responseData |
Base64 encoded pattern to be validated as UDP or TCP health check probe response. | string |
No | - | - |
retries |
The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3 |
integer |
No | - | - |
returnCode |
The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200 |
integer |
No | - | - |
timeoutInMillis |
The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: 3000 |
integer |
No | - | - |
urlPath |
The path against which to run the health check. Example: /healthcheck |
string |
No | - | - |
Spec.healthChecker.dns¶
BackendSetHealthCheckerDns defines nested fields for BackendSet.HealthChecker.Dns.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
domainName |
The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query. | string |
Yes | - | - |
queryClass |
The class the dns health check query to use; either IN or CH. Example: IN |
string |
No | - | - |
queryType |
The type the dns health check query to use; A, AAAA, TXT. Example: A |
string |
No | - | - |
rcodes |
An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"] | list[string] |
No | - | - |
transportProtocol |
DNS transport protocol; either UDP or TCP. Example: UDP |
string |
No | - | - |
Status¶
BackendSetStatus defines the observed state of BackendSet.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
areOperationallyActiveBackendsPreferred |
If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. The new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy. | boolean |
No | - | - |
backends |
An array of backends. | list[object] |
No | - | - |
healthChecker |
BackendSetHealthChecker defines nested fields for BackendSet.HealthChecker. | object |
No | - | - |
ipVersion |
IP version associated with the backend set. | string |
No | - | - |
isFailOpen |
If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default. | boolean |
No | - | - |
isInstantFailoverEnabled |
If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy. | boolean |
No | - | - |
isInstantFailoverTcpResetEnabled |
This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. If disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled. | boolean |
No | - | - |
isPreserveSource |
If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default. | boolean |
No | - | - |
name |
A user-friendly name for the backend set that must be unique and cannot be changed. Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information. Example: example_backend_set |
string |
No | - | - |
policy |
The network load balancer policy for the backend set. Example: FIVE_TUPLE |
string |
No | - | - |
status |
- | object |
Yes | - | - |
Status.backends[]¶
BackendSetBackend defines nested fields for BackendSet.Backend.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ipAddress |
The IP address of the backend server. Example: 10.0.0.3 |
string |
No | - | - |
isBackup |
Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false |
boolean |
No | - | - |
isDrain |
Whether the network load balancer should drain this server. Servers marked "isDrain" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out. Example: false |
boolean |
No | - | - |
isOffline |
Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false |
boolean |
No | - | - |
name |
A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<var><unique_ID></var>:443 or 10.0.0.3:0 |
string |
No | - | - |
port |
The communication port for the backend server. Example: 8080 |
integer |
Yes | - | - |
targetId |
The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var><unique_ID></var> |
string |
No | - | - |
weight |
The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see Network Load Balancer Policies (https://docs.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: 3 |
integer |
No | - | - |
Status.healthChecker¶
BackendSetHealthChecker defines nested fields for BackendSet.HealthChecker.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dns |
BackendSetHealthCheckerDns defines nested fields for BackendSet.HealthChecker.Dns. | object |
No | - | - |
intervalInMillis |
The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000 |
integer |
No | - | - |
port |
The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080 |
integer |
No | - | - |
protocol |
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP |
string |
Yes | - | - |
requestData |
Base64 encoded pattern to be sent as UDP or TCP health check probe. | string |
No | - | - |
responseBodyRegex |
A regular expression for parsing the response body from the backend server. Example: ^((?!false).\|\s)*$ |
string |
No | - | - |
responseData |
Base64 encoded pattern to be validated as UDP or TCP health check probe response. | string |
No | - | - |
retries |
The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3 |
integer |
No | - | - |
returnCode |
The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200 |
integer |
No | - | - |
timeoutInMillis |
The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: 3000 |
integer |
No | - | - |
urlPath |
The path against which to run the health check. Example: /healthcheck |
string |
No | - | - |
Status.healthChecker.dns¶
BackendSetHealthCheckerDns defines nested fields for BackendSet.HealthChecker.Dns.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
domainName |
The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query. | string |
Yes | - | - |
queryClass |
The class the dns health check query to use; either IN or CH. Example: IN |
string |
No | - | - |
queryType |
The type the dns health check query to use; A, AAAA, TXT. Example: A |
string |
No | - | - |
rcodes |
An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"] | list[string] |
No | - | - |
transportProtocol |
DNS transport protocol; either UDP or TCP. Example: UDP |
string |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Listener¶
Manage OCI Network Load Balancer listeners.
Plural:listenersScope:NamespacedAPIVersion:networkloadbalancer.oracle.com/v1beta1Sample: Sample (config/samples/networkloadbalancer_v1beta1_listener.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ListenerSpec defines the desired state of Listener.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
defaultBackendSetName |
The name of the associated backend set. Example: example_backend_set |
string |
Yes | - | - |
ipVersion |
IP version associated with the listener. | string |
No | - | - |
isPpv2Enabled |
Property to enable/disable PPv2 feature for this listener. | boolean |
No | - | - |
l3IpIdleTimeout |
The duration for L3IP idle timeout in seconds. Example: 200 |
integer |
No | - | - |
name |
A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener |
string |
Yes | - | - |
port |
The communication port for the listener. Example: 80 |
integer |
Yes | - | - |
protocol |
The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP |
string |
Yes | - | - |
tcpIdleTimeout |
The duration for TCP idle timeout in seconds. Example: 300 |
integer |
No | - | - |
udpIdleTimeout |
The duration for UDP idle timeout in seconds. Example: 120 |
integer |
No | - | - |
Status¶
ListenerStatus defines the observed state of Listener.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
defaultBackendSetName |
The name of the associated backend set. Example: example_backend_set |
string |
No | - | - |
ipVersion |
IP version associated with the listener. | string |
No | - | - |
isPpv2Enabled |
Property to enable/disable PPv2 feature for this listener. | boolean |
No | - | - |
l3IpIdleTimeout |
The duration for L3IP idle timeout in seconds. Example: 200 |
integer |
No | - | - |
name |
A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener |
string |
No | - | - |
port |
The communication port for the listener. Example: 80 |
integer |
No | - | - |
protocol |
The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP |
string |
No | - | - |
status |
- | object |
Yes | - | - |
tcpIdleTimeout |
The duration for TCP idle timeout in seconds. Example: 300 |
integer |
No | - | - |
udpIdleTimeout |
The duration for UDP idle timeout in seconds. Example: 120 |
integer |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
NetworkLoadBalancer¶
Manage OCI Network Load Balancers.
Plural:networkloadbalancersScope:NamespacedAPIVersion:networkloadbalancer.oracle.com/v1beta1Sample: Sample (config/samples/networkloadbalancer_v1beta1_networkloadbalancer.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
NetworkLoadBalancerSpec defines the desired state of NetworkLoadBalancer.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
assignedIpv6 |
IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789" | string |
No | - | - |
assignedPrivateIpv4 |
Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1" | string |
No | - | - |
backendSets |
Backend sets associated with the network load balancer. | map[string, object] |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancer. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
Network load balancer identifier, which can be renamed. | string |
Yes | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No | - | - |
isPreserveSourceDestination |
This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact. | boolean |
No | - | - |
isPrivate |
Whether the network load balancer has a virtual cloud network-local (private) IP address. If "true", then the service assigns a private IP address to the network load balancer. If "false", then the service assigns a public IP address to the network load balancer. A public network load balancer is accessible from the internet, depending on the security list rules (https://docs.oracle.com/iaas/Content/network/Concepts/securitylists.htm) for your virtual cloud network. For more information about public and private network load balancers, see Network Load Balancer Types (https://docs.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#NetworkLoadBalancerTypes). This value is true by default. Example: true |
boolean |
No | - | - |
isSymmetricHashEnabled |
This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT. | boolean |
No | - | - |
listeners |
Listeners associated with the network load balancer. | map[string, object] |
No | - | - |
networkSecurityGroupIds |
An array of network security groups OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with the network load balancer. During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: * Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. * The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access. Example: ["ocid1.nsg.oc1.phx.unique_ID"] | list[string] |
No | - | - |
nlbIpVersion |
IP version associated with the NLB. | string |
No | - | - |
reservedIps |
An array of reserved Ips. NLB supports reserved public ip, reserved private IP and reserved IPv6. Customer can pass 3 reserved IP ocids, with all items unique, and a maximum of 1 allowed for each entity type: public-ip, private-ip and IPv6 Note that NLB does not support changing an IP’s lifecycle state between ephemeral and reserved if the IP is already assigned to the NLB. While this type of lifecycle state change is supported by VCN IPs even when the IP is assigned to a resource, such changes will not be recognized or reflected by NLB. | list[object] |
No | - | - |
reservedIpv6Id |
The reservedIpv6Id field is used to specify the OCID of a reserved IPv6 address to be used only when updating NLB from single-stack IPv4 to dual-stack. This field should not be used for any other scenario | string |
No | - | - |
securityAttributes |
ZPR tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} |
map[string, map[string, string]] |
No | - | - |
subnetId |
The subnet in which the network load balancer is spawned OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
Yes | - | - |
subnetIpv6Cidr |
IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this. | string |
No | - | - |
Spec.backendSets{}¶
Back to NetworkLoadBalancer spec
NetworkLoadBalancerBackendSets defines nested fields for NetworkLoadBalancer.BackendSets.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
areOperationallyActiveBackendsPreferred |
If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. The new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy. | boolean |
No | - | - |
backends |
An array of backends. | list[object] |
No | - | - |
healthChecker |
NetworkLoadBalancerBackendSetsHealthChecker defines nested fields for NetworkLoadBalancer.BackendSets.HealthChecker. | object |
Yes | - | - |
ipVersion |
IP version associated with the backend set. | string |
No | - | - |
isFailOpen |
If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default. | boolean |
No | - | - |
isInstantFailoverEnabled |
If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy. | boolean |
No | - | - |
isInstantFailoverTcpResetEnabled |
This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. If disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled. | boolean |
No | - | - |
isPreserveSource |
If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default. | boolean |
No | - | - |
policy |
The network load balancer policy for the backend set. Example: FIVE_TUPLE |
string |
No | - | - |
Spec.backendSets{}.backends[]¶
Back to NetworkLoadBalancer spec
NetworkLoadBalancerBackendSetsBackend defines nested fields for NetworkLoadBalancer.BackendSets.Backend.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ipAddress |
The IP address of the backend server. Example: 10.0.0.3 |
string |
No | - | - |
isBackup |
Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false |
boolean |
No | - | - |
isDrain |
Whether the network load balancer should drain this server. Servers marked "isDrain" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out. Example: false |
boolean |
No | - | - |
isOffline |
Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false |
boolean |
No | - | - |
name |
A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<var><unique_ID></var>:443 or 10.0.0.3:0 |
string |
No | - | - |
port |
The communication port for the backend server. Example: 8080 |
integer |
Yes | - | - |
targetId |
The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var><unique_ID></var> |
string |
No | - | - |
weight |
The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about network load balancing policies, see Network Load Balancer Policies (https://docs.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: 3 |
integer |
No | - | - |
Spec.backendSets{}.healthChecker¶
Back to NetworkLoadBalancer spec
NetworkLoadBalancerBackendSetsHealthChecker defines nested fields for NetworkLoadBalancer.BackendSets.HealthChecker.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dns |
NetworkLoadBalancerBackendSetsHealthCheckerDns defines nested fields for NetworkLoadBalancer.BackendSets.HealthChecker.Dns. | object |
No | - | - |
intervalInMillis |
The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000 |
integer |
No | - | - |
port |
The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080 |
integer |
No | - | - |
protocol |
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP |
string |
Yes | - | - |
requestData |
Base64 encoded pattern to be sent as UDP or TCP health check probe. | string |
No | - | - |
responseBodyRegex |
A regular expression for parsing the response body from the backend server. Example: ^((?!false).\|\s)*$ |
string |
No | - | - |
responseData |
Base64 encoded pattern to be validated as UDP or TCP health check probe response. | string |
No | - | - |
retries |
The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3 |
integer |
No | - | - |
returnCode |
The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200 |
integer |
No | - | - |
timeoutInMillis |
The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: 3000 |
integer |
No | - | - |
urlPath |
The path against which to run the health check. Example: /healthcheck |
string |
No | - | - |
Spec.backendSets{}.healthChecker.dns¶
Back to NetworkLoadBalancer spec
NetworkLoadBalancerBackendSetsHealthCheckerDns defines nested fields for NetworkLoadBalancer.BackendSets.HealthChecker.Dns.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
domainName |
The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query. | string |
Yes | - | - |
queryClass |
The class the dns health check query to use; either IN or CH. Example: IN |
string |
No | - | - |
queryType |
The type the dns health check query to use; A, AAAA, TXT. Example: A |
string |
No | - | - |
rcodes |
An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"] | list[string] |
No | - | - |
transportProtocol |
DNS transport protocol; either UDP or TCP. Example: UDP |
string |
No | - | - |
Spec.listeners{}¶
Back to NetworkLoadBalancer spec
NetworkLoadBalancerListeners defines nested fields for NetworkLoadBalancer.Listeners.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
defaultBackendSetName |
The name of the associated backend set. Example: example_backend_set |
string |
Yes | - | - |
ipVersion |
IP version associated with the listener. | string |
No | - | - |
isPpv2Enabled |
Property to enable/disable PPv2 feature for this listener. | boolean |
No | - | - |
l3IpIdleTimeout |
The duration for L3IP idle timeout in seconds. Example: 200 |
integer |
No | - | - |
name |
A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener |
string |
Yes | - | - |
port |
The communication port for the listener. Example: 80 |
integer |
Yes | - | - |
protocol |
The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP |
string |
Yes | - | - |
tcpIdleTimeout |
The duration for TCP idle timeout in seconds. Example: 300 |
integer |
No | - | - |
udpIdleTimeout |
The duration for UDP idle timeout in seconds. Example: 120 |
integer |
No | - | - |
Spec.reservedIps[]¶
Back to NetworkLoadBalancer spec
NetworkLoadBalancerReservedIp defines nested fields for NetworkLoadBalancer.ReservedIp.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
id |
Ocid of the Reserved IP (Public IP, Private IP or IPv6) created with VCN. Reserved IPs are IPs which are already registered using VCN API. For public Network load balancers, customer can create a reserved Public IP and/or reserved private IP and/or reserved IPv6 and pass the OCID's in the reservedIps array field to attach the IP addresses to the network load balancer during create For private Network load balancers, customer can create a reserved Private IP and/or reserved IPv6 and pass the OCID's in the reservedIps array field to attach the IP addresses to the network load balancer during create Reserved IPs will not be deleted when the Network Load balancer is deleted. They will be detached from the Network Load balancer. Public IP Example: "ocid1.publicip.oc1.phx.unique_ID" Private IP Example: "ocid1.privateip.oc1.phx.unique_ID" IPV6 example: "ocid1.ipv6.oc1.phx.unique_ID" | string |
No | - | - |
Status¶
NetworkLoadBalancerStatus defines the observed state of NetworkLoadBalancer.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
backendSets |
Backend sets associated with the network load balancer. | map[string, object] |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancer. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer |
string |
No | - | - |
freeformTags |
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 Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer. | string |
No | - | - |
ipAddresses |
An array of IP addresses. | list[object] |
No | - | - |
isPreserveSourceDestination |
When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP. | boolean |
No | - | - |
isPrivate |
Whether the network load balancer has a virtual cloud network-local (private) IP address. If "true", then the service assigns a private IP address to the network load balancer. If "false", then the service assigns a public IP address to the network load balancer. A public network load balancer is accessible from the internet, depending the security list rules (https://docs.oracle.com/iaas/Content/network/Concepts/securitylists.htm) for your virtual cloudn network. For more information about public and private network load balancers, see Network Load Balancer Types (https://docs.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#NetworkLoadBalancerTypes). This value is true by default. Example: true |
boolean |
No | - | - |
isSymmetricHashEnabled |
This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT. | boolean |
No | - | - |
lifecycleDetails |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. | string |
No | - | - |
lifecycleState |
The current state of the network load balancer. | string |
No | - | - |
listeners |
Listeners associated with the network load balancer. | map[string, object] |
No | - | - |
networkSecurityGroupIds |
An array of network security groups OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with the network load balancer. During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: * Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. * The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access. Example: ["ocid1.nsg.oc1.phx.unique_ID"] | list[string] |
No | - | - |
nlbIpVersion |
IP version associated with the NLB. | string |
No | - | - |
securityAttributes |
ZPR tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: { "oracle-zpr": { "td": { "value": "42", "mode": "audit" } } } |
map[string, map[string, string]] |
No | - | - |
status |
- | object |
Yes | - | - |
subnetId |
The subnet in which the network load balancer is spawned OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
systemTags |
Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z |
string |
No | - | - |
Status.backendSets{}¶
Back to NetworkLoadBalancer status
NetworkLoadBalancerBackendSets defines nested fields for NetworkLoadBalancer.BackendSets.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
areOperationallyActiveBackendsPreferred |
If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. The new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy. | boolean |
No | - | - |
backends |
An array of backends. | list[object] |
No | - | - |
healthChecker |
NetworkLoadBalancerBackendSetsHealthChecker defines nested fields for NetworkLoadBalancer.BackendSets.HealthChecker. | object |
Yes | - | - |
ipVersion |
IP version associated with the backend set. | string |
No | - | - |
isFailOpen |
If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default. | boolean |
No | - | - |
isInstantFailoverEnabled |
If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy. | boolean |
No | - | - |
isInstantFailoverTcpResetEnabled |
This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. If disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled. | boolean |
No | - | - |
isPreserveSource |
If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default. | boolean |
No | - | - |
policy |
The network load balancer policy for the backend set. Example: FIVE_TUPLE |
string |
No | - | - |
Status.backendSets{}.backends[]¶
Back to NetworkLoadBalancer status
NetworkLoadBalancerBackendSetsBackend defines nested fields for NetworkLoadBalancer.BackendSets.Backend.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ipAddress |
The IP address of the backend server. Example: 10.0.0.3 |
string |
No | - | - |
isBackup |
Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false |
boolean |
No | - | - |
isDrain |
Whether the network load balancer should drain this server. Servers marked "isDrain" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out. Example: false |
boolean |
No | - | - |
isOffline |
Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false |
boolean |
No | - | - |
name |
A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<var><unique_ID></var>:443 or 10.0.0.3:0 |
string |
No | - | - |
port |
The communication port for the backend server. Example: 8080 |
integer |
Yes | - | - |
targetId |
The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var><unique_ID></var> |
string |
No | - | - |
weight |
The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about network load balancing policies, see Network Load Balancer Policies (https://docs.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: 3 |
integer |
No | - | - |
Status.backendSets{}.healthChecker¶
Back to NetworkLoadBalancer status
NetworkLoadBalancerBackendSetsHealthChecker defines nested fields for NetworkLoadBalancer.BackendSets.HealthChecker.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dns |
NetworkLoadBalancerBackendSetsHealthCheckerDns defines nested fields for NetworkLoadBalancer.BackendSets.HealthChecker.Dns. | object |
No | - | - |
intervalInMillis |
The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000 |
integer |
No | - | - |
port |
The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080 |
integer |
No | - | - |
protocol |
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP |
string |
Yes | - | - |
requestData |
Base64 encoded pattern to be sent as UDP or TCP health check probe. | string |
No | - | - |
responseBodyRegex |
A regular expression for parsing the response body from the backend server. Example: ^((?!false).\|\s)*$ |
string |
No | - | - |
responseData |
Base64 encoded pattern to be validated as UDP or TCP health check probe response. | string |
No | - | - |
retries |
The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3 |
integer |
No | - | - |
returnCode |
The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200 |
integer |
No | - | - |
timeoutInMillis |
The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: 3000 |
integer |
No | - | - |
urlPath |
The path against which to run the health check. Example: /healthcheck |
string |
No | - | - |
Status.backendSets{}.healthChecker.dns¶
Back to NetworkLoadBalancer status
NetworkLoadBalancerBackendSetsHealthCheckerDns defines nested fields for NetworkLoadBalancer.BackendSets.HealthChecker.Dns.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
domainName |
The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query. | string |
Yes | - | - |
queryClass |
The class the dns health check query to use; either IN or CH. Example: IN |
string |
No | - | - |
queryType |
The type the dns health check query to use; A, AAAA, TXT. Example: A |
string |
No | - | - |
rcodes |
An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"] | list[string] |
No | - | - |
transportProtocol |
DNS transport protocol; either UDP or TCP. Example: UDP |
string |
No | - | - |
Status.ipAddresses[]¶
Back to NetworkLoadBalancer status
NetworkLoadBalancerIpAddress defines nested fields for NetworkLoadBalancer.IpAddress.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ipAddress |
An IP address. Example: 192.168.0.3 |
string |
No | - | - |
ipVersion |
IP version associated with this IP address. | string |
No | - | - |
isPublic |
Whether the IP address is public or private. If "true", then the IP address is public and accessible from the internet. If "false", then the IP address is private and accessible only from within the associated virtual cloud network. | boolean |
No | - | - |
reservedIp |
NetworkLoadBalancerIpAddressReservedIp defines nested fields for NetworkLoadBalancer.IpAddress.ReservedIp. | object |
No | - | - |
Status.ipAddresses[].reservedIp¶
Back to NetworkLoadBalancer status
NetworkLoadBalancerIpAddressReservedIp defines nested fields for NetworkLoadBalancer.IpAddress.ReservedIp.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
id |
Ocid of the Reserved IP (Public IP, Private IP or IPv6) created with VCN. Reserved IPs are IPs which are already registered using VCN API. For public Network load balancers, customer can create a reserved Public IP and/or reserved private IP and/or reserved IPv6 and pass the OCID's in the reservedIps array field to attach the IP addresses to the network load balancer during create For private Network load balancers, customer can create a reserved Private IP and/or reserved IPv6 and pass the OCID's in the reservedIps array field to attach the IP addresses to the network load balancer during create Reserved IPs will not be deleted when the Network Load balancer is deleted. They will be detached from the Network Load balancer. Public IP Example: "ocid1.publicip.oc1.phx.unique_ID" Private IP Example: "ocid1.privateip.oc1.phx.unique_ID" IPV6 example: "ocid1.ipv6.oc1.phx.unique_ID" | string |
No | - | - |
Status.listeners{}¶
Back to NetworkLoadBalancer status
NetworkLoadBalancerListeners defines nested fields for NetworkLoadBalancer.Listeners.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
defaultBackendSetName |
The name of the associated backend set. Example: example_backend_set |
string |
Yes | - | - |
ipVersion |
IP version associated with the listener. | string |
No | - | - |
isPpv2Enabled |
Property to enable/disable PPv2 feature for this listener. | boolean |
No | - | - |
l3IpIdleTimeout |
The duration for L3IP idle timeout in seconds. Example: 200 |
integer |
No | - | - |
name |
A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener |
string |
Yes | - | - |
port |
The communication port for the listener. Example: 80 |
integer |
Yes | - | - |
protocol |
The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP |
string |
Yes | - | - |
tcpIdleTimeout |
The duration for TCP idle timeout in seconds. Example: 300 |
integer |
No | - | - |
udpIdleTimeout |
The duration for UDP idle timeout in seconds. Example: 120 |
integer |
No | - | - |
Status.status¶
Back to NetworkLoadBalancer status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Back to NetworkLoadBalancer status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
Back to NetworkLoadBalancer status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
Back to NetworkLoadBalancer status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |