XE Lan Scanner 1.0 serial key or number

enable

Example:

Enables privileged EXEC mode.

Enter your password, if prompted.

configure terminal

Example:

Enters global configuration mode.

{ip | ipv6} name-server [] [] [] [] []

Example:

Configures Domain Name System (DNS).

ip name-server vrf Mgmt-vrf [] [] [] [] []

Example:

(Optional) Configures DNS on the VRF interface.

ip domain lookup source-interface

Example:

(Optional) Configures the source interface for the DNS domain lookup.

ip domain name example.com

Example:

Configures the domain name.

ip host tools.cisco.com

Example:

(Optional) Configures static hostname-to-address mappings in the DNS hostname cache if automatic DNS mapping is not available.

interface

Example:

Configures a Layer 3 interface.

ntp server [version] [key] [prefer]

Example:

Forms a server association with the specified system.

switchport access vlan

Example:

(Optional) Enables the VLAN for which this access port carries traffic and sets the interface as a nontrunking nontagged single-VLAN Ethernet interface.

ip route

Example:

Configures a route on the device.

license smart transport callhome

Example:

Enables the transport mode as Call Home.

ip http client source-interface

Example:

Configures a source interface for the HTTP client.

exit

Example:

(Optional) Exits global configuration mode and returns to privileged EXEC mode.

copy running-config startup-config

Example:

(Optional) Saves your entries in the configuration file.

The xe CLI enables you to script and automate system administration tasks. Use the CLI to integrate Citrix Hypervisor into an existing IT infrastructure.

Installing the xe CLI

The xe command line interface is installed by default on all Citrix Hypervisor servers and is included with XenCenter. A stand-alone remote CLI is also available for Linux.

On Windows

On Windows, the command is installed along with XenCenter.

To use the command, open a Windows Command Prompt and change directories to the directory where the file is located (typically ). If you add the installation location to your system path, you can use the command without having to change into the directory.

On Linux

On RPM-based distributions (such as Red Hat), you can install the stand-alone xe command from the RPM named on the main Citrix Hypervisor installation ISO.

To install from the RPM, use the following command:

You can use parameters at the command line to define the Citrix Hypervisor server, user name, and password to use when running xe commands. However, you also have the option to set this information as an environment variable. For example:

Note:

The remote xe CLI on Linux might hang when attempting to run commands over a secure connection and these commands involve file transfer. If so, you can use the parameter to run the command over an insecure connection to the Citrix Hypervisor server.

Getting help with xe commands

Basic help is available for CLI commands on-host by typing:

A list of the most commonly used xe commands is displayed if you type:

Or a list of all xe commands is displayed if you type:

Basic xe syntax

The basic syntax of all Citrix Hypervisor xe CLI commands is:

Each specific command contains its own set of arguments that are of the form . Some commands have required arguments, and most have some set of optional arguments. Typically a command assumes default values for some of the optional arguments when invoked without them.

If the xe command runs remotely, extra arguments are used to connect and authenticate. These arguments also take the form .

The argument is used to specify the host name or IP address. The and arguments are used to specify credentials.

A argument can be specified instead of the password directly. In this case, the xe command attempts to read the password from the specified file and uses that password to connect. (Any trailing CRs and LFs at the end of the file are stripped off.) This method is more secure than specifying the password directly at the command line.

The optional argument can be used to specify the agent port on the remote Citrix Hypervisor server (defaults to 443).

Example: On the local Citrix Hypervisor server:

Example: On the remote Citrix Hypervisor server:

Shorthand syntax is also available for remote connection arguments:

• user name
• password
• password file
• port
• server

Example: On a remote Citrix Hypervisor server:

Arguments are also taken from the environment variable XE_EXTRA_ARGS, in the form of comma-separated key/value pairs. For example, to enter commands that are run on a remote Citrix Hypervisor server, first run the following command:

After running this command, you no longer have to specify the remote Citrix Hypervisor server parameters in each xe command that you run.

Using the XE_EXTRA_ARGS environment variable also enables tab completion of xe commands when issued against a remote Citrix Hypervisor server, which is disabled by default.

Special characters and syntax

To specify argument/value pairs on the command line, write:

Unless the value includes spaces, do not use quotes. There should be no whitespace in between the argument name, the equals sign (=), and the value. Any argument not conforming to this format is ignored.

For values containing spaces, write:

When you use the CLI on your Citrix Hypervisor server, commands have a tab completion feature similar to the feature in the standard Linux bash shell. For example, if you type and then press the TAB key, the rest of the command is displayed. If more than one command begins with , pressing TAB a second time lists the possibilities. This feature is useful when specifying object UUIDs in commands.

Note:

Tab completion does not normally work when executing commands on a remote Citrix Hypervisor server. However, if you set the XE_EXTRA_ARGS variable on the machine where you enter the commands, tab completion is enabled. For more information, see Basic xe syntax.

Command types

The CLI commands can be split in two halves. Low-level commands are concerned with listing and parameter manipulation of API objects. Higher level commands are used to interact with VMs or hosts in a more abstract level.

The low-level commands are:

• class-list

• class-param-get

• class-param-set

• class-param-list

• class-param-add

• class-param-remove

• class-param-clear

Where class is one of:

Not every value of class has the full set of class-param-action commands. Some values of class have a smaller set of commands.

Parameter types

The objects that are addressed with the xe commands have sets of parameters that identify them and define their states.

Most parameters take a single value. For example, the parameter of a VM contains a single string value. In the output from parameter list commands, such as , a value in parentheses indicates whether parameters are read-write (RW) or read-only (RO). The output of on a specified VM might have the following lines:

The first parameter, , is writable and has the value 1. The second, , is read-only and has a value of false.

The two other types of parameters are multi-valued. A set parameter contains a list of values. A map parameter is a set of key/value pairs. As an example, look at the following piece of sample output of the on a specified VM:

The parameter has a list of items that represent key/value pairs. The key names are followed by a colon character (:). Each key/value pair is separated from the next by a semicolon character (;). The M preceding the RW indicates that this parameter is a map parameter and is readable and writable. The parameter has a list that makes up a set of items. The S preceding the RO indicates that this is a set parameter and is readable but not writable.

To filter on a map parameter or set a map parameter, use a colon (:) to separate the map parameter name and the key/value pair. For example, to set the value of the key of the parameter of a VM to , the command would be

Note:

In previous releases, the hyphen character (-) was used to specify map parameters. This syntax still works but is deprecated.

Low-level parameter commands

There are several commands for operating on parameters of objects: class-param-get, class-param-set, class-param-add, class-param-remove, class-param-clear, and class-param-list. Each of these commands takes a parameter to specify the particular object. Since these commands are considered low-level commands, they must use the UUID and not the VM name label.

• Lists all of the parameters and their associated values. Unlike the class-list command, this command lists the values of “expensive” fields.

• Returns the value of a particular parameter. For a map parameter, specifying the param-key gets the value associated with that key in the map. If param-key is not specified or if the parameter is a set, the command returns a string representation of the set or map.

• Sets the value of one or more parameters.

• Adds to either a map or a set parameter. For a map parameter, add key/value pairs by using the key=value syntax. If the parameter is a set, add keys with the param-key=key syntax.

• Removes either a key/value pair from a map, or a key from a set.

• Completely clears a set or a map.

Low-level list commands

The class-list command lists the objects of type class. By default, this type of command lists all objects, printing a subset of the parameters. This behavior can be modified in the following ways:

• It can filter the objects so that it only outputs a subset
• The parameters that are printed can be modified.

To change the parameters that are printed, specify the argument params as a comma-separated list of the required parameters. For example:

Alternatively, to list all of the parameters, use the syntax:

The list command doesn’t show some parameters that are expensive to calculate. These parameters are shown as, for example:

To obtain these fields, use either the command class-param-list or class-param-get

To filter the list, the CLI matches parameter values with those values specified on the command-line, only printing objects that match all of the specified constraints. For example:

This command lists only those VMs for which both the field has the value halted and the field has the value BIOS order.

You can also filter the list by the value of keys in maps or by the existence of values in a set. The syntax for filtering based on keys in maps is . The syntax for filtering based on values existing in a set is .

When scripting, a useful technique is passing on the command line, causing to print only the first field in a comma-separated list. For example, the command on a host with three VMs installed gives the three UUIDs of the VMs:

Secrets

Citrix Hypervisor provides a secrets mechanism to avoid passwords being stored in plaintext in command-line history or on API objects. XenCenter uses this feature automatically and it can also be used from the xe CLI for any command that requires a password.

Note

Password secrets cannot be used to authenticate with a Citrix Hypervisor host from a remote instance of the xe CLI.

To create a secret object, run the following command on your Citrix Hypervisor host.

A secret is created and stored on the Citrix Hypervisor host. The command outputs the UUID of the secret object. For example, . Append to the name of the password argument to pass this UUID to any command that requires a password.

Example: On the Citrix Hypervisor host where you created the secret, you can run the following command:

Command history

Some xe commands, for example or , take secrets like passwords as parameters. These can end up in the shell history and during execution of the command are visible in the process table. It is therefore important to execute these commands only in trustworthy environments.

For the bash shell, you can use the variable to control which commands are stored in the shell history.

xe command reference

This section groups the commands by the objects that the command addresses. These objects are listed alphabetically.

Appliance commands

Commands for creating and modifying VM appliances (also known as vApps). For more information, see vApps.

Appliance parameters

Appliance commands have the following parameters:

Tests whether storage is available to recover this VM appliance/vApp.

Creates an appliance/vApp. For example:

Add VMs to the appliance:

Destroys an appliance/vApp. For example:

Recover a VM appliance/vApp from the database contained in the supplied VDI.

Shuts down all VMs in an appliance/vApp. For example:

Starts an appliance/vApp. For example:

Audit commands

Audit commands download all of the available records of the RBAC audit file in the pool. If the optional parameter is present, it downloads only the records from that specific point in time.

parameters

has the following parameters

For example, to obtain audit records of the pool since a precise millisecond timestamp, run the following command:

Run the following command:

Bonding commands

Commands for working with network bonds, for resilience with physical interface failover. For more information, see Networking.

The bond object is a reference object which glues together master and member PIFs. The master PIF is the bonding interface which must be used as the overall PIF to refer to the bond. The member PIFs are a set of two or more physical interfaces that have been combined into the high-level bonded interface.

Bond parameters

Bonds have the following parameters:

Create a bonded network interface on the network specified from a list of existing PIF objects. The command fails in any of the following cases:

• If PIFs are in another bond already
• If any member has a VLAN tag set
• If the referenced PIFs are not on the same Citrix Hypervisor server
• If fewer than 2 PIFs are supplied

Deletes a bonded interface specified by its UUID from a host.

Change the bond mode.

CD commands

Commands for working with physical CD/DVD drives on Citrix Hypervisor servers.

CD parameters

CDs have the following parameters:

List the CDs and ISOs (CD image files) on the Citrix Hypervisor server or pool, filtering on the optional argument .

If the optional argument is used, the value of params is a string containing a list of parameters of this object that you want to display. Alternatively, you can use the keyword to show all parameters. When is not used, the returned list shows a default subset of all available parameters.

Optional arguments can be any number of the CD parameters listed at the beginning of this section.

Cluster commands

Commands for working with clustered pools.

Clustered pools are resource pools that have the clustering feature enabled. Use these pools with GFS2 SRs. For more information, see Clustered pools

The cluster and cluster-host objects can be listed with the standard object listing commands ( and ), and the parameters manipulated with the standard parameter commands. For more information, see Low-level parameter commands. Commands for working with clustered pools.

Cluster parameters

Clusters have the following parameters:

Add a host to an existing cluster.

Destroy a cluster host, effectively leaving the cluster.

Disable cluster membership for an enabled cluster host.

Enable cluster membership for a disabled cluster host.

Destroy a cluster host object forcefully, effectively leaving the cluster.

Create pool-wide cluster.

Destroy pool-wide cluster. The pool continues to exist, but it is no longer clustered and can no longer use GFS2 SRs.

Force destroy pool-wide cluster.

Resync a cluster across a pool.

Console commands

Commands for working with consoles.

The console objects can be listed with the standard object listing command (), and the parameters manipulated with the standard parameter commands. For more information, see Low-level parameter commands.

Console parameters

Consoles have the following parameters:

Attach to a particular console.

Diagnostic commands

Commands for gathering diagnostic information from Citrix Hypervisor.

Perform a major GC collection and heap compaction.

DEPRECATED:

Start logging the database operations. Warning: once started, this cannot be stopped.

Print database statistics.

Print GC statistics.

Help diagnose pool-wide licensing problems.

Print network statistics.

Print timing statistics.

Query the locking and sharing status of a VDI.

Query the hosts on which the VM can boot, check the sharing/locking status of all VBDs.

Disaster recovery commands

Commands for recovering VMs after a disaster

Creates a disaster recovery task. For example, to connect to an iSCSI SR in preparation for Disaster Recovery:

Note:

The command lists SR UUIDs that are allowed. The command only introduces and connects to an SR which has one of the allowed UUIDs

Destroys a disaster recovery task and forgets the introduced SR.

Tests whether storage is available to recover this VM.

Checks whether the storage (containing the appliance’s/vAPP disk) is visible.

Recover an appliance/vAPP from the database contained in the supplied VDI.

Recovers a VM from the database contained in the supplied VDI.

Enables XAPI database replication to the specified (shared) SR.

Disables XAPI database replication to the specified SR.

Example usage

The example below shows the DR CLI commands in context:

On the primary site, enable database replication:

After a disaster, on the secondary site, connect to the SR. The command has the same fields as .

Look for database VDIs on the SR:

Query a database VDI for VMs present:

Recover a VM:

Destroy the DR task. Any SRs introduced by the DR task and not required by VMs are destroyed:

Event commands

Commands for working with events.

Event classes

Event classes are listed in the following table:

Blocks other commands from executing until an object exists that satisfies the conditions given on the command line. The argument means “wait for field x to take value y” and means “wait for field x to take any value other than y.”

Example: wait for a specific VM to be running.

The Cisco licensing mechanism provides flexibility to run a device at different technology package levels. This mechanism is referred to as technology package licensing and leverages the universal technology package based licensing solution. A universal image containing all levels of a software package is loaded on to the device. During startup, the device determines the highest level of license and loads the corresponding software features or subsystems.

The Cisco ASR 1001 Router and ASR 1002-X Router support technology package-based licenses that are not node locked. Technology packages and feature licenses are activated using evaluation licenses that are built in. Evaluation licenses are limited period-metered licenses that are valid for 60 days. When the time allowed for an evaluation license expires, the license is automatically upgraded to RTU license. After all the RTU licenses are activated, there is no expiration of license and are valid for a lifetime.

To enable an evaluation license, you have to accept the global end user license agreement (EULA).

Note	Permanent licenses are not affected by Cisco IOS XE release upgrades.

• Inter chassis redundancy

• Lawful intercept

• Software redundancy

• IPsec

• Throughput

Accept the EULA to activate the corresponding feature. Migration of a permanent license from previous versions of the software images are seamless. For information on accepting the EULA, see Example: Accepting the Global EULA, page 10-6.

Evaluation licenses and RTU licenses available on the Cisco ASR 1000 Series Routers