Skip to content

Definitions

Jakub Šindelář edited this page Sep 17, 2020 · 1 revision

You will learn how to create definition files for Lazy Admin. Complete reference for both master definition file and scripts definitions files are on the following pages.

Basic information

Master definition file

Master definition file is simple JSON file, which tells Lazy Admin where to look for scripts definitions files. Simply put, it is single point, where you can control who gets which definitions.
Master definition file location is configured via registry key HKLM\SOFTWARE\Lazy Admin\MasterDefinitionUrl. When Lazy Admin launches and user logs in, application looks for this registry value and attempts to download file from either local storage, network share or web server. Downloaded file is parsed as JSON and processed for paths to scripts definitions, which may be as well either on local storage, network share or web server.

#c5f015 Note: Master definition registry value may be configured in GPO with our ADM/ADMX templates.

Scripts definitions files

Scripts definitions files are usually complex JSON files, where you configure everything about commands you want to use in Lazy Admin. You can have either one or many scripts definitions files. You can split scripts to multiple definitions files to separate them for multiple reasons, for example:

  • Create groups of scripts for each department, e.g. Helpdesk Staff, Database Admins, Azure Admins etc.
  • Create groups of scripts for each module, e.g. Active Directory, Exchange, SharePoint etc.
  • Each administrator may maintain their own set of commands, but allowing others to use each others commands, e.g. Joe's commands, Pauls's commands etc.

Contents

Next pages contain following sections.

  • Overview
  • Examples
  • Parameters
    • version
    • icon
    • displayName
    • description
    • definition
  • Definition's parameters
    • commandName
    • icon
    • returns
    • progress
    • insidePsSession
    • usesLoginObjects
    • confirm
    • friendlyName
    • description
    • help
    • login
      • name
      • description
      • commandBlock
    • parameters
      • parameter
      • format
      • value
      • required
      • type
      • hint
    • commandBlock
    • workflow
      • acceptsParams
      • joinParamsAsString
      • returns
      • insidePsSession
      • confirm
      • passedParameters
      • parameters
        • parameter
        • format
        • value
        • required
        • type
        • hint
      • commandBlock
Clone this wiki locally