IRPCServerAdmin.BackUpMasterDB
Administration API / specialized admin session
Backs up the server's master database to a file on the server, and returns when the backup is complete.
| Service | Server administration MFiles.IRPCServerAdmin |
|---|---|
| gRPC method | /MFiles.IRPCServerAdmin/BackUpMasterDB |
| HTTP (mf-http-grpc) | POST /grpc/v1/back-up-master-db |
| Request | BackUpMasterDBRequest |
| Response | BackUpMasterDBResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires the system administrator server role (server right
backup_master_database). - The path is on the server computer. The file is written as the account in
utf8szimpersonation(the server's own account when it is the system account). - Runs synchronously. To run it as a cancellable job instead, use
BackUp with a
BackupJobwhosevault_guidis the null GUID.
Request: BackUpMasterDBRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
target_file | string | Full path of the backup file on the server computer. |
utf8szimpersonation | Impersonation | The account used to write the backup file. See Impersonation. |
utf8szimpersonation.type | ImpersonationType | Impersonation type.Values: IMPERSONATION_TYPE_SYSTEM_ACCOUNT (0), IMPERSONATION_TYPE_LOCAL_WINDOWS_ACCOUNT (1), IMPERSONATION_TYPE_EXTERNAL_ACCOUNT (2). |
utf8szimpersonation.account | string | Account name (e.g. DOMAIN\user). |
utf8szimpersonation.encrypted_password | bytes | Encrypted password. |
overwrite_existing_files | bool | True to overwrite existing files; false fails if a target file exists. |
file_size_limit_in_mb | uint32 | The maximum size of one backup file in megabytes; larger backups continue in sequentially numbered files. 0 means a single file of any size. |
Response: BackUpMasterDBResponse
No fields.
Related methods
- BackUp -- Starts a backup of a vault or of the master database as a server job and returns the job ID.