Skip to main content
Version 4.1.0

PgSmart CLI Parameters Configuration

Command Syntax
Terminal input
  pgsmart config [COMPONENTS] [Flags]

Components:​

  • client => Settings for the local PgSmart Client
  • agent => Settings for the Remote PgSmart Agent

Flags:​

  • -a, --agent=<agent> => Alias, Hostname, or IP address where the PgSmart Agent is installed.
  • -h, --help => Help.

Supported Parameters:​

PgSmart-Client and PgSmart-Agent Parameters​

  • default_timeout: Specifies the maximum time PgSmart can run an OS command or a platform component command.
  • log_command_history: Enables/disables logging of the history of commands executed by PgSmart in the OS.
  • log_debug: Enables/disables the debug logging of PgSmart code modules/functions (namespaces).
  • log_detail: Specifies the level of detail for information to be logged.
  • log_rotation_age: Enables automatic log rotation when opening the log file if the elapsed time exceeds the configured value (soft limit).
  • log_rotation_size: Enables automatic log rotation when opening the log file if the file size exceeds the configured value (soft limit).

PgSmart-Agent Specific Parameters​

  • agent_port: TCP port on which the PgSmart Agent receives requests from PgSmart Clients.
  • backup_adm_timeout: Maximum time PgSmart can perform administration operations of the Backup environments.
  • component_version: Shows the version of the component within the PostgreSYS Platform.
  • geo_install-timeout: Maximum time PgSmart can perform installation of the Georeferencing component (PostGIS).
  • ha_adm_timeout: Maximum time PgSmart can perform administration operations of the High Availability environment.
  • install_timeout: Maximum time PgSmart can perform the installation of each repository and package of the components that are part of the PostgreSYS Platform.
  • job_check_interval: Interval between executions of the Task Scheduler verification of the PgSmart Agent.
  • job_disk_retention_age: Maximum time the metadata file of finished tasks, successful or not, can remain available for consultation before being archived.
  • job_mem_retention_age: Maximum time the information of finished task queues, successful or not, can remain in the memory of the PgSmart Agent.
  • metadb_password: Password of the connection user (pgsmart) in the metadata database of the PostgreSYS Environment.
  • metadb_port: TCP port where the metadata database of the PostgreSYS Environment will receive connections.
  • metrics_password: Password of the connection user (pgsmart_metrics) used for collecting component metrics.
Command Execution

  1. Select the Parâmetros option.

  2. Select the desired parameter.

  3. PgSmart will display the current data for the selected parameter.

  4. Enter the new value for the parameter.

  5. Confirm the operation.

    Figure 1 - PgSmart Parameter Configuration
    Figure 1 - PgSmart Parameter Configuration

Command Variations​

Some parameters can be pre-passed in the command; however, the execution remains interactive, meaning you must confirm the provided parameters along with the default values.

Examples:

PgSmart Agent Configuration:

Terminal input
    pgsmart config agent

PgSmart Agent Configuration with host already specified:

Terminal input
    pgsmart config agent -a 192.168.0.102
Final Notes
note

PgSmart Client configurations are stored in the pgsmart.conf file located in /opt/pgsmart-client.

note

The PgSmart-Agent and PgSmart-Client configuration parameters are similar.
For PgSmart Agent configuration, it is necessary to first select the desired Agent.