IRPCVault.BroadcastRequest

View as Markdown

Vault API / core write session idempotent returns metadata structure version

Broadcasts a vault level request.

ServiceVault information MFiles.IRPCVault
gRPC method/MFiles.IRPCVault/BroadcastRequest
HTTP (mf-http-grpc)POST /grpc/v1/broadcast-request
RequestBroadcastRequestRequest
ResponseBroadcastRequestResponse
Book and levelVault API, core
Kindwrite
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentyes
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Remarks

Used by M-Files administration tools. Requires full control of the vault. The only request type, BROADCAST_REQUEST_TYPE_RESTART_VAULT, restarts the vault on all servers and waits for the restart on this server. Other values fail with E_INVALIDARG.

Request: BroadcastRequestRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
request_typeBroadcastRequestTypeThe broadcast request type.Values: BROADCAST_REQUEST_TYPE_RESTART_VAULT (0).
request_datastringThe optional custom data that can be attached to the request.

Response: BroadcastRequestResponse

No fields.