AtlassianPS.Configuration

AtlassianPS.Configuration is a module that offers a common set of tools to the AtlassianPS products to handle user-specific configuration.

It also provides a shared runtime helper surface for dependent modules. Runtime helpers are intentionally separated from configuration cmdlets under AtlassianPS.Configuration/Public/SharedRuntime/ (with shared internals under Private/SharedRuntime/) so helper evolution stays isolated from core configuration behavior.

Join the conversation on SlackLogo AtlassianPS.Slack.com

Instructions

Installation

This module does not need to be installed manually.
AtlassianPS products which use this module will install it automatically using the PowerShell Gallery.

Usage

This example uses ConfluencePS for illustration.
This example uses splatting.

Import-Module ConfluencePS   # AtlassianPS.Configuration is imported automatically

$serverData = @{
    # BaseURL of the server
    Uri = "https://powershell.atlassian.net/wiki"
    # Name with which you want to address this server
    ServerName = "AtlassianPS - wiki"
    # Type of the Atlassian product
    Type = "Confluence"
}
Add-AtlassianServerConfiguration @serverData

Get-ConfluenceSpace -Server "AtlassianPS - wiki"

You can find the full documentation on our homepage and in the console.

# Review the help at any time!
Get-Help about_AtlassianPS.Configuration
Get-Command -Module AtlassianPS.Configuration
Get-Help Get-AtlassianServerConfiguration -Full # or any other command

Contribute

Want to contribute to AtlassianPS? Great! We appreciate everyone who invests their time to make our modules the best they can be.

Check out our guidelines on Contributing to our modules and documentation.

Tested on

Configuration	Status
Windows PowerShell v5.1	CI workflow
PowerShell 7 on Windows	CI workflow
PowerShell 7 on Ubuntu	CI workflow
PowerShell 7 on macOS	CI workflow

Acknowledgements

Thanks to everyone (Our Contributors) that helped with this module

Useful links

Disclaimer

Hopefully this is obvious, but:

This is an open source project (under the MIT license), and all contributors are volunteers. All commands are executed at your own risk. Please have good backups before you start, because you can delete a lot of stuff if you’re not careful.