PowerShell Module Reference

The GENESIS PowerShell interface provides one module per provider. This topic lists the modules, the command prefix that each one uses, and the configuration it manages, so you can find the right module for a task. For background on how the commands work, see the PowerShell Interface Overview; for how command names are formed, see the Command Naming Reference.

Every command belongs to exactly one module, and the command prefix—the text immediately after the verb, such as Ac in New-AcEquipment—identifies that module's provider. The prefix is the link between a command and its module: if you know a command name, its prefix tells you which module it comes from; if you know the module, its prefix tells you how its commands are named.

The command prefix is not always identical to the module name. For example, the HHPowershell module uses the HH prefix, and MelPowershell uses the Melco prefix. List the modules installed on your own system with Get-Module -ListAvailable -Name *Powershell; the present set depends on which products are installed and licensed.

Provider Modules

Module

Command Prefix

Configures

IcoAssetCatalogPowershell

Ac

Assets—the asset model: equipment, levels, classes, properties, and units.

HHPowershell

HH

Data Historian—historical data logging tags, collector groups, and logging groups.

IcoTrgPowershell

Trg

Triggers—data, time, alarm, file, event, and database trigger items and folders.

IcoUdmPowershell

Udm

Unified Data Manager—registers, expressions, value sets, groups, and alarm subscriptions.

IcoGasPowershell

Gas

Global Aliasing—global aliases and themes.

IcoLasPowershell

Las

Language Aliasing—language aliases and translations.

IcoSecurityPowershell

Sec

Security—users, account policies, access control entries, and passwords.

IcoFwxPowershell

Fwx

FrameWorX—server and network aliases and active configuration files.

IcoGdxPowershell

Gdx

Databases—database connectivity, data sources, and transactions.

IcoBiPowershell

Bi

BI Server—data flows, models, columns, and relations.

IcoBwxPowershell

Bwx

Bridging—data bridging configurations and transactions.

IcoMgxPowershell

Mgx

Data Historian Importer—data collection folders, plugins, and tags.

IcoRwxPowershell

Rwx

Reports—report commands and configurations.

IcoRcpPowershell

Rcp

Recipes.

IcoSchwxPowershell

Schwx

Schedules—schedules and holiday tags.

AlmsPowershell

Alms

Alarm Server—alarm server areas and equipment property sources.

AlmlPowershell

Alml

Alarm Historian—logging collections, collectors, and dataset definitions.

IcoAlertPowershell

Alert

Alert Notifications—email, SMS, and Microsoft Teams notification configurations.

IcoFaPowershell

Fa

Fault Detection—device models, conditions, causes, and asset diagnostics.

IcoCfsWaPowershell

CfsWa

Connected Field Service—contacts, groups, and mobile health configurations.

IcoHmiPowershell

Hmi

HMI layouts—layouts, devices, icons, and groups.

IcoIotPowershell

Iot

Internet of Things—aggregate groups and IoT configurations.

IcoProfPowershell

Prof

Application profiles—profile applications, items, owners, and properties.

IcoWsPowershell

Ws

Web Services connector—REST methods, parameters, and refresh triggers.

IcoBacPowershell

Bac

BACnet connectivity—channels and devices.

IcoModbusPowershell

Mb

Modbus connectivity—channels and devices.

IcoOpcUaPowershell

OpcUa

OPC UA connectivity—global discovery servers.

IcoSnmpPowershell

Snmp

SNMP connectivity—devices.

MelPowershell

Melco

Mitsubishi Electric FA—device folders and devices.

IcoFilePowershell

File

File operations—file archives and transfers.

Utility Modules

These modules provide cross-cutting commands rather than a single provider's entities.

Module

Configures

IcoWorkbenchPowershell

Workbench project management—the target host (Get-WbHost, Set-WbHost), tasks, key helpers (New-WbKey, New-WbEmptyKey), database backup and restore (Set-WbBackupDatabase, Get-WbRestorePoints), and Pack and Go settings.

IcoConfigPowershell

Configuration import and export (Import-WbConfiguration, Export-WbConfiguration), GUID generation (Get-Guid), and bulk multiply (Set-WbMultiply).

Related Topics: