Contents
The Tachyon PowerShell Toolkit allows you to use PowerShell to automate the Tachyon Platform by exposing many features as PowerShell cmdlets.
This toolkit is being continuously developed and so the feature list may change at any point; documentation will be updated accordingly. For latest changes, please refer to Tachyon PowerShell Toolkit release information.
Key features and concepts of the Tachyon PowerShell Toolkit
The Tachyon PowerShell Toolkit allows you to use PowerShell to automate the Tachyon Platform by exposing many features as PowerShell cmdlets.
Installing the Tachyon PowerShell Toolkit
How to install the Tachyon PowerShell Toolkit, and information about its installation files.
- Requirements for using the Tachyon PowerShell Toolkit — Common requirements for using the Toolkit. Specific requirements for some features. Further features have additional requirements that are described on their pages.
Using the Tachyon PowerShell Toolkit
Guidance for using the Tachyon PowerShell Toolkit.
- Creating your own cmdlet from a Tachyon instruction — Walkthrough example of using the PowerShell Toolkit to turn a useful Tachyon instruction into a PowerShell cmdlet for re-use.
- Dynamic File Copy — Using the dynamic file copy feature of the PowerShell Toolkit.
- Dynamic SCALE — Allows a user to run a PowerShell script or executable program on a device via Tachyon, without first creating an instruction.
- Dynamic Scripting and executable command execution using the Tachyon PowerShell Toolkit — Dynamic Scripting allows you to create a PowerShell script and then deploy it dynamically.
- Executing an instruction using the Tachyon PowerShell Toolkit — Invoke-TachyonInstruction lets you execute any Tachyon instruction directly from the PowerShell command window, and return the results.
- Staged rollouts using the Tachyon PowerShell Toolkit — How to use the PowerShell Toolkit to manage a staged rollout of a Tachyon instruction.
- Installing and using Visual Studio Code with the Tachyon PowerShell Toolkit — How to install and use the Visual Studio Code development environment with the PowerShell Toolkit.
- Integrating the Tachyon PowerShell Toolkit with Microsoft Power BI — How to use the Tachyon PowerShell Toolkit with Microsoft Power BI desktop.
- Interactive instruction search using the Tachyon PowerShell Toolkit — Using the PowerShell Toolkit to interactively search for Tachyon instructions.
- Managing certificates with the Azure Credential Vault — How to set up and test an Azure environment and manage certificates with the Credential Vault.
- Offloading data to an external target — How to set up a Tachyon consumer to offload data to an external target and then invoke an instruction which sends the data to that target.
- OSQuery integration — Using the OSQuery integration functionality available with Tachyon PowerShell Toolkit.
- Querying Tachyon Activity Records using the Tachyon PowerShell Toolkit — Querying historical data from the Tachyon Activity Records on clients.
- Using scope and filter expressions with the Tachyon PowerShell Toolkit — How to use scope and filter expressions to target specific sets of devices and/or to filter results to only include selected rows of data.
- Using device tags with the Tachyon PowerShell Toolkit — How to use device tags with the PowerShell Toolkit.
- Using the Tachyon PowerShell Toolkit on non-Windows platforms — Special considerations using the Tachyon PowerShell toolkit from a non-Windows platform.
- Using the Tachyon PowerShell Toolkit to manage Tachyon schedules — How to use the Tachyon PowerShell Toolkit to manage Tachyon schedules.
- Using the Tachyon PowerShell Toolkit with platform-neutral authentication — How to use the PowerShell toolkit when connecting to a Tachyon platform server that is configured for platform-neutral authentication.
- WMI Integration — Invoke any WMI query directly from a PowerShell cmdlet. Because the Tachyon platform handles the transport and execution of the underlying instruction, you do not need to have enabled WinRM to use this functionality.
- Working with management groups and the Tachyon PowerShell Toolkit — How to work with management groups using the Tachyon PowerShell Toolkit.
- Direct-based management groups — Using the PowerShell Toolkit to create and update Direct-based management groups.
- SLA management groups and rule expressions — SLA management groups and rule expressions.
Tachyon PowerShell Toolkit management cmdlet reference
List of Tachyon PowerShell Toolkit cmdlets used for Tachyon management.
- Credential management cmdlets — The credential management cmdlets provide a secure mechanism for distributing credentials (secrets) such as usernames and passwords to devices.
- Using Credential Vault Credentials — Example of using credentials retrieved from the Windows Credential Vault in PowerShell to perform a privileged operation.
- Guaranteed State management cmdlets — Guaranteed State management cmdlets allow you to manage entities associated with the Guaranteed State subsystem, including fragments, policies, rules and trigger templates.
- Instruction execution management cmdlets — The instruction execution management cmdlets allow you to invoke instructions, retrieve the estimated target count for an instruction and perform other tasks associated with the execution of instructions in Tachyon.
- Instruction management cmdlets — Instruction management cmdlets allow you to perform various tasks associated with Tachyon instructions.
- Instruction XML management cmdlets — Reference for the Instruction XML management cmdlets. These cmdlets allow you to create or modify instruction XML files, which can then be uploaded to Tachyon.
- Some useful scenarios using the instruction XML cmdlets — Walk-through scenarios where you can use the Tachyon PowerShell instruction XML cmdlets to assemble new Tachyon instructions.
- Role-Based Access Control (RBAC) cmdlets — Tachyon PowerShell Toolkit cmdlets that allow you to interact with the Tachyon RBAC subsystem.
- Management group changes in Tachyon v8 — Changes that have been made in Tachyon v8 relating to management groups.
- Tachyon Experience management cmdlets — Cmdlets that let you manage and interact with the Tachyon Experience subsystem.
- Tachyon Server management cmdlets — The server management cmdlets allow you to: Specify the Tachyon server to connect to, and verify its version; Manage device tags; Retrieve workflow notifications; Manage event subscriptions and assignments.
- Accessing Certificates from the Azure Key Vault — How to use the PowerShell toolkit to directly retrieve certificates from the Azure Key Vault and then use them to authenticate with the Tachyon Platform.
- Tachyon event management cmdlets — Cmdlets used to manage Tachyon events and subscriptions.
- Workflow management cmdlets — Workflow management cmdlets allow you to manage the workflow associated with Tachyon instructions which have been defined as actions, rather than questions.
Tachyon PowerShell Toolkit release information
Details of the Tachyon PowerShell Toolkit release history, and current release notes.