Virtual Machine Management
Datacenters that support several thousand VMs sometimes require support across multiple clouds. Workload Manager provides a Virtual Machine (VM) management feature for such datacenters. This feature allows you to import VMs into Workload Manager and manage them directly from the UI.
From the Workload Manager perspective, VMs have two categories. Both categories are included in the CCM UI under a new tab called Virtual Machines. The following table describes the categories.
Displays VMs that are already managed by Workload Manager. This list includes Workload Manager deployed VMs and imported VMs.
VMware Cloud Nuances
VMware Tools must be installed and running on VMs before users can import these VMs into Workload Manager. Refer to the VMware documentation for additional details.
Displays VMs that are not yet managed, by Workload Manager. This list includes VMs discovered by Workload Manager.
To manage a VM displayed in this list, you must first import the VM to Workload Manager.
Once you import a VM from the Unmanaged list to the Managed list, VM actions are available based on the underlying cloud. Additional VM actions are available for the following clouds:
Permissions and Access Control
A Workload Manager user with admin permissions can import a VM listed in the Unmanaged into the Managed category.
Imported VMs do not have any default Understand ACLs permission. Permissions are derived based on the importer's invitations when importing the VM – you may have permission to log into the VM imported to Workload Manager but may not have permission (as a Workload Manager user) to upgrade the agent for this VM.
The VMs displayed in this list includes the following VMs:
Workload Manager Deployed VMs display 2 logos – the Application logo (if available) and the OS logo.
Imported VMs display 1 logo – the Imported VM icon.
The following screenshot displays a filtered list of Workload Manager Deployed VMs displayed in the Managed category.
Regardless of the default filter settings, the information in the following table applies to the summary displayed at the top of the Virtual Machines page:
The total number of running VMs for the selected time period.
This count depends on the selected filters.
The total number of running (billed) VMs for the entire deployment without any time restriction.
This count includes VMs that display the ERROR / NOT REACHABLE status.
The term Running VMs in this summary differs from the term Running in the status-based filter. To co-relate the Running VMs count in the summary, check Running, Starting, and Error (NODE NOT REACHABLE) Statuses.
|Cloud Cost||The cost of running the VMs|
|Est Monthly Cost|
The estimated hourly rate of running VMs (based on the VM status)
|VM Hours||The total number of running VM hours during the selected time period|
The following table identifies various aspects of the Virtual Machines tab:
|Identity||Screenshot and Description|
Mark any VM as a favorite by clicking the star icon next to the VM.
|Parent deployment link|
Displays the deployment name as a link. Click the link to view details about the parent deployment
|VM details link|
Displays the VM name as a link. Click the link to view details about the deployment. Depending on the cloud, the information displayed for this link differs:
Color-coded status indicator to identify the high-level status of the VM displayed in the Virtual Machine tab, they do not indicate the status of the deployment. The following table describes the statuses.
See Deployment, VM, and Container States for a complete list and additional details.
|Error VM Status|
This information is only provided if a Workload Manager deployed VM is in the Error state – Identifies one of the types of errors that the following screenshot shows and provides additional details on cause and correction tool tips.
If a VM is not deployed by Workload Manager is in the error state, then Error / Not Found state is displayed.
A Management Agent can be installed on VMs that have been imported into Workload Manager. This agent is an alternate option for VMs that do not require the capability to launch applications but do require some basic Workload Manager functionality like performing platform actions. If installed, the Virtual Machines page and the VM Details page displays the icon and version as identified in the following screenshot.
The benefit to installing this agent on an imported VM is that you have additional actions types that become available for this VM.
You can only install this agent on Managed VMs – You can have Workload Manager Deployed VMs or Imported VMs that are managed by Workload Manager but do not have agent installed.
You cannot install this agent on Unmanaged VMs. You must first import the VM to the Managed list and then install the agent on that VM.
The Management Agent does not support the use of the Artifactory repository.
This option is not visible to users with only View permissions. Users require Manage permission to view this option that is only available on Managed VMs. Users will not see this option for Managed VMs that are in a terminated state.
When you click the link for a VM in the Virtual Machines tab, you see the server Details page, as shown in the following screenshot:
The Details tab (default) provides exhaustive details for the VM.
If any of your VM details are missing or showing zero values, click the Sync VM Details button to refresh the data.
The Logs tab provides the entire list of VM deployments details.
The History tab provides a complete history for all actions (succeeded, failed, occurred) performed on this VM.
The Available Actions (in the Actions panel) that you can perform for this VM. See Actions Library for additional context.
The IPV6 Address field identifies validated IPv6 addresses. See IP address allocation for additional context.
VM errors, if any, are displayed at the top of the Virtual Machines page and the VM Details page, as shown in the following screenshot:
Click the X to dismiss the error.
Click View Details to access the reason for the error.
Click Dismiss to remove it from being listed in the page.
The VMs displayed in this list include VMs discovered by Workload Manager. These VMs were launched/deployed outside of Workload Manager. When Workload Manager connects to a cloud account, all VMs in that cloud account are displayed in the Unmanaged VMs list.
This category is only visible to Admin users – the administrator and the cloud account owner to import a VM from this category into the Managed category.
The following screenshot displays a filtered list of ALL VMs displayed in the Unmanaged category.
Import to Workload Manager
A Workload Manager user who is the administrator and who is the cloud account owner can import a VM listed in the Unmanaged into the Managed category. To Import a VM, you must:
- Import a VM which into Workload Manager only if it is already running.
Be the administrator (only Admin users can create cloud accounts).
Be the cloud Account Owner – the following screenshot illustrates where you can locate the account owner permissions for each cloud region.
You can import unmanaged VMs in one of two ways:
Individually: Click the dropdown arrow next to the VM and selecting Import to Workload Manager. The following screenshot illustrates importing an unmanaged VM individually.
Batch: You can also multi-select VMs by clicking the corresponding check boxes next to each VM and then selecting Import to Workload Manager from the Actions menu which displays the number of selected VMs.
When performing bulk operations, if two instances have the same name then Workload Manager rejects this bulk operation request.
The following screenshot illustrates a batch import configuration.
See Actions Library for additional context on types of actions and other details.
Imported VMs do not have any default Understand ACLs permission. Permissions are derived based on the importer's invitations when importing the VM.
Once imported to Workload Manager, the VM is considered to be an Imported VM and the following behavior applies to this VM:
Only listed in the Managed category
Workload Manager licensing and billing begins as soon as the import is successful
Available for VM actions (see Actions Library for additional context).
Visible in Workload Manager but still does not have an agent installed
Eligible to have an Agent screenshot installed
The following screenshot displays a filtered list of Imported VMs displayed in the Managed category and identifies the imported VM icon as well as the icon for an unknown OS:
When you click the Imported VM link to view details about the imported VM, a page as shown in the following screenshot displays:
Install the Management Agent
If a VM was launched as part of an application deployment using Workload Manager, then the Go Management Agent may already be running on it (unless the VM was installed as an Agentless node or a user manually stopped the Agent). Such VM (with the Go Management agent installed as part of deployment) are referred to as Workload Manager Deployed VMs.
The action to Install Workload Manager Agent from the Actions dropdown list is only available for the agent. Installing the Management Agent is an alternate option for VMs that do not require the capability to launch applications but do require some basic Workload Manager functionality like performing platform actions. You can only install the Management Agent agent on imported VMs.
The following screenshot identifies an imported VM without the Management Agent installation:
If the Management Agent is installed, you see the Agent icon and the version displayed for each Imported VM on the Virtual Machines page, as shown in the following screenshot:
Use one of the following options to install an agent:
If the latest version of the agent is already installed on a VM, then the Install Workload Manager Agent action will no longer be available for this VM.
Manually: See the Install the Management Agent Manually section below for additional details.
Prerequisites to Use Management Agent
To install the Management Agent, you must meet the following conditions, you must meet the following conditions:
Required Utilities: Clouds like vCenter and AzureRM requires the following utilities:
Install the Management Agent from the UI
The Install Workload Manager Agent action installs the lightweight agent and enables Custom actions on this VM. After installing the Management Agent, the list of allowed custom actions is listed in the Actions dropdown for this VM.
To install the Workload Manager agent from the CCM UI, you must meet these requirements:
Use the manual procedure in the following situations:
Locating the vhost Value
You must specify the vhost (brokerVirtualHost) value for the region in which the vhost instance exists. To retrieve the vhost value, you must configure a load balancer instance for RabbitMQ, log into the load balancer instance, and retrieve the value using theAPI. The following screenshot provides a sample response of where this value is located.
The Node ID Input Parameter
The Node ID input parameter is optional for all supported clouds
To provide the Node ID value for Windows, issue the following command:
To provide the Node ID value for Linux, issue the following command:
Download the Management Agent Bundle
To install the Management Agent bundle, you must first download one of the following bundle store files:
SSH into the VM instance designated for this component by using the key pair that you used to launch the VM.
Along with the key pair, you may need to use your login credentials for sudo or root access based on your environment.
Download the following required files for this component from software.cisco.com. Be aware that the following files are contained in a file name that uses the following syntax:
agent-lite-linux-bundle.tar.gz (for Linux-based VMs)
Workload Manager installs this file on Linux servers ONLY if the WGET or CURL utilities are available in the image. If either of those utilities are not available, Workload Manager does not install this file. See CURL and WGET Utilities for additional context.
p (for Windows-based VMs, use RDP access)
Process: The process to install the Management Agent on a Windows instance differs based on the Windows version.
Set the Management Agent Environment Variables
You can set the environment variables to provide easy access to logs and configuration files.
Source the environment vars files:
Use the following variables to set the values:
Manage the Agent
Managing the agnt file and feature is specific to the OS in use. The following table provides information about managing the Management Agent.
|Management Agent Registration by Workload Manager||Registered as a daemon program agentd.||Registered as a service, called AgentService.|
|Start the Management Agent|
Use one of the following commands:
|Use the service manager to start the service.|
|Stop the Management Agent|
Use one of the following commands:
|Use the service manager to stop the service.|
|Restart the Management Agent|
Use one of the following commands:
|Use the service manager to restart the service.|
|Modify the configuration|
To modify the configuration, follow this process:
To modify the configuration, follow this process:
Uninstall the Management Agent
By uninstalling the agent, you are only removing the agent daemon from the Linux server and the agent service from the Windows server – you are not removing the folder/directory.
To uninstall an existing Management Agent instance on a VM and install a new Management Agent version, follow this procedure.
Uninstall the Management Agent file using the following OS-specific command:
Delete the Agent Home folder/directory
Install the Management Agent using one of the options provided in the sections above (from the UI Actions dropdown or Manually).
You can only upgrade agent for a Workload Manager VM if the agent was previously installed and if the VM is using CloudCenter Legacy 4.7.3 or later versions.
If the latest version of the agent is already installed on a VM, then the Upgrade Workload Manager Agent action will no longer be available for this VM.
You can upgrade the agent either from the UI or the API.
Before you can upgrade the agent on an imported Linux VM with the version 5.0.0 agent installed, you must perform these pre-upgrade steps:
- Create a new on demand action to prepare the VM before upgrade (see Actions Library for more details on creating a custom on demand action):
- Navigate to the Actions Library tab and click New Action.
- Give the new action a memorable Action Name, eg, "PreUpgrade".
- Add a resource mapping corresponding to all managed imported Linux VMs and click Done. See the screenshot below for guidance.
Copy and paste the following string in the Executable Command field:
- Click Done to save the new on demand action.
- Execute the on demand action you created on the VM needing the agent upgrade:
- Navigate to the VM details page of the VM you want to upgrade.
- Click the action button on the right side of the screen corresponding to the new "PreUpgrade" action.
You can now proceed to the steps below to upgrade the agent on the VM.
Perform VM Actions
You can perform VM operations such as start, stop, and reboot VMs from the Deployment Details page or the Virtual Machine list page. Admins can manage Workload Manager VMs and take several actions from the Virtual Machines list page or a VM Details page.
A new billing process calculates the run time and cost usage of imported VMs. This process is similar to existing billing process and runs once an hour.
The Workload Manager costs are accrued for each child job as well as for the total cost of the deployment.
Agent Time Zone Details
A Workload Manager-created or dynamically bootstrapped worker image has the NTP daemon automatically started and the timezone set to UTC.
The various timestamps generated for startTime, importedTime, terminatedTime generated and stored on behalf of any VM in Workload Manager are based on the Workload Manager timestamps.
Filter Favorites: Any time you mark a deployment as a favorite (see Deployment Details > Favorite Deployments) by clicking the star icon, you can also view a filtered list of favorite deployments, as shown in the following screenshot.
Search Strings: Specify strings in the Search icon field based on strings that identify the following resources:
High-level status (status)
Public IP address (publicIpAddr)
Private IP address (privateIpAddr)
Node name (nodeId)
Cloud account name (cloudAccountName)
Cloud group name (cloudGroupName)
Parent deployment name (name)
VM name (displayName)
- Time Period Filtering
The time period filtering options displayed in the top right corner of the Virtual Machines tab enables you to filter VMs based on the VM Run Time (default).
Time Period Filter
The time period filter is illustrated in the following screenshot.
Time Period Filter Description Notes MTD Month to Date The current month YTD Year to date The current year 30D (Default) 30 Days
The current 30 days ending with today
The data that is displayed in response to a 30-Day time period request only displays data from the 1st of the month, not for the previous 30 days. To work around this issue, use the date Range option and provide the begin and end date for the required period.
60D 60 Days The current 60 days ending with today 90D 90 Days The current 90 days ending with today Range A custom range specified by the selected month and year
If using APIs, this is the only available options to display reports for a period of time based on the startDate and endDate attributes
- Advance Filtering
The Hide Filter/Show Filter option enables you to hide or expand advanced filtering options. You can save custom filters just as you would for Workload Manager reports
This advanced filtering options helps you directly add short cuts to filtered lists that you can quickly access at a later time. This feature is available for some pages (for example, the Running VM History Report or the Virtual Machine Management page). The following screenshots display some of the available filters.
You can additionally filter CloudCenter resources using the user-based Groups filter (see the highlighted image above).
User Groups displayed in the filter lists all user groups that are configured for your tenant. Selecting any user group list filters the list of application deployments for the selected group and keeps those deployments selected in this list if they map to users in the user group.
You can also combine the user and user group filters, and in this case, the report displays deployments that map to either the selected user or any user who is a member of the selected user group.
By saving a a filter, you are directly adding short cuts to custom filtered lists that you can quickly access at a later time.
To save a custom filter, follow this procedure.
Select the required filters in the Filters pane and/or the Columns filter choices.
Click Save, located right above the Filters pane, as displayed in the following screenshot.
The Save Filter popup displays.
Enter a name for this filter and click Save.
The filter is saved and a status message displays in the page.
You can access and view the saved filters from the dropdown list.
Delete Saved Filters
You can delete saved filters by clicking the Trash icon next to the saved filter live link.
The Delete Saved Filters popup confirms your intention before deleting the saved filter and displaying the status message at the Application Deployments Report page.
- No labels