このページで説明する手順により、virtual databasesおよびSSH tunnelsを管理することができます。

SYSADMIN_VDB.createVdb

このプロシージャは、仮想データベースを作成します：

SYSADMIN_VDB.createVdb("name" => 'string_name');;

Example

CALL "SYSADMIN_VDB.createVdb"("name" => 'newVDB');;

SYSADMIN_VDB.dropVdb

このプロシージャは、ID によって仮想データベースを削除します：

SYSADMIN_VDB.dropVdb("id" => biginteger_id);;

削除する必要がある仮想データベースのID を表示するには、SYSADMIN_VDB.VirtualDatabasesテーブルを使用できます。

Please be aware that this operation cannot be undone, and a dropped virtual database is gone for good.

Example

CALL "SYSADMIN_VDB.dropVdb"("id" => 10);;

SYSADMIN_VDB.generateCloudAgentApiKey

このプロシージャは、新しいCLOUD_AGENT_CLIENT_API_KEYオプション値を生成します。

SYSADMIN_VDB.generateCloudAgentApiKey(OUT newApiKey string RESULT)

Example

CALL "SYSADMIN_VDB.generateCloudAgentApiKey"() ;;

SYSADMIN_VDB.getCloudAgentConfiguration

本プロシージャは、接続されているすべてのエージェントインスタンスからすべての構成ファイルの内容を取得します。 

SYSADMIN_VDB.getCloudAgentConfiguration(OUT clientId string NOT NULL, OUT file string NOT NULL, OUT configuration string)

clientId は、エージェントインスタンスの起動時にランダムに割り当てられる UUID です。これは、エージェントの Configuration ディレクトリ内のclient_idファイルに保存されます。clientIdはインスタンスの一意な識別子として機能し、特に複数のエージェントがクラスタに配置されている環境では、他のインスタンスと区別することができます。

Example

SELECT * FROM SYSADMIN_VDB.getCloudAgentConfiguration() ;;

SYSADMIN_VDB.getCloudAgentConnectionStatus

このプロシージャはdatasourceの値としてNULL が渡された場合に、特定のデータソースまたはサーバー全般に対するクラウドエージェントの接続状態を評価するために設計されています。

SYSADMIN_VDB.getCloudAgentConnectionStatus(IN datasource string, OUT connected boolean NOT NULL)

Parameter name

Parameter type

Mandatory

Description

datasource

string

NULL

This parameter specifies the data source for which the connection status needs to be checked.

Examples

SELECT * FROM "SYSADMIN_VDB.getCloudAgentConnectionStatus"() ;;
 
SELECT * FROM "SYSADMIN_VDB.getCloudAgentConnectionStatus"(
"datasource" => 'some_datasource'
) ;;

SYSADMIN_VDB.getJavaProp

このプロシージャは、Translator 関連のクライアントシークレットを取得します：

SYSADMIN_VDB.getJavaProp(IN key1 string NOT NULL, OUT value1 string RESULT)

Example

CALL "SYSADMIN_VDB.getJavaProp"("key1" => 'user.language');;

SYSADMIN_VDB.setJavaProp

このプロシージャは、Translator 関連のクライアントシークレットを設定します：

SYSADMIN_VDB.setJavaProp(IN key1 string NOT NULL, IN value1 string)

Example

CALL "SYSADMIN_VDB.setJavaProp"("key1" => 'user.language', "value1" => 'en');;

SYSADMIN_VDB.createSSHTunnel 

このプロシージャは、SSH トンネルを作成します。以下のパラメータを取ります：

To view the full table, click the expand button in its top right corner

Parameter name

Parameter type

Mandatory

Description

name

string

NOT NULL

Unique name of an SSH tunnel

localHost

string

NULL

Host of a client's machine (default: localhost)

localPort

integer

NOT NULL

Port of a client's machine

remoteHost

string

NOT NULL

Host of a remote machine

remotePort

integer

NOT NULL

Port of a remote machine

host

string

NOT NULL

Username and host used for connecting to a remote machine via SSH protocol (format: username@host)

sshKeyPairId

integer

NULL

ID of a key-pair in the SYSADMIN_VDB.SSHCredentials table

sshPort

integer

NULL

Port used by SSH server on a remote machine (default: 22)

sshProperties

string

NULL

SSH comma-separated properties in CSV-like form: property1=<value1>,property2=<value2>. Used to provide a timeout, cypher parameters, key parameters like used algorithms, a possibility to provide classes for custom algorithms, and so on

password

string

NULL

Password used for simple authentication on the SSH server

passPhrase

string

NULL

Password phrase used in case of a secured private key and key authentication on the SSH server

privateKeyPath

string

NULL

Private key path or the private key itself as a string in case of key authentication on the SSH server

proxy

string

NULL

Possible values: NONE, HTTP, SOCKS4, SOCKS5 (if this setting is not set via importSSHTunnel, proxy configuration set via System Properties will be considered)

proxyHost

string

NULL

Host address of the proxy (if this setting is not set via importSSHTunnel, proxy configuration set via System Properties will be considered)

proxyPort

integer

NULL

Port used by the proxy (if this setting is not set via importSSHTunnel, proxy configuration set via System Properties will be considered)

proxyUser

string

NULL

User at the proxy (if this setting is not set via importSSHTunnel, proxy configuration set via System Properties will be considered)

proxyPassword

string

NULL

Password for the proxy server (if this setting is not set via importSSHTunnel, proxy configuration set via System Properties will be considered)

SYSADMIN_VDB.removeSSHTunnel

このプロシージャは、SSH Tunnel を削除します。以下のパラメータを取ります：

Parameter name

Parameter type

Mandatory

Description

name

string

NOT NULL

Unique name of the SSH tunnel intended for removal

SYSADMIN_VDB.importSSHTunnel

このプロシージャは、SSH トンネルをインポートまたはリフレッシュします。以下のパラメータを取ります：

To view the full table, click the expand button in its top right corner

Parameter name

Parameter type

Mandatory

Description

name

string

NOT NULL

Unique name of an SSH tunnel

localHost

string

NULL

Host of a client's machine (default: localhost)

localPort

integer

NOT NULL

Port of a client's machine

remoteHost

string

NOT NULL

Host of a remote machine

remotePort

integer

NOT NULL

Port of a remote machine

host

string

NOT NULL

Username and host used for connecting to a remote machine via SSH protocol (format: username@host)

portForwardingType

string

NULL

Type of SSH port forwarding (L by default). As the Data Virtuality Server supports only local port forwarding at the moment, the field can have only the L value

sshKeyPairId

integer

NULL

ID of a key-pair in the SYSADMIN_VDB.SSHCredentials table

sshPort

integer

NULL

Port used by SSH Server on a remote machine (default: 22)

encryptedSshProperties

string

NULL

SSH comma-separated properties in CSV-like form: property1=<value1>,property2=<value2>. Used to provide a timeout, cypher parameters, key parameters like used algorithms, a possibility to provide classes for custom algorithms, and so on. It can consist of sensitive data, and this is why the value should be encrypted

encryptedPassword

string

NULL

Encrypted password used for simple authentication on the SSH server

encryptedPassPhrase

string

NULL

Encrypted password phrase used in case of secured private key and key authentication on the SSH server

encryptedPrivateKey

string

NULL

Encrypted private key in case of key authentication on the SSH server

proxy

string

NULL

Possible values: NONE, HTTP, SOCKS4, SOCKS5 (if this setting is not set via importSSHTunnel, proxy configuration set via System Properties will be considered)

proxyHost

string

NULL

Address of the proxy (if this setting is not set via importSSHTunnel, proxy configuration set via System Properties will be considered)

proxyPort

string

NULL

Port used by proxy (if this setting is not set via importSSHTunnel, proxy configuration set via System Properties will be considered)

proxyUser

string

NULL

User at the proxy (if this setting is not set via importSSHTunnel, proxy configuration set via System Properties will be considered)

encryptedProxyPassword

string

NULL

Encrypted password for the proxy server

sshProperties

string

NULL

SSH comma-separated properties in CSV-like form: property1=<value1>,property2=<value2>. Used to provide a timeout, cypher parameters, key parameters like used algorithms, a possibility to provide classes for custom algorithms, and so on

password

string

NULL

Password used for a simple authentication on the SSH server

passPhrase

string

NULL

Password phrase used in case of a secured private key and key authentication on the SSH server

privateKey

string

NULL

Private key in case of key authentication on the SSH server

proxyPassword

string

NULL

Password for the proxy server

SYSADMIN_VDB.createSSHKeyPair

このプロシージャは、鍵ペアを作成します。以下のパラメータを取ります：

Parameter name

Parameter type

Mandatory

Description

name

string

NULL

Unique name of a key pair

publicKey

string

NOT NULL

Public key

id

integer

NOT NULL

ID of the key pair

SYSADMIN_VDB.renameSSHKeyPair

このプロシージャは、鍵ペアの名前を変更します。以下のパラメータを取ります：

Parameter name

Parameter type

Mandatory

Description

name

string

NOT NULL

Unique name of a key pair

publicKey

string

NOT NULL

Public key

id

integer

NOT NULL

ID of the key pair

SYSADMIN_VDB.removeSSHKeyPair 

このプロシージャは、鍵ペアを削除します。以下のパラメータを取ります：

Parameter name

Parameter type

Mandatory

Description

id

integer

NOT NULL

ID of the key pair

SYSADMIN_VDB.importSSHKeyPair 

このプロシージャは、鍵ペアを作成します。以下のパラメータを取ります：

Parameter name

Parameter type

Mandatory

Description

name

string

NULL

Unique name of a key pair

publicKey

string

NULL

Public key

privateKey

string

NULL

Private key

encryptedPrivateKey

string

NULL

Encrypted private key

id

integer

NOT NULL

ID of the key pair

SYSADMIN_VDB.updateCloudAgentConfiguration

このプロシージャは、接続されているすべてのエージェントインスタンスにわたって、指定されたファイルに構成を作成または更新します。configurationパラメータがNULLまたは空の場合、指定された構成ファイルは削除されます。 設定エラー（無効なデータソース定義など）が発生した場合でも、SaaS URL と API キーが正しければ、エージェントはサーバーに接続します。

SYSADMIN_VDB.updateCloudAgentConfiguration(IN file string NOT NULL, IN configuration string)

Parameter name

Parameter type

Mandatory

Description

file

string

NOT NULL

The name of the cloud agent properties file to be created, updated, or deleted across all agents

configuration

string

NULL

Specifies the agent configuration to be written to the designated properties file. If the argument is set to NULL or omitted, the properties file will be deleted

Examples

--Update the configuration stored in "agent_A.properties" file of some cloud agent.
CALL SYSADMIN_VDB.updateCloudAgentConfiguration (
file => 'agent_A.properties',
configuration => 'dvsaas.ws.url=ws://localhost:8080/cloud-agent
client.api.key=<CLOUD_AGENT_API_KEY>'
);;
 
--Delete the "agent_A.properties" configuration file.
CALL SYSADMIN_VDB.updateCloudAgentConfiguration (
file => 'agent_A.properties'
);;