Class NetworkLoadBalancer
The properties that define a network load balancer. For more information, see
Managing a network load balancer.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized,
contact an administrator. If you are an administrator who writes policies to give users access, then see
Getting Started with Policies.
For information about endpoints and signing API requests, see
About the API. For information about available SDKs and tools, see
SDKS and Other Tools.
Inherited Members
Namespace: Oci.NetworkloadbalancerService.Models
Assembly: OCI.DotNetSDK.Networkloadbalancer.dll
Syntax
public class NetworkLoadBalancer
Properties
BackendSets
Declaration
[JsonProperty(PropertyName = "backendSets")]
public Dictionary<string, BackendSet> BackendSets { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, BackendSet> | Backend sets associated with the network load balancer. |
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment containing the network load balancer. |
Remarks
Required
DefinedTags
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see Resource Tags.
|
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | A user-friendly name, which does not have to be unique, and can be changed.
|
Remarks
Required
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | 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.
|
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the network load balancer. |
Remarks
Required
IpAddresses
Declaration
[Required(ErrorMessage = "IpAddresses is required.")]
[JsonProperty(PropertyName = "ipAddresses")]
public List<IpAddress> IpAddresses { get; set; }
Property Value
Type | Description |
---|---|
List<IpAddress> | An array of IP addresses. |
Remarks
Required
IsPreserveSourceDestination
Declaration
[JsonProperty(PropertyName = "isPreserveSourceDestination")]
public bool? IsPreserveSourceDestination { get; set; }
Property Value
Type | Description |
---|---|
bool? | 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. |
IsPrivate
Declaration
[JsonProperty(PropertyName = "isPrivate")]
public bool? IsPrivate { get; set; }
Property Value
Type | Description |
---|---|
bool? | Whether the network load balancer has a virtual cloud network-local (private) IP address.
|
IsSymmetricHashEnabled
Declaration
[JsonProperty(PropertyName = "isSymmetricHashEnabled")]
public bool? IsSymmetricHashEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | 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. |
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type | Description |
---|---|
string | A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
LifecycleState? | The current state of the network load balancer. |
Remarks
Required
Listeners
Declaration
[JsonProperty(PropertyName = "listeners")]
public Dictionary<string, Listener> Listeners { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Listener> | Listeners associated with the network load balancer. |
NetworkSecurityGroupIds
Declaration
[JsonProperty(PropertyName = "networkSecurityGroupIds")]
public List<string> NetworkSecurityGroupIds { get; set; }
Property Value
Type | Description |
---|---|
List<string> | An array of network security groups OCIDs associated with the network load
balancer.
|
NlbIpVersion
Declaration
[JsonProperty(PropertyName = "nlbIpVersion")]
[JsonConverter(typeof(ResponseEnumConverter))]
public NlbIpVersion? NlbIpVersion { get; set; }
Property Value
Type | Description |
---|---|
NlbIpVersion? | IP version associated with the NLB. |
SecurityAttributes
Declaration
[JsonProperty(PropertyName = "securityAttributes")]
public Dictionary<string, Dictionary<string, object>> SecurityAttributes { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | 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.
|
SubnetId
Declaration
[Required(ErrorMessage = "SubnetId is required.")]
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }
Property Value
Type | Description |
---|---|
string | The subnet in which the network load balancer is spawned OCIDs. |
Remarks
Required
SystemTags
Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"} |
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the network load balancer was created, in the format defined by RFC3339.
|
Remarks
Required
TimeUpdated
Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The time the network load balancer was updated. An RFC3339 formatted date-time string.
|