 |
Database
password encryption for the Vault Server properties file
|
|
You can generate the database password to put in the Vault Server properties
file by using the following command logged as root:
./catstart -run "GenVaultPasswd -UserName user_name -Passwd
user_database_password"
Then, you can copy and paste the password from the output into the
properties file. The pertaining key is VaultServer_DBPassword.
Some usage help will be provided if you execute:
./catstart -run GenVaultPasswd
|
|
|
VaultServer administration tool
|
|
In order to allow remote administration services on Vault Server, a tool
called vsadm, which stands for Vault Server Administration, has
been supplied. Some usage help will be provided if you execute:
./catstart -run vsadm
|
|
|
How to start/stop a Vault Server from a remote
workstation
|
|
You can start a remote Vault Server by using the following command logged on
as root:
./catstart -run "vsadm START {ALIAS vaultserver_alias_name
VAULT vaultserver_name
HOST vaultserver_host
PORT vaultserver_port }"
You can stop a remote Vault Server by using the following command:
./catstart -run "vsadm STOP {ALIAS vaultserver_alias_name
|
VAULT vaultserver_name
HOST vaultserver_host
PORT vaultserver_port }"
|
|
|
How to refresh Vault Server properties from a
remote workstation
|
|
You can reload Vault Server properties by using the following command logged
on as root:
./catstart -run "vsadm REFRESH PROPERTIES
VAULT vaultserver_name
HOST vaultserver_host
PORT vaultserver_port }"
Here is the list of VaultServer properties you can modify and reload:
VaultServer_ThreadNumber
VaultServer_Trace
VaultServer_DBMINPoolSize
VaultServer_DBMAXPoolSize
VaultServer_FDSMIN
VaultServer_NumOfRepo
VaultServer_Repo_x_Name
VaultServer_Repo_x_Path
VaultServer_Repo_x_ReadOnly
VaultServer_Repo_x_TmpDirName
VaultServer_Repo_x_Priority
VaultServer_Repo_x_NumOfSecDir
VaultServer_Repo_x_SecDireName_y
If you are using a VaultCache, you can modify and reload the following
additional properties:
VaultServer_Cache_MaxSize
VaultServer_Cache_CleanThreshold
VaultServer_Cache_Rate
VaultServer_Cache_Enabled
VaultServer_Cache_TimeoutForClean
|
|
|
How to enable Vault Server tracing from a remote
workstation
|
|
You can enable tracing on a Vault Server by using the following command
logged as root:
./catstart -run "vsadm TRACE {ALIAS
vaultserver_alias_name |
VAULT vaultserver_name
HOST vaultserver_host
PORT vaultserver_port }
{ON | OFF }" |
|
|
How to list
VaultAliasName
|
|
You can list the whole set of VaultAliasName entries by using the
following command logged on as root:
./catstart -run "vsadm LIST ALIAS"
|
|
|
How to get Vault Client configuration parameters
on the local workstation
|
|
You can get Vault Client parameters configuration by using the following
command logged on as root:
./catstart -run "vsadm GET CLIENT CFG"
|
|
|
How to get Vault Server configuration parameters
from a remote workstation
|
|
You can get Vault Server configuration parameters by using the following
command logged on as root:
./catstart -run "vsadm GET SERVER CFG FOR {ALIAS vaultserver_alias_name|
VAULT vaultserver_name
HOST vaultserver_host
PORT vaultserver_port}"
|
|
|
How to have a Vault Server online/offline from a
remote workstation
|
|
You can have a Vault Server online/offline by using the
following command logged on as root:
./catstart -run "vsadm TAKE {
ALIAS vaultserver_alias_name |
VAULT vaultserver_name
HOST vaultserver_host
PORT vaultserver_port }
{ONLINE | OFFLINE }"
When a Vault Server is offline, all database connections are
released and client requests receive a specific answer which is a dedicated
error message. However, client/server orbix connections are kept. Thus, the
client applications do not need to be restarted when the Vault Server is put
back online. |
|
|
How to test a Vault Server from a remote
workstation
|
|
You can test if a Vault Server is OK by using the following
command logged as root:
./catstart -run "vsadm TEST
ALIAS vaultserver_alias_name"
This test creates a file in the vault and reads it. The creation of the
file confirms that the vault is running correctly. |
|
|
How to get Vault Server request queues state from
a remote workstation
|
|
You can get Vault Server request queues state by using the
following command logged on as root:
./catstart -run "vsadm GET SERVER REQUEST STATE FOR { ALIAS
vaultserver_alias_name|
VAULT vaultserver_name
HOST vaultserver_host
PORT vaultserver_port }"
When a request arrives on the Vault Server it is dispatched to a
dedicated queue for execution, depending on the request type.
There is a dedicated queue to manage the commit request (commit
priority). The commit command releases some critical resources
such as a DB connection on the Vault Server; that is why there is a
dedicated pipe to manage it.
There is a dedicated queue to manage high priority
requests such as shutdown. Some commands have to be executed
immediately; that is why there is a dedicated pipe to manage them.
There is a default queue for all other request types (standard
priority). For instance, the request used to create a Vault
document is a standard priority request.
Most of the time you should not have more than two or three for each
priority queue. Otherwise, it means that you may have a lack of CPU or a
lack of execution thread.
For instance when you have:
Standard priority request queue state: <12>;
it means that 11 remote users are waiting to have their request
executed on the Vault Server.
Bad elapse time
The first thing to do is to check the CPU consumption. If the CPU
consumption on the machine is more than 70%, additional processors have
to be added on the machine. If the CPU consumption is low, then the:
VaultServer_ThreadNumber
parameter should be increased. |
| |
Commands for Vault Cache Management
|
|
|
How to force documents refresh between Vault Cache and Vault Servers from
a remote workstation
|
|
You can force document refresh between Vault Cache and all
Vault Servers by using the following command logged as root:
./catstart -run "vsadm REFRESH
DOCUMENTS VAULT vaultserver_name
HOST vaultserver_host
PORT vaultserver_port
[FETCHSIZE fetch_size_value]"
The command above trigger a document version check and
refresh for the Whole set of document hold by the Vault Cache regarding all
the Vault Server cached by the Vault Cache. You can specify your own
fetchsize if you want. |
|
|
How to force documents refresh between Vault Cache and a given
Vault Server from a remote workstation
|
|
You can force document refresh between Vault Cache and a
given Vault Server identified by an alias by using the following command
logged as root:
./catstart -run "vsadm REFRESH
DOCUMENTS VAULT vaultserver_name
HOST vaultserver_host
PORT vaultserver_port
FROM ALIAS vaultserver_alias_name
[FETCHSIZE fetch_size_value]"
The command above triggers a document version check and
refresh for the whole set of documents held by the Vault Cache regarding a
given Vault Server. You can specify your own fetchsize if you want. |
|
|
How to add new documents into Vault Cache and force document refresh
from an input file containing a list of Vault document URLs
|
| |
You can add new documents and force document refresh between Vault Cache
and a given Vault Server by using the following command logged as root:
./catstart -run "vsadm REFRESH DOCUMENTS VAULT vaultserver_name
HOST vaultserver_host
PORT vaultserver_port
FROM FILE file_full_path_name
[ FETCHSIZE fetch_size_value]"
The command above triggers a document version check and refresh for the
list of vault document URL specify by the input file. If a document is
missing in the Vault Cache, it is added automatically. You can specify your
own fetchsize if you want. The FROM FILE file which needs to
be used should be a text file and should contain a list of Vault URLs, and
the format of Vault URLs should look like this: vault://VaultAliasName/VaultDocumentOIDinHexa
For example, for the documents handled by Content Management, the Vault URL
can be found within the V_VaultDoc attribute of the VPMDocSecuredFile
type.
For example, create a file, for instance VDocURLColl.txt in
which the entries look like this: .....
vault://VaultServerINT18/6CCBDB530000183045E439AD00000004
vault://VaultServerINT18/6CCBDB530000183045E439AD00000005
vault://VaultServerINT18/6CCBDB530000183045E439AD00000006
vault://VaultServerINT18/6CCBDB530000183045E439AD00000007
.....
and then provide the path of the same file while using the
command below. ./catstart -run "vsadm REFRESH DOCUMENTS
VAULT vaultserver_name
HOST vaultserver_host
PORT vaultserver_port
FROM FILE file_full_path_name
[ FETCHSIZE fetch_size_value]"
|
|
 |
