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.
This section contains the following topics:
Registering service VMs with Prime Network Services Controller ensures that Prime Network Services Controller recognizes and can communicate with the VMs.
For Cisco service VMs, see Registering Cisco VMs Deployed on VMware.
For third-party service VMs, see Registering Third-Party VMs in VMware.
This procedure describes how to register ASA 1000V and VSM VMs that have been installed directly on the hypervisor. Cisco VMs that are instantiated on a hypervisor through Prime Network Services Controller are automatically registered with Prime Network Services Controller upon instantiation.
You do not need to register a VSG that is installed directly on the hypervisor. The deployment procedure automatically registers the VM with Prime Network Services Controller.
To register third-party VMs in Prime Network Services Controller, install the Prime Network Services Controller Device Adapter before deploying and registering the third-party VMs.
The following table identifies the tasks and related topics for deploying a Citrix NetScaler load balancer on VMware and registering the load balancer with Prime Network Services Controller:
Task | Comments |
---|---|
1. Install Prime Network Services Controller Device Adapter. |
See Deploying the Prime Network Services Controller Device Adapter on VMware. |
2. (Optional) Configure licensing for the Citrix NetScaler load balancer. |
|
3. Deploy a Citrix NetScaler load balancer. |
|
4. Register the Citrix NetScaler load balancer with Prime Network Services Controller. |
See Registering a Citrix NetScaler Load Balancer with Prime Network Services Controller. |
The Prime Network Services Controller Device Adapter enables third-party VMs (such as Citrix NetScaler load balancers) to register with Prime Network Services Controller.
This procedure installs the Prime Network Services Controller Device Adapter on a VMware host using an OVA image. For information on how to deploy a VM using an ISO image, see the VMware documentation.
Prime Network Services Controller Device Adapter must be installed before you can deploy and register third-party service nodes, such as Citrix NetScaler load balancers.
Adding or editing policies from the Prime Network Services Controller Device Adapter is not supported. All configuration must be performed using the Prime Network Services Controller GUI.
You need to install the Prime Network Services Controller Device Adapter only once for each Prime Network Services Controller instance.
If you reinitialize Prime Network Services Controller, you must also reinitialize Prime Network Services Controller Device Adapter.
Confirm that a network path exists between the Prime Network Services Controller Device Adapter IP address and the Prime Network Services Controller management IP address.
To view a sample license.xml file, see Example license.xml File.
All license files in the bundle must be from the same vendor and for a single platform. For the current release, the only supported vendor/platform combinations are Citrix and VPX or NS1000V.
All license files in the bundle must be of the same license category. For example, they must have same feature level (such as Standard or Premium) and throughput level (such as 10 or 1000).
You must import the license bundle before instantiating the load balancer.
You can import multiple license bundles, but the bundles cannot contain files with the same host ID or the same filename as an existing file.
You cannot delete a license if it is assigned to a load balancer service device.
xml version="1.0" encoding="UTF-8" <LicenseBundle> <Vendor>vendor-name</Vendor> <Platform>platform-type</Platform> <LicenseCategory> <FeatureLevel>feature-level</FeatureLevel> <ThroughputLevel>throughput-level</ThroughputLevel> <Licenses> <License file="license1.lic"> <HostId>host1-id</HostId> <License file="license2.lic"> <HostId>host2-id</HostId> </Licenses> </LicenseCategory> </LicenseBundle>
License XML Tag | Description | Example |
---|---|---|
Vendor |
Vendor from whom the licenses were obtained. |
Citrix |
Platform |
Platform for which the licences can be used. |
VPX |
LicenseCategory |
License category based on feature and throughput level. |
|
—FeatureLevel |
Feature level of the licenses in the bundle. |
Standard |
—ThroughputLevel |
Throughput level of the licenses in the bundle. |
10 |
Licenses |
Licenses in the bundle. |
|
—License file |
License filename. |
"GID_6087fdd1_1435dda300b__6e02.lic" |
—HostId |
Host ID of the device for which the license was issued. |
005056a91f72 |
This topic describes how to import bundled Citrix NetScaler load balancer licenses and prepare those licenses for assignment to load balancers.
Generate and download a license bundle for the required type of Citrix NetScaler load balancer. For more information, see:
Confirm the license category that has been purchased. For more information about the available license categories for Citrix NetScaler load balancers, see http://support.citrix.com/article/CTX122426.
Step 1 | Choose
Resource
Management >Managed Resources > root or
root >
tenant.
| ||
Step 2 | In the License tab, click Import License Bundle. | ||
Step 3 | Enter the import details, and then click OK. To check the import status, view the Recent Jobs window. After the import completes, the bundle is displayed in the table with a success status. | ||
Step 4 | Under the Feature License per platform area, choose the device and the license category. | ||
Step 5 | Click Edit to view the different licenses available for that category. You can also look at this table at a later time to see which licenses are assigned to instantiated load balancers. |
After a Citrix NetScaler load balancer VM starts, you can register it with Prime Network Services Controller.
Deploy a Citrix NetScaler load balancer VM in the hypervisor. For more information, see:
For OpenStack, see Instantiating a Citrix NetScaler VPX Load Balancer in OpenStack.
For VMware, see Citrix product documentation at http://support.citrix.com/proddocs/topic/infocenter/ic-how-to-use.html.
Create a tenant in Prime Network Services Controller if one does not exist.
Configure a virtual server profile in Prime Network Services Controller.
By default, Prime Network Services Controller includes a service path for use with the automatic instantiation of network services. This service path can cause issues if it is used by a port profile. As a result, we recommend that you remove the default service path from Prime Network Services Controller.
The following topics can help troubleshoot issues that you might encounter with the Prime Network Services Controller Device Adapter and service VMs:
If you change the management IP address of Prime Network Services Controller, configure service VMs that were previously registered with Prime Network Services Controller so that they can continue to communicate with Prime Network Services Controller. See the following topics for more information:
After changing the Prime Network Services Controller management IP address, you must register service VMs with the new IP address as follows.
Confirm the following:
If you change the IP address of the Prime Network Services Controller server, you must update vsm-service as follows so that Prime Network Services Controller can maintain communications with Nexus 1000V switches.
Obtain the Prime Network Services Controller debug plugin nsc-dplug.3.4.n.x.bin. If you need assistance in locating this file, contact the Cisco Technical Assistance Center.
You can contact the TAC over the phone or via the Web:
Regional phone numbers are available at http://www.cisco.com/c/en/us/support/web/tsd-cisco-worldwide-contacts.html#numbers.
To use the Web, go to http://www.cisco.com/cisco/web/support/index.html.
Step 1 | Log in to Prime Network Services Controller via the console. |
Step 2 | Stop the pmon
services by entering the following commands:
# connect local-mgmt (local-mgmt)# service stop |
Step 3 | Load the
Prime Network Services Controller debug plugin:
(local-mgmt)# update bootflash:/nsc-dplug.3.4.n.x.bin
A $ prompt is displayed when the
update bootflash command is complete.
|
Step 4 | Delete the
database for the vsm-service:
$ sudo bash # rm /opt/cisco/vsm-service/db/flash/dme.db |
Step 5 | Restart pmon
services:
# connect local-mgmt (local-mgmt)# service start |
Step 6 | Use the
Prime Network Services Controller XML API to identify and delete the
stale extpolClient object for vsm-service.
For more information, see the Cisco Prime Network Services Controller XML API Guide. |
Certain circumstances, such as loss of network connectivity, can cause Prime Network Services Controller and the Prime Network Services Controller Device Adapter (Device Adapter) to lose communication with each other. If this occurs, use the instructions in this topic to recover communications.
First, determine whether or not Prime Network Services Controller and the Device Adapter can communicate with each other. To do this, log in to the Prime Network Services Controller GUI and choose Administration > Service Registry. The Device Adapter should be displayed with two entries: managed-endpoint and mgmt-controller. If both entries are in lost-visibility state, it indicates that Prime Network Services Controller and the Device Adapter have not been able to communicate with each other for an extended period of time. If Prime Network Services Controller and the Device Adapter can resume communication with each other automatically, they will recover from the lost-visibility state.
If communication with the endpoint cannot be reestablished, you can remove the managed endpoints that are in lost-visibility state. However, do not remove the managed endpoint for the Device Adapter. Instead, replace the Device Adapter VM by using the same host information (hostname, access credentials, and management IP address) as the Device Adapter VM that is in lost-visibility state.
By removing the existing VM and recreating the Device Adapter VM with the same host information, Prime Network Services Controller will recognize the new Device Adapter VM as a replacement for the previous Device Adapter VM. In addition, the new Device Adapter VM will assume management of any third-party devices that the previous Device Adapter VM managed.
Prime Network Services Controller deploys three load balancers (lb1, lb2, and lb3) that are managed by Adapter1.
Adapter 1 becomes unavailable.
The administrator does not remove the managed-endpoint for Adapter1.
The administrator removes the Adapter1 VM and recreates it by using the same host information as that for the original Device Adapter.
Prime Network Services Controller recovers connectivity and recognizes the new Device Adapter VM as a replacement for the previous Adapter1.
The new Adapter1 assumes management of the existing service nodes. In addition, Prime Network Services Controller will deploy new service nodes (such as lb4) that are assigned to the new Adapter1.
Note | The new Adapter1 might attempt to reapply the configuration to the existing service nodes (lb1, lb2, and lb3). If this occurs, Prime Network Services Controller might update the configuration state for these service nodes to failed-to-apply. If this occurs, reboot the service nodes to display the correct configuration state. |
In this scenario, a new Device Adapter has different host information than the original Device Adapter.
If the new Device Adapter VM has different host information, such as a different management IP address or hostname, Prime Network Services Controller might not recognize it as a replacement for the existing VM. All existing service nodes that were managed by the original Device Adapter VM will continue to run, but in headless mode. Any additional configuration changes that are made to those service nodes by using Prime Network Services Controller will not be applied. In addition, because Prime Network Services Controller does not recognize the new Device Adapter VM as the replacement for the previous Device Adapter VM, subsequent deployments will fail because they cannot be assigned to the original Device Adapter.
Prime Network Services Controller deploys three load balancers (lb1, lb2, and lb3).
Adapter1 enters lost-visibility state.
The administrator does not remove the managed-endpoint for Adapter1.
The administrator deploys a new Device Adapter VM (Adapter2) with a management IP address that is different from the management IP address for Adapter1.
Prime Network Services Controller does not recognize Adapter2 as a replacement for Adapter1 and instead considers it a new instance of the Device Adapter.
All services (lb1, lb2, and lb3) that were managed by Adapter1 continue to run, but in headless mode; that is, any attempt by Prime Network Services Controller to change the configuration for those services fails.
Additional deployments, such as lb4, might be assigned to Adapter1 for management and will therefore fail to complete deployment.
Note | If you delete the managed-endpoint for the Device Adapter before replacing the Device Adapter VM, Prime Network Services Controller will not recognize the new Device Adapter VM as a replacement for the original Device Adapter VM. Instead, you will encounter the behavior described in this scenario. |
You can use Prime Network Services Controller to troubleshoot faults associated with managed devices and services.
Step 1 | Choose Resource Management > Managed Resources > root > tenant. |
Step 2 | In the Network Services tab, choose the required service or device, and then click Edit. |
Step 3 | In the General tab, review the Status area for any issues or states affecting reachability, configuration, or association. |
Step 4 | In the Faults tab, review the displayed faults. To view additional information about a fault, double-click the entry, or choose the entry and then click Properties. |