Run the EMM Connector Deployment Script

Step through the following command-line options to complete the On-Premises EMM Connector deployment. Whether you use a VM Appliance or Docker to set up EMM Connector, you must do these steps.

Download and run the script, either for VM Appliance or from Docker.

For EMM Connector 1.3.0:

curl -Ls http://connector.appthority.com/appthority-v1.3.0.sh > appthority.sh ; chmod +x appthority.sh ; ./appthority.sh

Tips for running commands

  • Enter the number for each action you want, then enter the information. You should normally go through the steps in order.
    When [Okay] displays, hit Return again to make the next selection.
  • Commands are not case-sensitive. You can use the first letter or type out the command.
  • Enter ctrl + c at any time to send a break and exit the current step.
  • See additional options for more commands. If you are installing multiple EMM Connector instances, you will need to use these options.

Gather Credentials

You will need various credentials to step through the script. Contact Appthority Support for your Appthority MTPOrg ID and Auth Token.

You may or may not be using a proxy for Appthority MTP and the EMM, so those are optional and are displayed in italics.

Appthority credentials

  • Installation key | WFbUPlCgZjdFB5yBfxJ4
  • Appthority Org ID |
  • Appthority Auth Token |
  • Appthority Proxy Host |
  • Appthority Proxy Port |
  • Appthority Proxy Username |
  • Appthority Proxy Password |

EMM credentials

  • EMM URL |
  • EMM API Token |
  • EMM Username |
  • EMM Password |
  • EMM Proxy Host |
  • EMM Proxy Port |
  • EMM Proxy Username |
  • EMM Proxy Password |

Run the Script for an Initial Deployment

To set the basic configuration options

  1. key - Set Install Key. Type or copy/paste the installation key (WFbUPlCgZjdFB5yBfxJ4) at the prompt, then click Return/Enter twice.
  2. appthority - Configure EMM Connector. Enter the Appthority MTP Org ID and follow the prompts.
    1. Enter the Appthority MTP auth token.
    2. Answer y or n to whether there is a proxy (optional). If yes, continue to enter details.
    3. If y, enter the proxy host.
    4. Enter the proxy port.
    5. Enter the proxy username.
    6. Enter the proxy password.

  3. emm - Configure EMM Settings. Select your EMM provider, then follow the prompts. The prompts vary slightly depending on the EMM.
    1. Select EMM Provider
      For MobileIron, answer whether the EMM is on-premises

    2. Enter the EMM URL.
    3. Answer whether the EMM user is a Domain Account
    4. Enter your EMM username.
    5. Enter your EMM Password.
    6. Enter your EMM API Token, if requested.
    7. Answer y or n to whether there is a proxy (optional). If yes, continue to enter details.
      • If y, enter the proxy host.
      • Enter the proxy port.
      • Enter the proxy username.
      • Enter the proxy password.

To install or update the On-Premises EMM Connector

  1. You cannot update an EMM Connector that is running, so first make sure that any pre-existing instance is not running. If it is running, use the ‘k’ command to first kill the instance you want to update.

    Tip: Commands apply to the running instance displayed at the top of the script commands.

  2. install - Install or Update Connector. The script gets the image and installs a new or updates an existing EMM Connector, if there is an update.

When the install or update is complete, last steps display:

To uninstall an on-premises EMM Connector

  1. Start the script.
  2. uninstall - Stop all Instances & Uninstall. Resets and removes configurations and images.
    A confirmation displays. Enter y to continue or n to cancel.

To test the on-premises EMM Connector configuration

  1. Run the script.
  2. Select test - Test Connector Configuration. Runs validation for connectivity and returns a success or fail result.
    Tip: You can also view Connector Status in MTP Manager for additional details once the EMM Connector is up and running.

Additional Script Options

Enter + from the main menu to access more commands.

To use commands that manage the image

Use these commands from the additional options to manage your Connector images.

  • A - About Connector Images. Displays details of current image, including version and release notes if available.
  • U - Update Connector Image. Downloads a new Connector image. You will need the install key to continue.
  • D - Delete Connector Images. Deletes current image.

To save or load configurations

You can save a configuration and reload it, then boot the instance from the command line. This allows you to skip steps 2 and 3 in the script, as the Appthority MTP and EMM credentials and details are saved in the configuration.

These are in the additional options from the script.

  • S - Save Configuration. Saves the current/last configuration.
  • V - View Configuration. View the current configuration.
  • L - Load Configuration. Loads the available configuration.
  • C - Change Configuration. Displays configurations available to select. Once you select an option, you will be switched to that configuration.

Manage Instances

Use these commands from the additional options to manage your Connector instances, and to view logs.

To manage instances

  • I - Show Running Instances. Displays all running instances.
  • B - Boot Up Instance [InstanceName]. Boots to the saved or selected configuration.
  • R - Restart Instance [InstanceName]. Restarts the running instance.
  • K - Kill Instance [InstanceName]. Kills the running instance.

Advanced Script Options

Use these commands for advanced options.

  • T - Tail Logs for <instance>. Displays logs of events.
  • P - Update CA Certs Location. Use to designate or change the location of your certificates.
  • H - Enter Local Host Entries. Use if you need to specify local hosts.

Troubleshooting

Some commands in the script are useful for troubleshooting or identifying details of your Connector.

Use Command A - About Connector Images to display details about the current image, including version and release notes.

Use Manage Instances to start, stop, or restart your Connector. Some reasons you may want to use these options include:

  • If you have any configuration errors, such as authentication, you may want to Kill Connector and create a new configuration, then boot that instance.
  • If you have the latest Connector image, you can boot that instead of reinstalling.
  • If you have a running instance of Connector but want to restart it, you can use restart instead of kill and reboot.

Use logs and other advanced options to investigate issues with your system.

Copyright ©Appthority, Inc. 2017-2018 All Rights Reserved. Contact Support