update
¶
Description¶
Updates the health check policy for a given network load balancer and backend set.
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
-
--network-load-balancer-id
[text]
¶
The OCID of the network load balancer to update.
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
-
--if-match
[text]
¶
For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
-
--interval-in-millis
[integer]
¶
The interval between health checks, in milliseconds.
Example:
10000
-
--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.
-
--port
[integer]
¶
The backend server port against which to run the health check.
Example:
8080
-
--protocol
[text]
¶
The protocol that the health check must use; either HTTP, UDP, or TCP.
Example:
HTTP
Accepted values are:
HTTP, HTTPS, TCP, UDP
-
--request-data
[text]
¶
Base64 encoded pattern to be sent as UDP or TCP health check probe.
-
--response-body-regex
[text]
¶
A regular expression for parsing the response body from the backend server.
Example:
^((?!false).|\s)*$
-
--response-data
[text]
¶
Base64 encoded pattern to be validated as UDP or TCP health check probe response.
-
--retries
[integer]
¶
The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state.
Example:
3
-
--return-code
[integer]
¶
The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200".
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
-
--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. Multiple states can be specified, returning on the first state. For example, --wait-for-state
SUCCEEDED --wait-for-state
FAILED would return on whichever lifecycle state is reached first. 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, CANCELED, CANCELING, 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.
Global Parameters¶
Use oci --help
for help on global parameters.
--auth-purpose
, --auth
, --cert-bundle
, --cli-rc-file
, --config-file
, --debug
, --defaults-file
, --endpoint
, --generate-full-command-json-input
, --generate-param-json-input
, --help
, --latest-version
, --no-retry
, --opc-client-request-id
, --opc-request-id
, --output
, --profile
, --query
, --raw-output
, --region
, --release-info
, --request-id
, --version
, -?
, -d
, -h
, -v