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

# nemo_gym.server_status

## Module Contents

### Classes

| Name                                                     | Description                       |
| -------------------------------------------------------- | --------------------------------- |
| [`StatusCommand`](#nemo_gym-server_status-StatusCommand) | Main class to check server status |

### API

<Anchor id="nemo_gym-server_status-StatusCommand">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.server_status.StatusCommand()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  Main class to check server status

  <Anchor id="nemo_gym-server_status-StatusCommand-check_health">
    <CodeBlock links={{"nemo_gym.server_utils.ServerInstanceDisplayConfig":"/nemo-gym/nemo_gym/server_utils#nemo_gym-server_utils-ServerInstanceDisplayConfig","nemo_gym.server_utils.ServerStatus":"/nemo-gym/nemo_gym/server_utils#nemo_gym-server_utils-ServerStatus"}} showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_gym.server_status.StatusCommand.check_health(
          server_info: nemo_gym.server_utils.ServerInstanceDisplayConfig
      ) -> nemo_gym.server_utils.ServerStatus
      ```
    </CodeBlock>
  </Anchor>

  <Indent>
    Check if server is responding
  </Indent>

  <Anchor id="nemo_gym-server_status-StatusCommand-discover_servers">
    <CodeBlock links={{"nemo_gym.server_utils.ServerInstanceDisplayConfig":"/nemo-gym/nemo_gym/server_utils#nemo_gym-server_utils-ServerInstanceDisplayConfig"}} showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_gym.server_status.StatusCommand.discover_servers() -> typing.List[nemo_gym.server_utils.ServerInstanceDisplayConfig]
      ```
    </CodeBlock>
  </Anchor>

  <Indent>
    Find all running NeMo Gym server processes
  </Indent>

  <Anchor id="nemo_gym-server_status-StatusCommand-display_status">
    <CodeBlock links={{"nemo_gym.server_utils.ServerInstanceDisplayConfig":"/nemo-gym/nemo_gym/server_utils#nemo_gym-server_utils-ServerInstanceDisplayConfig"}} showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_gym.server_status.StatusCommand.display_status(
          servers: typing.List[nemo_gym.server_utils.ServerInstanceDisplayConfig]
      ) -> None
      ```
    </CodeBlock>
  </Anchor>

  <Indent>
    Show server info in a table
  </Indent>
</Indent>