Welcome to the Tachyon SDK documentation space. The SDK provides the latest information for developing Tachyon instructions. The SDK is not specific to any single version of Tachyon, but instead pages will tell you the versions supported by a feature.
Please visit Tachyon Forum (in the 1E Support Portal) to ask questions and provide feedback.
Here's a quick overview of what the SDK pages will tell you.
Writing Tachyon Instructions
How to write instructions using SCALE and the Tachyon Instruction Management Studio (TIMS).
- Getting started with TIMS — Steps to create a simple instruction using Tachyon Instruction Management Studio (TIMS).
- Installing TIMS — Installing Tachyon Instruction Management Studio (TIMS).
- Running instructions in Tachyon for the first time — A getting started guide to configuring and verifying your Tachyon system so that you can run customized Tachyon Instructions.
- Instruction Definition Reference — Tachyon Instruction Definition format and attributes.
- SCALE User Guide — Understanding the Tachyon client language: SCALE - Simple Cross-platform Agent Language for Extensibility.
- Functions and Methods Reference — Tables showing the earliest version of the Agent in which a function or method was implemented, and on which OS, with links to full details.
- Custom Response Visualizations — Adding custom response visualizations to instruction definitions.
- Training Lab Guide - Advanced — Advanced training covers installing TIMS, writing instructions, and extending Guaranteed State.
Integrating with Tachyon
Integrate software with Tachyon using public facing Application Programming Interfaces (API).
- Introduction — How you can integrate software with Tachyon using public facing Application Programming Interfaces (API).
- Tachyon RunInstruction command-line tool — Tachyon RunInstruction command-line tool is a stand-alone command line (CLI) tool that supports submission of a Tachyon instruction, question or action to a set of computers.
- Consumer API reference — Each API endpoint is documented on a separate page. Pages are version controlled.
- Using scope and filter expressions — How to use create Expression objects used by many API endpoints as filter or scope definitions.
- How to guides — Section describing some basic and common Tachyon operations using the Consumer API and Consumer SDK.
Tachyon .NET Consumer SDK
Tachyon .NET Consumer SDK is a self-contained C# .NET 4 assembly consisting of Consumer and Offloading SDKs.
- Tachyon Consumer SDK library — This SDK is an object oriented abstraction of Tachyon's Consumer API. It's designed to facilitate integration of 3rd party code with Tachyon through the API.
- Tachyon Offloading SDK library — This SDK has been created to simplify creation of software that will function as an offloading client, receiving responses from Tachyon.
- Tachyon SDK release information — Details of the Tachyon release history, current release notes and details of third-party licenses.
Tachyon PowerShell Toolkit
The Tachyon PowerShell Toolkit allows you to use PowerShell to automate the Tachyon Platform by exposing many features as PowerShell cmdlets.
- 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.
- Tachyon PowerShell Toolkit release information — Details of the Tachyon PowerShell Toolkit release history, and current release notes.
- 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.
- 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.
- 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.
- 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.
- 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 — sHow to use scope and filter expressions to target specific sets of devices and/or to filter results so as to only include selected rows of data.
- Using the Tachyon PowerShell Toolkit to manage Tachyon schedules — How to use the Tachyon PowerShell Toolkit to manage Tachyon schedules.
- Working with management groups and the Tachyon PowerShell Toolkit — How to work with management groups using the Tachyon PowerShell Toolkit.
- 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.
- Tachyon PowerShell Toolkit management cmdlet reference — List of Tachyon PowerShell Toolkit cmdlets used for Tachyon management.
Index
This is an alphabetically sorted list of all the pages in the Tachyon SDK documentation, which you can use if you want to find a particular named page and you don't remember where exactly it lives in the documentation structure.
Copyright and trademark notices
All rights reserved. No part of this document or of the software (“the software”) to which it relates shall be reproduced, adapted, stored in a retrieval system, or transmitted by any means, electronic, mechanical, photocopying, recording, or otherwise, without permission from 1E Ltd. It is the responsibility of the user to use the software in accordance with this document and 1E Ltd shall not be responsible if the user fails to do so. Although every precaution has been taken in the preparation of this document, 1E Ltd and the authors assume no responsibility for errors or omissions, nor shall they be liable for damages resulting from any information in it.
Trademarks
1E, the 1E device, TACHYON, APPCLARITY, ACTIVEEFFICIENCY, NIGHTWATCHMAN, NOMAD BRANCH, NOMAD ENTERPRISE, PXE EVERYWHERE, DROWSY and DROWSY SERVER are trademarks belonging to 1E Ltd. 1E is registered in the UK, EU and the US. The 1E device is registered in the UK, EU, Australia and the US. NIGHTWATCHMAN is registered in the EU and the US. Nomad is registered in the EU and the US. DROWSY is registered in the UK. DROWSY SERVER is registered in the US.
MICROSOFT, WINDOWS, WINDOWS 7, WINDOWS VISTA, WINDOWS XP, SMS, CONFIGURATION MANAGER, INTERNET EXPLORER are all trademarks of Microsoft Corporation in the United States and other countries.
Mac is a trademark of Apple Inc., registered in the U.S. and other countries.