create-jms-connection

Description

Creates a new Connection.

Usage

oci goldengate connection create-jms-connection [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The OCID of the compartment being referenced.

--display-name [text]

An object’s Display Name.

--should-use-jndi [boolean]

If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.

--technology-type [text]

The Java Message Service technology type.

Optional Parameters

--authentication-type [text]

Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

--connection-factory [text]

The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: ‘com.stc.jmsjca.core.JConnectionFactoryXA’

--connection-url [text]

Connectin URL of the Java Message Service, specifying the protocol, host, and port. e.g.: ‘mq://myjms.host.domain:7676’

--defined-tags [complex type]

Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example:

{"foo-namespace": {"bar-key": "value"}}

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.

--description [text]

Metadata about this specific object.

--freeform-tags [complex type]

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example:

{"bar-key": "value"}

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.

--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: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--jndi-connection-factory [text]

The Connection Factory can be looked up using this name. e.g.: ‘ConnectionFactory’

--jndi-initial-context-factory [text]

The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: ‘org.apache.activemq.jndi.ActiveMQInitialContextFactory’

--jndi-provider-url [text]

The URL that Java Message Service will use to contact the JNDI provider. e.g.: ‘tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000

--jndi-security-credentials [text]

The password associated to the principal.

--jndi-security-principal [text]

Specifies the identity of the principal (user) to be authenticated. e.g.: ‘admin2’

--key-id [text]

Refers to the customer’s master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

--key-store [text]

The base64 encoded content of the KeyStore file.

--key-store-password [text]

The KeyStore password.

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

--nsg-ids [complex type]

An array of Network Security Group OCIDs used to define network access for either Deployments or Connections. 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.

--password [text]

The password Oracle GoldenGate uses to connect the associated Java Message Service.

--private-ip [text]

The private IP address of the connection’s endpoint in the customer’s VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

--security-protocol [text]

Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.

--ssl-key-password [text]

The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

--subnet-id [text]

The OCID of the subnet being referenced.

--trust-store [text]

The base64 encoded content of the TrustStore file.

--trust-store-password [text]

The TrustStore password.

--username [text]

The username Oracle GoldenGate uses to connect to the Java Message Service. This username must already exist and be available by the Java Message Service to be connected to.

--vault-id [text]

Refers to the customer’s vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

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

ACCEPTED, CANCELED, FAILED, IN_PROGRESS, SUCCEEDED
--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 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 and appropriate security policies 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/goldengate/connection/create-jms-connection.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/goldengate/connection/create-jms-connection.html#cmdoption-display-name
    export should_use_jndi=<substitute-value-of-should_use_jndi> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/goldengate/connection/create-jms-connection.html#cmdoption-should-use-jndi
    export technology_type=<substitute-value-of-technology_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/goldengate/connection/create-jms-connection.html#cmdoption-technology-type

    oci goldengate connection create-jms-connection --compartment-id $compartment_id --display-name $display_name --should-use-jndi $should_use_jndi --technology-type $technology_type