---
title: "NIOS Inventory"
canonical: "https://docs.infoblox.com/space/niosmodulesansible/45074747/NIOS%20Inventory"
format: markdown
---
Use the `nios_inventory` plug-in to query the NIOS Grid for host records, and use the response data to populate the inventory file.

The following table describes the parameters you can define in the `nios_inventory` module:

| **Parameter** | **Required/Optional** | **Description** |
| --- | --- | --- |
| host | Required | Specifies the DNS host name or address for connecting to the remote instance of NIOS WAPI over REST.  
You can also use the `INFOBLOX_HOST` environment variable to specify a value. |
| `username` | Required | Specifies the user name to use for authenticating the connection to the remote instance of NIOS.  
You can also use the `INFOBLOX_HOST` environment variable to specify a value |
| `password` | Required | Specifies the password to use for authenticating the connection to the remote instance of NIOS.  
You can also use the `INFOBLOX_HOST` environment variable to specify a value |
| `hostfilter` | Optional | Contains the key/value pair that the plug-in uses to filter the host records to be returned. |
| `extattrs` | Optional | Allows you to filter the returned host records based on the extensible attributes assigned to them. |
| `provider` | Required | Defines the details of the connection:<br>- `host`: The DNS host name or IP address to connect to the remote instance of NIOS.
- `username`: The user name to use for authenticating the connection to the remote instance.
- `password`: The password to use for authenticating the connection to the remote instance.<br>For information on additional fields you can define, see <span style="color: #172b4d">the list of subparameters in the </span><span style="color: #172b4d">*[NIOS Modules for Ansible Collections](https://infoblox-docs.atlassian.net/wiki/spaces/niosmodulesansible/pages/44525470)*</span><span style="color: #172b4d"> topic.</span> |
| `connection` | Required | The `nios_inventory` module must be run locally. |

## Examples

`plugin: infoblox.nios_modules.nios_inventory`  
`host: blox.example.com`  
`username: admin`