Starts an asynchronous job to create an ODA Private Endpoint Scan Proxy.

To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestID}.


oci oda management oda-private-endpoint-scan-proxy create [OPTIONS]

Required Parameters

--oda-private-endpoint-id [text]

Unique ODA Private Endpoint identifier which is the OCID.

--protocol [text]

The protocol used for communication between client, scanProxy and RAC’s scan listeners

--scan-listener-infos [complex type]

The FQDN/IPs and port information of customer’s Real Application Cluster (RAC)’s SCAN listeners. 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.

--scan-listener-type [text]

Type indicating whether Scan listener is specified by its FQDN or list of IPs

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:

--max-wait-seconds [integer]

The maximum time to wait for the work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.

--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource and uses a work request to track the progress of the operation. Specify this option to perform the action and then wait until the work request reaches a certain state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the work request has reached the state defined by --wait-for-state. Defaults to 30 seconds.

Example using required parameter

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci oda management oda-private-endpoint-scan-proxy create --generate-param-json-input scan-listener-infos > scan-listener-infos.json

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 oda_private_endpoint_id=<substitute-value-of-oda_private_endpoint_id> #
    export protocol=<substitute-value-of-protocol> #
    export scan_listener_type=<substitute-value-of-scan_listener_type> #

    oci oda management oda-private-endpoint-scan-proxy create --oda-private-endpoint-id $oda_private_endpoint_id --protocol $protocol --scan-listener-infos file://scan-listener-infos.json --scan-listener-type $scan_listener_type