---
title: "Install Ansible Nodegrid Collection on Nodegrid OS"
slug: "installation-of-nodegrid-ansible-collections-on-nodegrid-os"
updated: 2026-10-27T12:25:50Z
published: 2026-10-27T12:25:50Z
canonical: "docs.zpesystems.com/installation-of-nodegrid-ansible-collections-on-nodegrid-os"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zpesystems.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Install Ansible Nodegrid Collection on Nodegrid OS

### Installation on Nodegrid

The collection can be installed by the default 'admin' user. Enable the Cluster feature to directly manage Nodegrid appliances part of the cluster setup. These steps are applicable when you use Nodegrid as a server. If you use Nodegrid as a Client, refer to the following article: [Ansible Configuration on Remote Nodegrid Devices](https://support.zpesystems.com/portal/en/kb/articles/ansible-configuration-on-remote-nodegrid-devices).

#### Step 1 - Download the collection

Three ways to download this collection:

- Latest release from the Releases session;
- Repository as a [zip](https://github.com/ZPESystems/Ansible) for a complete collection;
- `git clone` command to duplicate the complete repository;

**Download a Release or repository as zip**

- Connect to the WebUI (admin user)
- Open File Manager and navigate to admin_group
- Upload the downloaded `.zip` file into the folder
- Close the File Manager window
- Open a Console connection to Nodegrid device
- (admin role) Use `shell` command
- Navigate to `/var/local/file_manager/admin_group/`

```
cd /var/local/file_manager/admin_group/
```

- extract the `.zip` file with

```
unzip <file_name>.zip
```

**Use git clone command**

- Connect to the WebUI (admin user).
- Open a Console connection to Nodegrid
- Navigate to `/var/local/file_manager/admin_group/`

```
cd /var/local/file_manager/admin_group/
```

- Clone the repository

```
git clone https://github.com/ZPESystems/Ansible.git
```

#### Step 2 - Install the collection

With **admin shell**, navigate to the downloaded collection location. Run the installation playbook.

```
ansible-playbook nodegrid_install.yml
```

To switch to ansible user.

```
sudo su - ansible
```

**[Optional] Allow a user to connect to the ansible user via ssh**

A user can be authorized access to the ansible user via ssh with the `setup_authorize_user.yml` playbook inside the examples folder. The user's ssh public key must be pasted in the playbook execution.

```
ansible-playbook ./examples/playbooks/setup/setup_authorize_user.yml
```