Deployment

Upload

This functionality only works for oMG and MG devices.

Note: ALEOS devices must be configured using the Configuration Control and Configuration Template functionality, and it’s recommended that this functionality be used for MG devices as well. Configuration templates provide a much more granular level of configuration by allowing you to configure individual fields as opposed to uploading underlying device configuration files which contain multiple configuration settings.

The Upload tab is used to add individual configuration files (i.e. .yaml) and scripts to the configuration folder.

It is not possible to directly restore an MGOS configuration backup file via AMM using this feature.

Uploading the configuration file:

• Apply to^* : the gateways to which the file(s) will be copied to. Enter the gateway’s ESN or alias, or locate it in the Gateway Tree.
• Configuration file^* : click on Browse to locate the appropriate file(s) to copy. Up to four files can be uploaded at a time, by locating a file for each of the four Configuration File fields provided.
• Click on Upload to upload the file.
• Click on Filter to refine your selection of gateway(s) that will be affected.

^*denotes a required field

Upload for AirLinkOS

The Upload for AirLinkOS screen is only used to configure AOS gateway(s).

The template configuration is created and tested on a local AOS gateway and then exported as a JSON file. The JSON file is used by the Upload for AirLinkOS function to upload the configuration into the gateways in the field. Refer to the AirLink OS software guides, https://source.sierrawireless.com/airlinkos/, for more information.

Upon applying the upload, any non-AOS gateways in the selection are disregarded. The system then redirects you to the Configuration Control screen.

In Configuration Control, the state will change to Pending (Sync to device). Once the AOS gateway checks in, it will automatically apply the configuration, and if there are no errors, the state will update to Confirmed.

Uploading the AirLink OS configuration file:

• Apply to^* : the gateways to which the file(s) will be copied to. Enter the gateway’s ESN or alias, or locate it in the Gateway Tree.
• Configuration file^* : click on Choose File to locate the appropriate file to copy.
• Click on Upload to upload the file.
• Click on Filter to refine your selection of gateway(s) that will be affected.

^*denotes a required field

Copy

This functionality only works for oMG and MG devices.

The Copy screen is used to copy the configuration file from a gateway to be used as a template for other gateways. This screen is used in conjunction with the Configuration Control screen when copying configurations. For more information on this procedure see: Copying Configurations Between Gateways .

Note: ALEOS devices must be configured using the Configuration Control and Configuration Template functionality, and it’s recommended that this functionality be used for MG devices as well. Configuration templates provide a much more granular level of configuration by allowing you to configure individual fields as opposed to copying the underlying device’s configuration files which contain multiple configuration settings. An AOS device configuration cannot be copied from one gateway to another.

Copying the gateway’s configuration file:

• Source^* : the gateway from which the configuration files are being copied.
• Copy config to^* : the gateway to which the files are to be copied to. Enter the gateway’s ESN, alias or locate it in the Gateway Tree.

  Note: users can enter more than one gateway in this field for mass configuration.

• Configuration Files options :
  • All files: enabled by default, this will display all files with a checkmark beside each. Clicking Copy will therefore copy all files to the gateway. To copy specific files from the source gateway, uncheck All Files to deselect all files and place a checkmark beside each file to copy.

    Note: the files available for selection may vary depending on the selected device type.

• Skip version check : by default, configuration files can only be copied to gateways running the same software version. Version check therefore verifies that both the source and destination gateways have the same software version and ensures compatible configuration files. To override this restriction, enable this option.
• Skip platform check (applicable to ALEOS devices only) : by default, configuration files can only be copied to gateways of the same type. The platform check verifies that both the source and destination gateways are of the same type and ensures compatible configuration files. Enabling this option, overrides this restriction.
• Reboot automatically after changes are applied (applicable to ALEOS devices only) : when selected, the device will be rebooted after the copy operation has completed.

  Note: A separate reboot operation is not created when this option is selected.

• Copy : click to copy the file(s); this opens the Configuration Control screen.

  Note: this screen is also available by locating the source gateway in the Gateway Tree, right-clicking on it and selecting Copy Configuration .

^* denotes a required field

Configuration Control

The Configuration Control screen aids administrators during mass configuration deployment of their gateways. Configuration Control maintains current gateway configurations and stores them on the AMM. This allows administrators to easily manage configurations over the fleet.

This screen is used in conjunction with the Copy screen, when copying oMG and MG configurations, and Upload for AirLinkOS screen, when deploying a configuration to AOS gateways. This screen is also used when deploying configuration Templates .

The list of gateways displayed can be filtered by using the following filter fields:

• Filter edit box: filters the list on part or all of a gateway name. For more information about searches see: Filter Box and Searching .
• Range dropdown: can be used to select a date/time range of previous deployments to filter on. Selecting an option from the dropdown will display a field where the range can be input.
• Search revision comments: filters the list to include only those units which participated in a deployment where the specified comment was attached. Revision comments are used for identifying units which participate in PSK rotations (see the sections entitled “Deploying PSK Rotation through the AMM” for the WLAN and WAN WiFi settings on CSV Import | Export for more information).
• Search file contents: filters the list based on the contents of script files. This is useful for filtering on script content where specific changes (e.g. additions) have been made and uploaded to gateways.

Information is provided in the following columns:

• Gateway: lists the gateways connected to the AMM. The list is based on those gateways which are organized under the folder (and its subfolders) currently selected in the Gateway tree.
• # of Files: indicates the number of configured files.
• Modify Time: the date and time when the gateway’s configuration was last modified.
• Config Confirmed Time (AOS and ALEOS only): the time when the configuration of an AOS or ALEOS device was synchronized with the AMM. This field is applicable when the State (see below) is for ALEOS Config Confirmed or Config Confirmed with Warnings or for AOS devices Confirmed. This time value is provided for ALEOS and AOS devices because changes to the gateways depend on when they check in. For MG devices, this field does not apply and will display the same value as the Modify Time column.
• State: displays information which allows administrators to see the state of each gateway’s configuration in relation to the configuration stored on the AMM. See Gateway Configuration States for a list of all possible states, and Functions for the functions that can be initiated based on the state. You can hover your mouse over each state in the AMM to get additional details describing about why the device is in the current state (e.g. error state). You can click on a state to view its configuration change history and view the legacy state history.
• Heartbeat: Specifies when the device was last seen by/reported to the AMM.
• Software Version: the current software version of the gateway listed.
• Linked Template(s): lists the configuration Template(s) that were used to configure the device when the template(s) were deployed. For more information see Deploying a template.
• Functions: function buttons described below.

Functions

Note: For AMM 2.18, these functions are not supported for AOS devices and will not be selectable.

Buttons for the following functions are available on the Configuration Control screen:

• Sync Now (available for MG devices only): use this function to initiate synchronization between the gateway and the AMM. Always ensure that the configuration is in sync before making any changes to configuration files or pushing a new configuration to the gateway. Note: this button is only available when a single gateway is selected and is only available for MG gateways. To select a single gateway, click on a gateway’s link in the Deploy list, or select the gateway in the Gateway Tree.
• Revert: pulls the gateway’s copy of the configuration into the AMM regardless of the Sync State.

The following popup will appear upon clicking Revert if one or more of the selected gateways has a software configuration update currently in progress:

The popup’s warning indicates that one or more of the selected gateways has a software update currently in progress. Selecting Yes will configure the revert process to cancel any software updates currently in progress, before starting the revert process on those devices. Depending on the exact state of a given update that is in progress, it may not be possible to cancel an update on some devices and the AMM will display the reason(s) why in the Cancellable column.

Note: For software update configurations that may not be in sync with the AMM, the AMM can only detect these issues after Revert is clicked . If a remote configuration change happened directly from the device side (e.g., a user changed the software update configuration via the LCI causing a configuration sync process in the background), the AMM will not be able to recognize that the software update configuration on the AMM has been overwritten, and the popup will not be displayed.

If one or more of the selected gateways has outstanding template deployment operations, the following popup will appear upon clicking Revert.

The popup indicates that one or more of the selected gateways has template deployment operations currently outstanding. Selecting Continue will configure the revert process to cancel any template deployment operations currently in a state of Initialized, Pending or In Progress, before starting the revert process on those devices.

Note: If you add a gateway that has not yet registered with the AMM and deploy a template to it, a subsequent Revert action will remove it from the Configuration Control gateway list. In this situation, you will not be able to deploy any other templates, revert, or check the configuration state of the gateway, until it has checked in with the AMM and its full configuration is pulled by the AMM for the first time.

• Apply: applies changes made on the AMM’s copy of the configuration to the MG.
• Export Config History: Exports a CSV file listing each configuration change made, including the time it was performed, the user who initiated it, the related event, and details.

Errors from ALEOS devices

If a configuration change failed due to an unknown MSCI error returned from the gateway, the deployment summary screen may display one of the following errors:

1. “invalid id specified”: An invalid ID was specified.
2. “element is read-only”: A write request included a MSCI ID for an element which is read-only.
3. “invalid value provided”: A write request attempted to write an invalid value.
4. “invalid data element provided”: An invalid data element was encountered.
5. “insufficient permissions”: The client attempted to read/write a value for which it does not have the proper access level.
6. “invalid encryption” - The modem was unable to decrypt an encrypted data value.

Otherwise: “unknown reason” will be displayed.

Configuration Change History

Clicking on a gateway’s state in the State column of the Configuration Control screen unveils the following details about the gateway’s configuration change history:

• Summary: displays the current state, the date when it was reported/collected, and a description of the state.
• Events History: displays the history of the state, including the underlying configuration state changes.
• Template Deployment History: displays the history of the template configuration deployment to the device.
• Configuration Comparison Pane: Allows for direct comparison of advanced configuration settings. For use only by advanced users such as Sierra Wireless Support, who have advanced knowledge of configuration data.