G.3 Migrate Agent Utility for Linux

Before you install or use Migrate Agent, ensure that your system satisfies the Requirements for Migrate Agent Utility.

G.3.1 Downloading and Installing Migrate Agent on a Source Linux Workload

Before you install Migrate Agent Utility for Linux, ensure that the source machine has GNU C Library (glibc) 2.11.3 or higher installed.

Ensure that you download the application with the appropriate architecture for your source Linux machines. The file name is case sensitive.

64-bit: MigrateAgent-x86_64.tar.gz
32-bit: MigrateAgent-x86.tar.gz

To download and install the Migrate Agent utility for Linux on the source workload:

Log in to the source Linux workload as the root user.
Use either of the following methods to get the MigrateAgent-arch.tar.gz file.

Replace arch with the appropriate architecture (x86_64 or x86).
- Download the zipped file from the Web Interface:
  1. In a web browser, launch the PlateSpin Migrate Web Interface and log in.
    
    https://<Your_PlateSpin_Server >/Migrate
    
    Replace Your_PlateSpin_Server with the DNS name or IP address of your PlateSpin Migrate server.
  2. Click the Downloads tab.
  3. Click the Migrate Agent application link for the appropriate Linux platform (x86_64 or x86), then save the MigrateAgent-arch.tar.gz file.
  -OR-
- Use the wget command to copy the file from the PlateSpin Server.
  
  NOTE:If the operating system on the PlateSpin Server host accepts only TLS 1.2 connections, use wget version 1.16.1 or higher on your source Linux workload.
  1. Launch a terminal, then enter
    wget --no-check-certificate --http-user=<username> --http-password=<password> https://<Your_PlateSpin_Server>/Migrate/Downloads/MigrateAgent-<arch>.tar.gz
    
    Replace Your_PlateSpin_Server with the DNS name or IP address of your PlateSpin Migrate server. Replace arch with x86_64 or x86.
Open the MigrateAgent-arch.tar.gz file in Archive Manager, then extract the MigrateAgent directory and its contents to the root directory (/).

Alternatively, in a shell prompt, enter
```
tar xvf MigrateAgent-<arch>.tar.gz
```
Replace arch with x86_64 or x86.
Change directory to the /MigrateAgent directory, then list its contents. In a terminal, enter:
```
cd MigrateAgent
ls
```
The directory contains a commands file and the MigrateAgent script file.
View the command Help by entering:
```
./MigrateAgent -h
```

G.3.2 Migrate Agent Commands for Linux

The syntax for running the Migrate Agent utility is:

./MigrateAgent [Command] [-h]

Table G-2 describes the options and arguments available for the MigrateAgent command on Linux.

Table G-2 Migrate Agent Utility for Linux Command Options and Arguments

Usage	Description
Commands
register <server> <user> [-pr <your-proxy-server-url>] [[-p password] \| [-pf <password-file-path>]] For server, specify the DNS name or IP address of your PlateSpin Migrate server. For user, specify a valid PlateSpin Server user name for an administrator-level user with rights to add a workload. For the password, do one of the following: Use the -p option and type the password in the command for the specified PlateSpin user name. -p mypassword Use the -pf option to specify the path to a file that contains the password for the specified PlateSpin user name. -pf /tmp/jsmith-password-file.txt Do not specify the password in the command. You will be prompted to enter the password at the command line. Example: ./MigrateAgent register 10.10.10.101 jsmith -p jspwd	Registers this machine as a workload on the specified server. It also checks for driver upgrades from the specified PlateSpin Server. Enables you to add workloads that cannot be discovered. Registered workloads differ from discovered workloads in the following ways: Registered source workloads do not store the source credentials. You must use Migrate Agent to install, upgrade, and remove the Linux blkwatch drivers from registered source workloads. After you delete the contract for a registered source workload, you must manually remove the OFX Controller from the workload. See Section 36.2, Cleaning Up Linux Workloads.
status [<server>] For server, specify the DNS name or IP address of your PlateSpin Migrate server.	Shows installation status for the PlateSpin controller and drivers. If you specify the PlateSpin Server, it checks for driver upgrades from the server.
driver-install [<server>] [-pr <your-proxy-server-url>] For server, specify the DNS name or IP address of your PlateSpin Migrate server.	Installs the appropriate PlateSpin blkwatch driver. If you specify the PlateSpin Server, it checks for driver upgrades from the server.
driver-upgrade [<server>] [-pr <your-proxy-server-url>] For server, specify the DNS name or IP address of your PlateSpin Migrate server.	Upgrades the installed PlateSpin blkwatch driver. If you specify the PlateSpin Server, it checks for driver upgrades from the server.
driver-uninstall	Uninstalls the installed PlateSpin blkwatch driver from the source Linux workload.
configure <server> <new-server> [-pr <your-proxy-server-url>] For server, specify the DNS name or IP address of your PlateSpin Migrate server. For new-server, specify the new DNS name or IP address of the PlateSpin Migrate server. Example: ./MigrateAgent configure 10.10.10.10 10.10.20.20	Stops the OFX Controller (ofxcontroller) service, modifies the OFX Controller configuration file with the new address, and restarts the service. If you modify the public IP address of the PlateSpin Server, you must run this command on each of the source workloads that are configured for the server.
Command Options
server	Specifies the DNS name or IP address of the PlateSpin Migrate Server. Downloads the blkwatch drivers from the specified server when you invoke the status, driver-install, or driver-upgrade options.
user	Specifies the PlateSpin Server user name for an administrator-level user with rights to add a workload.
Options
-h, --help	Displays usage and options for the command.
-pr, --proxyurl --proxyurl <your-proxy-server-url> -OR- -pr <your-proxy-server-url> Specify the HTTP proxy URL in the following format to send HTTP and HTTPS traffic to Migrate Server through the proxy server: http://<proxy-server-fqdn>:<port-number> Example: ./MigrateAgent register 10.10.10.101 jsmith -p jspwd -pr http://myproxy.example.com:8088	Proxy URL to use for connecting to the PlateSpin server. If HTTP and HTTPS communications with the PlateSpin Migrate Server are required to go through your proxy server, you can use the proxyurl option to specify the URL of your proxy server. Include the option with the following commands on source Linux workloads: reg\|register din\|driver-install dup\|driver-upgrade configure The ./MigrateAgent status command reports whether a proxy is set for the PlateSpin Controller Service. If a proxy is set, the Proxy URL parameter displays the proxy URL. NOTE:PlateSpin Migrate requires that you open port 3725 in your firewall for data transfer and communications between workloads. Migrate will not send data traffic through your proxy server.
-p, --password -p <user_password>	Specifies the password for the PlateSpin Server user name. If you exclude the password from the command line, the script will prompt for it. The password is obscured as you type it and it does not appear in the process list. Do not combine this option with the passwordfile option.
-pf, --passwordfile -pf <passwordfile_path>	Specifies the path to a file that contains the password for the specified PlateSpin Server user name. Do not combine this option with the password option.
Logging
logging.json	Contains the logging configuration settings in JSON format for logging Migrate Agent utility actions. To view logging settings, use the cat command: cat MigrateAgent/logging.json You can edit the file in a text editor. Set the level of the logging by changing the "level:" value from "DEBUG" to "INFO" or "ERROR". For example: "level": "DEBUG" or "level": "INFO" or "level": "ERROR" Logged messages are written by default to the MigrateAgent.log file in the MigrateAgent directory. You can modify the log file name setting in the logging.json file.
MigrateAgent.log	Contains the logged messages for the MigrateAgent command. To view the log, use the cat command. cat MigrateAgent.log

Usage

Description

Commands

For server, specify the DNS name or IP address of your PlateSpin Migrate server.

For user, specify a valid PlateSpin Server user name for an administrator-level user with rights to add a workload.

For the password, do one of the following:

Use the -p option and type the password in the command for the specified PlateSpin user name.

-p mypassword
Use the -pf option to specify the path to a file that contains the password for the specified PlateSpin user name.

-pf /tmp/jsmith-password-file.txt
Do not specify the password in the command. You will be prompted to enter the password at the command line.

Example:

./MigrateAgent register 10.10.10.101 jsmith -p jspwd

Registers this machine as a workload on the specified server. It also checks for driver upgrades from the specified PlateSpin Server.

Enables you to add workloads that cannot be discovered. Registered workloads differ from discovered workloads in the following ways:

Registered source workloads do not store the source credentials.
You must use Migrate Agent to install, upgrade, and remove the Linux blkwatch drivers from registered source workloads.
After you delete the contract for a registered source workload, you must manually remove the OFX Controller from the workload. See Section 36.2, Cleaning Up Linux Workloads.

status [<server>]

For server, specify the DNS name or IP address of your PlateSpin Migrate server.

Shows installation status for the PlateSpin controller and drivers.

If you specify the PlateSpin Server, it checks for driver upgrades from the server.

driver-install [<server>] [-pr <your-proxy-server-url>]

For server, specify the DNS name or IP address of your PlateSpin Migrate server.

Installs the appropriate PlateSpin blkwatch driver.

If you specify the PlateSpin Server, it checks for driver upgrades from the server.

driver-upgrade [<server>] [-pr <your-proxy-server-url>]

For server, specify the DNS name or IP address of your PlateSpin Migrate server.

Upgrades the installed PlateSpin blkwatch driver.

If you specify the PlateSpin Server, it checks for driver upgrades from the server.

driver-uninstall

Uninstalls the installed PlateSpin blkwatch driver from the source Linux workload.

configure <server> <new-server> [-pr <your-proxy-server-url>]

For server, specify the DNS name or IP address of your PlateSpin Migrate server.

For new-server, specify the new DNS name or IP address of the PlateSpin Migrate server.

Example:

./MigrateAgent configure 10.10.10.10 10.10.20.20

Stops the OFX Controller (ofxcontroller) service, modifies the OFX Controller configuration file with the new address, and restarts the service. If you modify the public IP address of the PlateSpin Server, you must run this command on each of the source workloads that are configured for the server.

Command Options

server

Specifies the DNS name or IP address of the PlateSpin Migrate Server.

Downloads the blkwatch drivers from the specified server when you invoke the status, driver-install, or driver-upgrade options.

user

Specifies the PlateSpin Server user name for an administrator-level user with rights to add a workload.

Options

-h, --help

Displays usage and options for the command.

-pr, --proxyurl

--proxyurl <your-proxy-server-url>

-OR-

-pr <your-proxy-server-url>

Specify the HTTP proxy URL in the following format to send HTTP and HTTPS traffic to Migrate Server through the proxy server:

http://<proxy-server-fqdn>:<port-number>

Example:

./MigrateAgent register 10.10.10.101 jsmith -p jspwd -pr http://myproxy.example.com:8088

Proxy URL to use for connecting to the PlateSpin server.

If HTTP and HTTPS communications with the PlateSpin Migrate Server are required to go through your proxy server, you can use the proxyurl option to specify the URL of your proxy server. Include the option with the following commands on source Linux workloads:

reg|register
din|driver-install
dup|driver-upgrade
configure

The ./MigrateAgent status command reports whether a proxy is set for the PlateSpin Controller Service. If a proxy is set, the Proxy URL parameter displays the proxy URL.

NOTE:PlateSpin Migrate requires that you open port 3725 in your firewall for data transfer and communications between workloads. Migrate will not send data traffic through your proxy server.

-p, --password

-p <user_password>

Specifies the password for the PlateSpin Server user name.

If you exclude the password from the command line, the script will prompt for it. The password is obscured as you type it and it does not appear in the process list.

Do not combine this option with the passwordfile option.

-pf, --passwordfile

-pf <passwordfile_path>

Specifies the path to a file that contains the password for the specified PlateSpin Server user name.

Do not combine this option with the password option.

Logging

logging.json

Contains the logging configuration settings in JSON format for logging Migrate Agent utility actions.

To view logging settings, use the cat command:

cat MigrateAgent/logging.json

You can edit the file in a text editor. Set the level of the logging by changing the "level:" value from "DEBUG" to "INFO" or "ERROR". For example:

"level": "DEBUG"

"level": "INFO"

"level": "ERROR"

Logged messages are written by default to the MigrateAgent.log file in the MigrateAgent directory. You can modify the log file name setting in the logging.json file.

MigrateAgent.log

Contains the logged messages for the MigrateAgent command. To view the log, use the cat command.

cat MigrateAgent.log