![]() |
![]()
| ![]() |
![]()
NAMElb_listener_create -
DESCRIPTIONAdds a listener to a load balancer.USAGEoci lb listener create [OPTIONS] REQUIRED PARAMETERS
The name of the associated backend set. Example: example_backend_set
The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the load balancer on which to add a listener.
A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener
The communication port for the listener. Example: 80
The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols <https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lb/protocol/list.html> operation. Example: HTTP OPTIONAL PARAMETERS
Cipher suite name for listener.
Connection Configuration Backend TCP Proxy Protocol Version.
The maximum idle time, in seconds, allowed between two successive receive or two successive send operations between the client and backend servers.
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
An array of hostname resource names. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax. The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.
The maximum time to wait for the work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.
Deprecated. Please use routingPolicies instead. The name of the set of path-based routing rules, PathRouteSet <https://docs.cloud.oracle.com/api/#/en/loadbalancer/20170115/PathRouteSet/>, applied to this listener’s traffic. Example: example_path_route_set
List of protocols to be configured for listener. It must be a list of strings. Example: ["TLSv1.1","TLSv1.2"]
The name of the routing policy applied to this listener’s traffic. Example: example_routing_policy
The names of the rule sets <https://docs.cloud.oracle.com/api/#/en/loadbalancer/20170115/RuleSet/> to apply to the listener. Example: ["example_rule_set"] This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax. The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.
Server order preference for listener.
A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information.
The maximum depth for peer certificate chain verification.
Whether the load balancer listener should verify peer certificates.
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, FAILED, IN_PROGRESS, SUCCEEDED
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 PARAMETERSUse oci --help for help on global parameters.--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v EXAMPLESCopy and paste the following example into a JSON file, replacing the example parameters with your own.oci lb load-balancer create --generate-param-json-input subnet-ids > subnet-ids.json Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own. Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples. export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lb/load-balancer/create.html#cmdoption-compartment-id export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lb/load-balancer/create.html#cmdoption-display-name export shape_name=<substitute-value-of-shape_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lb/load-balancer/create.html#cmdoption-shape-name export default_backend_set_name=<substitute-value-of-default_backend_set_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lb/listener/create.html#cmdoption-default-backend-set-name export port=<substitute-value-of-port> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lb/listener/create.html#cmdoption-port export protocol=<substitute-value-of-protocol> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lb/listener/create.html#cmdoption-protocol load_balancer_id=$(oci lb load-balancer create --compartment-id $compartment_id --display-name $display_name --shape-name $shape_name --subnet-ids file://subnet-ids.json --query data.id --raw-output) oci lb listener create --default-backend-set-name $default_backend_set_name --load-balancer-id $load_balancer_id --name $name --port $port --protocol $protocol AUTHOROracleCOPYRIGHT2016, 2022, Oracle
|