update

Description

Updates the health check policy for a given load balancer and backend set.

Usage

oci lb health-checker update [OPTIONS]

Required Parameters

--backend-set-name [text]

The name of the backend set associated with the health check policy to be retrieved.

Example:

example_backend_set
--interval-in-millis [integer]

The interval between health checks, in milliseconds.

Example:

10000
--load-balancer-id [text]

The OCID of the load balancer associated with the health check policy to be updated.

--port [integer]

The backend server port against which to run the health check.

Example:

8080
--protocol [text]

The protocol the health check must use; either HTTP or TCP.

Example:

HTTP
--response-body-regex [text]

A regular expression for parsing the response body from the backend server.

Example:

^((?!false).|\s)*$
--retries [integer]

The number of retries to attempt before a backend server is considered "unhealthy".

Example:

3
--return-code [integer]

The status code a healthy backend server should return.

Example:

200
--timeout-in-millis [integer]

The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period.

Example:

3000

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id --> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our "using CLI with advanced JSON options" link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--max-wait-seconds [integer]

The maximum time to wait for the work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.

--url-path [text]

The path against which to run the health check.

Example:

/healthcheck
--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource and uses a work request to track the progress of the operation. Specify this option to perform the action and then wait until the work request reaches a certain state. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

ACCEPTED, FAILED, IN_PROGRESS, SUCCEEDED
--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the work request to see if it has reached the state defined by --wait-for-state. Defaults to 30 seconds.