F5 Networks · Schema

PoolMemberCreate

Request body for adding a new pool member.

API GatewayApplication DeliveryAutomationEdge ComputingKubernetesLoad BalancingMulti-CloudNGINXSecurityWAF

Properties

Name	Type	Description
name	string	Member name in address:port format. If a node with the address does not exist, one will be created.
address	string	IP address if it differs from the name.
description	string
connectionLimit	integer
monitor	string
priorityGroup	integer
rateLimit	string
ratio	integer
session	string
state	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PoolMemberCreate",
  "title": "PoolMemberCreate",
  "type": "object",
  "description": "Request body for adding a new pool member.",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Member name in address:port format. If a node with the address does not exist, one will be created.",
      "example": "10.0.0.1:80"
    },
    "address": {
      "type": "string",
      "description": "IP address if it differs from the name.",
      "example": "example_value"
    },
    "description": {
      "type": "string",
      "example": "A sample description."
    },
    "connectionLimit": {
      "type": "integer",
      "minimum": 0,
      "example": 10
    },
    "monitor": {
      "type": "string",
      "example": "example_value"
    },
    "priorityGroup": {
      "type": "integer",
      "minimum": 0,
      "example": 10
    },
    "rateLimit": {
      "type": "string",
      "example": "example_value"
    },
    "ratio": {
      "type": "integer",
      "minimum": 1,
      "example": 10
    },
    "session": {
      "type": "string",
      "enum": [
        "user-enabled",
        "user-disabled"
      ],
      "example": "user-enabled"
    },
    "state": {
      "type": "string",
      "enum": [
        "user-up",
        "user-down"
      ],
      "example": "user-up"
    }
  }
}