Provided by: elbcli_1.0.17.0-0ubuntu1_all
NAME
elb-configure-healthcheck - Configure parameters for checking health of instances
SYNOPSIS
elb-configure-healthcheck LoadBalancerName --healthy-threshold value --interval value --target value --timeout value --unhealthy-threshold value [General Options]
DESCRIPTION
Configure the parameters for checking the health of instances registered with a LoadBalancer. When the instance fails to respond within timeout seconds to unhealthy-threshold number of consecutive healthcheck requests, the instance will be marked as OutOfService. Likewise, when an instance responds within the specified timeout to healthy-threshold number of consecutive healthcheck requests, it is marked as InService. target specifies the protocol and port, and in the case of HTTP.
ARGUMENTS
LoadBalancerName Name of the LoadBalancer. You can also set this value using "--lb". Required.
SPECIFIC OPTIONS
--healthy-threshold VALUE Number of consecutive successful healthchecks that will mark an instance as InService. Required. --interval VALUE Healthcheck interval in seconds. Required. -t, --target VALUE Target for healthcheck. <protocol>:<port> or <protocol>:<port>/<path>. Required. --timeout VALUE Healthcheck timeout in seconds. Required. --unhealthy-threshold VALUE Number of consecutive failed healthchecks that will mark an instance as OutOfService. Required.
GENERAL OPTIONS
--aws-credential-file VALUE Location of the file with your AWS credentials. This value can be set by using the environment variable 'AWS_CREDENTIAL_FILE'. -C, --ec2-cert-file-path VALUE Location of the file with your EC2 X509 certificate. This value can be set by using the environment variable 'EC2_CERT'. --connection-timeout VALUE Specify a connection timeout VALUE (in seconds). The default value is '30'. --delimiter VALUE What delimiter to use when displaying delimited (long) results. --headers If you are displaying tabular or delimited results, it includes the column headers. If you are showing xml results, it returns the HTTP headers from the service request, if applicable. This is off by default. -I, --access-key-id VALUE Specify VALUE as the AWS Access Id to use. -K, --ec2-private-key-file-path VALUE Location of the file with your EC2 private key. This value can be set by using the environment variable 'EC2_PRIVATE_KEY'. --region VALUE Specify region VALUE as the web service region to use. This value can be set by using the environment variable 'EC2_REGION'. -S, --secret-key VALUE Specify VALUE as the AWS Secret Key to use. --show-empty-fields Show empty fields and rows, using a "(nil)" value. The default is to not show empty fields or columns. --show-request Displays the URL the tools used to call the AWS Service. The default value is 'false'. --show-table, --show-long, --show-xml, --quiet Specify how the results are displayed: tabular, delimited (long), xml, or no output (quiet). Tabular shows a subset of the data in fixed column-width form, while long shows all of the returned values delimited by a character. The xml is the raw return from the service, while quiet suppresses all standard output. The default is tabular, or 'show-table'. -U, --url VALUE This option will override the URL for the service call with VALUE. This value can be set by using the environment variable 'AWS_ELB_URL'.
INPUT EXAMPLES
Configure a TCP healthcheck with target port 8080 $PROMPT> elb-configure-healthcheck example-lb --headers --target "TCP:8080" --interval 5 --timeout 3 --unhealthy-threshold 2 --healthy-threshold 2 Configure an HTTP healthcheck with target port 80 with a path $PROMPT> elb-configure-healthcheck example-lb --headers --target "HTTP:80/status" --interval 5 --timeout 3 --unhealthy-threshold 2 --healthy-threshold 2
OUTPUT
This command returns a table that contains the following: * TARGET - Healthcheck target. * INTERVAL - Interval between healthchecks in seconds. * TIMEOUT - Healthcheck timeout in seconds. * HEALTHY_THRESHOLD - Configured number of consecutive successful healthchecks that will mark an instance as InService. * UNHEALTHY_THRESHOLD - Configured number of consecutive failed healthchecks that will mark an instance as OutOfService.
OUTPUT EXAMPLES
HEALTH_CHECK TARGET INTERVAL TIMEOUT HEALTHY_THRESHOLD UNHEALTHY_THRESHOLD HEALTH_CHECK HTTP:8080/status 5 3 2 2
SEE ALSO
http://docs.amazonwebservices.com/ElasticLoadBalancing/2012-06-01/DeveloperGuide/ http://docs.amazonwebservices.com/ElasticLoadBalancing/latest/DeveloperGuide/ Elastic Load Balancing command line t1.0.17.0 api=2012-06-01 ELB-CONFIGURE-HEALTHCHECK(1)