Product Documentation

AutoConfiguration: Simplifying Remote CloudBridge Deployments

May 27, 2015

A CloudBridge solution requires the CloudBridge product to be present at both sides of the link. This imposes a deployment burden on the remote offices, especially the ones without dedicated IT staff. The autoconfiguration feature of Command Center eliminates this burden by offloading the deployment and configuration effort to the datacenters, thus reducing the effort and expertise required at the branch offices. The autoconfiguration feature eases deployments involving large number of branch offices.

With the autoconfiguration feature, Command Center automates the configuration and deployment of CloudBridge devices in the branch offices. You can use this feature to add new branch devices for either a new deployment or an existing deployment.

Points to Note:
  • The autoconfiguration feature is not supported on CloudBridge 600, 700, 4000, or 5000 appliances, CloudBridge VPX instances, or Repeater 8300, 8520, or 8820 appliances.
  • The autoconfiguration feature does not support IPv6 addresses.

Limitations

Updated: 2014-09-05

The autoconfiguration feature does not support the following configurations:
  • Local licenses
  • Certificate configuration (SSL/HA/GroupMode)
  • Install Software command

How AutoConfiguration Works

Updated: 2014-09-05

The autoconfiguration feature implicitly registers, discovers, and configures a CloudBridge device by using the CloudBridge device identifier and the configuration profile input provided by the datacenter administrator. It requires minimal manual configuration at both the datacenter and the branch offices.

The following figure shows how the autoconfiguration feature works.
Figure 1. How AutoConfiguration Works


Following is the workflow of the autoconfiguration feature:
  1. The datacenter administrator configures the Command Center server with the CloudBridge device serial number or the management service IP address and the configuration profile details. The datacenter administrator then notifies the branch office user.
  2. The branch office user powers on the CloudBridge device and performs the initial configuration by using the setup wizard where he provides the DNS IP address along with other network settings.

    After the initial setup of the CloudBridge device is completed, and the Command Center server IP address is resolved, the branch office user enables the device for registration with the Command Center server.

  3. The CloudBridge device, then implicitly requests the Command Center server to begin registration.
  4. On receiving this request, the Command Center server registers the device and starts the device discovery process.
  5. After discovery is successful, the Command Center server begins the CloudBridge device configuration based on the details in the configuration profiles assigned to this device.
Note: If any command fails during configuration, the Command Center server either rolls back the entire configuration or runs the rest of the commands depending on the settings configured by the datacenter administrator.

On completion of automatic registration and configuration on the CloudBridge device, the Command Center server raises an internal event. The information about this configuration is stored in execution logs on the Command Center server. The datacenter administrator can view the progress of the automatic registration, discovery, and configuration on the Command Center graphical user interface (GUI.)

Prerequisites to Configuring AutoConfiguration

Updated: 2014-09-05

Before you begin configuration, make sure you have the following information:

Datacenter Administrator

  • Serial number or management service IP address of the CloudBridge device from the purchase order of the CloudBridge device.
    Important: The datacenter administrator must use the management service IP address and not the CloudBridge IP address.
  • Configuration profiles that you want to assign to the device (See Appendix for a sample.)
  • Confirmation that CloudBridge registration settings status is enabled on the Command Center server ( Administration > Settings > CloudBridge Registration Settings.)
    Note: If this setting is enabled, the CloudBridge device initiates the discovery process through the Command Center server.
  • CloudBridge registration settings password.
  • Device profile password on the Command Center server (Citrix Network > Device Inventory > Device Profile > <profile_name>.)
    Note: Password of the device profile that you specify when you enable the CloudBridge registration settings on the Command Center server.

Branch Office User

  • Confirmation that the hardware installation of the CloudBridge device is completed.
  • Command Center server IP address.
  • DNS server is configured with a valid address record of the Command Center server. (Specify the DNS server hostname as commandcenter.yourdomain.)
  • Administrator password, which is the device profile password provided by the datacenter administrator on the Command Center server.
  • CloudBridge registration settings password.

Configuring AutoConfiguration

Updated: 2015-03-31

The configuration of the autoconfiguration feature requires the datacenter administrator to provide the CloudBridge device serial number or the management service IP address and the configuration profile to the Command Center server. At the branch office, the user needs to power on the device, perform initial setup, and set the device for registration with the Command Center server.

Configuration Steps Performed by the Datacenter Administrator

  1. In a web browser, type the IP address of the Command Center server.
  2. Navigate to Citrix Network > Device Inventory > CloudBridge Advanced Platform and, in the details pane, on the AutoConfiguration tab, click Add.
  3. In the Choose Configuration Profiles page, enter values for the CloudBridge device serial number or the management service IP address, select or create configuration profiles, and choose to either roll back or continue with the configuration on command failure.
    Note:
    • You can assign multiple configuration profiles to a device. The profiles will be configured on the device in the sequence specified on this page.
    • Before you specify the configuration profiles, make sure that the configuration works as expected.
  4. If you want to receive an email notification after the configuration is complete, specify your email address.
  5. Notify the branch office user to power on the CloudBridge device and perform the initial setup on the device.

Configuration Steps Performed by the Branch Office User

  1. In a web browser, type the IP address of the CloudBridge device.
  2. In the Command Center wizard, ( Configuration > Appliance Settings > Command Center), specify the Command Center IP address, port number and the registration password set by the datacenter administrator while configuring the CloudBridge registration settings, and click OK.
The CloudBridge device sends a registration request to the Command Center server, which automatically discovers the device and executes the commands in the configuration profile.

Verification Steps

Updated: 2014-09-05

After the configuration is complete at both the datacenter and the branch office, the datacenter administrator and the branch office user can monitor and verify the progress and success of the registration, discovery, and configuration process.

Verification at the datacenter

On the Command Center server, navigate to Citrix Network > Device Inventory > CloudBridge Advanced Platform and, in the details pane, click the AutoConfiguration tab.

You can view the registration status and the configuration status of the device in the AutoConfiguration pane, as shown in the following image.

Figure 2. Verification at the datacenter

Verification at the branch office

You can apply a license to the device by using the autoconfiguration feature. In such a case, after the autoconfiguration process is completed, the device is licensed with the license file that is specified in the configuration profile.

To verify that the CloudBridge device is configured:
  1. Log on to the CloudBridge device.
  2. Navigate to CloudBridge > Configuration > Appliance Settings > Licensing.

    The License Information tab of the Licensing page displays the details of the license applied to the device.

Figure 3. Verification at the branch office


Note: If the device is not yet licensed, a message stating "Appliance is not licensed." is displayed as soon as you log on to the device. This message disappears after the device is licensed and after you refresh the page.

Troubleshooting Tips

Updated: 2014-09-05

If the Registration Status column or the Configuration Status column on the Command Center server (Citrix Network > Device Inventory > CloudBridge Advanced Platform and click AutoConfiguration) does not show a green check mark, check if you see one of the following status messages and take the specified action.

  1. Registration Status: Registration request not received.
    • Possible Causes:
      • The Command Center server has not received a registration request from the CloudBridge device and is yet to discover the CloudBridge device. This is the initial status displayed on the AutoConfiguration tab after the datacenter administrator has specified the CloudBridge device identifier and configuration profiles.
      • The Command Center server has successfully discovered the CloudBridge device, but not the CloudBridge instance hosted on the device.
    • Action: The branch office user should initiate the setup wizard (System > Configuration > System > Setup Wizard) again and resend the registration request.
  2. Registration Status: Failed device.
    • Possible Cause: Discovery of the CloudBridge device in the Command Center server has failed.
    • Action: On the Command Center server, navigate to Citrix Network > Device Inventory. Select the CloudBridge device and, from the Action list, click Status and view the discovery error status. Rectify the error and start the rediscovery. For example, if the error message says, "Unable to enable SNMP on device : Exceeded task timeout of 15000ms waiting for end prompt", check to see if SSH from the Command Center server to CloudBridge device responds within 15 seconds. If it takes longer, increase the SSH timeout in the associated device profile and restart the discovery again.
  3. Configuration Status: Configuration request not received.
    • Possible Cause: AutoConfiguration by Command Center flag on the CloudBridge device is unset.

      To verify, on the CloudBridge device, after you perform the initial configuration on the setup wizard (System > Configuration > System > Setup Wizard), on the CloudBridge Registration Settings screen, check to see if the AutoConfiguration by Command Center flag is unset.

    • Action: On the Command Center server, from the AutoConfiguration tab, select the required row and click Retry Configuration to push the configuration profiles to the CloudBridge device.
  4. Configuration Status: Failed and Rolled Back.
    • Possible Cause: Command execution on the CloudBridge device has failed and the failed commands are rolled back.
    • Action: On the Command Center server, from the AutoConfiguration tab (Citrix Network > Device Inventory > CloudBridge Advanced Platform), select the required row and click View Report. This lists the commands executed and their statuses. Modify the failed command in the corresponding configuration profile and, from the AutoConfiguration tab, select the required row and click Retry Configuration to push the configuration profiles to the CloudBridge device.
  5. Configuration Status: m/n Commands Failed.
    • Possible Cause: One or more commands have failed to execute in the CloudBridge device.
    • Action: On the Command Center server, from the AutoConfiguration tab (Citrix Network > Device Inventory > CloudBridge Advanced Platform), select the required row and click View Report. This lists the commands executed and their statuses. Modify the failed command in the corresponding configuration file and, from the AutoConfiguration tab, select the required row and click Retry Configuration to push the configuration profiles to the CloudBridge device.

Appendix

Updated: 2014-09-04

Configuration Profile Sample

########## 
# System Configuration 
enable unit 
enable acceleration 
enable traffic-shaping 
 
########## 
# Link Configuration 
remove link -all 
add link -name "Link (apA.2)" -type WAN -max-in-bandwidth 10000000 bps -max-out-bandwidth 10000000 bps -adapters apA.2 
add link -name "Link (apA.1)" -type LAN -max-in-bandwidth 1000000000 bps -max-out-bandwidth 1000000000 bps -adapters apA.1 
 
#Set the License Server 
set license-server -location remote -model 2000-050 -ip 10.102.137.44 -port 27000  
 
#Set the apA network configuration 
set adapter apa -ip 88.88.88.0 -netmask 255.255.255.0 -gateway 88.88.88.1 -vlan enable -vlan-group 75 
set dns-server 10.140.50.5 -backup-dns 10.140.50.6 
 
########## 
# Date Time Configuration 
add ntpserver 10.102.76.127 
set timezone Asia/Kolkata 
 
 
#Enable video caching.As Enable video caching takes RESTART hence above changes will take effect automatically   
enable videocaching 
 
#Add the Video sources 
 
########## 
# Video Caching Source and Listen Port List 
remove videocaching -video-source -clear-enabled 
remove videocaching -video-source -clear-disabled 
remove videocaching -video-source -clear-excluded 
remove videocaching -listen-ports -clear 
add videocaching -video-source "vimeo.com" -state  enable 
add videocaching -video-source "youtube.com" -state  enable 
add videocaching -video-source "dailymotion.com" -state  disable 
add videocaching -video-source "metacafe.com" -state  disable 
add videocaching -video-source "youku.com" -state  disable 
add videocaching -listen-ports "80" 
 
 
#Add the Pre-population list 
 
#Advanced Configuration 
########## 
# Video Caching DNS Suffix, Max Object Size 
remove videocaching dns-suffix 
set videocaching -dns-suffix "citrix.com" 
set videocaching -max-object-size 100 
 
 
########## 
# SYSLOG Configuration 
add syslog -ip 4.5.6.76 -port 514 
 
# SNMP Configuration 
enable snmp 
add snmp-manager -community "public" -ip 10.102.203.199 -netmask 32 
add snmp-trapdest -name "MYSNMP_Trap203.199" -ip 10.102.203.199 -port 162 -version v2c -community "public"