# getOmniMachines

> Function getOmniMachines in pulumi-portainer.

<!-- Generated from the pulumi-portainer SDK. -->

Function getOmniMachines in pulumi-portainer.

Invoke token: `portainer:index/getOmniMachines:getOmniMachines`.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as portainer from "pulumi-portainer"

const result = await portainer.getOmniMachines({
  credentialId: 0,
})
```

`getOmniMachinesOutput` accepts Input values and returns `Output` of the same result.

## Arguments

| Property       | Type     | Required | Description |
| -------------- | -------- | -------- | ----------- |
| `credentialId` | `number` | yes      |             |
| `id`           | `string` | no       |             |

## Result

| Property       | Type                       | Always present | Description |
| -------------- | -------------------------- | -------------- | ----------- |
| `credentialId` | `number`                   | yes            |             |
| `id`           | `string`                   | yes            |             |
| `machines`     | `GetOmniMachinesMachine[]` | yes            |             |

## `GetOmniMachinesMachine`

Output object `GetOmniMachinesMachine`. Fields below belong to this object.

| Property            | Type                        | Always present | Description |
| ------------------- | --------------------------- | -------------- | ----------- |
| `cluster`           | `string`                    | no             |             |
| `connected`         | `boolean`                   | no             |             |
| `labels`            | `{ [key: string]: string }` | no             |             |
| `lastError`         | `string`                    | no             |             |
| `machineName`       | `string`                    | no             |             |
| `maintenance`       | `boolean`                   | no             |             |
| `managementAddress` | `string`                    | no             |             |
| `powerState`        | `string`                    | no             |             |
| `role`              | `string`                    | no             |             |
| `talosVersion`      | `string`                    | no             |             |