The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The high-level steps below summarize the workflow using the Ultra Web Services (UWS) – AutoDeploy interface.
Step 1 | Create a new service deployment by following the instructions in Create a new Service Deployment, or upload a YANG compliant service deployment configuration XML file by following the instructions in Upload a Service Deployment Configuration. |
Step 2 | (Optional) Add or remove site(s) from the service deployment by following the instructions in Add/Remove Site(s) from a Service Deployment. |
Step 3 | (Optional) Add or remove AutoVNF(s) from a site by following the instructions in Add/Remove AutoVNF from a Site. |
Step 4 | Activate the VIM-Orch for a site by following the instructions in Activate VIM-Orch. |
Step 5 | Activate the VIM for a site by following the instructions in Activate VIM. |
Step 6 | Add (if not previously configured) or update (existing configuration) the AutoIT configuration information by following the instructions in Add/Edit AutoIT Information. |
Step 7 | Add (if not previously configured) or update (existing configuration) the AutoIT-VNF configuration information by following the instructions in Add/Edit AutoIT-VNF Information. |
Step 8 | Activate a service deployment, a site within the service deployment, or an AutoVNF within a site by following the instructions in Activate a Service Deployment, Activate a Site, or Activate AutoVNF respectively. |
Step 9 | (Optional) Dectivate a service deployment, a site within the service deployment, VIM-Orch, VIM, or an AutoVNF within a site by following the instructions in Deactivate a Service Deployment, Deactivate a Site, Deactivate VIM-Orch, Deactivate VIM, or Deactivate AutoVNF respectively. |
Step 10 | (Optional) At any point, view the transaction logs to monitor the activation or deactivation of the service deployment, site, or AutoVNF by following the instructions in View User Transaction Logs. |
Step 11 | (Optional) View and manage the secure tokens in the system by following the instructions in Manage Secure Tokens. |
Step 12 | Launch the UWS – AutoVNF interface to monitor various AutoVNF parameters in real-time by following the instructions in Launch UWS – AutoVNF Interface. |
Use the following task to create a new service deployment:
Step 1 | From the Service Deployment screen, click Create.
The Create Service Deployment screen pops up. |
Step 2 | Specify the name for the service deployment. |
Step 3 | Specify an appropriate description. |
Step 4 | Click Submit.
A new service deployment will be created. |
Use the following task to upload a service deployment configuration XML file:
Ensure that the YANG compliant service deployment configuration XML file is available. Refer the Cisco Ultra Services Platform Deployment Automation Guide for information on creating the configuration file.
Step 1 | From the Service Deployment screen, click Upload.
The Add Service Deployment screen pops up. |
Step 2 | Click Drop File Here in the Add Service Deployment screen. |
Step 3 | Navigate and select the Service Deployment configuration XML file from the local directory.
The XML file will be validated and listed in the Add Service Deployment screen on successful validation. |
Step 4 | Click Submit. |
Log into the USP UWS - AutoDeploy interface, and use the following task to upload a configuration XML file for a site (including the VIM-Orch and VIM configuration information):
Ensure that the YANG compliant site deployment configuration XML file is available. Refer the Cisco Ultra Services Platform Deployment Automation Guide for information on creating the configuration file.
Step 1 | From the Service Deployment screen, select the service deployment for which you want to upload the site, and click Upload.
Alternatively, click Catalog from the Left navigation pane, and click Upload. The Add Service Deployment screen pops up. |
Step 2 | Click Drop File Here in the Add Service Deployment screen. |
Step 3 | Navigate and select the XML file that contains the configuration information for the site from the local directory.
The XML file will be validated and listed in the Add Service Deployment screen on successful validation. |
Step 4 | Click Submit. |
Log into the USP UWS - AutoDeploy interface, and use the following task to upload a configuration XML file:
Ensure that the YANG compliant AutoVNF deployment configuration XML file is available. Refer the Cisco Ultra Services Platform Deployment Automation Guide for information on creating the configuration file.
Step 1 | From the Service Deployment screen, click Upload.
The Add Service Deployment screen pops up. |
Step 2 | Click Drop File Here in the Add Service Deployment screen. |
Step 3 | Navigate and select the configuration XML file from the local directory.
The XML file will be validated and listed in the Add Service Deployment screen on successful validation. |
Step 4 | Click Submit. |
The Security Catalog screen displays all the secure tokens for users configured in the system. To add a new secure token, use the following task to upload a configuration XML file that contains the secure token(s):
Step 1 | Click the left navigation icon in the USP UWS – AutoDeploy User Interface. |
Step 2 | Click Security Catalog.
The Security Catalog screen appears with a list of all the configured secure tokens. |
Step 3 | To add a new secure token, click Upload.
The Add Security Catalog window pops up. |
Step 4 | Click Drop File Here in the Add Security Catalog screen. |
Step 5 | Navigate and select the configuration XML file with the secure token from the local directory.
The XML file will be validated and listed in the Add Security Catalog screen on successful validation. |
Step 6 | Click Submit. |
Use the following task to add or remove site(s) from a service deployment:
Ensure that the site you want to add is not in use by other service deployments.
Step 1 | From the Service Deployment screen, click the service deployment you want to edit. |
Step 2 | Click Edit.
The Edit Service Deployment screen opens with a list of all the configured sites on the left and the available sites on the right. |
Step 3 | To add a site to the service deployment, drag the site from the Available Sites (right) section to the Current Sites (left) section. |
Step 4 | To remove a site from the service deployment, drag the site from the Current Sites (left) section to the Available Sites (right) section |
Step 5 | Click Save. |
Refer Add/Edit AutoIT Information for more information.
Use the following task to add or remove an AutoVNF from a site:
Ensure that the AutoVNF you want to add is not in use by other sites.
Step 1 | Click Catalog from the Left navigation.
The catalog screen opens with a list of all the available sites. |
Step 2 | Click the site you want to edit. |
Step 3 | Click AutoVNFD. |
Step 4 | Click Edit (Add, if the site does not contain any AutoVNFs yet)
The Add AutoVNF Package screen opens with a list of all the configured AutoVNF on the left and the available AutoVNFs on the right. |
Step 5 | To add an AutoVNF to the site, drag the AutoVNF from the Available AutoVNF (right) section to the Current AutoVNF (left) section. |
Step 6 | To remove an AutoVNF from the site, drag the AutoVNF from the Current AutoVNF (left) section to the Available AutoVNF (right) section |
Step 7 | Click Save. |
The catalog section of the AutoDeploy interface lets you:
Upload configuration files individually for Sites, AutoVNFD, Vnf-Package, Vnf-Rack, VNFMD, and VNFD.
View the uploaded configuration.
Delete existing configuration.
Deleting Sites, AutoVNFD, Vnf-Package, Vnf-Rack, VNFMD, and VNFD through the Catalog section will permanently delete the configuration from the UWS.
Ensure that the YANG compliant configuration XML file is available for the component you want to upload. Refer the Cisco Ultra Services Platform Deployment Automation Guide for information on creating the configuration file.
You can view the configuration information for these components by selecting the uploaded configuration in their respective pages.
AutoIT-NFVI is the UAS software module used to automate the process of installing and deploying the virtual infrastructure manager (VIM) Orchestrator (synonymous with the OpenStack Undercloud) which manages the network function virtualization infrastructure (NFVI).
Sites can be activated from the Service Deployment screen only after the VIM-Orch and VIM are activated for the site. The Activate button in the Service Deployment and Site screens will be disabled until the VIM-Orch and VIM are successfully activated.
Use the following task to activate the VIM-Orch:
Ensure that the YANG compliant configuration XML file is uploaded with the following information:
![]() Note | A site can map to one VIM-Orch and VIM. |
For more information on uploading the configuration file, refer Upload a Service Deployment Configuration or Upload a Configuration for a Site.
Step 1 | From the Service Deployment screen, click on the service deployment with the site that contains the VIM-Orch and VIM configuration you want to activate.
The site information screen opens with a list of all the sites configured under the service deployment. |
Step 2 | Click on the site that contains the VIM-Orch and VIM configuration you want to activate. |
Step 3 | Click any of the options (except AutoIT-NFVI) under the site. |
Step 4 | Review the configuration information for the VIM-Orch, and click Activate to activate the VIM-Orch.
On successful activation, the "Activated a Vim_Orch in a Service Deployment Successfully" message is displayed, and the Pod View screen opens with the configured node for the VIM-Orch (director node). |
Step 5 | You can monitor the status of the VIM-Orch deployment using the progress bar on the top of the page.
In the Icon view, the VIM-Orch icon, the node ID, and the IP address are displayed. |
If the VIM-Orch deployment fails, you can view the transaction logs to troubleshoot the issue. To view the transaction logs, refer View User Transaction Logs.
If activation of VIM-Orch is successful, activate VIM by following the instructions in Activate VIM.
AutoIT-NFVI is the UAS software module used to automate the process of installing and deploying the virtual infrastructure manager (VIM, synonymous with the OpenStack Overcloud) which manages the network function virtualization infrastructure (NFVI).
Sites can be activated from the Service Deployment screen only after VIM-Orch and VIM are activated for the site. The Activate button in the Service Deployment and Site screens will be disabled until the VIM-Orch and VIM are successfully activated.
Use the following task to activate VIM for the site:
Before activating VIM:
Ensure that the VIM-Orch for the site is activated. For more information, refer Activate VIM-Orch.
Ensure that the configuration for VIM is available as part of the configuration file uploaded to activate VIM-Orch. For more information, refer to the Before you begin section in Activate VIM-Orch.
Step 1 | From the Service Deployment screen, click on the service deployment with the site that contains the VIM configuration you want to activate.
The site information screen opens with a list of all the sites configured under the service deployment. |
Step 2 | Click on the site that contains the VIM you want to activate. |
Step 3 | Click any of the options (except AutoIT-NFVI) under the site. |
Step 4 | Select the VIM tab. |
Step 5 | Review the configuration information for VIM, and click Activate to activate the nodes.
On successful activation, the "Activated a Vim in a Service Deployment Successfully" message is displayed, and the Pod View screen opens with the configured nodes for VIM-Orch (director node) and VIM. A toggle button is available on the Pod View screen to view the deployment progress for VIM-Orch and VIM. By default, the toggle button is set to VIM-Orch. |
Step 6 | Click on the toggle button for VIM to view the progress bar for VIM. |
Step 7 | You can monitor the status of the deployment of the various nodes of VIM using the progress bar.
Each node (compute, controller, storage, and OSD compute) of VIM is identified by a separate node icon. In the Icon view, the node icon (to indicate the node type), the node ID, and the IP address are displayed. The status of the nodes are indicated by the color highlighted on the left side of the node: Blue indicates that the node is bootstrapped, Orange indicates that the node is shutting down, Grey indicates that the status of the node is unknown, and Green indicates that the node is activated successfully. Nodes can be filtered by the node type on the Pod screen using the Filters drop-down on the top left corner of Pod screen. Different operational data for each node is displayed depending on the type of node. |
If VIM deployment fails, you can view the transaction logs to troubleshoot the issue. To view the transaction logs, refer View User Transaction Logs.
If activation of VIM-Orch and VIM is successfully, add or edit the configuration information (manually) for AutoIT and/or AutoIT-VNF by following the instructions in Add/Edit AutoIT Information and/or Add/Edit AutoIT-VNF Information.
New AutoIT configuration information must be added (or existing configuration edited) manually using the Catalog navigation pane. When no AutoIT configuration exists for a site, the AutoIT tab under the Site Overview screen will be empty with the message "No AutoIT configuration present. Add AutoIT configuration under Catalog > Site."
Use the following task to add (or edit) the AutoIT information for a site:
Ensure that VIM-Orch and VIM are activated, and openstack is running. For more information, refer Activate VIM-Orch and Activate VIM.
Step 1 | Click Catalog from the Left navigation.
The catalog screen opens with a list of all the available sites. |
Step 2 | Click the site you want to edit. |
Step 3 | Click the AutoIT tab. |
Step 4 | Click Add to specify the AutoIT information (Edit to update existing AutoIT information). |
Step 5 | Specify(/update) the Authentication URL, Tenant, and Secure Token information.
Once VIM-Orch and VIM are activated, and OpenStack is running, log on to the AutoDeploy VM and use the following steps to determine the authentication URL: Alternatively, log on to the AutoDeploy VM and use the following steps to determine the authentication URL: |
Step 6 | Verify that the AutoIT configuration information is successfully added/updated by navigating to the AutoIT tab under the Site Overview screen (Service Deployment > Site). The configuration information added/updated through the Catalog must reflect in the AutoIT tab under the Site Overview screen. |
Add or edit the AutoIT-VNF configuration information by following the instructions in Add/Edit AutoIT-VNF Information.
New AutoIT-VNF configuration information must be added (or existing configuration edited) manually using the Catalog navigation pane. When no AutoIT-VNF configuration exists for a site, the AutoIT-VNF tab under the Site Overview screen will be empty with the message "No AutoIT-VNF configuration present. Add AutoIT-VNF configuration under Catalog > Site.".
Use the following task to add (or edit) the AutoIT-VNF information for a site:
Ensure that VIM-Orch and VIM are activated, and openstack is running. For more information, refer Activate VIM-Orch and Activate VIM.
Step 1 | Click Catalog from the Left navigation.
The catalog screen opens with a list of all the available sites. |
Step 2 | Click the site you want to edit. |
Step 3 | Click the AutoIT-VNF tab. |
Step 4 | Click Add to specify the AutoIT-VNF information (Edit to update existing AutoIT-VNF information). |
Step 5 | Specify/update the IP Address, Port Number, and Authentication-Info information. |
Step 6 | Verify that the AutoIT-VNF configuration information is successfully added/updated by navigating to the AutoIT-VNF tab under the Site Overview screen (Service Deployment > Site). The configuration information added/updated through the Catalog must reflect in the AutoIT-VNF tab under the Site Overview screen.
|
Add or remove AutoVNF for a site by following the instructions in Add/Remove AutoVNF from a Site.
Use the following task to deactivate (undeploy) the VIM-Orch:
Ensure that the VIM-Orch you want to deactivate (undeploy) is activated.
Step 1 | From the Service Deployment screen, click on the service deployment with the site that contains the VIM-Orch you want to deactivate.
The site information screen opens with a list of all the sites configured under the service deployment. |
Step 2 | Click on the site that contains the VIM-Orch you want to deactivate. |
Step 3 | Click any of the options (except AutoIT-NFVI) under the site. |
Step 4 | With the VIM-Orch tab selected, click Deactivate to deactivate VIM-Orch.
On deactivation, the "Deactivated a Vim_Orch in a Service Deployment Successfully" message is displayed. |
Use the following task to deactivate (undeploy) VIM:
Ensure that the VIM you want to deactivate (undeploy) is activated.
Step 1 | From the Service Deployment screen, click on the service deployment.
The site information screen opens with a list of all the sites configured under the service deployment. |
Step 2 | Click on the site that contains the VIM you want to deactivate. |
Step 3 | Click any of the options (except AutoIT-NFVI) under the site. |
Step 4 | With the VIM tab selected, click Deactivate to deactivate VIM.
On deactivation, the "Deactivated a Vim in a Service Deployment Successfully" message is displayed. |
When uploaded, a service deployment will appear as a configuration (config) type, and the tile border at the bottom of the service deployment will be highlighted in yellow. When activated, the type changes to a record, and the tile border at the bottom of the service deployment will be highlighted in blue.
When a service deployment is activated, all sites (and the VNFs within each site) within the service deployment are activated.
Use the following task to activate a service deployment:
Ensure that the YANG compliant deployment configuration XML file is uploaded, and the service deployment is available for activation. For more information, refer Upload a Service Deployment Configuration.
Ensure that the VIM-Orch for the site within the service deployment is activated. For more information, refer Activate VIM-Orch.
Ensure that the VIM for the site within the service deployment is activated. For more information, refer Activate VIM.
Verify that the AutoIT and AutoIT-VNF configuration information is successfully added/updated by navigating to the AutoIT and AutoIT-VNF tabs under the Site Overview screen (Service Deployment > Site) for all the Sites under the Service Deployment. The configuration information added/updated through the Catalog must reflect in the AutoIT and AutoIT-VNF tabs under the Site Overview screen. For more information, refer Add/Edit AutoIT Information and Add/Edit AutoIT-VNF Information.
Step 1 | From the Service Deployment screen, click the service deployment you want to activate.
The site information screen opens with a list of all the sites configured under the service deployment. |
Step 2 | Click Activate. |
You can view the transaction logs to monitor the activation of the service deployment. To view the transaction logs, refer View User Transaction Logs.
When uploaded, a site will appear as a configuration (config) type. When activated, the type changes to a record.
Use the following task to activate a site:
Ensure that the YANG compliant deployment configuration XML file is uploaded and available for activation. For more information, refer Upload a Configuration for a Site.
Ensure that the VIM-Orch for the site is activated. For more information, refer Activate VIM-Orch.
Ensure that the VIM for the site within the service deployment is activated. For more information, refer Activate VIM.
Verify that the AutoIT and AutoIT-VNF configuration information is successfully added/updated by navigating to the AutoIT and AutoIT-VNF tabs under the Site Overview screen (Service Deployment > Site). The configuration information added/updated through the Catalog must reflect in the AutoIT and AutoIT-VNF tabs under the Site Overview screen. For more information, refer Add/Edit AutoIT Information and Add/Edit AutoIT-VNF Information.
Step 1 | From the Service Deployment screen, click on the service deployment that contains the site you want to activate.
The site information screen opens with a list of all the sites configured under the service deployment. |
Step 2 | To activate a site, click on the site you want to activate.
A site-overview screen opens with configuration information on the specific site. |
Step 3 | Click Activate. |
You can view the transaction logs to monitor the activation of the site. To view the transaction logs, refer View User Transaction Logs.
When uploaded, an AutoVNF will appear as a configuration (config) type. When activated, the type changes to a record.
Use the following task to activate an AutoVNF:
Ensure that the YANG compliant deployment configuration XML file is uploaded and available for activation. For more information, refer Upload an AutoVNF Configuration.
Verify that the AutoIT and AutoIT-VNF configuration information is successfully added/updated by navigating to the AutoIT and AutoIT-VNF tabs under the Site Overview screen (Service Deployment > Site). The configuration information added/updated through the Catalog must reflect in the AutoIT and AutoIT-VNF tabs under the Site Overview screen. For more information, refer Add/Edit AutoIT Information and Add/Edit AutoIT-VNF Information.
Step 1 | From the Service Deployment screen, click on the service deployment with the site that contains the AutoVNF you want to activate.
The site information screen opens with a list of all the sites configured under the service deployment. |
Step 2 | Click on the site with the AutoVNF you want to activate.
A site-overview screen opens with configuration information on the specific site. |
Step 3 | Click Auto-VNF in the site-overview screen and click the AutoVNF you want to activate. |
Step 4 | Click Activate. |
Use the following task to view a list of all the transactions performed by the user, and open detailed logs for any transaction:
The UWS – AutoVNF interface provides real-time monitoring functionalities for various AutoVNF parameters. Use the following task to launch the USP UWS – AutoVNF interface:
Step 1 | Navigate to the Auto-Vnf Configuration Overview screen for the AutoVNF you want to monitor. |
Step 2 | Click the UWS – AutoVNF icon in the Auto-Vnf configuration overview banner. The USP UWS – AutoVNF Interface opens in a separate window on the browser. |
Use the following task to deactivate (undeploy) a service deployment record:
Ensure that the service deployment you want to deactivate is activated.
Step 1 | From the Service Deployment screen, click the service deployment you want to deactivate.
The site information screen opens with a list of all the sites configured under the service deployment. |
Step 2 | Click De-activate. |
You can view the transaction logs to monitor the deactivation of the service deployment. To view the transaction logs, refer View User Transaction Logs.
Use the following task to deactivate (undeploy) a site:
Ensure that the service site you want to deactivate (undeploy) is activated.
Step 1 | From the Service Deployment screen, click on the service deployment that contains the site you want to deactivate.
The site information screen opens with a list of all the sites configured under the service deployment. |
Step 2 | Click on the site you want to de-activate.
A site-overview screen opens with configuration information on the specific site. |
Step 3 | Click De-activate. |
You can view the transaction logs to monitor the deactivation of the service deployment. To view the transaction logs, refer View User Transaction Logs.
Use the following task to deactivate (undeploy) an AutoVNF:
Ensure that the AutoVNF you want to deactivate (undeploy) is activated.
Step 1 | From the Service Deployment screen, click on the service deployment with the site that contains the AutoVNF you want to activate.
The site information screen opens with a list of all the sites configured under the service deployment. |
Step 2 | Click on the site with the AutoVNF you want to activate.
A site-overview screen opens with configuration information on the specific site. |
Step 3 | Click Auto-VNF in the site-overview screen, and click the AutoVNF you want to de-activate.
An Auto-Vnf Configuration Overview screen opens. |
Step 4 | Click De-activate. |