/PSAYX

Alteryx PowerShell Module

Primary LanguagePowerShellMIT LicenseMIT

Alteryx PowerShell module

PSScriptAnalyzer

Alteryx PowerShell module (PSAYX) is a framework for the automation of administration tasks for Alteryx.

Table of contents

  1. Usage
    1. Installation
    2. Import
    3. List available functions
  2. Dependencies

Usage

Installation

There are two methods of setting up the Alteryx PowerShell Module on your system:

  1. Download the PSAYX module from the GitHub repository;
  2. Install the PSAYX module from the PowerShell Gallery.
Install-Module -Name "PSAYX" -Repository "PSGallery"

Import

Import-Module -Name "PSAYX"

List available functions

Get-Command -Module "PSAYX"
CommandType Name Version Source
Function Add-AlteryxLicense 1.0.1 PSAYX
Function Backup-AlteryxDatabase 1.0.1 PSAYX
Function Get-AlteryxInstallDirectory 1.0.1 PSAYX
Function Get-AlteryxLicense 1.0.1 PSAYX
Function Get-AlteryxRegistryVersion 1.0.1 PSAYX
Function Get-AlteryxServerSecret 1.0.1 PSAYX
Function Get-AlteryxUtility 1.0.1 PSAYX
Function Get-AlteryxVersion 1.0.1 PSAYX
Function Install-AlteryxDataPackage 1.0.1 PSAYX
Function Install-AlteryxServer 1.0.1 PSAYX
Function Lock-AlteryxWorkflow 1.0.1 PSAYX
Function New-AlteryxLicenseFile 1.0.1 PSAYX
Function New-AlteryxPackage 1.0.1 PSAYX
Function Remove-AlteryxLicense 1.0.1 PSAYX
Function Reset-AlteryxLicenseServer 1.0.1 PSAYX
Function Restore-AlteryxDatabase 1.0.1 PSAYX
Function Set-AlteryxLicenseServer 1.0.1 PSAYX
Function Set-AlteryxServerSecret 1.0.1 PSAYX
Function Set-AlteryxSetting 1.0.1 PSAYX
Function Set-AlteryxSettingFile 1.0.1 PSAYX
Function Start-AlteryxWorkflow 1.0.1 PSAYX
Function Test-AlteryxSettingFile 1.0.1 PSAYX
Function Uninstall-AlteryxServer 1.0.1 PSAYX

Dependencies

This module depends on the usage of functions provided by the PowerShell Tool Kit (PSTK) module (version 1.2.4).