Skip to navigation

Utility and Jobs

View as MarkdownOpen in Claude

Read the server version and poll asynchronous jobs.

RPCExecutionSummary
GetVersionSynchronousGetVersion returns server version information.
GetJobStatusSynchronousGetJobStatus returns the current state of a job including its results if finished.
GetFirmwareJobStatusSynchronousGetFirmwareJobStatus retrieves the current status of an asynchronous firmware job.
GetSwitchSystemImageJobStatusSynchronousGetSwitchSystemImageJobStatus retrieves the current status of an asynchronous switch system image update job.
GetConfigureSwitchCertificateJobStatusSynchronousGetConfigureSwitchCertificateJobStatus retrieves the current status of an asynchronous switch certificate configuration job.

For definitions of execution modes and job polling, refer to Async jobs.

GetVersion

rack_manager.RackManager/GetVersion

GetVersion returns server version information.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetNot node-specific. Acts on the service, the firmware catalog, or a job.
Behavior detailsOperations guide
Protobuf referenceGetVersion

Request: GetVersionRequest

This message has no fields.

Response: GetVersionResponse

FieldTypeDescription
versionstring-

Errors: Refer to Conventions for how RMS reports failures.

Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{}' \
"$RMS_ADDR" rack_manager.RackManager/GetVersion

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> version

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.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetNot node-specific. Acts on the service, the firmware catalog, or a job.
Behavior detailsOperations guide
Protobuf referenceGetJobStatus

Request: GetJobStatusRequest

FieldTypeDescription
job_idstringID of the job to query
include_child_job_statesboolWhether to include results of child jobs. This is disabled by default

Response: GetJobStatusResponse

FieldTypeDescription
job_statesrepeated JobStatusStates of all jobs queried If a parent job is queried, it will be the first in the result list

Errors: Refer to Conventions for how RMS reports failures. This RPC also returns these gRPC errors:

  • INVALID_ARGUMENT: The job_id is empty.
  • NOT_FOUND: No tracked job has the supplied job_id.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"job_id": "<job_id>",
"include_child_job_states": false
}' \
"$RMS_ADDR" rack_manager.RackManager/GetJobStatus

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> job_status <job_id> [--include-child-job-states]

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.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetNot node-specific. Acts on the service, the firmware catalog, or a job.
Behavior detailsOperations guide
Protobuf referenceGetFirmwareJobStatus

Request: GetFirmwareJobStatusRequest

FieldTypeDescription
job_idstringJob ID returned from UpdateFirmware or BatchUpdateFirmwareByNodeType

Response: GetFirmwareJobStatusResponse

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if job found, RETURN_CODE_FAILURE if job_id not found
job_idstringEchoed job ID
job_stateFirmwareJobStateCurrent state of the firmware job
state_descriptionstringHuman-readable description of current state (e.g., “Installing firmware”)
rack_idstringRack ID associated with this job
node_idstringNode ID associated with this job
error_codeFirmwareUpdateErrorError code if job failed
error_messagestringError details if job failed
result_jsonstringJSON with detailed result data (populated on completion)
created_atgoogle.protobuf.TimestampTime when job was created
updated_atgoogle.protobuf.TimestampTime when job was last updated

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"job_id": "<job_id>"
}' \
"$RMS_ADDR" rack_manager.RackManager/GetFirmwareJobStatus

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> firmware_job_status <job_id>

GetSwitchSystemImageJobStatus

rack_manager.RackManager/GetSwitchSystemImageJobStatus

GetSwitchSystemImageJobStatus retrieves the current status of an asynchronous switch system image update job.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetNot node-specific. Acts on the service, the firmware catalog, or a job.
Behavior detailsOperations guide
Protobuf referenceGetSwitchSystemImageJobStatus

Request: GetSwitchSystemImageJobStatusRequest

FieldTypeDescription
job_idstringParent or child job ID returned from UpdateSwitchSystemImage

Response: GetSwitchSystemImageJobStatusResponse

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if job found, RETURN_CODE_FAILURE if job_id not found
job_idstringEchoed job ID
statestringqueued, running, completed, or failed
messagestringHuman-readable progress description
rack_idstringRack ID associated with this job
node_idstringNode ID associated with this job; empty for parent jobs
error_messagestringError details if job failed
result_jsonstringJSON with detailed result data (populated on completion)
created_atgoogle.protobuf.TimestampTime when job was created
updated_atgoogle.protobuf.TimestampTime when job was last updated

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"job_id": "<job_id>"
}' \
"$RMS_ADDR" rack_manager.RackManager/GetSwitchSystemImageJobStatus

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> switch_system_image_job_status <job_id>

GetConfigureSwitchCertificateJobStatus

rack_manager.RackManager/GetConfigureSwitchCertificateJobStatus

GetConfigureSwitchCertificateJobStatus retrieves the current status of an asynchronous switch certificate configuration job.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetNot node-specific. Acts on the service, the firmware catalog, or a job.
Behavior detailsOperations guide
Protobuf referenceGetConfigureSwitchCertificateJobStatus

Request: GetConfigureSwitchCertificateJobStatusRequest

FieldTypeDescription
job_idstringParent or child job ID returned from ConfigureSwitchCertificate

Response: GetConfigureSwitchCertificateJobStatusResponse

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if job found, RETURN_CODE_FAILURE if job_id not found
job_idstringEchoed job ID
statestringqueued, running, completed, or failed
messagestringHuman-readable progress description
rack_idstringRack ID associated with this job
node_idstringNode ID associated with this job; empty for parent jobs
error_messagestringError details if job failed
result_jsonstringJSON with detailed result data (populated on completion)
created_atgoogle.protobuf.TimestampTime when job was created
updated_atgoogle.protobuf.TimestampTime when job was last updated

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"job_id": "<job_id>"
}' \
"$RMS_ADDR" rack_manager.RackManager/GetConfigureSwitchCertificateJobStatus

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> switch configure_certificate_status <job_id>