Um Workspace do Enterprise Server pode conter uma vasta gama de dados valiosos, incluindo utilizadores definidos, grupos, tarefas de sincronização LDAP, dados de design (incluindo projetos, componentes, modelos, templates) e configurações para os serviços PLS e NIS (e, normalmente, uma gama de produtos e extensões adquiridos, bem como pacotes de implementação definidos para estes últimos). Um requisito fundamental para garantir a integridade destes dados a longo prazo é a criação de cópias de segurança. A instalação padrão do Enterprise Server inclui uma ferramenta de backup e restauro, acedida através de uma linha de comandos.
A localização predefinida da ferramenta de backup é a pasta \Program Files (x86)\Altium\Altium365\Tools\BackupTool.
O nome da ferramenta de backup é avbackup.exe.
-
Se a ferramenta avbackup.exe não estiver localizada no caminho predefinido – \Program Files (x86)\Altium\Altium365\Tools\BackupTool – podem ocorrer erros/exceções durante um restauro.
-
A ferramenta autónoma Health Monitor (avhealth.exe) tem de estar fechada ao utilizar a ferramenta de Backup (quer em modo de backup quer de restauro), uma vez que ambas as ferramentas requerem acesso ao ficheiro da base de dados do Enterprise Server.
-
É altamente recomendável que os utilizadores não estejam ligados nem a utilizar o Workspace durante os processos de backup e restauro, que requerem acesso à base de dados do Workspace. Como administrador do Workspace, pode terminar a sessão dos utilizadores à força, se necessário, encerrando a respetiva sessão atual do Workspace através da página Sessions da interface do browser (Admin – Sessions). Consulte a página Sessions para mais informações.
-
Restaurar um backup só é possível para a mesma versão do Enterprise Server a partir da qual esse backup foi criado. Neste contexto, pode ser uma boa ideia manter o instalador desse Enterprise Server e os respetivos ficheiros de licença com o arquivo Zip do backup.
O processo de backup/restauro também repõe a contagem de transações da base de dados. O estado atual da contagem de transações do servidor pode ser verificado através da ferramenta Health Monitor (consulte a entrada Transaction count na região DATABASE da janela da ferramenta).
A ferramenta de backup utiliza o Volume Shadow Copy Service (VSS) para criar uma cópia-sombra do volume onde os dados do servidor estão localizados (também é suportada uma configuração em que as revisões são armazenadas num volume separado). Com o VSS, a ferramenta de backup para os serviços, cria uma cópia-sombra, reinicia os serviços e, em seguida, executa o backup dos dados utilizando a cópia-sombra criada. Esta abordagem minimiza o período de indisponibilidade do servidor (um período entre a paragem e o arranque dos serviços) e é utilizada por predefinição. Em caso de erro durante a criação de uma cópia-sombra, a ferramenta de backup utilizará uma abordagem sem criar uma cópia-sombra (que também pode ser ativada explicitamente através do comutador --skip-shadow-copy).
Aceder à ferramenta de Backup
Para utilizar a ferramenta:
-
Abra uma linha de comandos do Windows.
Tem de executar a linha de comandos em modo de administrador para poder utilizar a ferramenta de Backup e Restauro. Se não estiver a executar uma linha de comandos CMD como Administrador do Windows, qualquer tentativa de executar um comando relativo ao backup ou restauro do seu Enterprise Server resultará na seguinte mensagem clara: Access Denied. Administrator permissions are needed to use the selected options. Use an administrator command prompt to complete these tasks.
-
Navegue até à pasta correta. Numa instalação predefinida na unidade C do computador anfitrião, esta será: cd C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\
-
Para executar a ferramenta e listar as opções disponíveis, escreva na linha de comandos: avbackup ?
Em algumas versões do Windows, não é possível colar numa linha de comandos usando Ctrl+V, mas pode colar através do menu do botão direito. Copie primeiro as cadeias necessárias e depois cole utilizando esta técnica para poupar tempo e evitar erros.
Aceder à ferramenta de backup através de uma linha de comandos (executada como administrador).
Tenha em atenção o ?, cuja inclusão apresenta a ajuda sobre as funções disponíveis na ferramenta de backup:
-
backup – fazer backup dos dados para um arquivo ZIP.
-
restore – restaurar dados a partir de um arquivo ZIP. O ponto de restauro será criado automaticamente.
-
help – apresentar o ecrã de ajuda (? pode ser utilizado em vez da cadeia help).
Conteúdo do Arquivo Zip
A ferramenta faz backup de todo o Enterprise Server e dos dados do utilizador, incluindo:
-
Backup completo da base de dados, incluindo: todos os itens de dados (modelos, componentes, managed sheets, templates, designs libertados, etc.), utilizadores, grupos, instalações adquiridas através do Network Installation Service e definições de sincronização LDAP.
-
Todas as revisões do acima indicado.
-
Repositórios e designs do Workspace incluídos.
-
Índice de pesquisa.
-
Definições definidas pelo utilizador (personalizadas).
Sintaxe do Backup e Comutadores
Os seguintes comutadores estão disponíveis ao utilizar a função de backup da ferramenta:
avbackup backup -z [-t] [-h] [-i] [-m] [-d] [-c] [--split] [--skip-shadow-copy]
-
-z – caminho e nome do ficheiro zip de destino a criar. Coloque entre aspas se existirem espaços na cadeia. Este comutador é obrigatório.
-
-t, --test – se este comutador for especificado, o ficheiro zip será testado após o backup.
-
-h, --hash – se este comutador for especificado, será criado um ficheiro de hash MD5 (*.md5).
-
-i – caminho completo para o ficheiro LocalVault.ini do Enterprise Server, que fornece informações sobre a localização dos dados do Enterprise Server a salvaguardar. O caminho predefinido deste ficheiro é C:\Program Files (x86)\Altium\Altium365\LocalVault.ini. Se este comutador não for especificado, a ferramenta tentará encontrar o ficheiro automaticamente com base nesta localização de instalação predefinida. Coloque entre aspas se existirem espaços na cadeia.
-
-m – permite determinar se a operação de backup deve ser executada em modo silencioso (-m silent, que é o modo predefinido), ou se deve surgir uma caixa de diálogo a pedir nova tentativa em caso de falha (-m dialog). Se este comutador não for especificado, será utilizado o modo silencioso.
-
-d, --debug – se este comutador for especificado, será utilizado o modo de depuração, permitindo a criação de mais registos para fins de diagnóstico e para partilha com os engenheiros da Altium.
-
-c – permite especificar o nível de compressão do ficheiro zip de destino. Utilize um número entre 0 e 9. Também pode utilizar os seguintes valores:
-
Default – equivale ao nível de compressão 6 (utilizado se este comutador não for especificado)
-
None – equivale ao nível de compressão 0
-
BestSpeed – equivale ao nível de compressão 1
-
BestCompression – equivale ao nível de compressão 9.
-
--split – se este comutador for especificado, serão criados ficheiros zip separados para repositórios e revisões (sem compressão), além do ficheiro zip para os restantes dados.
-
--skip-shadow-copy – se este comutador for especificado, não será criada uma cópia-sombra. Tenha em atenção que o tempo de indisponibilidade do servidor (o período entre a paragem e o arranque dos serviços) aumenta quando este comutador é utilizado.
Ao escrever apenas avbackup backup, estes comutadores serão listados como ajuda útil.
Comutadores disponíveis ao utilizar a ferramenta em modo de backup.
Backup Example
A seguinte entrada fará silenciosamente o backup do Enterprise Server para o ficheiro com o nome 02102024_Backup.zip, escrevendo o ficheiro na pasta C:\Backups\Altium Enterprise Server\:
avbackup backup -z "C:\Backups\Altium Enterprise Server\02102024_Backup.zip" -i "C:\Program Files (x86)\Altium\Altium365\LocalVault.ini"
Quaisquer pastas especificadas já têm de existir. Além disso, os ficheiros existentes são substituídos se o novo ficheiro tiver o mesmo nome que um ficheiro existente.
O resultado da execução do comando de backup de exemplo.
Sintaxe do Restauro e Comutadores
Os seguintes comutadores estão disponíveis ao utilizar a função de restauro da ferramenta:
avbackup restore -z [--skip-backup] [-i] [-m] [-d] [-c] [--split] [--skip-shadow-copy]
-
-z – caminho e nome do ficheiro zip de backup a partir do qual restaurar. Coloque entre aspas se existirem espaços na cadeia. Este comutador é obrigatório.
-
--skip-backup – permite ignorar a criação de um ponto de restauro antes de iniciar o restauro do Enterprise Server. Utilize-o com cuidado, uma vez que, se o restauro dos dados falhar, não será possível reverter.
-
-i – caminho completo para o ficheiro LocalVault.ini do Enterprise Server, que fornece informações sobre as localizações onde restaurar os dados do Enterprise Server. O caminho predefinido deste ficheiro é C:\Program Files (x86)\Altium\Altium365\LocalVault.ini. Se este comutador não for especificado, a ferramenta tentará encontrar o ficheiro automaticamente com base nesta localização de instalação predefinida. Coloque entre aspas se existirem espaços na cadeia.
-
-m – permite determinar se a operação de restauro deve ser executada em modo silencioso (-m silent, que é o modo predefinido), ou se deve surgir uma caixa de diálogo a pedir nova tentativa em caso de falha (-m dialog). Se este comutador não for especificado, será utilizado o modo silencioso.
-
-d, --debug – se este comutador for especificado, será utilizado o modo de depuração, permitindo a criação de mais registos para fins de diagnóstico e para partilha com os engenheiros da Altium.
-
-c – permite especificar o nível de compressão do ficheiro zip de destino para o ponto de restauro (um backup da instalação atual do Enterprise Server). Utilize um número entre 0 e 9. Também pode utilizar os seguintes valores:
-
Default – equivale ao nível de compressão 6 (utilizado se este comutador não for especificado)
-
None – equivale ao nível de compressão 0
-
BestSpeed – equivale ao nível de compressão 1
-
BestCompression – equivale ao nível de compressão 9.
-
--split – se este comutador for especificado, serão criados ficheiros zip separados para repositórios e revisões (sem compressão), além do ficheiro zip para os restantes dados, para o ponto de restauro (um backup da instalação atual do Enterprise Server).
-
--skip-shadow-copy – se este parâmetro for especificado, não será criada uma cópia sombra para o ponto de restauro (uma cópia de segurança da instalação atual do Enterprise Server). Tenha em atenção que o tempo de indisponibilidade do servidor (o período entre a paragem e o arranque dos serviços) aumenta quando este parâmetro é utilizado.
Ao escrever apenas avbackup restore, estes parâmetros serão listados como uma ajuda útil.
Parâmetros disponíveis ao utilizar a ferramenta no modo de restauro.
Se existir um ficheiro de hash *.md5 para o ficheiro zip de cópia de segurança a partir do qual será feito o restauro (o ficheiro *.md5 está na mesma pasta que o ficheiro zip e tem o nome do ficheiro zip, ou seja, <ZipFileName>.zip.md5), o respetivo hash será verificado antes do restauro.
Restore Example
A entrada seguinte irá restaurar silenciosamente o Enterprise Server utilizando o ficheiro zip de cópia de segurança com o nome 30082022_Backup.zip, que está armazenado na pasta C:\Backups\Altium Enterprise Server\:
avbackup restore -z "C:\Backups\Altium Enterprise Server\30082022_Backup.zip" -i "C:\Program Files (x86)\Altium\Altium365\LocalVault.ini"
O resultado da execução do comando de restauro de exemplo. Repare que a ferramenta cria primeiro um ponto de restauro (uma cópia de segurança da instalação atual do Enterprise Server), antes de efetuar o restauro.
Ponto de Restauro
A ferramenta de cópia de segurança cria automaticamente um ponto de restauro antes de iniciar o restauro do Enterprise Server (se --skip-backup não tiver sido utilizado para o restauro). Para o fazer, a ferramenta de cópia de segurança executa uma cópia de segurança do Enterprise Server existente e copia o ZIP de restauro para a seguinte localização:
C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\Backups\
O ZIP é nomeado no formato: Backup_<Date>_<Time>.zip.
Registo de Cópia de Segurança e Restauro
As informações sobre eventos durante uma cópia de segurança ou restauro são apresentadas diretamente na janela CMD e também podem ser encontradas no ficheiro de registo:
C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\avbackup.log
Se ocorrer um erro durante uma cópia de segurança ou restauro, as informações completas sobre o mesmo também podem ser encontradas no ficheiro de registo (
).
AI-localized