3.1.5.5.3 frontendIPConfigurations

The frontendIPConfigurations resource represents the frontend IP addresses of the load balancer. Either a publicIPAddress or a privateIPAddress and subnet MUST be configured.

It is invoked through the following URI.

 https://<url>/networking/v1/loadBalancers/{parentResourceId}/frontendIPConfigurations/{resourceId}

url: The address or name of the REST server of the Network Controller.

parentResourceId: the identifier for the specific ancestor resource within the resource type. See section 2.2.3.3 for more details.

resourceId: the identifier for the specific descendant resource within the resource type. See section 2.2.3.4 for more details.

Note  The server MAY support additional versions, besides v1 in the URI.

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.5.3.1.1

Create a new frontendIPConfigurations resource or update an existing frontendIPConfigurations resource.

GET

3.1.5.5.3.1.2

Get one frontendIPConfigurations resource.

GET ALL

3.1.5.5.3.1.3

List all frontendIPConfigurations resources in the Network Controller.

DELETE

3.1.5.5.3.1.4

Deletes a frontendIPConfigurations resource.

The following property elements are valid.

Element name

Type

Description

etag

Read-only

Specified in Common JSON Elements, section 2.2.2.

provisioningState

Read-only

Specified in Common JSON Elements, section 2.2.2.

inboundNatRules

Read-only

Indicates a reference to the inboundNatRules resource used by the frontEndIPConfigurations resource.

loadBalancingRules

Read-only

Indicates a reference to the loadBalancingRules resource used by the frontendIPConfigurations resource.

outboundNatRules

Read-only

Indicates a reference to the outboundNatRules resource used by the frontendIPConfigurations resource.

publicIPAddress

Optional

Indicates a reference to the publicIPAddresses resource (section 3.1.5.14) used by the frontendIPConfigurations resource. If a publicIPAddress is specified, then a privateIPaddress is not specified. When a publicIPAddress is specified, the privateIPAllocationMethod is set to Dynamic.

IPv6 addresses are supported with URI version v2 or later.

privateIPAddress

Optional

This is only specified if a specific private IP address identifies an IP address which is statically configured for use with this frontendIPConfigurations resource. The privateIPAllocationMethod MUST be allocated static for this case.

If a privateIPAddress is specified, a reference to a publicIPaddress cannot be specified at the same time.

The private IP address can be either from the infrastructure address space or from a tenant address space, in either case they MUST be accompanied with a valid subnet specified in the subnet element reference.

IPv6 addresses are supported with URI version v2 or later.

privateIPAllocationMethod

Optional

Static or Dynamic

subnet

Optional

Indicates a reference to the subnet resource used by the frontendIPConfigurations resource.  MUST be specified if a privateIPaddress is specified.

A subnet reference to a logical network subnet is needed if the privateIPAddress is from the infrastructure address space. A subnet reference to a virtual network subnet is needed if the privateIPAddress is from a tenant address space.

The subnet MUST include the IP address specified in privateIPAddress.

configurationState

Read-only

A LoadBalancerVipConfigurationState structure that represents the running state of a VIP endpoint. This structure extends the base configurationState (section 2.2.4) and adds a

LoadBalancerVipEndPointConfigurationState type array that is a list of VipEndpointStates. More details are given in the section for the GET operation section 3.1.5.5.3.1.2.

This property is supported with URI version v2 or later.

configurationState.vipEndpointStates

Read-only

An array that contains the configurationState of the VIP endpoints (privateIPAddress) associated with the frontendIPConfigurations resource in loadBalancers resource or the VIP endpoints (ipAddress) associated with the publicIPAddresses resource.

configurationState.vipEndpointStates.vipEndpoint

Read-only

Virtual IP endpoint.

configurationState.vipEndpointStates.dipEndpointStates

Read-only

An array that contains the configurationState of the DIP endpoints associated with:

1. the VIP endpoints (privateIPAddress) associated with the frontendIPConfigurations resource in loadBalancers resource, or

2. the VIP endpoints (ipAddress) associated with the publicIPAddresses resource.

configurationState.vipEndpointStates.dipEndpointStates.dipEndpoint

Read-only

Contextual information about the load-balanced dip endpoint for which the associated state is presented. Formatted as "IPAddress:Port".

configurationState.vipEndpointStates.dipEndpointStates.hostIPAddress

Read-only

The host server’s IP address from which the fault state is being provided. See servers resource section 3.1.5.15

configurationState.vipEndpointStates.dipEndpointStates.hostId

Read-only

Unique identifier for the server for which the fault state is being provided for, see servers resource.

configurationState.vipEndpointStates.dipEndpointStates.AdapterId

Read-only

Physical address (MAC) of the adapter for which fault state is being provided for.

configurationState.vipEndpointStates.dipEndpointStates.ProbeRule

Read-only

Any associated probe rule which might be offline. Empty ("") if no probe was specified.

counters

Optional Read-only

Array of ResourceCounter structures (section 3.1.1.1). The supported properties are documented in the following table.

This property is supported with URI version v2 or later.

Either a privateIPAddress or a reference to a publicIPAddresses MUST be specified – both these represent VIPs. A privateIPAddress can specify a VIP in either the infrastructure space or in the tenant space (depending on the subnet reference). A public IP reference can only specify a VIP in the infrastructure address space. VIPs in the infrastructure space MUST be contained within a VIP pool configured on the loadbalancerManager object.

Properties supported in the counters for the loadBalancers frontendIpConfigurations resource. The following property elements are valid where source is SoftwareLoadBalancer, and category is Performance.

Name

Unit

Meaning

TotalPackets

Decimal

Total IP packets processed by the MUX.

DroppedPackets

Decimal

Total packets dropped for the VIP.

FlowEntries

Decimal

Total flow entries created for the VIP.

DroppedFlowEntries

Decimal

Total flow entries dropped for the VIP.

SynPackets

Decimal

Total SYN packets processed for the VIP.

AverageBandwidth

Decimal

Average bandwidth in Mbps.

PacketsPerSecond

Decimal

Total packets processed per second for the VIP.