Retrieves the configuration information for the specified backend server.


oci nlb backend get [OPTIONS]

Required Parameters

--backend-name [text]

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:` or `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:8080
--backend-set-name [text]

The name of the backend set that includes the backend server.


--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:

--if-none-match [text]

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 using required parameter

Copy the following CLI commands into a file named Run the command by typing “bash” 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 and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> #
    export display_name=<substitute-value-of-display_name> #
    export subnet_id=<substitute-value-of-subnet_id> #
    export backend_name=<substitute-value-of-backend_name> #
    export backend_set_name=<substitute-value-of-backend_set_name> #

    network_load_balancer_id=$(oci nlb network-load-balancer create --compartment-id $compartment_id --display-name $display_name --subnet-id $subnet_id --query --raw-output)

    oci nlb backend get --backend-name $backend_name --backend-set-name $backend_set_name --network-load-balancer-id $network_load_balancer_id