Voradmin Utility
Voradmin Syntax
secfs Information
| Command | Configuration Parameters | Description | 
|---|---|---|
| voradmin secfs attr get <file path> | Gets and displays the secfs attributes from the GuardPoint. | |
| voradmin secfs iv get <file path> | Gets and displays the value of the base IV (Initialization Vector) file. | |
| voradmin secfs crypto | Displays CTE-U support information for encryption modes. | |
| voradmin secfs config <config param> <config value> [guardpoint path] | Sets the Configuration parameter and value for the GuardPoint path. See GuardPoint Tuning for more information. | 
Upgrade Management
| Command | Description | 
|---|---|
| voradmin upgrade show | Displays any scheduled upgrades. | 
| voradmin upgrade cancel | Cancels any scheduled upgrades. | 
| voradmin upgrade schedule <path to CTEU package> [ -y ] | Schedule an upgrade. Note that you must enter the path to the CTE-U upgrade package. | 
COS (Cloud Object Storage Management)
| Command | Options | Description | 
|---|---|---|
| voradmin cos service | {[start|stop|status|clear|reload|check|logrotate]} | * Start, stop, clear, reload * Check the status of the certificate * Rotate the logs for the certificate | 
| voradmin cos ca_cert | {create [Certificate Parameter] [Subject Alt Name] delete|display|check} | * Create the certificate parameter * Delete the certificate * Display the certificate * Check/validate the certificate | 
| voradmin cos mimic_db | {delete} | Cleans the MimicCertificate  Database. Use  this  command to recover from a corruptedMimicdatabase. If the COS service certificate and  private  key  are manually  configured,  all  of the  cached certificates in theMimicdatabase are now invalid. Use this command to initialize theMimiccertificate database to a clean state. | 
| voradmin cos s3 | {cred add [<key id> <secret key>]} | Add credentials: * <aws_key_id>: The AWS secret key ID from the.aws/credentialsfile* <aws_secret_key>: The AWS secret key from the same file | 
| delete {[<key id> <secret key>]> check <key id> } | * Delete the key ID or secret key * Validate the Key ID | |
| {chunk [<key id> <secret key> <chunk size>]} | * <chunk_size>is the number of MB per chunk that you want to use for multi-part uploads. Enter an integer between 5 and 5120.* Default chunk size for multi-part uploads is 8 MB | |
| {role config [<key id> <secret key> <user arn> <role arn>] | Configure the roles: * <user_arn>is the Amazon Resource Name for the delegated IAM user that you created* <role_arn>is the Amazon Resource Name for the delegated IAM Role that you created | |
| secure-bucket <key id> <secret key> <cos name> <region> <bucket name> | Enter the information for the AWS S3 bucket. | |
| release-bucket <key id> <secret key> <cos name> <region> <bucket name>} | Disable the AWS S3 bucket | |
| {credstore <create|reset|check|version>} | * Create credentials * Reset your credentials * Check the credentials * Check the version of the credentials | 
MFA (Multifactor Authentication Management)
| Command | Description | 
|---|---|
| voradmin mfa config | Displays configuration information. | 
| voradmin mfa login | Enables Multifactor Authentication for the current shell, and commands and programs running in that shell, so that it can access MFA-enabled GuardPoints. You must provide a login name and password for Multifactor Authentication enablement. | 
| voradmin mfa ssh_enable | Enables the option to use Multifactor Authentication once a user has established an ssh login to the current host. | 
| voradmin mfa ssh_disable | Disables the option to use Multifactor Authentication once a user has established an ssh login to the current host. | 
| voradmin mfa set_auth | Sets up the authentication method (either OTP or password) to use during CTE multi-factor authentication. If not setup, users have to choose a method during ssh login or voradmin mfa login. | 
| voradmin mfa set_timeout | MFA timeout only applies to new processes. Once a process, like Bash, for example, is MFA-authenticated, it does not time out. Additionally, when a timeout value changes, all MFA-authenticated processes remain authenticated. The timeout change does not affect them. |