Deploy Configuration Templates to Devices
In Administration Portal, users with the SP (Service Provider) Administrator role (on-premises installation only) or OpCo (Operating Company) Administrator role can deploy a configuration template directly on one or more devices that were previously activated. This enables you to deploy configuration templates added after a device was activated or to deploy additional configuration to devices.
You can deploy configuration templates to devices from the Configuration Templates or Tenant Devices pages.
In CSO releases before Release 5.1.0, configuration templates are called stage-2 configuration templates.
Deploy from the Configuration Templates Page
To deploy a configuration template to one or more devices:
- Select Resources > Templates > Configuration Templates.
The Configuration Templates page appears.
- Select the configuration template that you want deploy
and click Deploy to Devices.
If you select a configuration template that was added in CSO Release 5.3.0, the Deploy Template Template-Name To Devices page appears. Proceed to Step 3.
If you select a configuration template that was added in a release before CSO Release 5.3.0, an alert message appears asking you to confirm whether you want to edit the template to automatically upgrade the template to the current CSO release version. You must go through the Edit workflow to upgrade the version.
- On the Edit Configuration Template page that appears,
proceed to the Summary tab and click OK.
The template is automatically upgraded to CSO Release 5.3.0 and the Configuration Templates page appears.
- Select the template again and click Deploy to Devices.
The Deploy Template Template-Name To Devices page appears.
- On the Edit Configuration Template page that appears,
proceed to the Summary tab and click OK.
- Complete the configuration according
to the guidelines provided in Table 1.
Note Fields marked with an asterisk (*) are mandatory.
- Click OK.
The settings that you entered are saved and you are returned to the Configuration Templates page. A confirmation message appears indicating that a job was created. For each device, a separate job is triggered to deploy the configuration.
You can view the status of the jobs from the Jobs page (Monitor > Jobs).
Table 1: Deploy Template <Template-Name> To Devices Settings
Setting | Guideline |
---|---|
Select Devices | |
Configuration Template | Displays the name of the configuration template that you are deploying; you cannot modify this field. |
Component Name | This field is displayed only for NFX250 devices. Select the component of the NFX250 device on which to deploy the template:
|
Devices | You can specify the devices on which you want to deploy the configuration template in the following ways:
Click Next. You are taken to the Configure Global Parameters or the Configure Device Parameters tab. |
Configure Global Parameters | Note: This tab is displayed only if the configuration template contains parameters that are global in scope. Specify the global parameters that are common to all the devices that you selected in the preceding step. After you are done, click Next. You are taken to the Configure Device Parameters tab. |
Configure Device Parameters | |
Devices | The devices that you selected in the preceding step are displayed in the Devices table, and the first device is selected by default. For each device, the device name, device family, operational status, and the configuration status are displayed. When you first arrive on this tab, the configuration status for each device is Not configured. The Device-Name Parameters pane on the right displays the input parameters (from the configuration template) that you can specify for each device. After you specify the values for one device, you can select a different device and enter the configuration values.
Note: You can optionally delete a device by selecting the device and clicking the delete (trash can) icon. After you specify the input parameter values for all the devices and ensure that the configuration status of all devices is Valid, click Next. You are taken to the Summary tab. |
Summary | |
Devices | The devices that you selected in the preceding step are displayed in the Devices table, and the first device is selected by default. For each device, the device name, device family, and operational status are displayed. For each device, the Device-Name Configuration pane on the right displays the actual configuration that will be deployed on the device. After you review the configuration for all the devices, click Next. You are taken to the Deploy tab. |
Deploy | |
Deployment Schedule | Specify whether the configuration should be deployed on devices immediately(Deploy now) or deployed later (Deploy later). If you choose to deploy the configuration later, you must enter the date (in MM/DD/YYYY format) and time (in HH:MM:SS 24-hour or AM/PM format) that you want the deployment to occur. |
Deploy from the Tenant Devices Page
To deploy a configuration template to one or more tenant devices:
- Select Resources > Tenant Devices.
The Tenant Devices page appears.
- Select one or more devices on which you want deploy and
click More > Deploy Configuration Template.
Note The devices that you select must belong to the same device family. If you select devices from different device families, CSO displays an error message.
The Deploy Template to Device Device-Name page appears.
- From the Configuration Templates table, select
the configuration template that you want to deploy and click Next.
The configuration templates displayed are filtered based on the device family of the devices that you selected.
If you select a configuration template that was added in CSO Release 5.3.0, proceed to Step 4.
If you select a configuration template that was added in a release before CSO Release 5.3.0, an alert message appears asking you to confirm whether you want to edit the template to automatically upgrade the template to the current CSO release version. You must go through the Edit workflow to upgrade the version.
- On the Edit Configuration Template page that appears,
proceed to the Summary tab and click OK.
The template is automatically upgraded to CSO Release 5.3.0 and the Tenant Devices page appears.
- Select the device again and click More > Deploy Configuration
Template.
The Deploy Template to Device Device-Name page appears.
- On the Edit Configuration Template page that appears,
proceed to the Summary tab and click OK.
- The rest of
the deploy workflow is the same as you encounter if you initiate the
deployment from the Configuration Templates page. Complete the configuration
according to the guidelines provided in Table 1.
Note Fields marked with an asterisk (*) are mandatory.
- Click OK.
The settings that you entered are saved and you are returned to the Tenant Devices page. A confirmation message appears indicating that a job was created. For each device, a separate job is triggered to deploy the configuration.
You can view the status of the jobs from the Jobs page (Monitor > Jobs).