ZeXtras CLI/pt
From ZeXtras Suite Wiki
| Língua: | English • español • português |
|---|
|
Warning! This wiki is outdated and not maintained anymore, please refer to the new Zextras Documentation Hub at https://docs.zextras.com |
Contents
|
|
Interface da linha de comandos de ZeXtras Suite - zxsuite
A versão 1.0 de ZeXtras Suite introduziu a opção CLI que permite aos administradores realizar operações diretamente desde a linha de comandos do servidor. Esta caracteristica é muito útil para aqueles que precisam inserir operações de ZeXtras Suite em um Script.
|
|
Atenção! Esta é somente uma linha de comandos de referência. Para uma descripção completa e exemplos de uso execute `zxsuite help {module} [command]` |
Uso básico
Ajuda Online: Se encontra disponível uma ajuda para cada comando com zxsuite help {module} [command]. Se for omitido o comando se mostrará a lista completa com todos os que estejam disponíveis.
Linha de comandos do Core
Uso básico:
zxsuite core {action} [options]
Comandos do Core
- getVersion - Mostra a versão de ZeXtras Suite
zxsuite core getVersion
- getProperty - Obtem as propriedades de configuração
zxsuite core getProperty [attr1 value1 [attr2 value2...]]
- setProperty - Estabelece as propriedades de configuração
zxsuite core setProperty {property_name} {property_value}
- getLicenseInfo - Mostra informação sobre as licença ZeXtras Suite
zxsuite core getLicenseInfo
- doUploadLicense - Carrega uma licença ZeXtras
zxsuite core doUploadLicense {license_path}
- doLicenseChecks - Força um check-up das licenças ZeXtras
zxsuite core doLicenseChecks
- getUpdateInfo - Mostra informação sobre atualizações de ZeXtras Suite
zxsuite core getUpdateInfo core getUpdateInfo
- doCheckUpdate - Pede informação sobre atualizações ao servidor ZeXtras Suite
zxsuite core doCheckUpdate
- getAccountStats - Mostra informação estatística sobre uma conta para um ID dado
zxsuite core getAccountStats {account}
- getNotification - Mostra notificações de ZeXtras
zxsuite core getNotification [attr1 value1 [attr2 value2...]]
- doDeleteAllDelegatedRights - Este comando apaga as configurações de ZeXtras Admin e de administração delegada de Zimbra
zxsuite core doDeleteAllDelegatedRights {confirmation string}
Linha de comandos do Backup
Uso básico:
zxsuite backup {action} [options]
Comandos de ZxBackup
- getProperty - Mostra as propriedades de configuração
zxsuite backup getProperty [attr1 value1 [attr2 value2...]]
- setProperty - Estabelece propriedades de configuração
zxsuite backup setProperty {property_name} {property_value}
- doFullScan - Executa o Full Scan
zxsuite backup doFullScan [attr1 value1 [attr2 value2...]]
- doSmartScan - Executa o Smart Scan
zxsuite backup doSmartScan [attr1 value1 [attr2 value2...]]
- doAccountScan - Executa o Full Scan para uma caixa unica
zxsuite backup doAccountScan {account} [attr1 value1 [attr2 value2...]]
- doExport - Executa uma exportação limitada por domínios
zxsuite backup doExport {destination_path} [attr1 value1 [attr2 value2...]]
- doRestoreOnNewAccount - Executa o Restore on New Account
zxsuite backup doRestoreOnNewAccount {source_account} {destination_account} {"dd/MM/yyyy HH:mm:ss"|last} [attr1 value1 [attr2 value2...]]
- doEnableDisableCOS - Abilita ou deshabilita o backup para uma COS específica
zxsuite backup doEnableDisableCOS {cos_name} {enable|disable}
- doUndelete - Executa o Undelete Restore
zxsuite backup doUndelete {account} {"dd/MM/yyyy HH:mm:ss"|first} {"dd/MM/yyyy HH:mm:ss"|last} [attr1 value1 [attr2 value2...]]
- doItemSearch - Busca um elemento
zxsuite backup doItemSearch {account} [attr1 value1 [attr2 value2...]]
- doItemRestore - Recupera um elemento individualmente
zxsuite backup doItemRestore {account_name} {item_id}
- doExternalRestore - Faz um External Restore
zxsuite backup doExternalRestore {source_path} [attr1 value1 [attr2 value2...]]
- doStopOperation - Detém uma operação em execução
zxsuite backup doStopOperation {operation_uuid}
- doStopAllOperations - Detém todas as operações em execução e esvazía a fila de operações
zxsuite backup doStopAllOperations
- doCheckShares - Verifica todos os compartilhamentos nas contas locais
zxsuite backup doCheckShares
- doFixShares - Tenta reparar todos os compartilhamentos nas contas locais
zxsuite backup doFixShares {import_idmap_file}
- doFixOrphans - Elimina arquivos orfãos
zxsuite backup doFixOrphans [attr1 value1 [attr2 value2...]]
- doCoherencyCheck - Verifica coerência do backup
zxsuite backup doCoherencyCheck {backup_path} [attr1 value1 [attr2 value2...]]
- getAccountInfo - Mostra a informação de uma conta
zxsuite backup getAccountInfo {account} [attr1 value1 [attr2 value2...]]
- getBackupInfo - Mostra informação acerca do sistema de backup
zxsuite backup getBackupInfo [attr1 value1 [attr2 value2...]]
- getMap - Mostra objeto de mapa binario <String, String> como uma tabela legível
zxsuite backup getMap {file_path}
- getItem - Mostra elemento em formato legível
zxsuite backup getItem {account} {item} [attr1 value1 [attr2 value2...]]
- getAvailableAccounts - Mostra todas as contas disponíveis para restaurar
zxsuite backup getAvailableAccounts [attr1 value1 [attr2 value2...]]
- getAvailableDomains - Mostra todos os domínios disponíveis para restaurar
zxsuite backup getAvailableDomains {dd/MM/yyyy HH:mm:ss|"last"} {backup_path}
- getServerConfig - Provê uma lista de configurações de servidores armazenados
zxsuite backup getServerConfig {"dd/MM/yyyy HH:mm:ss"|"last"|"all"} {standard|customizations} [attr1 value1 [attr2 value2...]]
- getCOSBackupStatus - Mostra o estado do backup de todas as COS
zxsuite backup getCOSBackupStatus [attr1 value1 [attr2 value2...]]
- getAllOperations - Mostra todas as operações em execução e na fila
zxsuite backup getAllOperations
- monitor - Monitoreia uma operação em execução
zxsuite backup monitor {operation_uuid} [attr1 value1 [attr2 value2...]]
Linha de comandos do Mobile
Uso básico:
zxsuite mobile {action} [options]
Comandos de ZxMobile
- getProperty - Obtém propriedades de configuração.
zxsuite mobile getProperty [attr1 value1 [attr2 value2...]]
- setProperty - Estabelece propriedades de configuração
zxsuite mobile setProperty {property_name} {property_value}
- getDeviceList - Mostra todos os dispositivos para a conta provista.
zxsuite mobile getDeviceList {account}
- getDeviceInfo - Mostra informação sobre o dispositivo provisto.
zxsuite mobile getDeviceInfo {account} {device_id}
- doResetAccount - Reseta os estados de TODOS os dispositivos para a conta provista.
zxsuite mobile doResetAccount {account}
- doResetDevice - Reseta o SynState do dispositivo para uma conta
zxsuite mobile doResetDevice {account} [attr1 value1 [attr2 value2...]]
- getAllSessions - Mostra informação sobre todas as sessões móveis armazenadas
zxsuite mobile getAllSessions
- getActiveSessions - Mostra todas as sessões móveis ativas
zxsuite mobile getActiveSessions
- doRemoveDevice - Remove o SyncState e histórico de todos os dispositivos do servidor
zxsuite mobile doRemoveDevice {account} {device_id}
- getAccountLoggers - Devolve informações sobre os loggers de todas as contas
zxsuite mobile getAccountLoggers
- doRemoveLogger - Remove um logger da conta
zxsuite mobile doRemoveLogger {logger_id|"all_loggers"}
- doAddAccountLogger - Adiciona um logger á conta
zxsuite mobile doAddAccountLogger {account} {debug|info|warn|err|crit} {log_file}
Linha de comandos de ZxPowerstore
Uso básico:
zxsuite powerstore {action} [options]
Comandos de ZxPowerstore
- getProperty - Mostra propriedades de configuração
zxsuite powerstore getProperty [attr1 value1 [attr2 value2...]]
- setProperty - Estabelece propriedades de configuração
zxsuite powerstore setProperty {property_name} {property_value}
- getAllVolumes - Mostra todos os volumes presentes no servidor
zxsuite powerstore getAllVolumes
- getHsmPolicy - Mostra as políticas
zxsuite powerstore getHsmPolicy
- setHsmPolicy - Estabelece a política HSM por padrão
zxsuite powerstore setHsmPolicy {hsm_policy}
- +setHsmPolicy - Adiciona uma política HSM
zxsuite powerstore +setHsmPolicy {hsm_policy}
- doCreateVolume - Cria um volume no servidor
zxsuite powerstore doCreateVolume {primary|secondary|index} {volume_name} {volume_path} [attr1 value1 [attr2 value2...]]
- doUpdateVolume - Atualiza um volume específico no servidor
zxsuite powerstore doUpdateVolume {volume_id} [attr1 value1 [attr2 value2...]]
- doDeleteVolume - Elimina um volume específico no servidor
zxsuite powerstore doDeleteVolume {volume_id}
- doMoveBlobs - Inicia a operação doMoveBlob
zxsuite powerstore doMoveBlobs [attr1 value1 [attr2 value2...]]
- doDeduplicate - Inicia a operação de deduplicação
zxsuite powerstore doDeduplicate {volume_name} [attr1 value1 [attr2 value2...]]
- doVolumeToVolumeMove - Inicia a operação doMoveVolumeBlobs
zxsuite powerstore doVolumeToVolumeMove {source_volume_name} {destination_volume_name}
- getAllOperations - Mostra as operações em curso e em coda
zxsuite powerstore getAllOperations
- monitor - Monitoreia uma operação em curso
zxsuite powerstore monitor {operation_uuid} [attr1 value1 [attr2 value2...]]
- doStopAllOperations - Detém as operações em curso e esvazía a fila de operações
zxsuite powerstore doStopAllOperations
- getVolumeStats - Mostra o espaço ocupado, número de elementos e blobs (Binary Large Objects) contidos no volume
zxsuite powerstore getVolumeStats {volume_id} [attr1 value1 [attr2 value2...]]
Linha de comandos de ZxAdmin
Uso básico:
zxsuite admin {action} [options]
Comandos de ZxAdmin
- getDelegationSettings - Mostra os Administradores Delegados com os seus domínios de competência, o atributo viewMail e a cota atribuível
zxsuite admin getDelegationSettings [attr1 value1 [attr2 value2...]]
- doEditDelegationSettings -
zxsuite admin doEditDelegationSettings {account} {domain} [attr1 value1 [attr2 value2...]]
- doAddDelegationSettings -
zxsuite admin doAddDelegationSettings {account} {domain} [attr1 value1 [attr2 value2...]]
- doRemoveDelegationSettings -
zxsuite admin doRemoveDelegationSettings {account} {domain}
- getDomainSettings - Mostra o nome, limíte de número de contas e cota máxima de conta de todos os domínios
zxsuite admin getDomainSettings
- setDomainSettings - Estabelece cota máxima da conta do domínio e limíte de conta
zxsuite admin setDomainSettings {domain} [attr1 value1 [attr2 value2...]]
- resetDomainSettings - Reseteia o limíte global da conta, limíte de conta por COS, e cota da conta do domínio para o domínio selecionado
zxsuite admin resetDomainSettings {domain}
- doShowAdminActivity - Mostra toda a atividade gravada do administrador
zxsuite admin doShowAdminActivity [attr1 value1 [attr2 value2...]]
- doEnableDisableAdminLogging - Ativa ou desativa o registro das atividades de administração
zxsuite admin doEnableDisableAdminLogging {enable|disable}
- setProperty - Estabelece propriedades de configuração
zxsuite admin setProperty {property_name} {property_value}
- getProperty - Mostra propriedades de configuração
zxsuite admin getProperty [attr1 value1 [attr2 value2...]]
- doMonthlyReport - Gera um relatorio das atividades de administração para um mes especifico
zxsuite admin doMonthlyReport [attr1 value1 [attr2 value2...]]
- getMonthlyReport - Mostra um relatorio da atividade de administração para um mês específico
zxsuite admin getMonthlyReport [attr1 value1 [attr2 value2...]]
- doSetZimletRights - Fixa os direitos do zimlet ZeXtras para todos os Administradores Delegados
zxsuite admin doSetZimletRights
- getAllOperations - Mostra todas as operações em curso e na fila
zxsuite admin getAllOperations
- doStopAllOperations - Detém todas as operações em curso e esvazía a fila de operações
zxsuite admin doStopAllOperations
- doStopOperation - Detém uma operação em curso
zxsuite admin doStopOperation {operation_uuid}
- monitor - Monitoreia uma operação em curso
zxsuite admin monitor {operation_uuid} [attr1 value1 [attr2 value2...]]
Linha de comandos de ZxMig
Veja AQUI
Video Tutorial del CLI de ZeXtras
ZeXtras Backup - Undelete Restore
ZeXtras Backup - Restore on New Account
ZeXtras Backup - Restore on New Account
