SYSADMIN_VDB Procedures
You are looking at an older version of the documentation. The latest version is found here.
The procedures described on this page enable you to manage virtual databases and SSH tunnels.
SYSADMIN_VDB.createVdb
This procedure creates a virtual database:
SYSADMIN_VDB.createVdb("name" => 'string_name');;
Example
CALL "SYSADMIN_VDB.createVdb"("name" => 'newVDB');;
SYSADMIN_VDB.dropVdb
This procedure removes a virtual database by ID:
SYSADMIN_VDB.dropVdb("id" => biginteger_id);;
To view the ID of the virtual database you need to delete, you can use the SYSADMIN_VDB.VirtualDatabases
table.
Example
CALL "SYSADMIN_VDB.dropVdb"("id" => 10);;
SYSADMIN_VDB.getJavaProp
This procedure gets the translator-related client secret:
SYSADMIN_VDB.getJavaProp(IN key1 string NOT NULL, OUT value1 string RESULT)
Example
CALL "SYSADMIN_VDB.getJavaProp"("key1" => 'user.language');;
SYSADMIN_VDB.setJavaProp
This procedure sets the translator-related client secret:
SYSADMIN_VDB.setJavaProp(IN key1 string NOT NULL, IN value1 string)
Example
CALL "SYSADMIN_VDB.setJavaProp"("key1" => 'user.language', "value1" => 'en');;
SYSADMIN_VDB.createSSHTunnel
This procedure creates an SSH tunnel. It takes the following parameters:
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 |
| 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
This procedure removes an SSH tunnel. It takes the following parameter:
Parameter name | Parameter type | Mandatory | Description |
---|---|---|---|
name | string | NOT NULL | Unique name of the SSH tunnel intended for removal |
SYSADMIN_VDB.importSSHTunnel
This procedure imports or refreshes an SSH tunnel. It takes the following parameters:
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 |
| 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) |
| 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 |
| string | NULL | Password for the proxy server |
SYSADMIN_VDB.createSSHKeyPair
This procedure creates a key pair. It takes the following parameters:
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
This procedure renames a key pair. It takes the following parameters:
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
This procedure removes a key pair. It takes the following parameters:
Parameter name | Parameter type | Mandatory | Description |
---|---|---|---|
id | integer | NOT NULL | ID of the key pair |
SYSADMIN_VDB.importSSHKeyPair
This procedure creates a key pair. It takes the following parameters:
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 |