Utility and Jobs
Read the server version and poll asynchronous jobs.
For definitions of execution modes and job polling, refer to Async jobs.
GetVersion
rack_manager.RackManager/GetVersion
GetVersion returns server version information.
Request: GetVersionRequest
This message has no fields.
Response: GetVersionResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
The rack_manager_client test client offers an equivalent command:
GetJobStatus
rack_manager.RackManager/GetJobStatus
GetJobStatus returns the current state of a job including its results if finished. If the job has any associated child jobs, it is possible to query results for all jobs with a single call.
Request: GetJobStatusRequest
Response: GetJobStatusResponse
Errors: Refer to Conventions for how RMS reports failures. This RPC also returns these gRPC errors:
INVALID_ARGUMENT: Thejob_idis empty.NOT_FOUND: No tracked job has the suppliedjob_id.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
The rack_manager_client test client offers an equivalent command:
GetFirmwareJobStatus
rack_manager.RackManager/GetFirmwareJobStatus
GetFirmwareJobStatus retrieves the current status of an asynchronous firmware job. Returns state and error information for the specified job ID. Works for all node types (compute, powershelf, switch) and parent batch jobs.
Request: GetFirmwareJobStatusRequest
Response: GetFirmwareJobStatusResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
The rack_manager_client test client offers an equivalent command:
GetSwitchSystemImageJobStatus
rack_manager.RackManager/GetSwitchSystemImageJobStatus
GetSwitchSystemImageJobStatus retrieves the current status of an asynchronous switch system image update job.
Request: GetSwitchSystemImageJobStatusRequest
Response: GetSwitchSystemImageJobStatusResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
The rack_manager_client test client offers an equivalent command:
GetConfigureSwitchCertificateJobStatus
rack_manager.RackManager/GetConfigureSwitchCertificateJobStatus
GetConfigureSwitchCertificateJobStatus retrieves the current status of an asynchronous switch certificate configuration job.
Request: GetConfigureSwitchCertificateJobStatusRequest
Response: GetConfigureSwitchCertificateJobStatusResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
The rack_manager_client test client offers an equivalent command: