Skip to main content

PowerShell

This article contains instructions for how to connect to Odoo API using PowerShell.

What do you need to know before you begin?

  • The requirements for installing and using the module are described in Install and maintain the PowerShellForOdoo module.
  • After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC).

Step 1: Load the Odoo API PowerShell module

note

If the module is already installed, you can typically skip this step and run Connect-OdooApi without manually loading the module first.

After you've installed the module, open a PowerShell window and load the module by running the following command:

PowerShell
Import-Module PowerShellForOdoo

Step 2: Connect and authenticate

PowerShell
Connect-OdooApi -Host