Device Lifecycle

Prev Next

With Graphiant, it’s easy to navigate all of your device service and maintenance needs in one place.

From viewing the states of your Edges, to creating bootstrap tokens for onboarding, it’s easy to manage all of your devices in the Device Lifecycle center.

Locating the Device Lifecycle in the Graphiant Portal

From the Graphiant Portal home screen, click ‘Maintain’ in the left sidebar;  select ‘Device Lifecycle’.

Dashboard overview showing device lifecycle and usage statistics for user management.

This will take you to the Device Lifecycle area of the Graphiant Portal.

Overview of device lifecycle status, including active, staging, and upgrade information.

Devices Information

The Landing page for the Device Lifecycle area is the “Devices” tab.

Here you can:

  • Visualize:

    • The states of your Graphiant devices

    • What devices are scheduled to be upgraded

    • Any devices whose software is End-Of-Life

    • Any failed upgrades

  • Change the state of your devices

  • Schedule an upgrade

Overview of device lifecycle status, including active, staging, and upgrade information.

The filters at the top are clickable and will show you which devices currently fall into the following categories:

  • Active:  Up and running and connected to the Graphiant Core

  • Staging:  Provisioned but not currently connected to the Graphiant Core

  • Maintenance:  Online but not receiving traffic; possibly due to undergoing configuration changes (click here for further information on Maintenance Mode)

  • Scheduled Upgrades:  Marked to receive a software release upgrade

  • EOL Software:  Configured with a software release that is at End-Of-Life for support

  • Upgrade Failures: Experiencing a failure at upgrade

To deselect a filter, simply click that filter box again.

Note:

Only one filter at a time may be activated;  filters are not stackable.

Overview of device lifecycle status including active, staging, and upgrade failures.

The Devices table shows the following:

  • Upgrade Status:  Whether the device is up to date, or an upgrade is available

    • Upon hover, you will see:

      • The Release Train you are on (Latest or Recommended)

      • The Version currently installed

      • For “Up to Date” devices, the date that version was installed

Software details showing version, release train, and installation date information.

  • For “Upgrade Available” devices, the version that is available

Software details showing upgrade status, current version, and latest version information.

  • Host Name:  The name of your device

  • Site:  Where the device is located and configured

  • Lifecycle State:  Whether the device is:

    • Active:  Up and running and connected to the Graphiant Core

    • In Staging:  Provisioned but not currently connected to the Graphiant Core

    • In Maintenance:  Having configurations performed on them;  online but not receiving traffic (click here for further information on Maintenance Mode)

  • Software Version:  Which software is currently running on the device

  • Rollout Name: [**coming soon]

Device lifecycle management table showing upgrade statuses and software versions for devices.

Changing the Lifecycle State of Your Graphiant Device

Should you need to change the lifecycle of your device, click on the ellipses to its right;  select ‘Change Lifecycle State’.

Device lifecycle management interface showing active and staging devices with upgrade options.

Alternatively, if multiple devices are selected, the actions are listed at the top of the table.

Select ‘Change Lifecycle State’.

Device lifecycle management interface showing upgrade options and device statuses.

A modal will appear to set the state change, along with the number of devices selected that will receive the change.

Click the carat to see the state options.

Popup window for changing device lifecycle state with selection options.

Select the desired state from the dropdown.

Popup window for changing device lifecycle state with options to select mode.

Confirm the selection;  click ‘Change Mode’ to proceed.

Dialog box for changing device lifecycle state to maintenance mode.

You will receive a notification that the state change was successful, and the table will be updated to reflect the new lifecycle state.

Device lifecycle management interface showing status updates and upgrade options for devices.

Scheduling a Manual Upgrade of Your Graphiant Device

Should you want to manually upgrade your device, click on the ellipses to the right of that device;  select ‘Schedule Manual Upgrade’.

Device lifecycle management interface showing upgrade statuses and options for devices.

Alternatively, if multiple devices are selected, the actions are listed at the top of the table.

Select ‘Schedule Manual Upgrade’.

Device lifecycle management interface showing upgrade options and device statuses.

This will open a modal to customize your upgrade.

Fill out the following fields:

  • Upgrade Type:

    • Download and Install:  Install the software to your device as well as have a copy downloaded

    • Download Only:  Download the software, install at a later date

  • Upgrade Timing:

    • Now:  The upgrade will happen immediately

    • Later:  The upgrade will be scheduled for a future time and date in a calendar that will appear here

  • Select Version:

    • Recommended:  The software that is released every 3 months, after having been utilized and tested for three months prior.  See more information on Recommended Releases.

    • Latest:  The software version that is released every month with the most recent features.  See more information on Latest Releases.

Options for scheduling a software upgrade, including timing and version selection.

Once you have filled in the desired information,  click ‘Schedule Upgrade’.

Schedule a manual software upgrade by selecting options for timing and version.

Software Upgrade Scheduled for “Now”

If you selected “Now” for your upgrade, the device will immediately start the process.

While the software is upgrading, the device will be put in Maintenance Mode, and the status will read “Upgrade in Progress”.  Click here for further information on Maintenance Mode.

Device lifecycle management showing upgrade status and maintenance for various devices.

When complete, the device will have a status of “Up to Date” in the Device table.

Device lifecycle management table showing upgrade status and active devices.

Software Upgrade Scheduled for “Later”

If you selected “Later” for your upgrade, the device will show an Upgrade Status of “Upgrade Scheduled”.

Device lifecycle management showing upgrade status and software versions for various devices.

Upon hover, you will see:

  • The Release Train of the software to be installed upon upgrade

  • The software Version that will be installed

  • The date & time that the upgrade will occur

Software upgrade status showing scheduled and available updates with version details.

Performing Rollback to the Previous Software Version

If your device has the Status of “Up to Date” you can roll back to the prior version of software.

Note:

You can only roll back to the software version that was immediately prior to the current software.

Devices that have a Status of “Upgrade Available” will not have this option.

Click the ellipses;  select ‘Rollback to Previous Version’.

Device lifecycle management table showing upgrade statuses and actions for various devices.

A modal will appear confirming the rollback intention, and that a brief service interruption may be experienced during the process.

Click ‘Rollback Devices’.

Confirmation prompt for rolling back a device to a previous software version.

While the rollback is in progress, the device will automatically be put into Maintenance Mode.  Click here for further information on Maintenance Mode.

Device lifecycle management showing upgrade status and maintenance for various devices.

The device will now be back on the prior software version, and out of Maintenance Mode.

Note:

You can upgrade again at any time.

Device lifecycle management showing upgrade status and active devices in a table format.

Provisioning Information for Your New Graphiant Device

If you have a new device, the “Provisioning” tab of Device Lifecycle is the place for you to set up your new device.

Here you can:

  • Download current software versions to load onto a new device

  • Generate custom, device-specific tokens for use upon initial boot-up

Overview of device lifecycle status, including active, staging, and upgrade information.

Downloading Up to Date Software to Load onto Your New Graphiant Device

The downloads of current software versions are found under “System Images:”.

The dates within each Release train indicate when it was last updated.

System images section showing recommended and latest software versions for devices.

Click the carat to see the format options for the software version of your choice.

Device lifecycle management interface showing recommended system images and bootstrap tokens.

Select the download file that works best for your device.

Download options for recommended system images in device lifecycle provisioning interface.

You will receive a green banner stating that the image download has begun.

Device lifecycle management interface showing successful image download notification and token details.

Bootstrap Tokens

Graphiant offers Bootstrap Tokens, making it quick and easy to have a basic configuration immediately installed upon boot-up, allowing a new device to connect to the Graphiant network.

Whether you have procured your hardware on your own, or have a new virtual machine, you can onboard it to the Graphiant network using Bootstrap Tokens.

Bootstrap Tokens are located at the bottom of the Provisioning Tab within the Device Lifecycle.

Note:

Each Bootstrap Token can be used only once.  They are unique and for one-time usage.

The table gives the following information:

  • Status:  Whether the token has been used or not

  • Used By:  If the token has been used, the Name and Serial Number of the device by which it was utilized

  • Token Name:  Assigned name of the token

  • Token:  The unique token ID

  • Mode:  

    • Simple:  The token contains “Name” and “Device Role” assigned only;  no advanced configuration

    • Custom:  The token contains advanced configuration options

  • Device Type (Custom Mode only):  What type of device by which the token will be used

Device lifecycle provisioning page showing bootstrap tokens and system images options.

Generating a New Bootstrap Token

To create a new Bootstrap Token, click ‘Generate Token’ at the top right of the Bootstrap Tokens table.

Device lifecycle provisioning page showing system images and token generation options.

Generating a Single Bootstrap Token

For one Bootstrap Token, in filling out the Basic Configuration, complete the following required fields:

  • Number of Tokens:  Leave as “1”

  • Token Name:  Type the name with which you want to refer to this token

  • Device Role:  Choose from:

    • CPE:  Edge Connectivity to the Graphiant Core

    • Gateway:  Direct cloud connectivity to the Graphiant Core

Configuration screen for generating a token with device role options and input fields.

From here you can either:

  1. Click ‘Generate Token’:

    When you click ‘Generate Token’:

    It will also download the Cloud Init files to your computer.


    Configuration settings for generating a token in a cloud environment interface.

    OR

  1. Add Advanced Configuration information (optional):

Advanced Configuration contains the following:

Note:

Each one of these fields is optional.

  • Device and Interface Configuration — customizes the network settings to your device

    • Device Type:  The name / model that matches your device

    • Hostname:  Name assigned to your device

  • Management Interface — For local device access and configuration;  If not specified, this will pre-populate.

    • Management Interface:  Ethernet interface to reach the device

  • WAN Interface — Defines the interface and network settings used for WAN connectivity;  If not specified, this will pre-populate.

    • WAN Interface:  Interface that will connect to the Graphiant Core

  • Custom Configuration — Advanced device-specific configuration for the Cloud Init file

    • LWS Toggle:  Option to enable the Local Web Server to access locally

      • If toggled on, a password is required.

    • DNS Servers:  IP address to the DNS server your device will use

Configuration options for generating tokens, including device settings and management interface.

Once you have completed the desired fields, click ‘Generate Token’.

When you click ‘Generate Token’:

It will also download the Cloud Init files to your computer.

Configuration settings for generating a token, including device and network options.

Once you have generated the token (using Advanced Configuration or not), you will receive a green banner stating that the token has been successfully generated, and the new Bootstrap Token will appear in the table.

Device lifecycle provisioning interface showing system images and bootstrap tokens for configuration.

Generating Multiple Bootstrap Tokens

If you need to create multiple Bootstrap Tokens:

  • Number of Tokens:  Enter as many as needed

  • Device Role:  Use the dropdown to choose:

    • CPE:  Edge Connectivity to the Graphiant Core

    • Gateway:  Direct cloud connectivity to the Graphiant Core

Note:

The name field is not present here, as this information will be gathered later.

Then click the carat to access Advanced Configuration

Configuration settings for generating three tokens with device role CPE.

Click the carat to open the dropdown for Device Type.

Configuration settings for generating tokens, including device type and role options.

Select the name / model that matches your device.

Note:

When configuring multiple bootstrap tokens at once, they must all be the same Device Type.

Configuration settings for generating tokens in a cloud environment interface.

You will see a box that contains a link to a worksheet where you will input the configurations for your tokens.

Click ‘Bulk Import Worksheet’.

Configuration interface for importing hardware settings using a CSV file worksheet.

The worksheet will have headers asking for your configuration information.

Fill out the rows beneath the headers with your corresponding configuration data as shown below.

For Local Web Password:

If you fill out this column for any token, the Graphiant Portal will know to enable Local Web Server in your configuration.

Table displaying device information including hostnames, IP addresses, and management types.

Select ‘Browse Files’ to select the completed worksheet.

Advanced configuration options for importing hardware configuration from CSV files.

Click ‘Upload file’ to provide the information to the Graphiant Portal.

Configuration settings for generating tokens and uploading a configuration file.

You will now see a green banner stating that your file was uploaded successfully.

You can preview your configuration by scrolling left and right through the information at the bottom of the modal.

Click ‘Generate Token’ once you have confirmed your data.

When you click ‘Generate Token’:

It will also download the Cloud Init files to your computer.

Configuration preview for generating tokens with device types and hostnames listed.

The new Bootstrap Tokens are now complete and in the table.

Device lifecycle provisioning page displaying bootstrap tokens and their statuses.

Copying a Bootstrap Token

To copy a Token value, click the ellipses to the right of that token;  select ‘Copy Token’.

Device lifecycle management interface showing system images and bootstrap tokens options.

You will see a green banner stating that the token is in your clipboard.

Device lifecycle management interface showing system images and bootstrap tokens for devices.

Downloading a Bootstrap Token File

Should you need to downloaded another copy of the file, click the ellipses to the right of the desired token;  select ‘Download File’.

Device lifecycle management interface showing system images and bootstrap tokens options.

The configuration will be downloaded on your computer as a .zip file.

Duplicating a Bootstrap Token Configuration

Sometimes you may wish to make token configurations that are either the same as, or so similar to, another token that it’s easier to use a prior configuration and make minor adjustments.

In this case, you can just duplicate the original token configuration and tweak from there.

To duplicate a configuration, click the ellipses to the right of the token whose configuration is to be duplicated;  select ‘Duplicate Configuration’.

Device lifecycle management interface showing system images and bootstrap tokens options.

This will open a modal for a Duplicate Bootstrap.

The configuration will be identical, except for the Token Name, which will be “[Original Token Name] - Copy”.

Make any alterations needed, including the name.

Configuration screen for duplicating a token with highlighted token name and options.

You will see a green banner stating that the token was successfully generated and the duplicated token will appear in the table.

Bootstrap tokens table showing unused tokens and their details for device provisioning.

Deleting a Bootstrap Token

Should you no longer need a previously-created token, it can be deleted easily.

Click the ellipses to the right of the token to be deleted;  select ‘Delete Token’.

Device lifecycle management interface showing system images and bootstrap tokens for configuration.

A warning modal will appear:

Warning:

You will no longer be able to download a Cloud Init file for the deleted token.

Click ‘Delete Token’.

Warning message about deleting a token with confirmation options displayed.

You will receive a green banner stating that the token was successfully deleted, and it will no longer appear in the table.

Device lifecycle management interface showing system images and bootstrap tokens.