Class CreateNetworkLoadBalancerDetails

The properties that define a network load balancer. For more information, see Introduction to Network Load Balancer.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, then 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.

Inheritance

object

CreateNetworkLoadBalancerDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.NetworkloadbalancerService.Models

Assembly: OCI.DotNetSDK.Networkloadbalancer.dll

Syntax

public class CreateNetworkLoadBalancerDetails

Properties

AssignedIpv6

Declaration

[JsonProperty(PropertyName = "assignedIpv6")]
public string AssignedIpv6 { get; set; }

Property Value

Type	Description
string	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"

AssignedPrivateIpv4

Declaration

[JsonProperty(PropertyName = "assignedPrivateIpv4")]
public string AssignedPrivateIpv4 { get; set; }

Property Value

Type	Description
string	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"

BackendSets

Declaration

[JsonProperty(PropertyName = "backendSets")]
public Dictionary<string, BackendSetDetails> BackendSets { get; set; }

Property Value

Type	Description
Dictionary<string, BackendSetDetails>	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. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	Network load balancer identifier, which can be renamed.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsPreserveSourceDestination

Declaration

[JsonProperty(PropertyName = "isPreserveSourceDestination")]
public bool? IsPreserveSourceDestination { get; set; }

Property Value

Type	Description
bool?	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.

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. 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 for your virtual cloud network. For more information about public and private network load balancers, see Network Load Balancer Types. This value is true by default. Example: true

Type

Description

bool?

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 for your virtual cloud network. For more information about public and private network load balancers, see Network Load Balancer Types. This value is true by default.
Example: true

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.

Listeners

Declaration

[JsonProperty(PropertyName = "listeners")]
public Dictionary<string, ListenerDetails> Listeners { get; set; }

Property Value

Type	Description
Dictionary<string, ListenerDetails>	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. 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"]

Type

Description

List<string>

An array of network security groups OCIDs 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"]

NlbIpVersion

Declaration

[JsonProperty(PropertyName = "nlbIpVersion")]
[JsonConverter(typeof(StringEnumConverter))]
public NlbIpVersion? NlbIpVersion { get; set; }

Property Value

Type	Description
NlbIpVersion?	IP version associated with the NLB.

ReservedIps

Declaration

[JsonProperty(PropertyName = "reservedIps")]
public List<ReservedIP> ReservedIps { get; set; }

Property Value

Type	Description
List<ReservedIP>	An array of reserved Ips.

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. Example: {"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}}

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

SubnetIpv6Cidr

Declaration

[JsonProperty(PropertyName = "subnetIpv6Cidr")]
public string SubnetIpv6Cidr { get; set; }

Property Value

Type	Description
string	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.