PowerShell API

Show me!

Two video tutorials are available on this topic. To access the videos, click the following links:

API Overview (05:37)

Demonstration of API Commands (05:43)

Overview information

The PowerShell API feature is meant for advanced users who want to perform tasks beyond those available through the Security Controls user interface. The feature exposes the Security Controls API stack, enabling you to execute API-level calls from the command-line or from a PowerShell console. You can use the API feature to:

  • Interact with different systems in your environment
  • You are now able to integrate your patching and power state processes with items such as vulnerability scanners, SQL Server consoles and orchestrators such as Chef, vRealize or Puppet.

  • Perform actions that you can't with the Ivanti Security Controls user interface
  • This can be actions such as suspending nodes, starting and stopping services at certain points, restarting machines in a specific order, etc.

  • Script a sequence of complex events that contain dependencies
  • Using PowerShell, you can script out interesting and complicated workflows. You can include checks within the script to make sure that everything goes according to plan. For example, you might patch one machine in a cluster and make sure that everything goes according to plan before proceeding with the other machines in the cluster.

For complete information on how to access and use the PowerShell API feature, please see Overview of the PowerShell Command-Line API in the Security Controls Help.