> For the complete documentation index, see [llms.txt](https://documentation.2pintsoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.2pintsoftware.com/deployr/automation-and-powershell/scripting-for-deployr-server/automating-content-item-creation/1.4-get-deployrcloudos.md).

# 1.4 Get-DeployRCloudOS

{% hint style="info" %}
Applies to: DeployR 1.4 and later. Requires DeployR Enterprise.
{% endhint %}

Use `Get-DeployRCloudOS` to find a Windows image in the 2Pint cloud OS catalog (the same catalog used by the **Apply operating system from cloud** step), then pipe it to `Import-DeployRCloudOS` to import it into DeployR as an operating system content item. Importing the image means devices download it from the DeployR server, or from peers, instead of from Microsoft.

Run these commands from the DeployR server. Import the DeployR module and authenticate first. See [Scripting for DeployR Server](/deployr/automation-and-powershell/scripting-for-deployr-server.md).

### Syntax

```powershell
Get-DeployRCloudOS [[-OS] <string>] [[-OSReleaseId] <string>] [[-OSArchitecture] <string>] [[-LanguageCode] <string>] [[-Edition] <string>] [[-DeployRApiUrl] <string>] [<CommonParameters>]
```

### Finding an image

Specify the parameters in order. When a parameter is missing, the command returns the valid values for it, so you can build the command one step at a time:

```powershell
Get-DeployRCloudOS                                            # List the operating systems
Get-DeployRCloudOS -OS "Windows 11"                           # List the releases
Get-DeployRCloudOS -OS "Windows 11" -OSReleaseId 25H2         # List the architectures
Get-DeployRCloudOS -OS "Windows 11" -OSReleaseId 25H2 -OSArchitecture x64                      # List the languages
Get-DeployRCloudOS -OS "Windows 11" -OSReleaseId 25H2 -OSArchitecture x64 -LanguageCode en-us  # List the editions
```

When all five parameters are specified, the command returns the matching images. To import one, pipe it to `Import-DeployRCloudOS`:

```powershell
Get-DeployRCloudOS -OS "Windows 11" -OSReleaseId 25H2 -OSArchitecture x64 -LanguageCode en-us -Edition Enterprise | Import-DeployRCloudOS
```

The catalog is downloaded once per PowerShell session and cached.

### Parameters

| Parameter         | Description                                                   |
| ----------------- | ------------------------------------------------------------- |
| `-OS`             | The operating system, for example `Windows 11`.               |
| `-OSReleaseId`    | The release, for example `25H2`.                              |
| `-OSArchitecture` | The operating system architecture.                            |
| `-LanguageCode`   | The language code for the operating system.                   |
| `-Edition`        | The operating system edition.                                 |
| `-DeployRApiUrl`  | The 2Pint cloud service URL. Leave it out to use the default. |

<figure><img src="https://2118352581-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8m0VARX9oyZ2zXWCdPgr%2Fuploads%2FFpNnHlPJdFXPfIn6uUix%2Fimage.png?alt=media&#x26;token=7dd1ff8c-4661-43d1-b92d-13a047f883d5" alt=""><figcaption></figcaption></figure>

### Monitor the import

`Import-DeployRCloudOS` starts the import on the DeployR server and returns immediately.

DeployR writes an import log to `DeployRContentFolder\Logs`. Log files use this format:

```
ImportCloudOS-GUID.log
```

<figure><img src="https://2118352581-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8m0VARX9oyZ2zXWCdPgr%2Fuploads%2FA4fUsWX1LY8BM2MXJsO6%2Fimage.png?alt=media&#x26;token=7481e38e-009f-4edc-abea-431582cda190" alt=""><figcaption></figcaption></figure>

### Confirm the imported OS

After the import completes, the operating system appears in the DeployR dashboard in the Content Items blade. It has an appropriate name and tags.

<figure><img src="https://2118352581-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8m0VARX9oyZ2zXWCdPgr%2Fuploads%2F4fthGcCBIksQKrB4o18I%2Fimage.png?alt=media&#x26;token=a5bc6ce3-761f-4b28-8031-b8e96c93f66f" alt=""><figcaption></figcaption></figure>

<figure><img src="https://2118352581-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8m0VARX9oyZ2zXWCdPgr%2Fuploads%2FARlVhX98Dxt99vZpfOE9%2Fimage.png?alt=media&#x26;token=6f871321-415c-4cf8-9258-81ca62004d0b" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.2pintsoftware.com/deployr/automation-and-powershell/scripting-for-deployr-server/automating-content-item-creation/1.4-get-deployrcloudos.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
