Commande de ping serveur (server-ping)

Pongez un serveur TLS pgBackRest pour vérifier qu’il accepte les connexions. Cette opération ne sert qu’à vérifier la disponibilité, car aucune authentification n’est tentée.

Si aucun hôte n’est spécifié en ligne de commande, l’option tls-server-host sera utilisée.

Options de commande

Option d’adresse serveur TLS (--tls-server-address)

Adresse du serveur TLS.

Adresse IP sur laquelle le serveur écoute les requêtes clients.

default: localhost
example: --tls-server-address=*

Option de port serveur TLS (--tls-server-port)

Port du serveur TLS.

Port sur lequel le serveur écoute les requêtes clients.

default: 8432
allowed: [1, 65535]
example: --tls-server-port=8000

Options générales

Autoriser l’exécution en tant qu’utilisateur root (--allow-root)

Permettre à la commande de s’exécuter en tant qu’utilisateur root.

Par défaut, seul la commande restore peut être exécutée en tant qu’utilisateur root, car elle est conçue pour gérer soigneusement les propriétés des fichiers. Exécuter d’autres commandes en tant que root risque de créer des fichiers (par exemple dans le dépôt) dont le propriétaire est root, rendant ces fichiers inaccessibles à l’utilisateur PostgreSQL, ce qui entraîne l’échec des commandes ultérieures.

Activez cette option pour exécuter une commande en tant qu’utilisateur root malgré tout. Toutefois, il est bien préférable d’exécuter pgBackRest en tant qu’utilisateur propriétaire du dépôt et du cluster PostgreSQL.

default: n
example: --allow-root

Option Taille tampon (--buffer-size)

Taille du tampon pour les opérations d’E/S.

Taille de tampon utilisée pour les opérations de copie, de compression, de chiffrement et autres. Le nombre de tampons utilisés dépend des options, et chaque opération peut utiliser une mémoire supplémentaire, par exemple, la compression gz peut utiliser jusqu’à 256KiB de mémoire supplémentaire.

Les valeurs autorisées sont 16KiB, 32KiB, 64KiB, 128KiB, 256KiB, 512KiB, 1MiB, 2MiB, 4MiB, 8MiB et 16MiB.

default: 1MiB
example: --buffer-size=2MiB

Option de configuration (--config)

Fichier de configuration pgBackRest.

Utilisez cette option pour spécifier un fichier de configuration différent du fichier par défaut.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

Option Chemin d’inclusion de configuration (--config-include-path)

Chemin vers les fichiers de configuration supplémentaires de pgBackRest.

Les fichiers de configuration se trouvant dans l’emplacement spécifié et ayant l’extension .conf seront concaténés au fichier de configuration de pgBackRest, ce qui donne un seul fichier de configuration.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

Option de chemin de configuration (--config-path)

Chemin de base des fichiers de configuration de pgBackRest.

Ce paramètre est utilisé pour remplacer le chemin de base par défaut pour les options --config et --config-include-path, sauf si ces dernières sont explicitement définies en ligne de commande.

Par exemple, passer uniquement --config-path=/conf/pgbackrest fait que la valeur par défaut de --config est définie à /conf/pgbackrest/pgbackrest.conf et que la valeur par défaut de --config-include-path est définie à /conf/pgbackrest/conf.d.

default: CFGOPTDEF_CONFIG_PATH
example: --config-path=/conf/pgbackrest

Option d’expiration I/O (--io-timeout)

Délai d’attente d’E/S dépassé.

Délai d’attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.

Notez que l’opération de lecture/écriture entière n’a pas besoin de se terminer dans ce délai d’attente, mais une certaine progression doit être réalisée, même si elle ne concerne qu’un seul octet.

default: 1m
allowed: [100ms, 1h]
example: --io-timeout=120

Définir l’option de priorité du processus (--priority)

Définir la priorité du processus.

Définit la priorité (c’est-à-dire la valeur de niceness) accordée au processus par l’ordonnanceur du noyau. Les valeurs positives réduisent la priorité, tandis que les valeurs négatives l’augmentent. Dans la plupart des cas, les processus ne disposent pas des autorisations nécessaires pour augmenter leur priorité.

allowed: [-20, 19]
example: --priority=19

Option Keep Alive (--sck-keep-alive)

Activation du keep-alive.

Active les messages keep-alive sur les connexions socket.

default: y
example: --no-sck-keep-alive

Option de nombre de connexions Keep Alive (--tcp-keep-alive-count)

Nombre de maintien de connexion.

Spécifie le nombre de messages TCP keep-alive pouvant être perdus avant que la connexion ne soit considérée comme inactive.

Cette option est disponible sur les systèmes qui prennent en charge l’option de socket TCP_KEEPCNT.

allowed: [1, 32]
example: --tcp-keep-alive-count=3

Option d’idle Keep Alive (--tcp-keep-alive-idle)

Délai d’inactivité pour la maintien de la connexion.

Spécifie la durée (en secondes) pendant laquelle aucune activité réseau ne se produit, après laquelle le système d’exploitation doit envoyer un message de maintien de connexion TCP.

Cette option est disponible sur les systèmes qui prennent en charge l’option de socket TCP_KEEPIDLE.

allowed: [1, 3600]
example: --tcp-keep-alive-idle=60

Option Intervalle Keep Alive (--tcp-keep-alive-interval)

Intervalle de temps pour la maintien de la connexion active.

Spécifie la durée (en secondes) après laquelle un message TCP keep-alive non reconnu doit être renvoyé.

Cette option est disponible sur les systèmes qui prennent en charge l’option de socket TCP_KEEPINTVL.

allowed: [1, 900]
example: --tcp-keep-alive-interval=30

Suites de chiffrement TLSv1.2 Option (--tls-cipher-12)

Suites de chiffrement TLSv1.2 autorisées.

Toutes les connexions TLS entre le client pgBackRest et le serveur sont chiffrées. Par défaut, les connexions aux magasins d’objets (par exemple S3) sont également chiffrées.

NOTE : Le niveau de sécurité minimal absolu pour toute connexion de transport est TLSv1.2.

Les suites de chiffrement acceptées peuvent être ajustées si nécessaire. L’exemple proposé constitue un choix raisonnable sauf si des exigences de sécurité spécifiques s’appliquent. Si non définies (valeur par défaut), la valeur par défaut de la bibliothèque OpenSSL sous-jacente s’applique.

example: --tls-cipher-12=HIGH:MEDIUM:+3DES:!aNULL

Suites de chiffrement TLSv1.3 Option (--tls-cipher-13)

Suites de chiffrement TLSv1.3 autorisées.

Toutes les connexions TLS entre le client pgBackRest et le serveur sont chiffrées. Par défaut, les connexions aux magasins d’objets (par exemple S3) sont également chiffrées.

NOTE : Le niveau de sécurité minimal absolu pour toute connexion de transport est TLSv1.2.

Les suites de chiffrement acceptées peuvent être ajustées si nécessaire. Si non définies (valeur par défaut), la valeur par défaut de la bibliothèque OpenSSL sous-jacente s’applique.

example: --tls-cipher-13=TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256

Options de journalisation

Niveau de journalisation de la console (--log-level-console)

Niveau de journalisation pour la console.

Les niveaux de journalisation suivants sont pris en charge :

• off - Aucune journalisation (non recommandé)
• error - Journaliser uniquement les erreurs
• warn - Journaliser les avertissements et les erreurs
• info - Journaliser les informations, les avertissements et les erreurs
• detail - Journaliser les détails, les informations, les avertissements et les erreurs
• debug - Journaliser le débogage, les détails, les informations, les avertissements et les erreurs
• trace - Journaliser les traces (débogage très détaillé), le débogage, les informations, les avertissements et les erreurs

default: warn
example: --log-level-console=error

Niveau de journalisation du fichier (--log-level-file)

Niveau de journalisation des fichiers.

Les niveaux de journalisation suivants sont pris en charge :

• off - Aucune journalisation (non recommandé)
• error - Journaliser uniquement les erreurs
• warn - Journaliser les avertissements et les erreurs
• info - Journaliser les informations, les avertissements et les erreurs
• detail - Journaliser les détails, les informations, les avertissements et les erreurs
• debug - Journaliser le débogage, les détails, les informations, les avertissements et les erreurs
• trace - Journaliser les traces (débogage très détaillé), le débogage, les informations, les avertissements et les erreurs

default: info
example: --log-level-file=debug

Niveau de journalisation des erreurs standard (--log-level-stderr)

Niveau de journalisation pour stderr.

Spécifie les niveaux de journalisation qui seront envoyés vers stderr plutôt que vers stdout (spécifié par log-level-console). L’horodatage et le processus ne seront pas envoyés vers stderr.

Les niveaux de journalisation suivants sont pris en charge :

• off - Aucune journalisation (non recommandé)
• error - Journaliser uniquement les erreurs
• warn - Journaliser les avertissements et les erreurs
• info - Journaliser les informations, les avertissements et les erreurs
• detail - Journaliser les détails, les informations, les avertissements et les erreurs
• debug - Journaliser le débogage, les détails, les informations, les avertissements et les erreurs
• trace - Journaliser les traces (débogage très détaillé), le débogage, les informations, les avertissements et les erreurs

default: off
example: --log-level-stderr=error

Option Chemin Journal (--log-path)

Chemin où les fichiers de journalisation sont stockés.

Le chemin de journalisation fournit un emplacement où pgBackRest peut stocker les fichiers de journalisation. Notez que si log-level-file=off, aucun chemin de journalisation n’est requis.

default: /var/log/pgbackrest
example: --log-path=/backup/db/log

Option de timestamp de journal (--log-timestamp)

Activer les horodatages dans la journalisation.

Active l’horodatage dans la journalisation console et fichier. Cette option est désactivée dans des situations spéciales, telles que la génération de documentation.

default: y
example: --no-log-timestamp