Provisioning steps
Each provisioning job consists of one or more steps that the
Figure 1. The New Job Step window
Each job runs one or more provisioning steps:
- Add Station User (component:AddStationUserStep) – adds a new user to the station.
- Backup Stations (component: BackupStationExt) – makes an online backup of each running station.
- Configure Niagara IdP and SAML Scheme configures authentication properties.
- Copy Local File (component: FileCopyStep) – makes a copy of a local file on your PC.
- Copy Supervisor File (component: FileCopyStep) – makes a copy of a
- Deploy Template (component: DeployTemplateStep) – deploy a component template to each station using and Excel file.
- Enable Bootstrap Mode (component: EnableBootstrapStep) – creates a one-time provisioning job to connect from the Supervisor to the remote controller using a certificate exemption for the default self-signed certificate. This step is intended for use with other provisioning steps that set up credentials and configure certificates. It is useful for provisioning new out-of-the-box devices.
- Export Application Template Configuration exports an application template configuration as an .xlsx file.
- Export Certificate Signing Request (component: ExportCsrJobStep) - generate and export a CSR for each remote host.
- Generate Certificate (component :GenerateCertJobStep) – generate a certificate on each remote host.
- Import Signed Certificate (component: ImportSignedCertificateJobStep) – import a signed certificate for each remote host.
- Install Application Template (component: DeployApplicationStep) – install and application template on each station using an Excel file.
- Install Certificate (component: InstallCertificateJobStep) – installs a certificate from the supervisor's user trust store to each remote host's user trust store.
- Install Clean Distribution (component: InstallCleanDistStep) – installs the selected clean distribution file to the target platforms.
- Install Software (component: InstallBySpecStep) – installs a software module in one or more remote hosts.
- Reboot (component: RebootJobStep) – reboots the platform host.
- Remove Station User (component: RemoveStationUserStep) – remove a named user from the station.
- Rename Device Station (component: RenameStationStep) – renames the station on the remote host to match the name in the supervisor's NiagaraNetwork.
- Run Robot (component: RunRobotStep) – allows you to create custom code to run on each station.
- Security Job Steps is a convenience step that configures and inserts the three credential-related steps in one sequence. The results are the same as if you added the steps for Set Platform Credentials, Set System Passphrase, and Set Station User Password individually.
- Set Certificate Alias (component: SetCertificateAliasJobStep) – set the certificate alias used for the remote device's platform, web, and fox services.
- Set Platform Credentials (component: SetPlatformCredentialsJobStep) – adds a new platform user account and remove the default account on the remote device.
- Set Platform User Password (component: SetPlatformUserPasswordJobStep) – changes password for an existing platform user.
- Set Property (component: SetPropertyJobStep) – set or add a property.
- Set Station Connection Credentials (component: SetStationConnectionCredentialsStep) – set the station credentials used to connect to the remote station.
- Set Station User Password (component: SetStationUserPasswordJobStep) – sets the station user password.
- Set System Passphrase (component: SetSystemPassphraseJobStep) - sets the system passphrase.
- Set TLS Level (component: SetTlsLevelJobStep) – set the minimum TLS level for the remote device's platform, web, and fox services.
- Set Time (component: SetTimeJobStep) - set the time on the remote device.
- Setup Reciprocal Connection (component: SetupReciprocalConnectionStep) – sets the connection settings for the "reciprocal" station connection, which is the station proxy in the NiagaraNetwork on the remote station that points back to the
- Sign Certificate (omponent: SignCertificateStep) signs a certificate (typically a server certificate) for each remote platform in the job.
- Update Connections Using Niagara Network Discovery (component: NiagaraNetworkDiscoveryStep) – updates station connections using NiagaraNetwork discovery.
- Update Connections Using Provisioning Station’s DHCP Server (component: DhcpDiscoveryStep) – updates station connections using the provisioning station’s DHCP server leases.
- Upgrade Out-of-Date Software (component: SoftwareStationExt) – installs software, upgrades out-of-date software, supports copy supervisor step, and the reboot step.
- Update Template or Application Configuration (component: UpdateConfigurationStep updates the template configuration values of an installed template in each remote station.
- Update Licenses job step (component: UpdateLicensesJobStep – updates software license in each remote host.
- Upgrade Application Template (UpgradeApplicationStep) upgrades the installed application template in each remote host.
- Upgrade Out-of-Date Software (UpgradeOutOfDateStep) compares module versions on the target hosts with the latest versions in the
- Upgrade Template (component: UpgradeTemplateStep) - upgrades deployed component template instances on each station using and Excel file.