Skip to main content
Version 4.1.0

Backup Site Parameters Configuration

Prerequisites
Command Syntax
Terminal input
    pgsmart backup config [Flags]

Flags​

  • -a, --agent= <agent>. => Alias, hostname, or IP of the server where the desired PgSmart Agent is installed.
  • -h, --help. => Help
Non-Interactive Configuration

Non-interactive execution is disabled for this operation.

Interactive Configuration
Terminal input
    pgsmart backup config

Backup Site specific parameters can be viewed or configured in the following ways:

Query Parameters​

  1. Select the desired PgSmart Agent or Register a new Agent.

  2. Select Sites de Backups from the options menu.

  3. Select Listar.

    • The existing Backup Sites will be displayed with their default and user-configured parameters.

    • To locate a parameter in the list, type its full name, partial name, or any set of characters related to the value or section you desire. The search is case insensitive.

    • To view the details of the parameter, press <ENTER> on the desired parameter.

      warning
      • Parameters in blue are mandatory and essential for the service to function.
      • Parameters in red are inconsistent in the configuration file and need to be corrected.
      Figure 1 - Backup Site Parameters Configuration - Query
      Figure 1 - Backup Site Parameters Configuration - Query

Add Backup parameters​

There are two ways to insert a new Backup Site parameter:

  1. Select the desired PgSmart Agent or Register a new Agent.

    1.1. Select Sites de Backups from the options menu.

    1.2. Select Listar.

    • The existing Backup Sites will be displayed with their default and user-configured parameters.

    • To locate a parameter in the list, type its full name, partial name, or any set of characters related to the value or section you desire. The search is case insensitive.

    • To view the details of the parameter, press <ENTER> on the desired parameter.

      warning
      • Parameters in blue are mandatory and essential for the service to function.
      • Parameters in red are inconsistent in the configuration file and need to be corrected.

    1.3. Press insert on your keyboard to add a parameter to the Backup Site.

    1.4. Select a parameter and <enter> to detail the selected parameter.

    1.5. Select the section of the configuration file (Site) where the parameter will be inserted.

    1.6. Select the operation where the parameter will be configured, if prompted.

    1.7. Choose/Enter the new value of the parameter valid for the selected Site.

    1.8. Confirm the operation.

    1.9. Confirm the Reload if prompted.

    Figure 2 - Backup Site Parameters Configuration - Insertion
    Figure 2 - Backup Site Parameters Configuration - Insertion

Edit Parameters​

  1. Select the desired PgSmart Agent or Register a new Agent.

1.1. Select Sites de Backups from the options menu.

1.2. Select Listar

The Backup Sites will be displayed with their respective parameters.

1.3. Select a Backup Site parameter

1.4. Press Enter to detail the parameter.

1.5. Select Editar

1.6. Adjust the Backup information as needed:

1.7. Confirm the Operation.

1.8. Confirm the Reload of the Backup service if prompted.

Figure 5 - Backup Site Parameters Configuration - Edit
Figure 5 - Backup Site Parameters Configuration - Edit

Remove Parameters​

  1. Select the desired PgSmart Agent or Register a new Agent.

    1.1. Select Sites de Backups from the options menu.

    1.2. Select Listar

    The Backup Sites with their respective parameters will be displayed.

    1.3. Select a Backup Site parameter

    1.4. Press Enter to detail the parameter.

    1.5. Select Remover

    1.6. Confirm the Operation.

    1.7. Confirm the Reload of the Backup service if prompted.

    Figure 6 - Backup Site Parameters Configuration - Query
    Figure 6 - Backup Site Parameters Configuration - Query
Final Notes
note

  • Depending on the parameter modified, it may be necessary to RELOAD or RESTART the instance. PgSmart will inform you of the action required to apply the parameter change.

  • If Reload or Restart is not confirmed, the configuration will remain in the file until the necessary action is performed.

note

  • Backup parameters are grouped by section:

  • Each parameter is identified by its value source:

    • site : parameters configured specifically for the backup.
    • cmd : parameters configured specifically for a command.

    Examples:

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

  • Backup parameters are described based on their key characteristics, which help understand their behavior and restrictions.

  • Each parameter is fully documented to ensure the user knows how to configure it correctly with the following information (where applicable):

    • Name: Name of the parameter.
    • Type: Defines the data type accepted (e.g., integer, boolean, string, size, list, list_kv).
    • Current Value: Currently configured value.
    • Value Source: Source that defined the value (e.g., default, global, site, and cmd (command)).
    • Default Value: Value assumed if no other is configured.
    • Group: Functional category of the parameter (e.g., backup, restore).
    • Sections: Contexts where the parameter can be used (global, site, repo).
    • Default Unit: Unit assumed in the absence of explicit specification.
    • Mandatory?: Indicates whether the parameter is mandatory.
    • Requires Restart?: If changes require restarting the service.
    • Read-Only?: Indicates if the value can or cannot be changed after initial configuration.
    • Commands: Operations where the parameter is used (e.g., backup, restore, check).
    • Description: Brief explanation of the parameter’s function.
    • Additional Description: Additional information, examples, or important observations.

  • Details specific to Integer and Size types:

    • Units (B, kB, MB, etc.)
    • Accepts decimals?
    • Accepts negative values?
    • Value range.

  • Details specific to List type:

    • Mandatory indexing (pg1-, pg2-).

  • Details specific to String type :

    • Quotes required (special cases).
    • Case sensitive.