1E Platform management cmdlets

The table below lists a number of 1E PowerShell Toolkit cmdlets that support interaction with the 1E Platform. These cmdlets allow you to perform a variety of tasks against the 1E Platform.

Cmdlets

Description

Credential management cmdlets

The credential management cmdlets provide a secure mechanism for distributing credentials (secrets) such as usernames and passwords to devices. Refer to Credential management cmdlets.

For an example of using credentials retrieved from the Windows Credential Vault in PowerShell to perform a privileged operation, refer to Using Credential Vault Credentials.

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. Refer to Guaranteed State management cmdlets.

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 on the 1E Platform. Refer to Instruction execution management cmdlets.

Instruction management cmdlets

Instruction management cmdlets allow you to perform various tasks associated with 1E Platform instructions. Refer to Instruction management cmdlets.

Management Group cmdlets

Management group cmdlets allow you to perform various tasks associated with 1E Platform instructions. Refer to Management Group cmdlets.

Instruction XML management cmdlets

Instruction XML management cmdlets allow you to create or modify instruction XML files, which can then be uploaded to the 1E Platform. Refer to Instruction XML management cmdlets.

For walk-through scenarios where you can use the 1E PowerShell Toolkit instruction XML cmdlets to assemble new 1E Platform instructions, refer to Scenarios using the instruction XML cmdlets.

Platform server management cmdlets

The platform server management cmdlets allow you to do the following:

  • Specify the platform server to connect to and verify its version.
  • Manage device tags.
  • Retrieve workflow notifications.
  • Manage event subscriptions and assignments.

Refer to the following articles:

Role-Based Access Control (RBAC) cmdlets

Role-Based Access Control (RBAC) cmdlets allow you to interact with the 1E Platform RBAC subsystem. Refer to Role-Based Access Control cmdlets.

Also refer to Management group changes in version 8 of the 1E Platform.

 

Tachyon Experience management cmdlets

Tachyon Experience management cmdlets allow you to manage and interact with the Tachyon Experience subsystem. Refer to Tachyon Experience management cmdlets.

Workflow management cmdlets

Workflow management cmdlets allow you to manage the workflow associated with 1E Platform instructions that have been defined as actions rather than questions. Refer to Workflow management cmdlets.

Integration management cmdlets

Integration management cmdlets allow you to manage and interact with external integration subsystems. Refer to Integration Management Cmdlets.

Windows AD cmdlets

Windows AD cmdlets are intended for use with on-premise platform instances that have been configured to use Windows AD as the identity provider. Refer to Windows AD cmdlets.

Additional functionality

The 1E PowerShell Toolkit provides additional functionality which is explained in more detail below.

Scope and filter expressions

Scope  expressions allow you to flexibly target devices based on criteria such as device FQDN, operating system version, management group, and so on. Scope expressions also support device tags. Device tags are a 1E Platform feature that allows you to easily label devices with arbitrary property sets. For example, using device tags, you can label all database servers and then target only that device set in an instruction by specifying the tag and value.

Filter expressions allow you to specify the data you actually want to be returned from devices. This allows you to efficiently return just the information you require, for example, all devices with two populated memory slots.

Refer to Scope and filter expressions.

Staged rollouts

Staged rollouts allow you to target tranches of devices with an instruction and automatically keep track of the devices that have received it, for each deployment tranche. Refer to Staged rollouts.

OSQuery integration

OSQuery is an open source initiative developed by Facebook's engineers. Like the 1E Platform, it provides a set of device-level queries expressed via SQLite queries. The functionality available through OSQuery extends that available natively via the 1E Client. The 1E PowerShell Toolkit lets you invoke any OSQuery query without requiring additional installed software on the devices. Refer to OSQuery integration.

WMI integration

WMI integration allows you to directly execute a WMI query against a targeted set of devices. Refer to WMI integration.

Dynamic cmdlet creation from 1E Platform instructions

The 1E PowerShell Toolkit allows you to easily create new PowerShell cmdlets from existing 1E Platform instructions. To learn how to turn a useful platform instruction into a cmdlet for reuse, refer to Creating your own cmdlet from a 1E Platform instruction.