3.1.5.7 loadBalancerMuxes

  • Article

The loadBalancerMuxes resource represents a MUX VM deployed in the Network Controller's stamp.

It is invoked through the following URI.

 https://<url>/networking/v1/loadBalancerMuxes/{resourceId}

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

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, v1 or later, in the URI.

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.7.1.1

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

GET

3.1.5.7.1.2

Get one loadBalancerMuxes resource.

GET ALL

3.1.5.7.1.3

List all loadBalancerMuxes resources.

DELETE

3.1.5.7.1.4

Delete a loadBalancerMuxes 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.

connections

Optional

Indicates an array of connections that specifies the information needed to connect to the specific device for the purposes of managing and controlling the device.

connections.credential

Optional

Indicates a reference to a credentials resource that can be used to connect to the device for management purposes.

connections.credentialType

Optional

Indicates the type of credential, e.g., X509Certificate or usernamePassword.

connections.managementAddresses

Optional

Indicates the management address used to connect to the server.  This is in the form of an IPv4 IP address, an IPv6 IP address, a DNS name or a flat (NetBIOS) name.

routerConfiguration

Required

Provides the BGP router configuration to the MUX to ensure it peers with the datacenter routing infrastructure and properly advertises routes.

routerConfiguration.localASN

Required

Is the BGP autonomous system number (ASN) of the MUX.

routerConfiguration.peerRouterConfigurations

Required

The BGP settings the MUX uses to establish and maintain BGP peering with one or more peers.

routerConfiguration.peerRouterConfigurations.routerName

Required

The friendly name of the peer router.

routerConfiguration.peerRouterConfigurations.peerAsn

Required

The BGP autonomous system number (ASN) of the peer.

routerConfiguration.peerRouterConfigurations.routerIpAddress

Optional

The IPv4 address of the local interface on the MUX from which peering to BGP will be established. If this is not specified, peering is attempted from the management interface on the MUX.

If a localIpAddress is specified on a router configuration, the same localIpAddress MUST be specified for every other router configuration in a given MUX resource.

virtualServer

Required

Indicates a reference to the virtualServer resource that the loadBalancer MUX runs on.

configurationState

Optional

Read-only

See configurationState specification in section 2.2.4.

Additional details are in the section for the GET operation section 3.1.5.7.1.2.

networkInterfaces

Optional

Read/write

Indicates the external and internal interfaces on which the loadBalancerMuxes resource operates.

networkInterfaces.externalNetworkInterface

Required

A resource reference to a network interface.<13>

networkInterfaces.internalNetworkInterface

Required

A resource reference to a network interface.<14>

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.

activityState

Read-only

Indicates the activity state of the mux. The activity state will be set to NA, Active, or Standby.

NA indicates not initialized.


Active in BGP mode indicates all muxes that are active and advertise VIPs. Active in L2-Forwarding (BGP-less) mode denotes the single mux that is active and has VIPs configured on its interface.


Standby indicates a mux is in standby state. In L2-Forwarding (BGP-less) mode, the VIPs will not be configured on a standby mux’s interface.

This property is supported with URI v6 or later.

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

Name

Unit

Meaning

TotalPacketsIPv4

Decimal

Total IPv4 packets processed by the MUX.

TotalPacketsIPv6

Decimal

Total IPv6 packets processed by the MUX.

DroppedPacketsIPv4

Decimal

Total IPv4 packets dropped by the MUX.

DroppedPacketsIPv6

Decimal

Total IPv6 packets dropped by the MUX

SynPacketsIPv4

Decimal

Total IPv4 SYN packets processed by the MUX.

SynPacketsIPv6

Decimal

Total IPv6 SYN packets processed by the MUX.

FlowEntriesIPv4

Decimal

Total IPv4 Flow entries currently being processed by the MUX.

FlowEntriesIPv6

Decimal

Total IPv6 Flow entries currently being processed by the MUX.

DroppedFlowEntriesIPv4

Decimal

Total number of IPv4 flows that were failed during setup.

DroppedFlowEntriesIPv6

Decimal

Total number of IPv6 flows that were failed during setup.

AverageBandwidthIPv4

Decimal

Average bandwidth for IPv4 in Mbps.

AverageBandwidthIPv6

Decimal

Average bandwidth for IPv6 in Mbps.

PacketsPerSecondIPv4

Decimal

Total IPv4 packets being process per second.

PacketsPerSecondIPv6

Decimal

Total IPv6 packets being process per second.