Summary

Nomad integrates with Tachyon to enable pausing or resuming Nomad downloads throughout the estate. This feature provides a safety measure for situations when a faulty or harmful deployment is made by mistake. In such situations pausing Nomad downloads on all targeted devices can prevent or limit the potential damage.

It can also be used to facilitate troubleshooting, making it possible to pause all Nomad downloads across the network and enable IT teams to eliminate content distribution from their assessment of network bandwidth usage.

Support for this feature was originally introduced in Tachyon 3.3 and requires the Tachyon client (Tachyon Agent or 1E Client) deployed to all the devices where you want the pause feature enabled.

The latest version requires Tachyon Platform 5.2 and a valid Tachyon license.

The Nomad Download Pause feature lets you immediately pause or resume current and future Nomad downloads at the press of a button. It is integrated directly into the Configuration Manager console and lets you select the collections you want to control. The feature works by pausing Nomad's job queue and effectively pauses all downloads on that agent and those added later, until the queue is resumed. Tachyon is used as the medium to send the pause and resume actions to the devices in the selected collection in real-time.

The feature is designed with a fail-safe in mind such that when a pause is triggered it is only active for the next 24 hours. After 24 hours Nomad service automatically resumes the queue. This prevents the situation where a device receives a pause command but then fails to receive a corresponding resume command for an extended period due to network problems or because it is switched off.

Refer to Using Nomad for example scenarios about how systems administrators use Nomad to deploy software, software updates and operating system upgrades and how you can monitor those deployments using the Nomad app.
On this page:

Installing Nomad Download Pause

To use the Nomad Download Pause feature you will need to use the 1E Nomad Branch Admin Extensions installer (NomadBranchAdminUIExt.msi). For more details refer to Installing Nomad Configuration Manager console extensions.

Before you start

All users require the following permissions to install and use the Nomad Configuration Manager console extensions:

  • Local administrator rights on the computer - to install the console extensions
  • Configuration Manager console installed on the computer - to install and use the console extensions
  • Configuration Manager user with Full Administrator rights - to be able to use the Download Pause feature
  • Tachyon (or later) installed and working - you must know and enter the full URL for the Tachyon website in the installer.

The Nomad Download Pause feature requires:

  • Tachyon Platform 5.2 installed
  • Uploaded Tachyon instructions
  • Permissions allowing Configuration Manager (CM) administrators to execute the uploaded instructions.

These steps should be completed by a user that has Global Admin role in Tachyon, refer to Installing the Nomad app and 1E Content Distribution for details about Tachyon Platform setup, Nomad Administrators role and the 1E Nomad product pack.

Upgrading

If you are upgrading Nomad or Tachyon and you have previously installed Nomad Download Pause then you can continue using your existing setup, you do not need to do anything further, and you can ignore the steps below. However...

  • You are recommended to rename the instruction set from Nomad Core Instructions to 1E Nomad to match the name used in the steps below for new installations. The renamed set will retain the permissions you previously configured.
  • The 1E-Nomad product pack (included in the Tachyon Platform download zip) includes new versions of the same instructions. A list of these instructions is provided below under the heading 1E-Nomad product pack, which include the two instructions required by Nomad Download Pause.

In previous versions of Nomad, you were advised not to change the name of the instruction set. This was because the NomadBranchAdminUIExt.msi installer uploaded the instructions into an instruction set named Nomad Core Instructions. From version 7.0.200 onwards, this restriction no longer applies, because the instructions are no longer in the installer, and instead are only available in the 1E-Nomad product pack.

The installation steps below use the Settings app to create the 1E Nomad instruction set and upload instructions for a new installation. However, if you instead use the Tachyon Product Pack Deployment Tool to upload the 1E Nomad product pack, the tool will create an instruction set called 1E Nomad and place new instructions there. If the instruction set Nomad Core Instructions has not been renamed, any existing instructions in it will remain or be updated if they are new versions. You may end up with two instruction sets. You can keep both sets, or you can do the following which will retain the permissions you previously configured:

  • move the new instructions from 1E Nomad to Nomad Core Instructions
  • delete the now empty instruction set 1E Nomad
  • rename the old instruction set from Nomad Core Instructions to 1E Nomad

Installing Nomad Configuration Manager console extensions

The following steps describe how to run the 1E Nomad Branch Admin Extensions installer interactively, for more details and how to install from the command line, refer to Installing Nomad Configuration Manager console extensions.

The Configuration Manager console must not be running when the 1E Nomad Branch Admin Extensions installer is run.

The Nomad Configuration Manager console extensions are installed where the Configuration Manager Console is installed. This is done by running NomadBranchAdminUIExt.msi from an elevated command prompt.

Installing interactively

To install:

  1. Download the Nomad Branch software ZIP file from our Support portal.
  2. Extract NomadBranchAdminUIExt.msi from the downloaded ZIP file.

Start a Command Prompt with elevated rights, navigate to the location where you extracted NomadBranchAdminUIExt.msi and run it with the following command-line:

> msiexec /i NomadBranchAdminUIExt.msi /l*v NomadBranchAdminUIExtInstall.log REBOOT=REALLYSUPPRESS

Nomad and Platform Integration

Before installing this feature, please refer to Nomad Download Pause, for steps on configuring the prerequisites.

You need to supply the root URL to the Tachyon API. Which will be in the form: https://<Tachyon DNS Alias FQDN> using the Tachyon DNS Alias FQDN defined when Tachyon was installed.

For example if Tachyon was installed using tachyon.acme.local as the DNS Alias FQDN then the Tachyon API Root URL should be set to:

https://tachyon.acme.local

The Tachyon API is Tachyon's Consumer API. You can learn more about Tachyon in Tachyon Platform 5.2.

Click Next to continue.

Nomad and Tachyon Platform Integration

Confirming Nomad Download Pause installation

It is good practice to confirm the installation of the Nomad Download Pause components in both Tachyon and Configuration Manager (CM).

Confirm the installation in Tachyon

  1. Logon to Tachyon Platform as a user with at least Consumer Administrators, Instruction Set Administrators and Permissions Administrators roles and click the Settings app from the Tachyon Portal
  2. On the Consumers page check the following:
    1. A consumer with the name Nomad is already listed.

      This consumer name will have been registered already by one of the following methods:

      • installation of the Nomad Configuration Manager console extensions, if the installation account had the correct Tachyon user permissions
      • a previous installation of Nomad Configuration Manager console extensions
      • installation of the Nomad app and Content Distribution by Tachyon Setup
  3. On the Instruction→Instructions sets page check the following:
    1. 1E Nomad instruction set exists, and contains the following two instructions:

      • Pause the Nomad job queue for <PauseDurationMinutes> minutes
      • Resume the paused Nomad job queue.

  4. On the Permissions page check the following:
    1. On the Roles tab check that the Nomad Administrators role has been created with Actioner permissions on the 1E Nomad set.

    2. Click on the Nomad Administrators→Management Groups tab, and click on the Add button. Select All Devices in the Add management group popup, and then click Add.

      If other management groups are selected instead then members of this role can only use the instructions on devices belonging to those management groups.

    3. On the Permissions→Users tab check that all Configuration Manager users and groups that have the "Full Administrator" role have been added to Tachyon as users.

      You may remove users if you know they do not require Tachyon permissions. However, they will be re-added the next time the installer is run and the installation account has permissions to add users.

      You may add additional users and groups manually.

    4. Select each of the added Configuration Manager users in turn and check that they have the Nomad Administrators role added.

      These permissions ensure all current CM "Full Administrators" are able to use the Nomad Download Pause feature by allowing them to execute the Tachyon instructions. Any other users or groups will need to be manually added to the Nomad Admins role.

Confirm the installation in Configuration Manager

  1. On the Administration Client Settings page check the following:
    1. Right-click on Default Client Settings and check that a 1E Nomad sub-menu has been added to the context menu containing a Nomad Properties menu item
  2. On the Assets and Compliance→Device Collections page check the following:
    1. Two Nomad related buttons have been added to the Home ribbon:
      1. Pause Nomad Downloads
      2. Resume Nomad Downloads

If all these checks have passed you should have a working installation of the Nomad Download Pause feature.

Using Nomad Download Pause

Pausing Nomad downloads

The Nomad Download Pause feature can be applied to a collection of devices. To do this:

  1. Select the collection you want and click the Pause Nomad Downloads button or select the Pause Nomad Downloads menu item from the collection's right-click context menu.
  2. A Nomad Job Queue Management dialog will appear asking explaining the consequences of continuing. If you want to continue. Click Yes to proceed and No to cancel.
  3. If you click Yes, a Pausing Nomad downloads dialog will appear showing the progress of the process. This should reach 100% with no errors, at this point click Done to close the dialog.
  4. When applied, the Nomad downloads on the selected collection will be paused for a period of 24 hours - after which they will resume automatically.


Checking paused collections in Configuration Manager

When a collection has been successfully paused an entry will appear on the Monitoring→1E Nomad→Paused Collections page, as shown in the picture opposite.

From here you can view the following information:

ColumnDescription
Collection IdThe Configuration Manager ID for the device collection
CollectionThe friendly name of the device collection
Status

The current paused status for the collection. The values in this column can show one of two states:

StateDescription
PausedThis state indicates that all the devices in the collection have been paused.
Partially PausedThis state indicates that some but not all the devices in the collection have been paused. This may happen if some devices in the collection are currently offline or the pause action is interrupted while Nomad is sending the instruction request to Tachyon.
Remaining TimeThis column shows the time remaining for the pause to be in effect. After the stated time the devices in the collection will automatically resume their Nomad job queues.

From this page you can also select to resume the paused collection by clicking on the Resume button or by selecting the Resume menu item from the collection's right-click context menu.

As soon as the Nomad job queue for the entire collection has been resumed the entry will disappear from the Monitoring→1E Nomad→Paused Collections page.

Checking the Pause instruction in Tachyon

You can check the progress of the pause process by looking at the instruction history in Tachyon:

  1. Log onto Tachyon using an account which has full Configuration Manager administrator access.
  2. Navigate to Explorer→Instructions→History, in the example shown we have filtered the Consumer to only show results related to Nomad.
  3. You should see an entry for the Pause the Nomad job queue for 1440 minutes instruction.
  4. Clicking on the instruction shows a detailed breakdown of the response from each device in the selected collection.

Resuming Nomad downloads

If you want to resume the Nomad downloads for a collection at any time during the 24 hours, you can

  1. Select the collection you want and click the Resume Nomad downloads button.
  2. Nomad Job Queue Management dialog will appear asking explaining the consequences of continuing. If you want to continue. Click Yes to proceed and No to cancel.
  3. If you click Yes, a Resuming Nomad downloads dialog will appear showing the progress of the process. This should reach 100% with no errors, at this point click Done to close the dialog.
  4. When applied, the Nomad downloads on the selected collection will be immediately resumed from where they left off.

As soon as the Nomad job queue for the collection has been resumed the paused collection entry will also disappear from the Monitoring 1E Nomad, Paused Collections page.

Checking the Resume instruction in Tachyon Platform

You can check the progress of the resume process by looking at the instruction history in Tachyon, using the same steps as Checking the Pause instruction in Tachyon:

  1. Log onto Tachyon using an account which has full Configuration Manager administrator access.
  2. Navigate to Explorer→Instructions→History, in the example shown we have filtered the Consumer to only show results related to Nomad.
  3. You should see an entry for the Resume the paused Nomad job queue instruction.
  4. Clicking on the instruction shows a detailed breakdown of the response from each device in the selected collection.

Troubleshooting

A typical error that can occur during the pause or resume process is if any of the devices in the selected collection do not have the 1E Clients installed. You can fix this by installing the 1E Client on all devices in the collection, refer to Installing the 1E Client for Nomad for details.

1E-Nomad product pack

This product pack is used to create the 1E Nomad instruction set required by the Download Pause feature.

Instruction text (ReadablePayload)TypeDescriptionInstruction file nameVersion

Pause the Nomad job queue for <PauseDurationMinutes> minutes

ActionPause Nomad job queue. Required by Nomad Download Pause feature.
1E-Nomad-PauseNomadJobQueue.xml
15

Resume the paused Nomad job queue

Action

Resume paused Nomad job queue. Required by Nomad Download Pause feature.

1E-Nomad-ResumeNomadJobQueue.xml
12