NetworkLoadBalancerClient¶

class oci.network_load_balancer.NetworkLoadBalancerClient(config, **kwargs)¶

This describes the network load balancer API.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_network_load_balancer_compartment`(…)	Moves a network load balancer into a different compartment within the same tenancy.
`create_backend`(network_load_balancer_id, …)	Adds a backend server to a backend set.
`create_backend_set`(network_load_balancer_id, …)	Adds a backend set to a network load balancer.
`create_listener`(network_load_balancer_id, …)	Adds a listener to a network load balancer.
`create_network_load_balancer`(…)	Creates a network load balancer.
`delete_backend`(network_load_balancer_id, …)	Removes a backend server from a given network load balancer and backend set.
`delete_backend_set`(network_load_balancer_id, …)	Deletes the specified backend set.
`delete_listener`(network_load_balancer_id, …)	Deletes a listener from a network load balancer.
`delete_network_load_balancer`(…)	Deletes a network load balancer resource by identifier.
`get_backend`(network_load_balancer_id, …)	Retrieves the configuration information for the specified backend server.
`get_backend_health`(network_load_balancer_id, …)	Retrieves the current health status of the specified backend server.
`get_backend_set`(network_load_balancer_id, …)	Retrieves the configuration information for the specified backend set.
`get_backend_set_health`(…)	Retrieves the health status for the specified backend set.
`get_health_checker`(network_load_balancer_id, …)	Retrieves the health check policy information for a given network load balancer and backend set.
`get_listener`(network_load_balancer_id, …)	Retrieves listener properties associated with a given network load balancer and listener name.
`get_network_load_balancer`(…)	Retrieves network load balancer configuration information by identifier.
`get_network_load_balancer_health`(…)	Retrieves the health status for the specified network load balancer.
`get_work_request`(work_request_id, **kwargs)	Retrieves the details of the work request with the given identifier.
`list_backend_sets`(network_load_balancer_id, …)	Lists all backend sets associated with a given network load balancer.
`list_backends`(network_load_balancer_id, …)	Lists the backend servers for a given network load balancer and backend set.
`list_listeners`(network_load_balancer_id, …)	Lists all listeners associated with a given network load balancer.
`list_network_load_balancer_healths`(…)	Lists the summary health statuses for all network load balancers in the specified compartment.
`list_network_load_balancers`(compartment_id, …)	Returns a list of network load balancers.
`list_network_load_balancers_policies`(**kwargs)	Lists the available network load balancer policies.
`list_network_load_balancers_protocols`(**kwargs)	This API has been deprecated so it won’t return the updated list of supported protocls.
`list_work_request_errors`(work_request_id, …)	Return a (paginated) list of errors for a given work request.
`list_work_request_logs`(work_request_id, …)	Returns a (paginated) list of logs for a given work request.
`list_work_requests`(compartment_id, **kwargs)	Lists all work requests.
`update_backend`(network_load_balancer_id, …)	Updates the configuration of a backend server within the specified backend set.
`update_backend_set`(network_load_balancer_id, …)	Updates a backend set.
`update_health_checker`(…)	Updates the health check policy for a given network load balancer and backend set.
`update_listener`(network_load_balancer_id, …)	Updates a listener for a given network load balancer.
`update_network_load_balancer`(…)	Updates the network load balancer
`update_network_security_groups`(…)	Updates the network security groups associated with the specified network load balancer.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

change_network_load_balancer_compartment(network_load_balancer_id, change_network_load_balancer_compartment_details, **kwargs)¶

Moves a network load balancer into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. change_network_load_balancer_compartment_details (oci.network_load_balancer.models.ChangeNetworkLoadBalancerCompartmentDetails) – (required) The configuration details for moving a network load balancer to a different compartment. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. opc_retry_token (str) – (optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_network_load_balancer_compartment API.

create_backend(network_load_balancer_id, create_backend_details, backend_set_name, **kwargs)¶

Adds a backend server to a backend set.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. create_backend_details (oci.network_load_balancer.models.CreateBackendDetails) – (required) The details to add a backend server to a backend set. backend_set_name (str) – (required) The name of the backend set to which to add the backend server. Example: example_backend_set opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. opc_retry_token (str) – (optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use create_backend API.

create_backend_set(network_load_balancer_id, create_backend_set_details, **kwargs)¶

Adds a backend set to a network load balancer.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. create_backend_set_details (oci.network_load_balancer.models.CreateBackendSetDetails) – (required) The details for adding a backend set. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. opc_retry_token (str) – (optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use create_backend_set API.

create_listener(network_load_balancer_id, create_listener_details, **kwargs)¶

Adds a listener to a network load balancer.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. create_listener_details (oci.network_load_balancer.models.CreateListenerDetails) – (required) Details to add a listener. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. opc_retry_token (str) – (optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use create_listener API.

create_network_load_balancer(create_network_load_balancer_details, **kwargs)¶

Creates a network load balancer.

Parameters:	create_network_load_balancer_details (oci.network_load_balancer.models.CreateNetworkLoadBalancerDetails) – (required) Details for the new network load balancer. opc_retry_token (str) – (optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NetworkLoadBalancer`
Return type:	`Response`
Example:

Click here to see an example of how to use create_network_load_balancer API.

delete_backend(network_load_balancer_id, backend_set_name, backend_name, **kwargs)¶

Removes a backend server from a given network load balancer and backend set.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. backend_set_name (str) – (required) The name of the backend set associated with the backend server. Example: example_backend_set backend_name (str) – (required) The name of the backend server to remove. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>. Example: 10.0.0.3:8080 or ocid1.privateip..oc1.<var><unique_ID></var>:8080 opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_backend API.

delete_backend_set(network_load_balancer_id, backend_set_name, **kwargs)¶

Deletes the specified backend set. Note that deleting a backend set removes its backend servers from the network load balancer.

Before you can delete a backend set, you must remove it from any active listeners.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. backend_set_name (str) – (required) The name of the backend set to delete. Example: example_backend_set opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_backend_set API.

delete_listener(network_load_balancer_id, listener_name, **kwargs)¶

Deletes a listener from a network load balancer.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. listener_name (str) – (required) The name of the listener to delete. Example: example_listener opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_listener API.

delete_network_load_balancer(network_load_balancer_id, **kwargs)¶

Deletes a network load balancer resource by identifier.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. if_match (str) – (optional) 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. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_network_load_balancer API.

get_backend(network_load_balancer_id, backend_set_name, backend_name, **kwargs)¶

Retrieves the configuration information for the specified backend server.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. backend_set_name (str) – (required) The name of the backend set that includes the backend server. Example: example_backend_set backend_name (str) – (required) The name of the backend server to retrieve. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>. Example: 10.0.0.3:8080 or ocid1.privateip..oc1.<var><unique_ID></var>:8080 opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. if_none_match (str) – (optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified). Example: example-etag retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Backend`
Return type:	`Response`
Example:

Click here to see an example of how to use get_backend API.

get_backend_health(network_load_balancer_id, backend_set_name, backend_name, **kwargs)¶

Retrieves the current health status of the specified backend server.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. backend_set_name (str) – (required) The name of the backend set associated with the backend server for which to retrieve the health status. Example: example_backend_set backend_name (str) – (required) The name of the backend server to retrieve health status for. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>. Example: 10.0.0.3:8080 or ocid1.privateip..oc1.<var><unique_ID></var>:8080 opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BackendHealth`
Return type:	`Response`
Example:

Click here to see an example of how to use get_backend_health API.

get_backend_set(network_load_balancer_id, backend_set_name, **kwargs)¶

Retrieves the configuration information for the specified backend set.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. backend_set_name (str) – (required) The name of the backend set to retrieve. Example: example_backend_set opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. if_none_match (str) – (optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified). Example: example-etag retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BackendSet`
Return type:	`Response`
Example:

Click here to see an example of how to use get_backend_set API.

get_backend_set_health(network_load_balancer_id, backend_set_name, **kwargs)¶

Retrieves the health status for the specified backend set.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. backend_set_name (str) – (required) The name of the backend set for which to retrieve the health status. Example: example_backend_set opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BackendSetHealth`
Return type:	`Response`
Example:

Click here to see an example of how to use get_backend_set_health API.

get_health_checker(network_load_balancer_id, backend_set_name, **kwargs)¶

Retrieves the health check policy information for a given network load balancer and backend set.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. backend_set_name (str) – (required) The name of the backend set associated with the health check policy to be retrieved. Example: example_backend_set opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. opc_retry_token (str) – (optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_none_match (str) – (optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified). Example: example-etag retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `HealthChecker`
Return type:	`Response`
Example:

Click here to see an example of how to use get_health_checker API.

get_listener(network_load_balancer_id, listener_name, **kwargs)¶

Retrieves listener properties associated with a given network load balancer and listener name.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. listener_name (str) – (required) The name of the listener to get. Example: example_listener opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. if_none_match (str) – (optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified). Example: example-etag retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Listener`
Return type:	`Response`
Example:

Click here to see an example of how to use get_listener API.

get_network_load_balancer(network_load_balancer_id, **kwargs)¶

Retrieves network load balancer configuration information by identifier.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. if_none_match (str) – (optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified). Example: example-etag opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NetworkLoadBalancer`
Return type:	`Response`
Example:

Click here to see an example of how to use get_network_load_balancer API.

get_network_load_balancer_health(network_load_balancer_id, **kwargs)¶

Retrieves the health status for the specified network load balancer.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NetworkLoadBalancerHealth`
Return type:	`Response`
Example:

Click here to see an example of how to use get_network_load_balancer_health API.

get_work_request(work_request_id, **kwargs)¶

Retrieves the details of the work request with the given identifier.

Parameters:	work_request_id (str) – (required) The identifier of the asynchronous request. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use get_work_request API.

list_backend_sets(network_load_balancer_id, **kwargs)¶

Lists all backend sets associated with a given network load balancer.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. if_none_match (str) – (optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified). Example: example-etag limit (int) – (optional) For list pagination. The maximum number of results per page or items to return, in a paginated “List” call. For important details about how pagination works, see List Pagination. page (str) – (optional) The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ‘asc’ (ascending) or ‘desc’ (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: “timeCreated”, “displayName” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BackendSetCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_backend_sets API.

list_backends(network_load_balancer_id, backend_set_name, **kwargs)¶

Lists the backend servers for a given network load balancer and backend set.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. backend_set_name (str) – (required) The name of the backend set associated with the backend servers. Example: example_backend_set opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. if_none_match (str) – (optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified). Example: example-etag limit (int) – (optional) For list pagination. The maximum number of results per page or items to return, in a paginated “List” call. For important details about how pagination works, see List Pagination. page (str) – (optional) The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ‘asc’ (ascending) or ‘desc’ (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: “timeCreated”, “displayName” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `BackendCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_backends API.

list_listeners(network_load_balancer_id, **kwargs)¶

Lists all listeners associated with a given network load balancer.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. if_none_match (str) – (optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified). Example: example-etag limit (int) – (optional) For list pagination. The maximum number of results per page or items to return, in a paginated “List” call. For important details about how pagination works, see List Pagination. page (str) – (optional) The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ‘asc’ (ascending) or ‘desc’ (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: “timeCreated”, “displayName” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ListenerCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_listeners API.

list_network_load_balancer_healths(compartment_id, **kwargs)¶

Lists the summary health statuses for all network load balancers in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment containing the network load balancers to list. sort_order (str) – (optional) The sort order to use, either ‘asc’ (ascending) or ‘desc’ (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. limit (int) – (optional) For list pagination. The maximum number of results per page or items to return, in a paginated “List” call. For important details about how pagination works, see List Pagination. page (str) – (optional) The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NetworkLoadBalancerHealthCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_network_load_balancer_healths API.

list_network_load_balancers(compartment_id, **kwargs)¶

Returns a list of network load balancers.

Parameters:	compartment_id (str) – (required) The OCID of the compartment containing the network load balancers to list. lifecycle_state (str) – (optional) A filter to return only resources that match the given lifecycle state. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” display_name (str) – (optional) A filter to return only resources that match the entire display name given. limit (int) – (optional) For list pagination. The maximum number of results per page or items to return, in a paginated “List” call. For important details about how pagination works, see List Pagination. page (str) – (optional) The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ‘asc’ (ascending) or ‘desc’ (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NetworkLoadBalancerCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_network_load_balancers API.

list_network_load_balancers_policies(**kwargs)¶

Lists the available network load balancer policies.

Parameters:	opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. limit (int) – (optional) For list pagination. The maximum number of results per page or items to return, in a paginated “List” call. For important details about how pagination works, see List Pagination. page (str) – (optional) The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ‘asc’ (ascending) or ‘desc’ (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: “timeCreated”, “displayName” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NetworkLoadBalancersPolicyCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_network_load_balancers_policies API.

list_network_load_balancers_protocols(**kwargs)¶

This API has been deprecated so it won’t return the updated list of supported protocls. Lists all supported traffic protocols.

Parameters:	opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. limit (int) – (optional) For list pagination. The maximum number of results per page or items to return, in a paginated “List” call. For important details about how pagination works, see List Pagination. page (str) – (optional) The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ‘asc’ (ascending) or ‘desc’ (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: “timeCreated”, “displayName” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NetworkLoadBalancersProtocolCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_network_load_balancers_protocols API.

list_work_request_errors(work_request_id, compartment_id, **kwargs)¶

Return a (paginated) list of errors for a given work request.

Parameters:	work_request_id (str) – (required) The identifier of the asynchronous request. compartment_id (str) – (required) The OCID of the compartment containing the network load balancers to list. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. page (str) – (optional) The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page or items to return, in a paginated “List” call. For important details about how pagination works, see List Pagination. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestErrorCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, compartment_id, **kwargs)¶

Returns a (paginated) list of logs for a given work request.

Parameters:	work_request_id (str) – (required) The identifier of the asynchronous request. compartment_id (str) – (required) The OCID of the compartment containing the network load balancers to list. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. page (str) – (optional) The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page or items to return, in a paginated “List” call. For important details about how pagination works, see List Pagination. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestLogEntryCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(compartment_id, **kwargs)¶

Lists all work requests.

Parameters:	compartment_id (str) – (required) The OCID of the compartment containing the network load balancers to list. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. limit (int) – (optional) For list pagination. The maximum number of results per page or items to return, in a paginated “List” call. For important details about how pagination works, see List Pagination. page (str) – (optional) The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_requests API.

update_backend(network_load_balancer_id, update_backend_details, backend_set_name, backend_name, **kwargs)¶

Updates the configuration of a backend server within the specified backend set.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. update_backend_details (oci.network_load_balancer.models.UpdateBackendDetails) – (required) Details for updating a backend server. backend_set_name (str) – (required) The name of the backend set associated with the backend server. Example: example_backend_set backend_name (str) – (required) The name of the backend server to update. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>. Example: 10.0.0.3:8080 or ocid1.privateip..oc1.<var><unique_ID></var>:8080 opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. opc_retry_token (str) – (optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_backend API.

update_backend_set(network_load_balancer_id, update_backend_set_details, backend_set_name, **kwargs)¶

Updates a backend set.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. update_backend_set_details (oci.network_load_balancer.models.UpdateBackendSetDetails) – (required) The details to update a backend set. backend_set_name (str) – (required) The name of the backend set to update. Example: example_backend_set opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. opc_retry_token (str) – (optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_backend_set API.

update_health_checker(network_load_balancer_id, update_health_checker_details, backend_set_name, **kwargs)¶

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

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. update_health_checker_details (oci.network_load_balancer.models.UpdateHealthCheckerDetails) – (required) The health check policy configuration details. backend_set_name (str) – (required) The name of the backend set associated with the health check policy to be retrieved. Example: example_backend_set opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. opc_retry_token (str) – (optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_health_checker API.

update_listener(network_load_balancer_id, update_listener_details, listener_name, **kwargs)¶

Updates a listener for a given network load balancer.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. update_listener_details (oci.network_load_balancer.models.UpdateListenerDetails) – (required) Details to update a listener. listener_name (str) – (required) The name of the listener to update. Example: example_listener opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. opc_retry_token (str) – (optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_listener API.

update_network_load_balancer(network_load_balancer_id, update_network_load_balancer_details, **kwargs)¶

Updates the network load balancer

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. update_network_load_balancer_details (oci.network_load_balancer.models.UpdateNetworkLoadBalancerDetails) – (required) The information to be updated. if_match (str) – (optional) 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. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_network_load_balancer API.

update_network_security_groups(network_load_balancer_id, update_network_security_groups_details, **kwargs)¶

Updates the network security groups associated with the specified network load balancer.

Parameters:	network_load_balancer_id (str) – (required) The OCID of the network load balancer to update. update_network_security_groups_details (oci.network_load_balancer.models.UpdateNetworkSecurityGroupsDetails) – (required) The details for updating the network security groups associated with the specified network load balancer. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. opc_retry_token (str) – (optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_network_security_groups API.