osc load-balancer pool member create

This operation provisions a member and adds it to a pool by using the configuration that you define in the request object. After the API validates the request and starts the provisioning process, it returns a response object, which contains a unique ID.

In the response, the member provisioning status is ACTIVE, PENDING_CREATE, or ERROR.

If the status is PENDING_CREATE, issue GET /v2/lbaas/pools/{pool_id}/members/{member_id} to view the progress of the provisioning operation. When the member status changes to ACTIVE, the member is successfully provisioned and is ready for further configuration.

If the API cannot fulfill the request due to insufficient data or data that is not valid, the service returns the HTTP Bad Request (400) response code with information about the failure in the response body. Validation errors require that you correct the error and submit the request again.

At a minimum, you must specify these member attributes:

Some attributes receive default values if you omit them from the request:

If you omit the subnet_id parameter, the vip_subnet_id for the parent load balancer will be used for the member subnet UUID.

The member address does not necessarily need to be a member of the subnet_id subnet. Members can be routable from the subnet specified either via the default route or by using host_routes defined on the subnet.

Administrative users can specify a project ID that is different than their own to create members for other projects.

monitor_address and/or monitor_port can be used to have the health monitor, if one is configured for the pool, connect to an alternate IP address and port when executing a health check on the member.

To create a member, the load balancer must have an ACTIVE provisioning status.

Usage: osc load-balancer pool member create [OPTIONS] --address <ADDRESS> --protocol-port <PROTOCOL_PORT> <POOL_ID>

Arguments:

  • <POOL_ID> — pool_id parameter for /v2/lbaas/pools/{pool_id}/members/{member_id} API

Options:

  • --address <ADDRESS> — The IP address of the resource

  • --admin-state-up <ADMIN_STATE_UP> — The administrative state of the resource, which is up (true) or down (false). Default is true

    Possible values: true, false

  • --backup <BACKUP> — Is the member a backup? Backup members only receive traffic when all non-backup members are down.

    New in version 2.1

    Possible values: true, false

  • --monitor-address <MONITOR_ADDRESS> — An alternate IP address used for health monitoring a backend member. Default is null which monitors the member address

  • --monitor-port <MONITOR_PORT> — An alternate protocol port used for health monitoring a backend member. Default is null which monitors the member protocol_port

  • --name <NAME> — Human-readable name of the resource

  • --project-id <PROJECT_ID> — The ID of the project owning this resource. (deprecated)

  • --protocol-port <PROTOCOL_PORT> — The protocol port number for the resource

  • --subnet-id <SUBNET_ID> — The subnet ID the member service is accessible from

  • --tags <TAGS> — A list of simple strings assigned to the resource.

    New in version 2.5

  • --tenant-id <TENANT_ID>

  • --weight <WEIGHT> — The weight of a member determines the portion of requests or connections it services compared to the other members of the pool. For example, a member with a weight of 10 receives five times as many requests as a member with a weight of 2. A value of 0 means the member does not receive new connections but continues to service existing connections. A valid value is from 0 to 256. Default is 1