Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
_secure_path(3)
determine if a file appears to be secure
acl_is_trivial_np(3)
determine whether ACL is trivial
check_utility_compat(3)
determine whether a utility should be compatible
clock(3)
determine processor time used
cr_bsd_visible(9)
determine if subjects may see entities according to BSD security policies
cr_cansee(9)
determine visibility of objects given their user credentials
cr_canseejailproc(9)
determine if subjects may see entities in sub-jails
cr_canseeothergids(9)
determine if subjects may see entities in a disjoint group set
cr_canseeotheruids(9)
determine if subjects may see entities with differing user ID
elf_kind(3)
determine ELF file type
file(1)
determine file type
fstyp(8)
determine filesystem type
is_term_resized(3), %is_term_resized(3), %resize_term(3), %resizeterm(3)
manage the terminal dimensions understood by curses
kstack_contains(9)
determine if an address range lies within the kernel stack for a thread
mbsinit(3)
determine conversion object status
mincore(2)
determine residency of memory pages
p_candebug(9)
determine debuggability of a process
p_cansee(9)
determine visibility of a process
pmap_is_prefaultable(9)
determine if a page may be prefaulted
pmap_mincore(9)
determine if a virtual address is resident in physical memory
pmap_page_exists_quick(9)
determine if a page exists in a physical map
prison_check(9)
determine if subjects may see entities according to jail restrictions
rpmatch(3)
determine whether the response to a question is affirmative or negative
signbit(3)
determine whether a floating-point number's sign is negative
sockatmark(3)
determine whether the read pointer is at the OOB mark
BIO_get_rpoll_descriptor(3), BIO_get_wpoll_descriptor(3)
obtain a structure which can be used to determine when a BIO object can next be read or written
DTLSv1_get_timeout(3)
determine when a DTLS or QUIC SSL object next needs a timeout event to be handled
EVP_KDF-HMAC-DRBG(7)
The HMAC DRBG DETERMINISTIC EVP_KDF implementation
PKCS7_type_is_other(3)
determine content type of PKCS#7 envelopedData structure
SSL_SESSION_is_resumable(3)
determine whether an SSL_SESSION object can be used for resumption
SSL_get_event_timeout(3)
determine when an SSL object next needs to have events handled
SSL_get_rpoll_descriptor(3), SSL_get_wpoll_descriptor(3), SSL_net_read_desired(3), SSL_net_write_desired(3)
obtain information which can be used to determine when network I/O can be performed
SSL_poll(3), SSL_POLL_EVENT_NONE(3), SSL_POLL_EVENT_F(3), SSL_POLL_EVENT_EL(3), SSL_POLL_EVENT_EC(3), SSL_POLL_EVENT_ECD(3), SSL_POLL_EVENT_ER(3), SSL_POLL_EVENT_EW(3), SSL_POLL_EVENT_R(3), SSL_POLL_EVENT_W(3), SSL_POLL_EVENT_IC(3), SSL_POLL_EVENT_ISB(3), SSL_POLL_EVENT_ISU(3), SSL_POLL_EVENT_OSB(3), SSL_POLL_EVENT_OSU(3), SSL_POLL_EVENT_RW(3), SSL_POLL_EVENT_RE(3), SSL_POLL_EVENT_WE(3), SSL_POLL_EVENT_RWE(3), SSL_POLL_EVENT_E(3), SSL_POLL_EVENT_IS(3), SSL_POLL_EVENT_ISE(3), SSL_POLL_EVENT_I(3), SSL_POLL_EVENT_OS(3), SSL_POLL_EVENT_OSE(3), SSL_POLL_FLAG_NO_HANDLE_EVENTS(3)
determine or await readiness conditions for one or more pollable objects
BIO_get_rpoll_descriptor(3ossl), BIO_get_wpoll_descriptor(3ossl)
obtain a structure which can be used to determine when a BIO object can next be read or written
DPMSQueryExtension(3)
queries the X server to determine the availability of the DPMS Extension
DTLSv1_get_timeout(3ossl)
determine when a DTLS or QUIC SSL object next needs a timeout event to be handled
EVP_KDF-HMAC-DRBG(7ossl)
The HMAC DRBG DETERMINISTIC EVP_KDF implementation
HPL_dlamch(3)
determines machine-specific arithmetic constants
HPL_pdlamch(3)
determines machine-specific arithmetic constants
HPL_pnum(3)
Rank determination
MPI_Cart_coords(3)
Determines process coords in cartesian topology given rank in group
MPI_Cart_rank(3)
Determines process rank in communicator given Cartesian location
MPI_Comm_rank(3)
Determines the rank of the calling process in the communicator
MPI_Comm_remote_size(3)
Determines the size of the remote group
MPI_Comm_size(3)
Determines the size of the group associated with a communicator
MPI_Topo_test(3)
Determines the type of topology (if any) associated with a communicator
PKCS7_type_is_other(3ossl)
determine content type of PKCS#7 envelopedData structure
RAND_DRBG(7)
the deterministic random bit generator
SDL_JoystickOpened(3)
Determine if a joystick has been opened
SPI_fname(3)
determine the column name for the specified column number
SPI_fnumber(3)
determine the column number for the specified column name
SSL_SESSION_is_resumable(3)
determine whether an SSL_SESSION object can be used for resumption
SSL_SESSION_is_resumable(3ossl)
determine whether an SSL_SESSION object can be used for resumption
SSL_get_event_timeout(3ossl)
determine when an SSL object next needs to have events handled
SSL_get_rpoll_descriptor(3ossl), SSL_get_wpoll_descriptor(3ossl), SSL_net_read_desired(3ossl), SSL_net_write_desired(3ossl)
obtain information which can be used to determine when network I/O can be performed
SSL_poll(3ossl), SSL_POLL_EVENT_NONE(3ossl), SSL_POLL_EVENT_F(3ossl), SSL_POLL_EVENT_EL(3ossl), SSL_POLL_EVENT_EC(3ossl), SSL_POLL_EVENT_ECD(3ossl), SSL_POLL_EVENT_ER(3ossl), SSL_POLL_EVENT_EW(3ossl), SSL_POLL_EVENT_R(3ossl), SSL_POLL_EVENT_W(3ossl), SSL_POLL_EVENT_IC(3ossl), SSL_POLL_EVENT_ISB(3ossl), SSL_POLL_EVENT_ISU(3ossl), SSL_POLL_EVENT_OSB(3ossl), SSL_POLL_EVENT_OSU(3ossl), SSL_POLL_EVENT_RW(3ossl), SSL_POLL_EVENT_RE(3ossl), SSL_POLL_EVENT_WE(3ossl), SSL_POLL_EVENT_RWE(3ossl), SSL_POLL_EVENT_E(3ossl), SSL_POLL_EVENT_IS(3ossl), SSL_POLL_EVENT_ISE(3ossl), SSL_POLL_EVENT_I(3ossl), SSL_POLL_EVENT_OS(3ossl), SSL_POLL_EVENT_OSE(3ossl), SSL_POLL_FLAG_NO_HANDLE_EVENTS(3ossl)
determine or await readiness conditions for one or more pollable objects
XEmptyRegion(3), XEqualRegion(3), XPointInRegion(3), XRectInRegion(3)
determine if regions are empty or equal
XQueryBestSize(3), XQueryBestTile(3), XQueryBestStipple(3)
determine efficient sizes
XSupportsLocale(3), XSetLocaleModifiers(3)
determine locale support and configure locale modifiers
XkbComputeShapeTop(3)
Determines the bounding box of the top surface of a shape
XkbGetDetectableAutoRepeat(3)
Determines whether or not the server supports DetectableAutoRepeat
XkbGetDeviceInfo(3)
Determine whether the X server allows Xkb access to particular capabilities of input devices other than the core X keyboard, or to determine the status of indicator maps, indicator names or button actions on a non-KeyClass extension device
XkbGetXlibControls(3)
Determines the current state of the Library Controls
XkbKeyHasActions(3)
Determines if the key corresponding to keycode has any actions associated with it
XkbKeyTypesForCoreSymbols(3)
Determine the Xkb key types appropriate for the symbols bound to a key in a core keyboard mapping
XkbLibraryVersion(3)
Determines the compatibility of a library at runtime
XkbQueryExtension(3)
Determines the compatibility of a library at runtime
XkbVirtualModsToReal(3)
Determines the mapping of virtual modifiers to core X protocol modifiers
XmDropSiteRegistered(3)
A Drag and Drop function that determines if a drop site has been registered "XmDropSiteRegistered" "Drag and Drop functions" "XmDropSiteRegistered" "register functions" "XmDropSiteRegistered"
XmGetVisibility(3)
A function that determines if a widget is visible "XmGetVisibility"
XmIconBoxIsCellEmpty(3)
A function that determines whether a cell in the IconBox is empty "XmIconBoxIsCellEmpty" "IconBox functions" "XmIconBoxIsCellEmpty"
XmIsMotifWMRunning(3)
A function that determines whether the window manager is running "XmIsMotifWMRunning"
XmListPosSelected(3)
A List function that determines if the list item at a specified position is selected "XmListPosSelected" "List functions" "XmListPosSelected"
XmObjectAtPoint(3)
A toolkit function that determines which child intersects or comes closest to a specified point "XmObjectAtPoint"
XmProcessTraversal(3)
A function that determines which component receives keyboard events when a widget has the focus "XmProcessTraversal"
XmStringExtent(3)
A compound string function that determines the size of the smallest rectangle that will enclose the compound string "XmStringExtent" "compound string functions" "XmStringExtent"
XtOffset(3), XtOffsetOf(3), XtNumber(3)
determine the byte offset or number of array elements
XvQueryBestSize(3)
determine the optimum drawable region size
applybddnodeterm(3)
applies an operator on two bdd nodes. man1/alc_origin.1
barman-cloud-backup(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-backup [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ { { -z | --gzip } | { -j | --bzip2 } | --snappy | --lz4 } ] [ { -h | --host } HOST ] [ { -p | --port } PORT ] [ { -U | --user } USER ] [ { -d | --dbname } DBNAME ] [ { -n | --name } BACKUP_NAME ] [ { -J | --jobs } JOBS ] [ { -S | --max-archive-size } MAX_ARCHIVE_SIZE ] [ --immediate-checkpoint ] [ --min-chunk-size MIN_CHUNK_SIZE ] [ --max-bandwidth MAX_BANDWIDTH ] [ --snapshot-instance SNAPSHOT_INSTANCE ] [ --snapshot-disk NAME [ --snapshot-disk NAME ... ] ] [ --snapshot-zone GCP_ZONE ] [ -snapshot-gcp-project GCP_PROJECT ] [ --tag KEY,VALUE [ --tag KEY,VALUE ... ] ] [ --endpoint-url ENDPOINT_URL ] [ --addressing-style { auto | virtual | path } ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ { -e | --encryption } { AES256 | aws:kms } ] [ --sse-kms-key-id SSE_KMS_KEY_ID ] [ --aws-region AWS_REGION ] [ --aws-await-snapshots-timeout AWS_AWAIT_SNAPSHOTS_TIMEOUT ] [ --aws-snapshot-lock-mode { compliance | governance } ] [ --aws-snapshot-lock-duration DAYS ] [ --aws-snapshot-lock-cool-off-period HOURS ] [ --aws-snapshot-lock-expiration-date DATETIME ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --encryption-scope ENCRYPTION_SCOPE ] [ --azure-subscription-id AZURE_SUBSCRIPTION_ID ] [ --azure-resource-group AZURE_RESOURCE_GROUP ] [ --gcp-project GCP_PROJECT ] [ --kms-key-name KMS_KEY_NAME ] [ --gcp-zone GCP_ZONE ] DESTINATION_URL SERVER_NAME Description The barman-cloud-backup script is used to create a local backup of a Postgres server and transfer it to a supported cloud provider, bypassing the Barman server. It can also be utilized as a hook script for copying Barman backups from the Barman server to one of the supported clouds (post_backup_retry_script). This script requires read access to PGDATA and tablespaces, typically run as the postgres user. When used on a Barman server, it requires read access to the directory where Barman backups are stored. If --snapshot- arguments are used and snapshots are supported by the selected cloud provider, the backup will be performed using snapshots of the specified disks (--snapshot-disk). The backup label and metadata will also be uploaded to the cloud. NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. IMPORTANT: 0.0 3.5 The cloud upload may fail if any file larger than the configured --max-archive-size is present in the data directory or tablespaces. However, Postgres files up to 1GB are always allowed, regardless of the --max-archive-size setting. Parameters 0.0 SERVER_NAME Name of the server to be backed up. DESTINATION_URL URL of the cloud destination, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. -V / --version Show version and exit. --help show this help message and exit. -v / --verbose Increase output verbosity (e.g., -vv is more than -v). -q / --quiet Decrease output verbosity (e.g., -qq is less than -q). -t / --test Test cloud connectivity and exit. --cloud-provider The cloud provider to use as a storage backend. Allowed options: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. -z / --gzip gzip-compress the backup while uploading to the cloud (should not be used with python < 3.2). -j / --bzip2 bzip2-compress the backup while uploading to the cloud (should not be used with python < 3.3). --snappy snappy-compress the backup while uploading to the cloud (requires optional python-snappy library). --lz4 lz4-compress the backup while uploading to the cloud (requires optional lz4 Python library). -h / --host Host or Unix socket for Postgres connection (default: libpq settings). -p / --port Port for Postgres connection (default: libpq settings). -U / --user User name for Postgres connection (default: libpq settings). -d / --dbname Database name or conninfo string for Postgres connection (default: (dqpostgres(dq). -n / --name A name which can be used to reference this backup in commands such as barman-cloud-restore and barman-cloud-backup-delete. -J / --jobs Number of subprocesses to upload data to cloud storage (default: 2). -S / --max-archive-size Maximum size of an archive when uploading to cloud storage (default: 100GB). --immediate-checkpoint Forces the initial checkpoint to be done as quickly as possible. --min-chunk-size Minimum size of an individual chunk when uploading to cloud storage (default: 5MB for aws-s3, 64KB for azure-blob-storage, not applicable for google-cloud-storage). --max-bandwidth The maximum amount of data to be uploaded per second when backing up to object storages (default: 0 - no limit). --snapshot-instance Instance where the disks to be backed up as snapshots are attached. --snapshot-disk Name of a disk from which snapshots should be taken. --tag Tag to be added to all uploaded files in cloud storage, and/or to snapshots created, if snapshots are used. --tags Tags to be added to all uploaded files in cloud storage, and/or to snapshots created, if snapshots are used. NOTE: 0.0 3.5 If you are using --tags before positional arguments, you must insert -- after it to indicate the end of optional arguments. This tells the parser to treat everything after -- as positional arguments. Without the --, Barman may misinterpret positional arguments as values for the last option. Deprecated since version 3.15: --tags is deprecated. Use --tag instead. Extra options for the AWS cloud provider 0.0 --endpoint-url Override default S3 endpoint URL with the given one. --addressing-style The addressing style to use for S3 requests. This is useful when connecting to S3-compatible services that require a specific addressing style. Allowed options are: 7.0 (bu 2 auto (default): Uses the addressing style determined by the underlying library. (bu 2 virtual: Uses virtual-hosted style addressing (e.g., bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (e.g., s3.amazonaws.com/bucket-name). -P / --aws-profile Profile name (e.g. INI section in AWS credentials file). --profile (deprecated) Profile name (e.g. INI section in AWS credentials file)
replaced by --aws-profile. --read-timeout The time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds). -e / --encryption The encryption algorithm used when storing the uploaded data in S3. Allowed options: 7.0 (bu 2 AES256. (bu 2 aws:kms. --sse-kms-key-id The AWS KMS key ID that should be used for encrypting the uploaded data in S3. Can be specified using the key ID on its own or using the full ARN for the key. Only allowed if -e / --encryption is set to aws:kms. --aws-region The name of the AWS region containing the EC2 VM and storage volumes defined by the --snapshot-instance and --snapshot-disk arguments. --aws-await-snapshots-timeout The length of time in seconds to wait for snapshots to be created in AWS before timing out (default: 3600 seconds). --aws-snapshot-lock-mode The lock mode for the snapshot. This is only valid if --snapshot-instance and --snapshot-disk are set. Allowed options: 7.0 (bu 2 compliance. (bu 2 governance. --aws-snapshot-lock-duration The lock duration is the period of time (in days) for which the snapshot is to remain locked, ranging from 1 to 36,500. Set either the lock duration or the expiration date (not both). --aws-snapshot-lock-cool-off-period The cooling-off period is an optional period of time (in hours) that you can specify when you lock a snapshot in compliance mode, ranging from 1 to 72. --aws-snapshot-lock-expiration-date The lock duration is determined by an expiration date in the future. It must be at least 1 day after the snapshot creation date and time, using the format YYYY-MM-DDTHH:MM:SS.sssZ. Set either the lock duration or the expiration date (not both). Extra options for the Azure cloud provider 0.0 --azure-credential / --credential Optionally specify the type of credential to use when authenticating with Azure. If omitted then Azure Blob Storage credentials will be obtained from the environment and the default Azure authentication flow will be used for authenticating with all other Azure services. If no credentials can be found in the environment then the default Azure authentication flow will also be used for Azure Blob Storage. Allowed options: 7.0 (bu 2 azure-cli. (bu 2 managed-identity. (bu 2 default. --encryption-scope The name of an encryption scope defined in the Azure Blob Storage service which is to be used to encrypt the data in Azure. --azure-subscription-id The ID of the Azure subscription which owns the instance and storage volumes defined by the --snapshot-instance and --snapshot-disk arguments. --azure-resource-group The name of the Azure resource group to which the compute instance and disks defined by the --snapshot-instance and --snapshot-disk arguments belong. Extra options for GCP cloud provider 0.0 --gcp-project GCP project under which disk snapshots should be stored. --snapshot-gcp-project (deprecated) GCP project under which disk snapshots should be stored - replaced by --gcp-project. --kms-key-name The name of the GCP KMS key which should be used for encrypting the uploaded data in GCS. --gcp-zone Zone of the disks from which snapshots should be taken. --snapshot-zone (deprecated) Zone of the disks from which snapshots should be taken - replaced by --gcp-zone
barman-cloud-backup-delete(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-backup-delete [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ --addressing-style { auto | virtual | path } ] [ { -r | --retention-policy } RETENTION_POLICY ] [ { -m | --minimum-redundancy } MINIMUM_REDUNDANCY ] [ { -b | --backup-id } BACKUP_ID] [ --dry-run ] [ --check-object-lock ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [--batch-size DELETE_BATCH_SIZE] SOURCE_URL SERVER_NAME Description The barman-cloud-backup-delete script is used to delete one or more backups created with the barman-cloud-backup command from cloud storage and to remove the associated WAL files. Backups can be specified for deletion either by their backup ID (as obtained from barman-cloud-backup-list) or by a retention policy. Retention policies mirror those used by the Barman server, deleting all backups that are not required to meet the specified policy. When a backup is deleted, any unused WAL files associated with that backup are also removed. WALs are considered unused if: 0.0 (bu 2 The WALs predate the begin_wal value of the oldest remaining backup. (bu 2 The WALs are not required by any archival backups stored in the cloud. NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. IMPORTANT: 0.0 3.5 Each backup deletion involves three separate requests to the cloud provider: one for the backup files, one for the backup.info file, and one for the associated WALs. Deleting by retention policy may result in a high volume of delete requests if a large number of backups are accumulated in cloud storage. IMPORTANT: 0.0 3.5 Starting with AWS boto3 1.36, the behavior of Data Integrity Protection checks has changed. Some methods used by Barman no longer require the Content-MD5 header. This means that S3-compatible storage providers that have not updated their server-side code may fail when used with newer boto3 versions. For example, MinIO addressed this change shortly after the boto3 1.36 announcement. If you are using MinIO, you must upgrade to the latest release (or at least RELEASE.2025-02-03T21-03-04Z or newer) to ensure compatibility and avoid failures. Parameters 0.0 SERVER_NAME Name of the server that holds the backup to be deleted. SOURCE_URL URL of the cloud source, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. -V / --version Show version and exit. --help show this help message and exit. -v / --verbose Increase output verbosity (e.g., -vv is more than -v). -q / --quiet Decrease output verbosity (e.g., -qq is less than -q). -t / --test Test cloud connectivity and exit. --cloud-provider The cloud provider to use as a storage backend. Allowed options are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. -b / --backup-id ID of the backup to be deleted. You can use a shortcut instead of the backup ID. -m / --minimum-redundancy The minimum number of backups that should always be available. -r / --retention-policy If specified, delete all backups eligible for deletion according to the supplied retention policy. Syntax: REDUNDANCY value | RECOVERY WINDOW OF value { DAYS | WEEKS | MONTHS } --batch-size The maximum number of objects to be deleted in a single request to the cloud provider. If unset then the maximum allowed batch size for the specified cloud provider will be used (1000 for aws-s3, 256 for azure-blob-storage and 100 for google-cloud-storage). --dry-run Find the objects which need to be deleted but do not delete them. Extra options for the AWS cloud provider 0.0 --check-object-lock Check whether backup files are protected by S3 Object Lock before attempting deletion. Enable this when your S3 bucket has Object Lock configured and you want to ensure deletion operations respect object-level retention policies. If any base backup file is locked (either by an active retention period or legal hold), the deletion is aborted with an error. For performance reasons, lock checks are only performed for base backup files, since once the base backup is removed, the corresponding WAL files are no longer useful. Note that this check requires one request per file to check the lock status, which may increase deletion time for backups with many files. This feature is only available for AWS S3-compatible object stores and it also requires the s3:GetObjectRetention and s3:GetObjectLegalHold IAM permissions. --endpoint-url Override default S3 endpoint URL with the given one. --addressing-style The addressing style to use for S3 requests. This is useful when connecting to S3-compatible services that require a specific addressing style. Allowed options are: 7.0 (bu 2 auto (default): Uses the addressing style determined by the underlying library. (bu 2 virtual: Uses virtual-hosted style addressing (e.g., bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (e.g., s3.amazonaws.com/bucket-name). -P / --aws-profile Profile name (e.g. INI section in AWS credentials file). --profile (deprecated) Profile name (e.g. INI section in AWS credentials file)
replaced by --aws-profile. --read-timeout The time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds). Extra options for the Azure cloud provider 0.0 --azure-credential / --credential Optionally specify the type of credential to use when authenticating with Azure. If omitted then Azure Blob Storage credentials will be obtained from the environment and the default Azure authentication flow will be used for authenticating with all other Azure services. If no credentials can be found in the environment then the default Azure authentication flow will also be used for Azure Blob Storage. Allowed options are: 7.0 (bu 2 azure-cli. (bu 2 managed-identity. (bu 2 default
barman-cloud-backup-keep(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-backup-keep [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ --addressing-style { auto | virtual | path } ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ { { -r | --release } | { -s | --status } | --target { full | standalone } } ] SOURCE_URL SERVER_NAME BACKUP_ID Description Use this script to designate backups in cloud storage as archival backups, ensuring their indefinite retention regardless of retention policies. This script allows you to mark backups previously created with barman-cloud-backup as archival backups. Once flagged as archival, these backups are preserved indefinitely and are not subject to standard retention policies. NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. IMPORTANT: 0.0 3.5 Starting with AWS boto3 1.36, the behavior of Data Integrity Protection checks has changed. Some methods used by Barman no longer require the Content-MD5 header. This means that S3-compatible storage providers that have not updated their server-side code may fail when used with newer boto3 versions. For example, MinIO addressed this change shortly after the boto3 1.36 announcement. If you are using MinIO, you must upgrade to the latest release (or at least RELEASE.2025-02-03T21-03-04Z or newer) to ensure compatibility and avoid failures when releasing a keep annotation. Parameters 0.0 SERVER_NAME Name of the server that holds the backup to be kept. SOURCE_URL URL of the cloud source, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. BACKUP_ID The ID of the backup to be kept. You can use a shortcut instead of the backup ID. -V / --version Show version and exit. --help show this help message and exit. -v / --verbose Increase output verbosity (e.g., -vv is more than -v). -q / --quiet Decrease output verbosity (e.g., -qq is less than -q). -t / --test Test cloud connectivity and exit. --cloud-provider The cloud provider to use as a storage backend. Allowed options are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. -r / --release If specified, the command will remove the keep annotation and the backup will be eligible for deletion. -s / --status Print the keep status of the backup. --target Specify the recovery target for this backup. Allowed options are: 7.0 (bu 2 full (bu 2 standalone Extra options for the AWS cloud provider 0.0 --endpoint-url Override default S3 endpoint URL with the given one. -P / --aws-profile Profile name (e.g. INI section in AWS credentials file). --profile (deprecated) Profile name (e.g. INI section in AWS credentials file)
replaced by --aws-profile. --read-timeout The time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds). --addressing-style The S3 addressing style to use when connecting to S3-compatible cloud storage. This option is useful when using custom S3 endpoints (such as MinIO) that may require a specific addressing style. Allowed options: 7.0 (bu 2 auto (default): Uses the addressing style determined by the boto3 library. (bu 2 virtual: Uses virtual-hosted-style addressing (bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (s3.amazonaws.com/bucket-name). Extra options for the Azure cloud provider 0.0 --azure-credential / --credential Optionally specify the type of credential to use when authenticating with Azure. If omitted then Azure Blob Storage credentials will be obtained from the environment and the default Azure authentication flow will be used for authenticating with all other Azure services. If no credentials can be found in the environment then the default Azure authentication flow will also be used for Azure Blob Storage. Allowed options are: 7.0 (bu 2 azure-cli. (bu 2 managed-identity. (bu 2 default
barman-cloud-backup-list(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-backup-list [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ --addressing-style { auto | virtual | path } ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --format FORMAT ] SOURCE_URL SERVER_NAME Description This script lists backups stored in the cloud that were created using the barman-cloud-backup command. NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. Parameters 0.0 SERVER_NAME Name of the server that holds the backup to be listed. SOURCE_URL URL of the cloud source, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. -V / --version Show version and exit. --help show this help message and exit. -v / --verbose Increase output verbosity (e.g., -vv is more than -v). -q / --quiet Decrease output verbosity (e.g., -qq is less than -q). -t / --test Test cloud connectivity and exit. --cloud-provider The cloud provider to use as a storage backend. Allowed options are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. --format Output format (console or json). Default console. Extra options for the AWS cloud provider 0.0 --endpoint-url Override default S3 endpoint URL with the given one. -P / --aws-profile Profile name (e.g. INI section in AWS credentials file). --profile (deprecated) Profile name (e.g. INI section in AWS credentials file)
replaced by --aws-profile. --read-timeout The time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds). --addressing-style The S3 addressing style to use when connecting to S3-compatible cloud storage. This option is useful when using custom S3 endpoints (such as MinIO) that may require a specific addressing style. Allowed options: 7.0 (bu 2 auto (default): Uses the addressing style determined by the boto3 library. (bu 2 virtual: Uses virtual-hosted-style addressing (bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (s3.amazonaws.com/bucket-name). Extra options for the Azure cloud provider 0.0 --azure-credential / --credential Optionally specify the type of credential to use when authenticating with Azure. If omitted then Azure Blob Storage credentials will be obtained from the environment and the default Azure authentication flow will be used for authenticating with all other Azure services. If no credentials can be found in the environment then the default Azure authentication flow will also be used for Azure Blob Storage. Allowed options are: 7.0 (bu 2 azure-cli. (bu 2 managed-identity. (bu 2 default
barman-cloud-backup-show(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-backup-show [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ --addressing-style { auto | virtual | path } ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --format FORMAT ] SOURCE_URL SERVER_NAME BACKUP_ID Description This script displays detailed information about a specific backup created with the barman-cloud-backup command. The output is similar to the barman show-backup from the %barman show-backup command reference, but it has fewer information. NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. Parameters 0.0 BACKUP_ID The ID of the backup. You can use a shortcut instead of the backup ID. SERVER_NAME Name of the server that holds the backup to be displayed. SOURCE_URL URL of the cloud source, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. -V / --version Show version and exit. --help show this help message and exit. -v / --verbose Increase output verbosity (e.g., -vv is more than -v). -q / --quiet Decrease output verbosity (e.g., -qq is less than -q). -t / --test Test cloud connectivity and exit. --cloud-provider The cloud provider to use as a storage backend. Allowed options are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. --format Output format (console or json). Default console. Extra options for the AWS cloud provider 0.0 --endpoint-url Override default S3 endpoint URL with the given one. -P / --aws-profile Profile name (e.g. INI section in AWS credentials file). --profile (deprecated) Profile name (e.g. INI section in AWS credentials file)
replaced by --aws-profile. --read-timeout The time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds). --addressing-style The S3 addressing style to use when connecting to S3-compatible cloud storage. This option is useful when using custom S3 endpoints (such as MinIO) that may require a specific addressing style. Allowed options: 7.0 (bu 2 auto (default): Uses the addressing style determined by the boto3 library. (bu 2 virtual: Uses virtual-hosted-style addressing (bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (s3.amazonaws.com/bucket-name). Extra options for the Azure cloud provider 0.0 --azure-credential / --credential Optionally specify the type of credential to use when authenticating with Azure. If omitted then Azure Blob Storage credentials will be obtained from the environment and the default Azure authentication flow will be used for authenticating with all other Azure services. If no credentials can be found in the environment then the default Azure authentication flow will also be used for Azure Blob Storage. Allowed options are: 7.0 (bu 2 azure-cli. (bu 2 managed-identity. (bu 2 default
barman-cloud-check-wal-archive(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-check-wal-archive [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ --addressing-style { auto | virtual | path } ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --timeline TIMELINE ] DESTINATION_URL SERVER_NAME Description Verify that the WAL archive destination for a server is suitable for use with a new Postgres cluster. By default, the check will succeed if the WAL archive is empty or if the target bucket is not found. Any other conditions will result in a failure. NOTE: 0.0 3.5 The barman-cloud-check-wal-archive command performs an initial HeadBucket call to verify whether the target bucket already exists in the S3 storage. If the bucket does not exist, the command will attempt to automatically create it. This is the only Barman command that performs these operations (bucket existence check and automatic creation). NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. Parameters 0.0 SERVER_NAME Name of the server that needs to be checked. DESTINATION_URL URL of the cloud destination, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. -V / --version Show version and exit. --help show this help message and exit. -v / --verbose Increase output verbosity (e.g., -vv is more than -v). -q / --quiet Decrease output verbosity (e.g., -qq is less than -q). -t / --test Test cloud connectivity and exit. --cloud-provider The cloud provider to use as a storage backend. Allowed options are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. --timeline The earliest timeline whose WALs should cause the check to fail. Extra options for the AWS cloud provider 0.0 --endpoint-url Override default S3 endpoint URL with the given one. -P / --aws-profile Profile name (e.g. INI section in AWS credentials file). --profile (deprecated) Profile name (e.g. INI section in AWS credentials file)
replaced by --aws-profile. --read-timeout The time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds). --addressing-style The S3 addressing style to use when connecting to S3-compatible cloud storage. This option is useful when using custom S3 endpoints (such as MinIO) that may require a specific addressing style. Allowed options: 7.0 (bu 2 auto (default): Uses the addressing style determined by the boto3 library. (bu 2 virtual: Uses virtual-hosted-style addressing (bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (s3.amazonaws.com/bucket-name). Extra options for the Azure cloud provider 0.0 --azure-credential / --credential Optionally specify the type of credential to use when authenticating with Azure. If omitted then Azure Blob Storage credentials will be obtained from the environment and the default Azure authentication flow will be used for authenticating with all other Azure services. If no credentials can be found in the environment then the default Azure authentication flow will also be used for Azure Blob Storage. Allowed options are: 7.0 (bu 2 azure-cli. (bu 2 managed-identity. (bu 2 default
barman-cloud-restore(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-restore [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ --addressing-style { auto | virtual | path } ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --snapshot-recovery-instance SNAPSHOT_RECOVERY_INSTANCE ] [ --snapshot-recovery-zone GCP_ZONE ] [ --aws-region AWS_REGION ] [ --gcp-zone GCP_ZONE ] [ --azure-resource-group AZURE_RESOURCE_GROUP ] [ --tablespace NAME:LOCATION [ --tablespace NAME:LOCATION ... ] ] [ --target-lsn LSN ] [ --target-time TIMESTAMP ] [ --target-tli TLI ] SOURCE_URL SERVER_NAME BACKUP_ID RECOVERY_DESTINATION Description Use this script to restore a backup directly from cloud storage that was created with the barman-cloud-backup command. Additionally, this script can prepare for recovery from a snapshot backup by verifying that attached disks were cloned from the correct snapshots and by downloading the backup label from object storage. This command does not automatically prepare Postgres for recovery. You must manually manage any %PITR options, custom restore_command values, signal files, or required WAL files to ensure Postgres starts, either manually or using external tools. NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. Parameters 0.0 SERVER_NAME Name of the server that holds the backup to be restored. SOURCE_URL URL of the cloud source, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. BACKUP_ID The ID of the backup to be restored. You can use a shortcut instead of the backup ID. Besides that, you can use auto to have Barman automatically find the most suitable backup for the restore operation. RECOVERY_DESTINATION The path to a directory for recovery. -V / --version Show version and exit. --help show this help message and exit. -v / --verbose Increase output verbosity (e.g., -vv is more than -v). -q / --quiet Decrease output verbosity (e.g., -qq is less than -q). -t / --test Test cloud connectivity and exit. --cloud-provider The cloud provider to use as a storage backend. Allowed options are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. --snapshot-recovery-instance Instance where the disks recovered from the snapshots are attached. --tablespace Tablespace relocation rule. --target-lsn The recovery target lsn, e.g., 3/64000000. --target-time The recovery target timestamp with or without timezone, in the format %Y-%m-%d %H:%M:%S. --target-tli The recovery target timeline. Extra options for the AWS cloud provider 0.0 --endpoint-url Override default S3 endpoint URL with the given one. --addressing-style The addressing style to use for S3 requests. This is useful when connecting to S3-compatible services that require a specific addressing style. Allowed options are: 7.0 (bu 2 auto (default): Uses the addressing style determined by the underlying library. (bu 2 virtual: Uses virtual-hosted style addressing (e.g., bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (e.g., s3.amazonaws.com/bucket-name). -P / --aws-profile Profile name (e.g. INI section in AWS credentials file). --profile (deprecated) Profile name (e.g. INI section in AWS credentials file)
replaced by --aws-profile. --read-timeout The time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds). --aws-region The name of the AWS region containing the EC2 VM and storage volumes defined by the --snapshot-instance and --snapshot-disk arguments. Extra options for the Azure cloud provider 0.0 --azure-credential / --credential Optionally specify the type of credential to use when authenticating with Azure. If omitted then Azure Blob Storage credentials will be obtained from the environment and the default Azure authentication flow will be used for authenticating with all other Azure services. If no credentials can be found in the environment then the default Azure authentication flow will also be used for Azure Blob Storage. Allowed options are: 7.0 (bu 2 azure-cli. (bu 2 managed-identity. (bu 2 default. --azure-resource-group The name of the Azure resource group to which the compute instance and disks defined by the --snapshot-instance and --snapshot-disk arguments belong. Extra options for GCP cloud provider 0.0 --gcp-zone Zone of the disks from which snapshots should be taken. --snapshot-recovery-zone (deprecated) Zone containing the instance and disks for the snapshot recovery - replaced by --gcp-zone
barman-cloud-wal-archive(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-wal-archive [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ { { -z | --gzip } | { -j | --bzip2 } | --xz | --snappy | --zstd | --lz4 } ] [ --compression-level COMPRESSION_LEVEL ] [ --tag KEY,VALUE [ --tag KEY,VALUE ... ] ] [ --history-tag KEY,VALUE [ --history-tag KEY,VALUE ... ] ] [ --endpoint-url ENDPOINT_URL ] [ --addressing-style { auto | virtual | path } ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ { -e | --encryption } ENCRYPTION ] [ --sse-kms-key-id SSE_KMS_KEY_ID ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --encryption-scope ENCRYPTION_SCOPE ] [ --max-block-size MAX_BLOCK_SIZE ] [ --max-concurrency MAX_CONCURRENCY ] [ --max-single-put-size MAX_SINGLE_PUT_SIZE ] [ --kms-key-name KMS_KEY_NAME ] DESTINATION_URL SERVER_NAME [ WAL_PATH ] Description The barman-cloud-wal-archive command is designed to be used in the archive_command of a Postgres server to directly ship WAL files to cloud storage. NOTE: 0.0 3.5 If you are using Python 2 or unsupported versions of Python 3, avoid using the compression options --gzip or --bzip2. The script cannot restore gzip-compressed WALs on Python < 3.2 or bzip2-compressed WALs on Python < 3.3. This script enables the direct transfer of WAL files to cloud storage, bypassing the Barman server. Additionally, it can be utilized as a hook script for WAL archiving (pre_archive_retry_script). NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. Parameters 0.0 SERVER_NAME Name of the server that will have the WALs archived. DESTINATION_URL URL of the cloud destination, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. WAL_PATH The value of the (aq%p(aq keyword (according to archive_command). -V / --version Show version and exit. --help show this help message and exit. -v / --verbose Increase output verbosity (e.g., -vv is more than -v). -q / --quiet Decrease output verbosity (e.g., -qq is less than -q). -t / --test Test cloud connectivity and exit. --cloud-provider The cloud provider to use as a storage backend. Allowed options are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. -z / --gzip gzip-compress the WAL while uploading to the cloud. -j / --bzip2 bzip2-compress the WAL while uploading to the cloud. --xz xz-compress the WAL while uploading to the cloud. --snappy snappy-compress the WAL while uploading to the cloud (requires the python-snappy Python library to be installed). --zstd zstd-compress the WAL while uploading to the cloud (requires the zstandard Python library to be installed). --lz4 lz4-compress the WAL while uploading to the cloud (requires the lz4 Python library to be installed). --compression-level A compression level to be used by the selected compression algorithm. Valid values are integers within the supported range of the chosen algorithm or one of the predefined labels: low, medium, and high. The range of each algorithm as well as what level each predefined label maps to can be found in %compression_level. --tag Tag to be added to archived WAL files in cloud storage. --tags Tag to be added to archived WAL files in cloud storage. NOTE: 0.0 3.5 If you are using --tags before positional arguments, you must insert -- after it to indicate the end of optional arguments. This tells the parser to treat everything after -- as positional arguments. Without the --, Barman may misinterpret positional arguments as values for the last option. Deprecated since version 3.15: --tags is deprecated. Use --tag instead. 0.0 --history-tag Tag to be added to archived history files in cloud storage. --history-tags Tags to be added to archived history files in cloud storage. NOTE: 0.0 3.5 If you are using --history-tags before positional arguments, you must insert -- after it to indicate the end of optional arguments. This tells the parser to treat everything after -- as positional arguments. Without the --, Barman may misinterpret positional arguments as values for the last option. Deprecated since version 3.15: --history-tags is deprecated. Use --history-tag instead. Extra options for the AWS cloud provider 0.0 --endpoint-url Override default S3 endpoint URL with the given one. --addressing-style The addressing style to use for S3 requests. This is useful when connecting to S3-compatible services that require a specific addressing style. Allowed options are: 7.0 (bu 2 auto (default): Uses the addressing style determined by the underlying library. (bu 2 virtual: Uses virtual-hosted style addressing (e.g., bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (e.g., s3.amazonaws.com/bucket-name). -P / --aws-profile Profile name (e.g. INI section in AWS credentials file). --profile (deprecated) Profile name (e.g. INI section in AWS credentials file)
replaced by --aws-profile. --read-timeout The time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds). -e / --encryption The encryption algorithm used when storing the uploaded data in S3. Allowed options: 7.0 (bu 2 AES256. (bu 2 aws:kms. --sse-kms-key-id The AWS KMS key ID that should be used for encrypting the uploaded data in S3. Can be specified using the key ID on its own or using the full ARN for the key. Only allowed if -e / --encryption is set to aws:kms. Extra options for the Azure cloud provider 0.0 --azure-credential / --credential Optionally specify the type of credential to use when authenticating with Azure. If omitted then Azure Blob Storage credentials will be obtained from the environment and the default Azure authentication flow will be used for authenticating with all other Azure services. If no credentials can be found in the environment then the default Azure authentication flow will also be used for Azure Blob Storage. Allowed options are: 7.0 (bu 2 azure-cli. (bu 2 managed-identity. (bu 2 default. --encryption-scope The name of an encryption scope defined in the Azure Blob Storage service which is to be used to encrypt the data in Azure. --max-block-size The chunk size to be used when uploading an object via the concurrent chunk method (default: 4MB). --max-concurrency The maximum number of chunks to be uploaded concurrently (default: 1). --max-single-put-size Maximum size for which the Azure client will upload an object in a single request (default: 64MB). If this is set lower than the Postgres WAL segment size after any applied compression then the concurrent chunk upload method for WAL archiving will be used. Extra options for GCP cloud provider 0.0 --kms-key-name The name of the GCP KMS key which should be used for encrypting the uploaded data in GCS
barman-cloud-wal-restore(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-wal-restore [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ --addressing-style { auto | virtual | path } ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --no-partial ] SOURCE_URL SERVER_NAME WAL_NAME WAL_DEST Description The barman-cloud-wal-restore script functions as the restore_command for retrieving WAL files from cloud storage and placing them directly into a Postgres standby server, bypassing the Barman server. This script is used to download WAL files that were previously archived with the barman-cloud-wal-archive command. Disable automatic download of .partial files by calling --no-partial option. IMPORTANT: 0.0 3.5 On the target Postgres node, when pg_wal and the spool directory are on the same filesystem, files are moved via renaming, which is faster than copying and deleting. This speeds up serving WAL files significantly. If the directories are on different filesystems, the process still involves copying and deleting, so there(aqs no performance gain in that case. NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. Parameters 0.0 SERVER_NAME Name of the server that will have WALs restored. SOURCE_URL URL of the cloud source, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. WAL_NAME The value of the (aq%f(aq keyword (according to restore_command). WAL_DEST The value of the (aq%p(aq keyword (according to restore_command). -V / --version Show version and exit. --help show this help message and exit. -v / --verbose Increase output verbosity (e.g., -vv is more than -v). -q / --quiet Decrease output verbosity (e.g., -qq is less than -q). -t / --test Test cloud connectivity and exit. --cloud-provider The cloud provider to use as a storage backend. Allowed options are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. --no-partial Do not download partial WAL files Extra options for the AWS cloud provider 0.0 --endpoint-url Override default S3 endpoint URL with the given one. --addressing-style The addressing style to use for S3 requests. This is useful when connecting to S3-compatible services that require a specific addressing style. Allowed options are: 7.0 (bu 2 auto (default): Uses the addressing style determined by the underlying library. (bu 2 virtual: Uses virtual-hosted style addressing (e.g., bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (e.g., s3.amazonaws.com/bucket-name). -P / --aws-profile Profile name (e.g. INI section in AWS credentials file). --profile (deprecated) Profile name (e.g. INI section in AWS credentials file)
replaced by --aws-profile. --read-timeout The time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds). Extra options for the Azure cloud provider 0.0 --azure-credential / --credential Optionally specify the type of credential to use when authenticating with Azure. If omitted then Azure Blob Storage credentials will be obtained from the environment and the default Azure authentication flow will be used for authenticating with all other Azure services. If no credentials can be found in the environment then the default Azure authentication flow will also be used for Azure Blob Storage. Allowed options are: 7.0 (bu 2 azure-cli. (bu 2 managed-identity. (bu 2 default
bdeinfo(1)
determines information about a BitLocker Drive Encrypted (BDE) volume
bindtags.tk86(n), bindtags(n)
Determine which bindings apply to a window, and order of evaluation
cgi_cookie_authority(3), cgi_cookie_authority (3)
determine the cookie authority for a domain
ck_bitmap_base(3)
determine the size of a bit array in bytes
ck_bitmap_test(3)
determine if the bit at the specified index is set
ck_ht_entry_empty(3)
determine whether entry contains a key-value pair
cmcalibrate(1)
fit exponential tails for covariance model E-value determination
coax(1)
determine impedance of a coaxial structure, where the inner may be offset from the centre if necessary
createNodeTermBdd(3)
creates a terminal node of variable
creginfo(1)
determines information about a Windows 9x/Me Registry File (CREG)
dfa_determinize(1)
Determinize NFA grammar network
dpkg-architecture(1)
set and determine the architecture for package building
drmAvailable(3)
determine whether a DRM kernel driver has been loaded
dualcoax(1)
determine impedance of a coaxial structure with two concentric dielectrics
esedbinfo(1)
determines information about an Extensible Storage Engine (ESE) Database File (EDB)
eu-elfclassify(1)
Determine the type of an ELF file
evtinfo(1)
determines information about a Windows Event Log (EVT)
evtxinfo(1)
determines information about a Windows XML EventViewer Log (EVTX) file
fidentify(8)
Determine file type using PhotoRec database
file(1)
determine file type
fsapfsinfo(1)
determines information about an Apple File System (APFS)
fsextinfo(1)
determines information about an Extended File System (ext) volume
fsfatinfo(1)
determines information about a File Allocation Table (FAT) file system volume
fshfsinfo(1)
determines information about a Hierarchical File System (HFS) volume
fsntfsinfo(1)
determines information about a Windows NT File System (NTFS) volume
fsxfsinfo(1)
determines information about a X File System (XFS) volume
fvdeinfo(1)
determines information about a FileVault Drive Encrypted (FVDE) volume
gcsplit(1), csplit(1)
split a file into sections determined by context lines
gdal-config(1)
Determines various information about a GDAL installation. Determines various information about a GDAL installation
get_midi_length(3)
Determines the total playing time of a midi, in seconds. Allegro game programming library
glAreTexturesResident(3), "glAreTexturesResident(3)
determine if textures are loaded in texture memory
glIsList(3), "glIsList(3)
determine if a name corresponds to a display-list
glIsTexture(3), "glIsTexture(3)
determine if a name corresponds to a texture
glutExtensionSupported(3)
helps to easily determine whether a given OpenGL extension is supported
glutIgnoreKeyRepeat(3)
determines if auto repeat keystrokes are reported to the current window
gutenfetch_is_threadsafe(3)
-- Determine whether the gutenfetch library is thread-safe or not
injail(8)
determine if a process is running in a jail
is_term_resized(3x), %is_term_resized(3x), %resize_term(3x), %resizeterm(3x)
manage the terminal dimensions understood by curses
jmanpath(1)
determine user's search path for Japanese man pages
kpseaccess(1)
determine whether a file can be accessed
latexdiff(1)
determine and markup differences between two latex files
libipmidetect(3)
a library of functions to determine if a node is detected or undetected
home | help