ecitsolutions / Autotask

A PowerShell module for Autotask Web Services API
MIT License
65 stars 18 forks source link

ReadMe

Content

Basics

Install the module from PowerShell Gallery (the published module version is based on branch "master". Any prerelease version is based on a snapshot of "Development"):

# Download and install the module
Install-Module Autotask

# Connect to the Autotask Web Services API
$Credential = Get-Credential # Your Autotask API user and password
$ApiKey = "<the API identifier from your resource in Autotask>"
Connect-AtwsWebAPI -Credential $Credential -ApiTrackingIdentifier $ApiKey

# Save your credentials locally (NB! Will be exported as SecureString in CliXML)
New-AtwsModuleConfiguration -Credential $Credential -SecureTrackingIdentifier ($ApiKey | ConvertTo-SecureString -AsPlainText -Force) -ProfileName Default

# Module can now load and connect automatically, so you can run any command directly
Get-AtwsAccount -id 0

# New options, can be changed at runtime with Set-AtwsModuleConfiguration
New-AtwsModuleConfiguration -PickListExpansion <String> (Disabled|Inline|Labelfield)
New-AtwsModuleConfiguration -UdfExpansion <String>      (Disabled|Inline|Hashtable)
New-AtwsModuleConfiguration -DateConversion <String>    (Disabled|Local|specific/timezone)

Get-Help New-AtwsModuleConfiguration

Disclaimer and Warning

Be careful! This module exposes all the Autotask Web Services API entities and methods as PowerShell functions. This makes it very easy to make a lot of changes very quickly. But there is no undo! If you use this module to destroy or delete anything in your Autotask tenant you did not intend to - you are entirely on your own! This module is provided "as is", without warranty of any kind, express or implied. In no event shall the authors or copyright holders be liable for any claim, damages or other liability (see the license). If this is not acceptable to you - do not use it!

Release notes

Version 2.0.3 - Bugfix

Version 2.0.2 - API version update to 1.6.11 and support for Powershell 7.3.1+

Version 2.0.1 - API version update to 1.6.9

Version 2.0.0 - ArgumentCompleter release - disk cache no longer needed

Version 2.0.0-beta6 - Release candidate 2

Version 2.0.0-beta5 - Release candidate 1

Version 2.0.0-beta4

Version 2.0.0-beta3

Version 2.0.0-beta2

Version 2.0.0-beta1

Version 1.6.14

Version 1.6.13

Version 1.6.12

Version 1.6.11

Version 1.6.10

Version 1.6.9

Version 1.6.8

Version 1.6.7

Version 1.6.6

Version 1.6.5 (GA)

Version 1.6.5-beta4

Version 1.6.5-beta3

Version 1.6.5-beta2

Version 1.6.5-beta1 - Multiplatform release

Version 1.6.4.2 - API update and bugfix release

This version has been delayed a lot by the introduction of pester testing, but I sincerely hope the added QA was worth the wait.

Version 1.6.2.17 - Bugfix release

Version 1.6.2.15 - Re-release

Version 1.6.2.14 - Attachments supported

Version 1.6.2.13 - Bugfix release

Version 1.6.2.12 - Bugfix release

Version 1.6.2.11 - Bugfix release

Version 1.6.2.10 - Bugfix and an update

Version 1.6.2.8 - Date improvements

Version 1.6.2.4 - Run without a personal disk cache (Azure Automation)

Version 1.6.2.3 - Bugfix release

Version 1.6.2.2 - Bugfix release

Version 1.6.2.1 - New API version

Version 1.6.1.8 - Bugfix release

Version 1.6.1.6 - Bugfix release

Version 1.6.1.5 - New Cache Model

Version 0.2.2.5

Version 0.2.2.4

Note: Connecting to API version 1.6 requires a personal API tracking ID code. You can create one on the security tab on the automation user resource that you use to connect to the API. Warning: Be aware that from the moment you create an API tracking ID on an automation user, the tracking code is required, regardless with API version you try to connect to.

Version 0.2.2.3

Version 0.2.2.2

Version 0.2.2.1

Version 0.2.2.0

Version 0.2.1.9

Previous versions

We didn't pay enough attention to changes between releases before this.