osc load-balancer healthmonitor set

Update an existing health monitor.

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

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

Usage: osc load-balancer healthmonitor set [OPTIONS] <ID>

Arguments:

  • <ID> — healthmonitor_id parameter for /v2/lbaas/healthmonitors/{healthmonitor_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

  • --delay <DELAY> — The time, in seconds, between sending probes to members

  • --domain-name <DOMAIN_NAME> — The domain name, which be injected into the HTTP Host Header to the backend server for HTTP health check.

    New in version 2.10

  • --expected-codes <EXPECTED_CODES> — The list of HTTP status codes expected in response from the member to declare it healthy. Specify one of the following values:

    • A single value, such as 200 - A list, such as 200, 202 - A range, such as 200-204

    The default is 200.

  • --http-method <HTTP_METHOD> — The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET

    Possible values: connect, delete, get, head, options, patch, post, put, trace

  • --http-version <HTTP_VERSION> — The HTTP version. One of 1.0 or 1.1. The default is 1.0.

    New in version 2.10

  • --max-retries <MAX_RETRIES> — The number of successful checks before changing the operating status of the member to ONLINE. A valid value is from 1 to 10

  • --max-retries-down <MAX_RETRIES_DOWN> — The number of allowed check failures before changing the operating status of the member to ERROR. A valid value is from 1 to 10. The default is 3

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

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

    New in version 2.5

  • --timeout <TIMEOUT> — The maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value

  • --url-path <URL_PATH> — The HTTP URL path of the request sent by the monitor to test the health of a backend member. Must be a string that begins with a forward slash (/). The default URL path is /