osc load-balancer pool member set

Update an existing member.

If the request is valid, the service returns the Accepted (202) response code. To confirm the update, check that the member provisioning status is ACTIVE. If the status is PENDING_UPDATE, use a GET operation to poll the member object for changes.

Setting the member weight to 0 means that the member will not receive new requests but will finish any existing connections. This “drains” the backend member of active connections.

This operation returns the updated member object with the ACTIVE, PENDING_UPDATE, or ERROR provisioning status.

Usage: osc load-balancer pool member set [OPTIONS] <POOL_ID> <ID>

Arguments:

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

Options:

  • --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

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

    New in version 2.5

  • --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