Pular para o conteúdo principal
Versão 4.1.0

Configuração dos Parâmetros do Site de Backup

Pré-Requisitos
Sintaxe do Comando
Terminal input
    pgsmart backup config [Flags]

Flags​

  • -a, --agent= <agent>. => Alias, hostname ou IP do servidor onde o PgSmart Agent desejado está instalado.
  • -h, --help. => Ajuda
Configuração Não-Interativa

A execução não interativa está desabilitada para esta operação.

Configuração Interativa
Terminal input
    pgsmart backup config

Os parâmetros específicos de Sites de Backup podem ser visualizados ou configurados das seguintes formas:

Consulta Parâmetros​

  1. Selecione o Agente do PgSmart desejado ou Registrar um novo Agente.

  2. Selecione Sites de Backups no menu de opções.

  3. Selecione Listar.

    • Serão exibidos os Sites de Backup existentes com seus parâmetros default e configurados pelo cliente.

    • Para localizar um parâmetro na lista, digite seu nome completo, parcial ou qualquer conjunto de caracteres relacionados ao valor ou à seção desejada. A busca não diferencia maiúsculas de minúsculas (case insensitive).

    • Para visualizar detalhes do parâmetro, clique <ENTER> no parâmetro desejado.

      alerta
      • parâmetros na cor azul são obrigatórios e essenciais para o funcionamento do serviço.
      • parâmetros em vermelho estão inconsistentes no arquivo de configuração e devem ser corrigidos.
      Figura 1 - Configuração de Parâmetros de Site de Backup - Consulta
      Figura 1 - Configuração de Parâmetros de Site de Backup - Consulta

Insere Parâmetros​

Existem duas formas de inserir um novo parâmetro de Site de Backup:

  1. Selecione o Agente do PgSmart desejado ou Registrar um novo Agente.

    1.1. Selecione Sites de Backups no menu de opções.

    1.2. Selecione Listar.

    • Serão exibidos os Sites de Backup existentes com seus parâmetros default e configurados pelo cliente.

    • Para localizar um parâmetro na lista, digite seu nome completo, parcial ou qualquer conjunto de caracteres relacionados ao valor ou à seção desejada. A busca não diferencia maiúsculas de minúsculas (case insensitive).

    • Para visualizar detalhes do parâmetro, clique <ENTER> no parâmetro desejado.

      alerta
      • parâmetros na cor azul são obrigatórios e essenciais para o funcionamento do serviço.
      • parâmetros em vermelho estão inconsistentes no arquivo de configuração e devem ser corrigidos.

    1.3. Pressione insert no seu teclado para adicionar um parâmetro ao Site de Backup.

    1.4. Selecione um parâmetro e <enter> para detalhar o parâmetro selecionado.

    1.5. Selecione a seção do arquivo de configuração (Site) onde será inserido o parâmetro.

    1.6. Selecione a operação onde o parâmetro será configurado, se assim for solicitado.

    1.7. Escolha/Informe o novo valor do parâmetro válido para o Site selecionado .

    1.8. Confirme a operação.

    1.9. Confirme o Reload se assim for solicitado.

    Figura 2 - Configuração de Parâmetros de Site de Backup - Inserção
    Figura 2 - Configuração de Parâmetros de Site de Backup - Inserção

Edita Parâmetros​

  1. Selecione o Agente do PgSmart desejado ou Registrar um novo Agente.

    1.1. Selecione Sites de Backup o menu de opções.

    1.2. Selecione Listar

    Serão apresentados os Sites de Backup com seus respectivos parâmetros.

    1.3. Selecione um parâmetro de Site de Backup

    1.4. Clique Enter para detalhar o parâmetro.

    1.5. Selecione Editar

    1.6. Ajuste as informações do Backup conforme sua necessidade:

    1.7. Confirme a Operação.

    1.8. Confirme o Reload do serviço de Backup se assim for solicitado.

    Figura 4 - Configuração de Parâmetros de Site de Backup - Edição
    Figura 4 - Configuração de Parâmetros de Site de Backup - Edição

Remove Parâmetros​

  1. Selecione o Agente do PgSmart desejado ou Registrar um novo Agente.

    1.1. Selecione Sites de Backup no menu de opções.

    1.2. Selecione Listar

    Serão apresentados os Sites de Backup com seus respectivos parâmetros.

    1.3. Selecione um parâmetro de Site de Backup

    1.4. Clique Enter para detalhar o parâmetro.

    1.5. Selecione Remover

    1.6. Confirme a Operação.

    1.7. Confirme o Reload do serviço de Backup se assim for solicitado.

    Figura 5 - Configuração de Parâmetros de Site de Backup - Consulta
    Figura 5 - Configuração de Parâmetros de Site de Backup - Consulta
Notas Finais
nota

  • Conforme o parâmetro modificado, pode ser necessário o RELOAD ou então o RESTART da instância. O PgSmart irá informar qual ação é necessária para efetivar a mudança do parâmetro.

  • Caso o Reload ou Restart não seja confirmado, a configuração permanecerá no arquivo até que a ação necessária seja realizada.

nota

  • Os parâmetros de Backup são agrupados por seção:

  • Cada parâmetro é identificado por sua origem de valores, que diz respeito a localização onde se origina o valor:

    • site : parâmetros configurados especificamente para o backup.
    • cmd : parâmetros configurados especificamente para um comando.

    Exemplos:

        ─── [ site01 ] ───
        (site) pg1-host = 192.168.56.237
        ─── [ site01:archive-push ] ───
        (cmd)  archive-push-queue-max = 1B
nota

  • Os parâmetros do backup são descritos com base em suas principais características, que ajudam a entender seu comportamento e restrições.

  • Cada parâmetro é documentado de forma completa para garantir que o usuário saiba como configurá-lo corretamente com as seguintes informações (desde que aplicáveis):

    • Nome: Nome do parâmetro.
    • Tipo: Define o tipo de dado aceito (ex.: integer, boolean, string, size, list, list_kv).
    • Valor Corrente: Valor atualmente configurado.
    • Origem do Valor: Fonte que definiu o valor (ex.: default, global, site e cmd (comando)).
    • Valor Padrão: Valor assumido se nenhum outro for configurado.
    • Grupo: Categoria funcional do parâmetro (ex.: backup, restore).
    • Seções: Contextos onde o parâmetro pode ser usado (global, site, repo).
    • Unidade Padrão: Unidade assumida na ausência de especificação explícita.
    • Obrigatório?: Informa se o parâmetro é mandatório.
    • Requer Reinicialização?: Se mudanças exigem reinicializar o serviço.
    • Somente Leitura?: Indica se o valor pode ou não ser alterado depois da configuração inicial.
    • Comandos: Operações em que o parâmetro é usado (ex.: backup, restore, check).
    • Descrição: Explicação resumida da função do parâmetro.
    • Descrição Complementar: Informações adicionais, exemplos ou observações importantes.

  • Detalhes específicos do tipo Integer e Size:

    • Unidades (B, kB, MB, etc.)
    • Aceita decimal?
    • Aceita negativo?
    • Intervalo de valores.

  • Detalhes específicos do tipoLista:

    • Indexação obrigatória (pg1-, pg2-).

  • Detalhes específicos do tipostring :

    • Aspas necessárias (casos especiais).
    • Case sensitive.