Commande de vérification (verify)

Verify détermine si les sauvegardes et les archives présentes dans un dépôt sont valides.

Options de commande

Option de sortie (--output)

Type de sortie.

Les types de sortie suivants sont pris en charge :

• none - Aucune vérification de sortie.
• text - Informations de vérification de sortie affichées sur stdout.

default: none
example: --output=text

Définir l’option (--set)

Sauvegarde configurée pour vérification.

Vérifiez tous les fichiers de base de données et d’archive associés à l’ensemble de sauvegarde spécifié.

example: --set=20150131-153358F_20150131-153401I

Option verbeuse (--verbose)

Affichage détaillé.

L’option Verbose vaut par défaut false, ce qui fournit une réponse minimale contenant uniquement des informations importantes sur les erreurs dans le dépôt. La spécification de true fournit davantage d’informations sur ce qui a été vérifié avec succès.

default: n
example: --verbose

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 commande pgBackRest (--cmd)

Commande pgBackRest.

pgBackRest peut générer une chaîne de commande, par exemple lorsque la commande restore génère le paramètre restore_command. Dans ce cas, la commande utilisée pour exécuter le processus pgBackRest sera employée, sauf si l’option cmd est fournie.

AVERTISSEMENT :

Envelopper la commande pgBackRest peut entraîner un comportement imprévisible et n’est pas recommandé.

default: [path of executed pgbackrest binary]
example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

Option de commande client SSH (--cmd-ssh)

Commande cliente SSH.

Utilisez une commande cliente SSH spécifique lorsque vous souhaitez utiliser une alternative ou que la commande ssh n’est pas disponible dans $PATH.

default: ssh
example: --cmd-ssh=/usr/bin/ssh

Option niveau de compression réseau (--compress-level-network)

Niveau de compression du réseau.

Définit le niveau de compression réseau lorsque compress-type=none et la commande ne sont pas exécutées sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau. Lorsque compress-type est différent de none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place, afin que le fichier ne soit compressé qu’une seule fois.

default: 1
allowed: [-5, 12]
example: --compress-level-network=1

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

Option de masque neutre (--neutral-umask)

Utilisez un umask neutre.

Définit le umask à 0000 afin que les modes du dépôt soient créés de manière cohérente. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640.

Pour utiliser le umask de l’utilisateur en cours, spécifiez neutral-umask=n dans le fichier de configuration ou --no-neutral-umask en ligne de commande.

default: y
example: --no-neutral-umask

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 de processus maximum (--process-max)

Nombre maximal de processus à utiliser pour la compression ou le transfert.

Chaque processus effectuera une compression et un transfert afin d’accélérer l’exécution de la commande, mais ne définissez pas process-max trop élevé afin de ne pas affecter les performances de la base de données.

default: 1
allowed: [1, 999]
example: --process-max=4

Option délai d’attente du protocole (--protocol-timeout)

Délai d’attente du protocole.

Définit le délai d’attente, en secondes, durant lequel le processus local ou distant attend qu’un nouveau message soit reçu au niveau du protocole. Cela empêche les processus de rester bloqués indéfiniment en attente d’un message.

NOTE : L’option protocol-timeout doit être supérieure à l’option db-timeout.

default: 31m
allowed: [100ms, 7d]
example: --protocol-timeout=630

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 stanza (--stanza)

Définit la stanza.

Une stanza est la configuration d’un cluster de base de données PostgreSQL qui définit son emplacement, la manière dont il sera sauvegardé, les options d’archivage, etc. La plupart des serveurs de base de données n’ont qu’un seul cluster PostgreSQL et donc une seule stanza, tandis que les serveurs de sauvegarde ont une stanza pour chaque cluster de base de données à sauvegarder.

Il est tentant de nommer la stanza en fonction du cluster principal, mais un nom plus pertinent décrit les bases de données contenues dans le cluster. Étant donné que le nom de la stanza sera utilisé pour le principal et toutes les répliques, il est préférable de choisir un nom qui décrit la fonction réelle du cluster, par exemple app ou dw, plutôt que le nom local du cluster, comme main ou prod.

example: --stanza=main

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 journalisation des sous-processus (--log-subprocess)

Activer la journalisation dans les sous-processus.

Activez la journalisation des fichiers pour tout sous-processus créé par ce processus, en utilisant le niveau de journalisation spécifié par log-level-file.

default: n
example: --log-subprocess

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

Options du mainteneur

Option de version PostgreSQL obligatoire (--pg-version-force)

Forcer la version de PostgreSQL.

La version de PostgreSQL spécifiée sera utilisée à la place de la version détectée automatiquement en lisant pg_control ou les en-têtes WAL. Cela est principalement utile pour les forks de PostgreSQL ou les versions de développement où ces valeurs diffèrent de la version de publication. La version rapportée par PostgreSQL via server_version_num doit correspondre à la version forcée.

AVERTISSEMENT :

Faites preuve de prudence en utilisant cette option, car pg_control et les en-têtes WAL seront toujours lus selon le format attendu pour la version spécifiée, c’est-à-dire le format issu de la version open-source officielle de PostgreSQL. Si la version fork ou développée modifie le format des champs sur lesquels pgBackRest dépend, cela entraînera un comportement imprévu. En général, cette option ne fonctionnera correctement que si le fork ajoute tous les membres de structure personnalisés après les membres standard de PostgreSQL.

example: --pg-version-force=15

Options du dépôt

Définir l’option dépôt (--repo)

Définir le dépôt.

Spécifiez le dépôt sur lequel une commande doit s’opérer.

Par exemple, cette option peut être utilisée pour effectuer une restauration à partir d’un dépôt spécifique, plutôt que de laisser pgBackRest choisir.

allowed: [1, 256]
example: --repo=1

Option de conteneur de dépôt Azure (--repo-azure-container)

Conteneur de dépôt Azure.

Conteneur Azure utilisé pour stocker le dépôt.

Les dépôts pgBackRest peuvent être stockés dans la racine du conteneur en définissant repo-path=/, mais il est généralement préférable de préciser un préfixe, tel que /repo, afin de pouvoir également stocker les journaux et d’autres contenus générés par Azure dans le conteneur.

example: --repo1-azure-container=pg-backup

Type de clé du dépôt Azure (--repo-azure-key-type)

Type de clé du dépôt Azure.

Les types suivants sont pris en charge pour l’autorisation :

• shared - Clé partagée
• sas - Signature d’accès partagé
• auto - Autorisation automatique à l’aide d’identités managées Azure

default: shared
example: --repo1-azure-key-type=sas

Option de style d’URI de dépôt Azure (--repo-azure-uri-style)

Style URI Azure.

Les styles d’URI suivants sont pris en charge :

• host - Se connecter à l’hôte account.endpoint.
• path - Se connecter à l’hôte endpoint et préfixer le compte aux URI.

default: host
example: --repo1-azure-uri-style=path

Type de chiffrement du dépôt (--repo-cipher-type)

Chiffrement utilisé pour chiffrer le dépôt.

Les types de chiffrement suivants sont pris en charge :

• none - Le dépôt n’est pas chiffré
• aes-256-cbc - Advanced Encryption Standard avec une longueur de clé de 256 bits

Notez que le chiffrement est toujours effectué côté client, même si le type de dépôt (par exemple S3) prend en charge le chiffrement.

default: none
example: --repo1-cipher-type=aes-256-cbc

Option de bac de dépôt GCS (--repo-gcs-bucket)

Dépôt de bucket GCS.

Dépôt GCS utilisé pour stocker le dépôt.

Les dépôts pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/, mais il est généralement préférable de préciser un préfixe, tel que /repo, afin de pouvoir également stocker les journaux et d’autres contenus générés par GCS dans le bucket.

example: --repo1-gcs-bucket=/pg-backup

Option de point de terminaison du dépôt GCS (--repo-gcs-endpoint)

Point de terminaison du dépôt GCS.

Point d’accès utilisé pour se connecter au service de stockage. Peut être mis à jour pour utiliser un serveur local GCS ou un point d’accès alternatif.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

Type de clé du dépôt GCS (--repo-gcs-key-type)

Type de clé du dépôt GCS.

Les types suivants sont pris en charge pour l’autorisation :

• auto - Autoriser à l’aide du compte de service de l’instance.
• service - Compte de service à partir d’une clé stockée localement.
• token - À utiliser pour les tests locaux, par exemple fakegcs.

Lorsque repo-gcs-key-type=service, les identifiants seront rechargés lorsque le jeton d’authentification sera renouvelé.

default: service
example: --repo1-gcs-key-type=auto

Option ID du projet du dépôt GCS (--repo-gcs-user-project)

Identifiant du projet GCS.

ID du projet GCS utilisé pour déterminer la facturation des requêtes.

example: --repo1-gcs-user-project=my-project

Option hôte du dépôt (--repo-host)

Hôte du dépôt lors de l’opération à distance.

Lors de la sauvegarde et de l’archivage vers un système de fichiers monté localement, ce paramètre n’est pas requis.

example: --repo1-host=repo1.domain.com

Nom obsolète : backup-host

Option du fichier de l’autorité de certification hôte du dépôt (--repo-host-ca-file)

Fichier de l’autorité de certification du serveur de dépôt.

Utilisez un fichier CA autre que celui par défaut du système pour vous connecter à l’hôte du dépôt.

example: --repo1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt

Option Chemin de l’autorité de certification du dépôt (--repo-host-ca-path)

Chemin de l’autorité de certification du serveur de dépôt.

Utilisez un chemin de certificat d’autorité (CA) autre que celui par défaut du système pour établir la connexion avec l’hôte du dépôt.

example: --repo1-host-ca-path=/etc/pki/tls/certs

Option de fichier de certificat d’hôte du dépôt (--repo-host-cert-file)

Fichier de certificat d’hôte du dépôt.

Envoyé à l’hôte du dépôt pour prouver l’identité du client.

example: --repo1-host-cert-file=/path/to/client.crt

Option de commande hôte du dépôt (--repo-host-cmd)

Hôte du dépôt commande pgBackRest.

Requis uniquement si le chemin vers la commande pgBackRest est différent sur les hôtes local et de dépôt. Si non défini, la commande de dépôt sera définie de la même manière que celle de l’hôte local.

default: [path of executed pgbackrest binary]
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Nom obsolète : backup-cmd

Option de configuration de l’hôte du dépôt (--repo-host-config)

Fichier de configuration du serveur de dépôt pgBackRest.

Spécifie l’emplacement du fichier de configuration sur l’hôte du dépôt. Cette option est nécessaire uniquement si le fichier de configuration de l’hôte du dépôt se trouve dans un emplacement différent du fichier de configuration local.

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

Nom obsolète : sauvegarde-config

Option de chemin d’inclusion de configuration d’hôte de dépôt (--repo-host-config-include-path)

Configuration du serveur de dépôt pgBackRest incluant le chemin.

Définit l’emplacement du chemin d’inclusion de configuration sur l’hôte du dépôt. Cette option est nécessaire uniquement si le chemin d’inclusion de configuration de l’hôte du dépôt est différent du chemin d’inclusion de configuration local.

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

Chemin de configuration de l’hôte du dépôt (--repo-host-config-path)

Chemin de configuration du serveur de dépôt pgBackRest.

Définit l’emplacement du chemin de configuration sur l’hôte du dépôt. Cette option est nécessaire uniquement si le chemin de configuration de l’hôte du dépôt est différent du chemin de configuration local.

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

Option de fichier de clé hôte du dépôt (--repo-host-key-file)

Fichier de clé hôte du dépôt.

Vérifie que le certificat client a été envoyé par le propriétaire.

example: --repo1-host-key-file=/path/to/client.key

Option de port hôte du dépôt (--repo-host-port)

Port de l’hôte du dépôt lorsque repo-host est défini.

Utilisez cette option pour spécifier un port non par défaut pour le protocole du serveur du dépôt.

NOTE : Lorsque repo-host-type=ssh, il n’existe pas de valeur par défaut pour repo-host-port. Dans ce cas, le port sera celui configuré pour la commande spécifiée par cmd-ssh.

default (depending on repo-host-type):
    tls - 8432

allowed: [0, 65535]
example: --repo1-host-port=25

Nom obsolète : backup-ssh-port

Type de protocole d’hôte de dépôt (--repo-host-type)

Type de protocole d’hôte de dépôt.

Les types de protocole suivants sont pris en charge :

• ssh - Shell sécurisé.
• tls - Serveur TLS pgBackRest.

default: ssh
example: --repo1-host-type=tls

Option d’utilisateur hôte de dépôt (--repo-host-user)

Utilisateur hôte du dépôt lorsque repo-host est défini.

Définit l’utilisateur utilisé pour les opérations sur l’hôte du dépôt. Il est préférable que ce ne soit pas l’utilisateur postgres, mais plutôt un autre utilisateur tel que pgbackrest. Si PostgreSQL s’exécute sur l’hôte du dépôt, l’utilisateur postgres peut être ajouté au groupe pgbackrest afin d’avoir des permissions de lecture sur le dépôt sans pouvoir accidentellement le modifier.

default: pgbackrest
example: --repo1-host-user=repo-user

Nom obsolète : backup-user

Option Chemin du dépôt (--repo-path)

Chemin où les sauvegardes et l’archive sont stockées.

Le dépôt est l’emplacement où pgBackRest stocke les sauvegardes et les archives des segments WAL.

Il peut être difficile de prévoir à l’avance l’espace nécessaire. La meilleure approche consiste à effectuer quelques sauvegardes, puis à noter la taille des différents types de sauvegardes (pleines, incrémentielles, différentielles) et à mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l’espace requis, bien que les besoins évoluent probablement au fil du temps avec l’évolution de votre base de données.

default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest

Option de bac de dépôt S3 (--repo-s3-bucket)

Dépôt S3.

Dépôt S3 utilisé pour stocker le dépôt.

Les dépôts pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/, mais il est généralement préférable de préciser un préfixe, tel que /repo, afin de pouvoir également stocker les journaux et d’autres contenus générés par AWS dans le bucket.

example: --repo1-s3-bucket=pg-backup

Option de point de terminaison du dépôt S3 (--repo-s3-endpoint)

Point de terminaison du dépôt S3.

Le point de terminaison AWS doit être valide pour la région sélectionnée.

Pour les configurations personnalisées ou les tests, les options repo-storage-ca-file, repo-storage-ca-path, repo-storage-host, repo-storage-port, et repo-storage-verify-tls peuvent être utiles.

example: --repo1-s3-endpoint=s3.amazonaws.com

Type de clé du dépôt S3 (--repo-s3-key-type)

Type de clé pour le dépôt S3.

Les types suivants sont pris en charge :

• shared - Clés partagées
• auto - Récupérer automatiquement les identifiants temporaires
• web-id - Récupérer automatiquement les identifiants d’identité web
• pod-id - Récupérer automatiquement les identifiants d’identité de pod EKS
• process - Récupérer les identifiants en exécutant un processus

default: shared
example: --repo1-s3-key-type=auto

Option ID de clé KMS pour dépôt S3 (--repo-s3-kms-key-id)

Clé KMS du dépôt S3.

Active le chiffrement côté serveur S3 en utilisant la clé du service de gestion des clés AWS spécifiée.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

Option de commande du processus d’authentification S3 (--repo-s3-process-cmd)

Commande du processus d’authentification S3.

Commande (et arguments facultatifs) à exécuter pour récupérer les identifiants temporaires S3. Le premier élément de la liste est la commande, les éléments suivants sont passés en tant que paramètres.

Le processus doit produire un JSON contenant les champs AccessKeyId, SecretAccessKey, SessionToken et Expiration. Les identifiants seront automatiquement actualisés avant l’expiration. Voir Process Credential Provider pour les détails du format.

example: --repo1-s3-process-cmd=/usr/local/bin/get-credentials --repo1-s3-process-cmd=--role --repo1-s3-process-cmd=my-role

Option de région du dépôt S3 (--repo-s3-region)

Région du dépôt S3.

La région AWS où le bucket a été créé.

example: --repo1-s3-region=us-east-1

Option Requesteur Payant pour le dépôt S3 (--repo-s3-requester-pays)

Dépôt S3 payeur de la demande.

Active le paiement par le demandeur S3.

default: n
example: --no-repo1-s3-requester-pays

Option de rôle du dépôt S3 (--repo-s3-role)

Rôle du dépôt S3.

Le nom du rôle AWS (pas le nom ARN complet) utilisé pour récupérer les identifiants temporaires lorsque repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

Option de service de dépôt S3 (--repo-s3-service)

Service de signature S3.

Le service de signature S3 utilisé dans l’authentification SigV4. La valeur par défaut est s3 pour les points d’accès S3 standards. À définir sur s3-outposts lors de l’utilisation d’un point d’accès S3 Outposts.

default: s3
example: --repo1-s3-service=s3-outposts

Option de point de terminaison STS du dépôt S3 (--repo-s3-sts-host)

Point de terminaison STS du dépôt S3.

Point de terminaison STS utilisé pour récupérer des identifiants temporaires lorsque repo-s3-key-type=web-id est configuré. Définissez-le sur un point de terminaison régional (par exemple sts.us-east-1.amazonaws.com) pour utiliser STS régional, ce qui peut être nécessaire pour les régions GovCloud, Chine, ou pour réduire la latence.

default: sts.amazonaws.com
example: --repo1-s3-sts-host=sts.us-east-1.amazonaws.com

Option de style d’URI de dépôt S3 (--repo-s3-uri-style)

Style d’URI S3.

Les styles d’URI suivants sont pris en charge :

• host - Se connecter à l’hôte bucket.endpoint.
• path - Se connecter à l’hôte endpoint et préfixer les URI par le répertoire.

default: host
example: --repo1-s3-uri-style=path

Option hôte du dépôt SFTP (--repo-sftp-host)

Hôte du dépôt SFTP.

Hôte SFTP contenant le dépôt.

example: --repo1-sftp-host=sftprepo.domain

Fingerprint de l’hôte du dépôt SFTP (--repo-sftp-host-fingerprint)

Empreinte du serveur hôte du dépôt SFTP.

La génération de l’empreinte d’hôte du dépôt SFTP doit correspondre à repo-sftp-host-key-hash-type. Générez l’empreinte via awk '{print $2}' ssh_host_xxx_key.pub | base64 -d | (md5sum or sha1sum) -b. Les clés d’hôte SSH se trouvent normalement dans le répertoire /etc/ssh.

example: --repo1-sftp-host-fingerprint=f84e172dfead7aeeeae6c1fdfb5aa8cf

Type d’option de vérification de la clé hôte SFTP (--repo-sftp-host-key-check-type)

Type de vérification de la clé hôte SFTP.

Les types de vérification de clé d’hôte SFTP suivants sont pris en charge :

• strict - pgBackRest n’ajoutera jamais automatiquement les clés d’hôte au fichier ~/.ssh/known_hosts, et refusera de se connecter aux hôtes dont la clé d’hôte a changé ou n’est pas trouvée dans les fichiers known hosts. Cette option oblige l’utilisateur à ajouter manuellement tous les nouveaux hôtes.
• accept-new - pgBackRest ajoutera automatiquement les nouvelles clés d’hôte au fichier known hosts de l’utilisateur, mais n’autorisera pas les connexions aux hôtes dont la clé d’hôte a changé.
• fingerprint - pgBackRest vérifiera la clé d’hôte contre l’empreinte spécifiée par l’option repo-sftp-host-fingerprint.
• none - aucune vérification de clé d’hôte ne sera effectuée.

default: strict
example: --repo1-sftp-host-key-check-type=accept-new

Type de hachage de la clé hôte du dépôt SFTP (--repo-sftp-host-key-hash-type)

Type de hachage de la clé d’hôte du dépôt SFTP.

Type de hachage de la clé hôte du dépôt SFTP. Déclare le type de hachage à utiliser pour calculer le hachage de la clé hôte du système distant au démarrage SSH. Les versions plus récentes de libssh2 prennent en charge sha256 en plus de md5 et sha1.

example: --repo1-sftp-host-key-hash-type=sha256

Option de port hôte du dépôt SFTP (--repo-sftp-host-port)

Port hôte du dépôt SFTP.

Port hôte du dépôt SFTP.

default: 22
allowed: [1, 65535]
example: --repo1-sftp-host-port=22

Option utilisateur hôte dépôt SFTP (--repo-sftp-host-user)

Utilisateur hôte du dépôt SFTP.

Utilisateur sur l’hôte utilisé pour stocker le dépôt.

example: --repo1-sftp-host-user=pg-backup

Option fichier Hôtes SFTP connus (--repo-sftp-known-host)

Fichier d’hôtes SFTP connus.

Fichier known hosts à consulter pour rechercher une correspondance avec un hôte SFTP lors de l’authentification. Si non spécifié, pgBackRest recherchera par défaut dans ~/.ssh/known_hosts, ~/.ssh/known_hosts2, /etc/ssh/ssh_known_hosts et /etc/ssh/ssh_known_hosts2. Si configuré avec un ou plusieurs chemins de fichier, pgBackRest recherchera dans ces fichiers une correspondance. Les chemins de fichier doivent être complets ou commencer par un tilde. L’option repo-sftp-known-host peut être spécifiée plusieurs fois pour indiquer plusieurs fichiers known hosts à consulter. Pour utiliser la vérification du fichier known hosts, l’option repo-sftp-host-fingerprint ne doit pas être définie. Voir également l’option repo-sftp-host-check-type.

example: --repo1-sftp-known-host=/home/postgres/.ssh/known_hosts

Option fichier de clé privée du dépôt SFTP (--repo-sftp-private-key-file)

Fichier de clé privée SFTP.

Fichier de clé privée SFTP utilisé pour l’authentification.

example: --repo1-sftp-private-key-file=~/.ssh/id_ed25519

Option de fichier de clé publique du dépôt SFTP (--repo-sftp-public-key-file)

Fichier de clé publique SFTP.

Fichier de clé publique SFTP utilisé pour l’authentification. Facultatif si compilé contre OpenSSL, obligatoire si compilé contre une autre bibliothèque.

example: --repo1-sftp-public-key-file=~/.ssh/id_ed25519.pub

Option du fichier CA du dépôt de stockage (--repo-storage-ca-file)

Fichier de certificat d’autorité de certification pour le dépôt.

Utilisez un fichier CA autre que celui par défaut du système pour les certificats du stockage (par exemple, S3, Azure).

example: --repo1-storage-ca-file=/etc/pki/tls/certs/ca-bundle.crt

Noms obsolètes : repo-azure-ca-file, repo-s3-ca-file

Option de chemin du certificat CA TLS pour le dépôt (--repo-storage-ca-path)

Chemin du certificat d’autorité de certification du dépôt.

Utilisez un chemin de certificat d’autorité de certification (CA) autre que celui par défaut du système pour les certificats du stockage (par exemple, S3, Azure).

example: --repo1-storage-ca-path=/etc/pki/tls/certs

Noms obsolètes : repo-azure-ca-path, repo-s3-ca-path

Option hôte de stockage du dépôt (--repo-storage-host)

Hôte de stockage du dépôt.

Se connecter à un hôte autre que le point de terminaison de stockage (par exemple S3, Azure). Cela est généralement utilisé pour les tests.

example: --repo1-storage-host=127.0.0.1

Noms obsolètes : repo-azure-host, repo-s3-host

Option de port du stockage du dépôt (--repo-storage-port)

Port du stockage du dépôt.

Port à utiliser lors de la connexion au point de terminaison du stockage (par exemple S3, Azure) ou à l’hôte (le cas échéant).

default: 443
allowed: [1, 65535]
example: --repo1-storage-port=9000

Noms obsolètes : repo-azure-port, repo-s3-port

Option d’étiquette de stockage du dépôt (--repo-storage-tag)

Étiquette(s) de stockage du dépôt.

Spécifiez les balises à ajouter aux objets lorsque le dépôt est un magasin d’objets (par exemple, S3). L’option peut être répétée pour ajouter plusieurs balises.

Il n’existe aucune fonctionnalité dans pgBackRest permettant de modifier ces balises ; veillez donc à les définir correctement avant d’exécuter stanza-create afin d’assurer une cohérence des balises dans l’ensemble du dépôt.

example: --repo1-storage-tag=key1=value1

Option de taille de morceau de chargement du dépôt (--repo-storage-upload-chunk-size)

Taille du morceau de chargement du dépôt.

Les magasins d’objets tels que S3 permettent de télécharger des fichiers par morceaux lorsque le fichier est trop volumineux pour être stocké en mémoire. Même si le fichier peut être stocké en mémoire, il est plus efficace en mémoire de limiter la quantité de mémoire utilisée pour les téléchargements.

Une taille de morceau plus élevée entraîne généralement de meilleures performances, car elle réduit le nombre de requêtes de téléchargement et permet de télécharger plus de fichiers en une seule requête plutôt qu’en morceaux. Le désavantage est que la consommation mémoire sera plus élevée, et comme la mémoire tampon de morceau doit être allouée par processus, des valeurs plus élevées de process-max entraînent une consommation mémoire globale plus importante.

Notez que les tailles de morceau valides varient selon le type de stockage et la plateforme. Par exemple, AWS S3 impose une taille minimale de morceau de 5MiB. La terminologie relative à la taille du morceau varie selon le type de stockage ; utilisez donc « part size » pour AWS S3, « chunk size » pour GCS et « block size » pour Azure lorsque vous recherchez les valeurs minimales ou maximales.

Si un fichier est plus grand que 1GiB (la taille maximale que PostgreSQL crée par défaut), la taille de tranche sera augmentée progressivement jusqu’à la valeur maximale autorisée afin de terminer le téléchargement du fichier.

default (depending on repo-type):
    azure - 4MiB
    gcs - 4MiB
    s3 - 5MiB

allow range (depending on repo-type):
    azure - [4MiB, 1GiB]
    gcs - [4MiB, 1GiB]
    s3 - [5MiB, 1GiB]

example: --repo1-storage-upload-chunk-size=16MiB

Option de vérification du certificat de stockage du dépôt (--repo-storage-verify-tls)

Vérification du certificat du dépôt de stockage.

Cette option permet d’activer/désactiver la vérification du certificat TLS du serveur de stockage (par exemple, S3, Azure). La désactivation ne doit être utilisée que pour des tests ou d’autres scénarios où un certificat a été auto-signé.

default: y
example: --no-repo1-storage-verify-tls

Noms obsolètes : repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

Heure cible pour l’option dépôt (--repo-target-time)

Heure cible pour le dépôt.

Le temps cible définit l’instant auquel les commandes lisent un dépôt sur un stockage versionné. Cela permet à la commande de lire le dépôt tel qu’il était à un instant donné, afin de récupérer des données supprimées ou corrompues par une erreur utilisateur ou un logiciel malveillant.

Le stockage versionné est pris en charge par S3, GCS et Azure, mais il est généralement désactivé par défaut. En plus d’activer la versioning, il peut être utile d’activer le verrouillage d’objets pour S3, ou la suppression progressive pour GCS ou Azure.

Lorsque l’option repo-target-time est spécifiée, l’option repo doit également être fournie. Il est probable que tous les types de dépôt ne prennent pas en charge la versionning, et il est généralement préférable de cibler un seul dépôt pour la récupération.

Notez que les comparaisons avec l’horodatage de stockage sont <= à l’horodatage fourni et que les millisecondes sont tronquées de l’horodatage lorsqu’elles sont fournies.

example: --repo-target-time=2024-08-08 12:12:12+00

Option de type de dépôt (--repo-type)

Type de stockage utilisé pour le dépôt.

Les types de dépôt suivants sont pris en charge :

• azure - Service de stockage Blob Azure
• cifs - Comme posix, mais désactive les liens et les fsyncs de répertoire
• gcs - Google Cloud Storage
• posix - Systèmes de fichiers conformes à Posix
• s3 - AWS Simple Storage Service
• sftp - Protocole de transfert de fichiers sécurisé

Lorsqu’un montage NFS est utilisé comme dépôt posix, les mêmes règles s’appliquent à pgBackRest qu’indiquées dans la documentation PostgreSQL : Création d’un cluster de base de données - Systèmes de fichiers .

default: posix
example: --repo1-type=cifs