describe-client-connectivity

subtitle

Returns client connectivity details

version

0.9.50 (BETA)

Description

Returns details to enable programmatic client connectivity for a database

Synopsis

  describe-client-connectivity
--environment-name <value>
--database-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options

--environment-name (string) The name of the environment

--database-name (string) The name of the database

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean) Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output

connectors -> (array)

Available connectors for this database

(object)

Information to use to connect to a database via some mechanism.

name -> (string)

The name of the API/Library this connector represents.

version -> (string)

The version of the connector.

kind -> (string)

A categorization of a connector to describe how it is broadly used. LIBRARY - A client library or API which user’s code invokes JDBC - A JDBC driver SERVICE - A Service URL ENVIRONMENT - An environment to use to run other commands and tools ODBC - An ODBC driver

dependencies -> (object)

Information about dependencies necessary to use a connector.

mavenUrl -> (string)

The URL of a Maven repository containing the client JARs.

configuration -> (object)

Runtime details necessary to use a connector.

clientConfigurationDetails -> (array)

Configuration information required to use a Connector

(object)

A URL which holds information necessary to configure a Connector.

name -> (string)

The name of this configuration

url -> (string)

The URL from which to fetch the configuration

jdbcUrl -> (string)

A base JDBC URL if the connector is a JDBC driver.

serviceUrl -> (string)

A base service URL

requiresKerberos -> (boolean)

True if the connector requires Kerberos to authenticate.

kerberosConfiguration -> (object)

Configuration information to enable Kerberos authentication

kdcHost -> (string)

The hostname of the KDC

realm -> (string)

The Kerberos realm

krb5Conf -> (string)

A base64-encoded krb5.conf file

Form Factors

public