> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/rms/llms.txt.

# Utility and Jobs


Read the server version and poll asynchronous jobs.

| RPC | Execution | Summary |
| --- | --- | --- |
| [`GetVersion`](#getversion) | Synchronous | GetVersion returns server version information. |
| [`GetJobStatus`](#getjobstatus) | Synchronous | GetJobStatus returns the current state of a job including its results if finished. |
| [`GetFirmwareJobStatus`](#getfirmwarejobstatus) | Synchronous | GetFirmwareJobStatus retrieves the current status of an asynchronous firmware job. |
| [`GetSwitchSystemImageJobStatus`](#getswitchsystemimagejobstatus) | Synchronous | GetSwitchSystemImageJobStatus retrieves the current status of an asynchronous switch system image update job. |
| [`GetConfigureSwitchCertificateJobStatus`](#getconfigureswitchcertificatejobstatus) | Synchronous | GetConfigureSwitchCertificateJobStatus retrieves the current status of an asynchronous switch certificate configuration job. |

For definitions of execution modes and job polling, refer to [Async jobs](/rms/api-reference/async-jobs).

## GetVersion

`rack_manager.RackManager/GetVersion`

GetVersion returns server version information.

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Not node-specific.** Acts on the service, the firmware catalog, or a job. |
| Behavior details | [Operations guide](/rms/documentation/operations/utility) |
| Protobuf reference | [`GetVersion`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-get-version) |

**Request:** [`GetVersionRequest`](/rms/api-reference/types/rack-manager#getversionrequest)

This message has no fields.

**Response:** [`GetVersionResponse`](/rms/api-reference/types/rack-manager#getversionresponse)

| Field | Type | Description |
| --- | --- | --- |
| `version` | `string` | - |

**Errors:** Refer to [Conventions](/rms/api-reference/conventions#error-handling) for how RMS reports failures.

<Accordion title="Example request">

Define `RMS_GRPCURL_FLAGS` and `RMS_ADDR` as described in [Getting started](/rms/api-reference/getting-started#call-an-rpc-with-grpcurl).

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

The `rack_manager_client` test client offers an equivalent command:

```bash
rack_manager_client <host> <port> version
```

</Accordion>

## 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.

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Not node-specific.** Acts on the service, the firmware catalog, or a job. |
| Behavior details | [Operations guide](/rms/documentation/operations/utility) |
| Protobuf reference | [`GetJobStatus`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-get-job-status) |

**Request:** [`GetJobStatusRequest`](/rms/api-reference/types/rack-manager#getjobstatusrequest)

| Field | Type | Description |
| --- | --- | --- |
| `job_id` | `string` | ID of the job to query |
| `include_child_job_states` | `bool` | Whether to include results of child jobs. This is disabled by default |

**Response:** [`GetJobStatusResponse`](/rms/api-reference/types/rack-manager#getjobstatusresponse)

| Field | Type | Description |
| --- | --- | --- |
| `job_states` | repeated [`JobStatus`](/rms/api-reference/types/rack-manager#jobstatus) | States of all jobs queried If a parent job is queried, it will be the first in the result list |

**Errors:** Refer to [Conventions](/rms/api-reference/conventions#error-handling) 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`.

<Accordion title="Example request">

Replace each `<placeholder>` with a real value. Define `RMS_GRPCURL_FLAGS` and `RMS_ADDR` as described in [Getting started](/rms/api-reference/getting-started#call-an-rpc-with-grpcurl).

```bash
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:

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

</Accordion>

## 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.

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Not node-specific.** Acts on the service, the firmware catalog, or a job. |
| Behavior details | [Operations guide](/rms/documentation/operations/firmware) |
| Protobuf reference | [`GetFirmwareJobStatus`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-get-firmware-job-status) |

**Request:** [`GetFirmwareJobStatusRequest`](/rms/api-reference/types/rack-manager#getfirmwarejobstatusrequest)

| Field | Type | Description |
| --- | --- | --- |
| `job_id` | `string` | Job ID returned from UpdateFirmware or BatchUpdateFirmwareByNodeType |

**Response:** [`GetFirmwareJobStatusResponse`](/rms/api-reference/types/rack-manager#getfirmwarejobstatusresponse)

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if job found, RETURN_CODE_FAILURE if job_id not found |
| `job_id` | `string` | Echoed job ID |
| `job_state` | [`FirmwareJobState`](/rms/api-reference/types/rack-manager#firmwarejobstate) | Current state of the firmware job |
| `state_description` | `string` | Human-readable description of current state (e.g., "Installing firmware") |
| `rack_id` | `string` | Rack ID associated with this job |
| `node_id` | `string` | Node ID associated with this job |
| `error_code` | [`FirmwareUpdateError`](/rms/api-reference/types/rack-manager#firmwareupdateerror) | Error code if job failed |
| `error_message` | `string` | Error details if job failed |
| `result_json` | `string` | JSON with detailed result data (populated on completion) |
| `created_at` | `google.protobuf.Timestamp` | Time when job was created |
| `updated_at` | `google.protobuf.Timestamp` | Time when job was last updated |

**Errors:** Refer to [Conventions](/rms/api-reference/conventions#error-handling) for how RMS reports failures.

<Accordion title="Example request">

Replace each `<placeholder>` with a real value. Define `RMS_GRPCURL_FLAGS` and `RMS_ADDR` as described in [Getting started](/rms/api-reference/getting-started#call-an-rpc-with-grpcurl).

```bash
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:

```bash
rack_manager_client <host> <port> firmware_job_status <job_id>
```

</Accordion>

## GetSwitchSystemImageJobStatus

`rack_manager.RackManager/GetSwitchSystemImageJobStatus`

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

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Not node-specific.** Acts on the service, the firmware catalog, or a job. |
| Behavior details | [Operations guide](/rms/documentation/operations/switch-management) |
| Protobuf reference | [`GetSwitchSystemImageJobStatus`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-get-switch-system-image-job-status) |

**Request:** [`GetSwitchSystemImageJobStatusRequest`](/rms/api-reference/types/rack-manager#getswitchsystemimagejobstatusrequest)

| Field | Type | Description |
| --- | --- | --- |
| `job_id` | `string` | Parent or child job ID returned from UpdateSwitchSystemImage |

**Response:** [`GetSwitchSystemImageJobStatusResponse`](/rms/api-reference/types/rack-manager#getswitchsystemimagejobstatusresponse)

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if job found, RETURN_CODE_FAILURE if job_id not found |
| `job_id` | `string` | Echoed job ID |
| `state` | `string` | queued, running, completed, or failed |
| `message` | `string` | Human-readable progress description |
| `rack_id` | `string` | Rack ID associated with this job |
| `node_id` | `string` | Node ID associated with this job; empty for parent jobs |
| `error_message` | `string` | Error details if job failed |
| `result_json` | `string` | JSON with detailed result data (populated on completion) |
| `created_at` | `google.protobuf.Timestamp` | Time when job was created |
| `updated_at` | `google.protobuf.Timestamp` | Time when job was last updated |

**Errors:** Refer to [Conventions](/rms/api-reference/conventions#error-handling) for how RMS reports failures.

<Accordion title="Example request">

Replace each `<placeholder>` with a real value. Define `RMS_GRPCURL_FLAGS` and `RMS_ADDR` as described in [Getting started](/rms/api-reference/getting-started#call-an-rpc-with-grpcurl).

```bash
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:

```bash
rack_manager_client <host> <port> switch_system_image_job_status <job_id>
```

</Accordion>

## GetConfigureSwitchCertificateJobStatus

`rack_manager.RackManager/GetConfigureSwitchCertificateJobStatus`

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

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Not node-specific.** Acts on the service, the firmware catalog, or a job. |
| Behavior details | [Operations guide](/rms/documentation/operations/switch-management) |
| Protobuf reference | [`GetConfigureSwitchCertificateJobStatus`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-get-configure-switch-certificate-job-status) |

**Request:** [`GetConfigureSwitchCertificateJobStatusRequest`](/rms/api-reference/types/rack-manager#getconfigureswitchcertificatejobstatusrequest)

| Field | Type | Description |
| --- | --- | --- |
| `job_id` | `string` | Parent or child job ID returned from ConfigureSwitchCertificate |

**Response:** [`GetConfigureSwitchCertificateJobStatusResponse`](/rms/api-reference/types/rack-manager#getconfigureswitchcertificatejobstatusresponse)

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if job found, RETURN_CODE_FAILURE if job_id not found |
| `job_id` | `string` | Echoed job ID |
| `state` | `string` | queued, running, completed, or failed |
| `message` | `string` | Human-readable progress description |
| `rack_id` | `string` | Rack ID associated with this job |
| `node_id` | `string` | Node ID associated with this job; empty for parent jobs |
| `error_message` | `string` | Error details if job failed |
| `result_json` | `string` | JSON with detailed result data (populated on completion) |
| `created_at` | `google.protobuf.Timestamp` | Time when job was created |
| `updated_at` | `google.protobuf.Timestamp` | Time when job was last updated |

**Errors:** Refer to [Conventions](/rms/api-reference/conventions#error-handling) for how RMS reports failures.

<Accordion title="Example request">

Replace each `<placeholder>` with a real value. Define `RMS_GRPCURL_FLAGS` and `RMS_ADDR` as described in [Getting started](/rms/api-reference/getting-started#call-an-rpc-with-grpcurl).

```bash
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:

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

</Accordion>