baramundisoftware / PS-bConnect

Powershell module for baramundi Connect (bConnect), the REST-API of the baramundi Management Suite
https://www.baramundi.com/en/management-suite/interfaces/
MIT License
26 stars 14 forks source link
automation baramundi bconnect management rest-api

GitHub PowerShell Gallery Version PowerShell Gallery Minimum Supported PowerShell Version

PS-bConnect

Powershell module for baramundi Connect (bConnect), the REST-API of the baramundi Management Suite.

Installation

You can install the module from the Powershell Gallery Repository directly by using the Install-Module Cmdlet:

Install-Module -Name bConnect

Update

You can update the module from the Powershell Gallery Repository directly by using the Update-Module Cmdlet:

Update-Module -Name bConnect

Usage

To use the functions of PS-bConnect you need to import the module into your current session and initialize the connection to the REST-API:

Import-Module -Name bConnect
$apiCred = Get-Credential -Message "bConnect" -UserName "user@domain.local"
Initialize-bConnect -Server "SRV-BARAMUNDI" -Credentials $apiCred

Security notice: Do not use common credential, which are also used by other tasks! Create a specific user and password for each script and assign only necessary permissions in the bMS.

You may also add the switch -AcceptSelfSignedCertifcate if you use a self-signed certificate at the bConnect port.

For more details please visit the Wiki.

Support & Warranty

This module is provided "as is" without any warranty or support from the baramundi software GmbH. If you encounter any issues refer to the issue tracker.

Author

Alexander Haugk

baramundi software GmbH

https://www.baramundi.com

Contributing

Contributions, feature requests and issues are welcome.

Please post your request in the issue tracker.

License

Copyright (c)2023 baramundi software GmbH.

This project ist licensed under the MIT License.