Guide complet pour automatiser l’installation de ConnectWise sur macOS

Points à retenir

• Installation automatisée: Le script automatise l’installation de ConnectWise Control sur macOS, améliorant ainsi l’efficacité des environnements informatiques.
• Fonctions de personnalisation: Il permet de personnaliser les installations avec le nom de l’organisation, l’emplacement de l’appareil, le type et le département.
• Gestion des erreurs: Le script comprend une gestion robuste des erreurs et une logique de réessai pour un téléchargement fiable.
• Flexibilité des paramètres: Offre une certaine souplesse en acceptant différents formats pour les arguments de la ligne de commande.
• Création d’URL: Construit dynamiquement l’URL de téléchargement en fonction des besoins spécifiques de l’organisation.
• Contrôle préalable à l’installation: Inclut une vérification pour éviter de réinstaller ConnectWise Control s’il est déjà présent.
• Du côté de la sécurité : Souligne la nécessité d’un approvisionnement sûr et d’une vérification de l’intégrité de l’emballage.
• Capacité d’adaptation: Bien que conçu pour macOS, le concept du script est adaptable à d’autres systèmes ou logiciels.
• Intégration avec les outils de gestion informatique: Met en évidence les synergies potentielles du script avec des plateformes de gestion informatique plus larges telles que NinjaOne.

L’automatisation et l’efficacité sont essentielles dans le paysage en constante évolution de la gestion informatique. La rationalisation de l’installation d’outils essentiels, tels que les logiciels d’assistance à distance, permet non seulement de gagner un temps précieux, mais aussi d’assurer la cohérence entre plusieurs appareils. Cette approche est particulièrement importante pour les fournisseurs de services gérés (MSP) et les professionnels de l’informatique qui gèrent un parc de machines.

Contexte

ConnectWise Control, anciennement connu sous le nom de ScreenConnect, est une solution d’assistance, d’accès et de réunion à distance très répandue dans le secteur des technologies de l’information. Son adaptabilité et son ensemble de fonctionnalités robustes en font un outil indispensable pour les MSP et les départements informatiques. Le script en question automatise l’installation de ConnectWise Control sur les systèmes macOS. Cette automatisation est particulièrement vitale pour les professionnels de l’informatique et les MSP afin de déployer efficacement ce logiciel sur plusieurs appareils macOS, en maintenant la standardisation et en réduisant la charge de travail manuelle.

Le script :

#!/usr/bin/env bash
#
# Description: Download and Install ConnectWise ScreenConnect. Supports automatic customization of the company name, device type, location, and other ScreenConnect fields.
# By using this script, you indicate your acceptance of the following legal terms as well as our Terms of Use at https://www.ninjaone.com/fr/conditions-dutilisation
# Ownership Rights: NinjaOne owns and will continue to own all right, title, and interest in and to the script (including the copyright). NinjaOne is giving you a limited license to use the script in accordance with these legal terms. 
# Use Limitation: You may only use the script for your legitimate personal or internal business purposes, and you may not share the script with another party. 
# Republication Prohibition: Under no circumstances are you permitted to re-publish the script in any script library or website belonging to or under the control of any other software provider. 
# Warranty Disclaimer: The script is provided “as is” and “as available”, without warranty of any kind. NinjaOne makes no promise or guarantee that the script will be free from defects or that it will meet your specific needs or expectations. 
# Assumption of Risk: Your use of the script is at your own risk. You acknowledge that there are certain inherent risks in using the script, and you understand and assume each of those risks. 
# Waiver and Release: You will not hold NinjaOne responsible for any adverse or unintended consequences resulting from your use of the script, and you waive any legal or equitable rights or remedies you may have against NinjaOne relating to your use of the script. 
# EULA: If you are a NinjaOne customer, your use of the script is subject to the End User License Agreement applicable to you (EULA).
#
# Preset Parameter: --screenconnectdomain "replace.me"
#   Replace the text encased in quotes to have the script build the download URL and then install ScreenConnect.
#
# Preset Parameter: --useOrgName
#   Modifies your URL to use the organization name in the "Company Name" field in ScreenConnect.
#
# Preset Parameter: --useLocation
#   Modifies your URL to use the Location Name in the "Site" field in ScreenConnect.
#
# Preset Parameter: --useDeviceType
#   Modifies your URL to fill in the "Device Type" field in ScreenConnect. (Either Workstation or Laptop).
#
# Preset Parameter: --Department "REPLACEME"
#   Modifies your URL to fill in the Department name with the text encased in quotes.
#
# Preset Parameter: --skipSleep
#   By default, this script sleeps at a random interval (between 3 and 30 seconds) before downloading the installation file.
#   This option skips the random sleep interval.
#
# Preset Parameter: --help
#   Displays some help text.

# These are all our preset parameter defaults. You can set these = to something if you would prefer the script automatically assumed a parameter is used.
_arg_instanceId=
_arg_screenconnectdomain=
# For parameters that don't have arguments "on" or "off" is used.
_arg_useOrgName="off"
_arg_useLocation="off"
_arg_useDeviceType="off"
_arg_department=
_arg_filename="ClientSetup.pkg"
_arg_destfolder=/tmp
_arg_skipsleep="off"

# Help text function for when invalid input is encountered
print_help() {
  printf '\n\n%s\n\n' 'Usage: [--screenconnectdomain <arg>] [--useOrgName] [--useLocation] [--useDeviceType] [--department <arg>] [--skipSleep] [-h|--help]'
  printf '\n%s\n' 'Preset Parameter: --screenconnectdomain "replace.me"'
  printf '\t%s\n' "Replace the text encased in quotes with the domain used for ConnectWise ScreenConnect. ex. 'example.screenconnect.com'"
  printf '\n%s\n' 'Preset Parameter: --useOrgName'
  printf '\t%s\n' "Builds the url so the 'Company Name' field in ScreenConnect is filled in with the Organization Name."
  printf '\n%s\n' 'Preset Parameter: --useLocation'
  printf '\t%s\n' "Builds the url so the 'Site Name' field in ScreenConnect is filled in with the Location the device is in in Ninja."
  printf '\n%s\n' 'Preset Parameter: --useDeviceType'
  printf '\t%s\n' "Builds the url so the 'Device Type' field in ScreenConnect is filled in with the detected device type (Laptop or Workstation)."
  printf '\n%s\n' 'Preset Parameter: --department "YourDesiredDepartmentName"'
  printf '\t%s\n' "Builds the url so the 'Department' field in ScreenConnect is filled in with the text encased in quotes."
  printf '\n%s\n' 'Preset Parameter: --skipSleep'
  printf '\t%s\n' "By default this script will sleep at a random interval between 3 and 60 seconds prior to download. Use this option to skip this behavior."
  printf '\n%s\n' 'Preset Parameter: --help'
  printf '\t%s\n' "Displays this help menu."
}

# Determines whether or not help text is necessary and routes the output to stderr
die() {
  local _ret="${2:-1}"
  echo "$1" >&2
  test "${_PRINT_HELP:-no}" = yes && print_help >&2
  exit "${_ret}"
}

# Grabbing the parameters and parsing through them.
parse_commandline() {
  while test $# -gt 0; do
    _key="$1"
    case "$_key" in
    --screenconnectdomain | --domain)
      test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
      _arg_screenconnectdomain=$2
      shift
      ;;
    --screenconnectdomain=*)
      _arg_screenconnectdomain="${_key##--screenconnectdomain=}"
      ;;
    --useOrgName | --useorgname | --orgname)
      _arg_useOrgName="on"
      ;;
    --useLocation | --useOrgLocation | --uselocation | --location)
      _arg_useLocation="on"
      ;;
    --useDeviceType | --usedevicetype | --devicetype)
      _arg_useDeviceType="on"
      ;;
    --department | --Department)
      test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
      _arg_department="$2"
      shift
      ;;
    --department=*)
      _arg_department="${_key##--department=}"
      ;;
    --skipsleep | --skipSleep)
      _arg_skipsleep="on"
      ;;
    --help | -h)
      _PRINT_HELP=yes die 0
      ;;
    *)
      _PRINT_HELP=yes die "FATAL ERROR: Got an unexpected argument '$1'" 1
      ;;
    esac
    shift
  done
}

parse_commandline "$@"

# If dynamic script variables are used override the comand line arguments

if [[ -n $screenconnectDomainName ]]; then
  _arg_screenconnectdomain="$screenconnectDomainName"
fi

if [[ -n $useNinjaOrganizationName && $useNinjaOrganizationName == "true" ]]; then
  _arg_useOrgName="on"
fi

if [[ -n $useNinjaLocationName && $useNinjaLocationName == "true" ]]; then
  _arg_useLocation="on"
fi

if [[ -n $addDeviceType && $addDeviceType == "true" ]]; then
  _arg_useDeviceType="on"
fi

if [[ -n $department ]]; then
  _arg_department="$department"
fi

if [[ -n $skipSleep && $skipSleep == "true" ]]; then
  _arg_skipsleep="on"
fi

# This function will download our file when we're ready for that.
downloadFile() {
  i=1
  while [[ $i -lt 4 ]]; do
    if [[ ! $_arg_skipsleep == "on" ]]; then
      sleep_time=$((3 + RANDOM % 60))
      echo "Sleeping for $sleep_time seconds..."
      sleep $sleep_time
    fi

    echo "Download Attempt $i"
    curl -L "$url" -o "$_arg_destfolder/$_arg_filename" -s -f

    file=$_arg_destfolder/$_arg_filename
    if [[ -f $file ]]; then
      echo 'Download was successful!'
      i=4
    else
      echo 'Attempt Failed!'
      ((i += 1))
    fi
  done
}

# If we're not given a download method error out
if [[ -z $_arg_screenconnectdomain ]]; then
  _PRINT_HELP=yes die "FATAL ERROR: The domain you use for ScreenConnect is required to install ScreenConnect." 1
fi

pattern='^http(.?)://(.*)'
if [[ $_arg_screenconnectdomain =~ $pattern ]]; then
  _arg_screenconnectdomain=${_arg_screenconnectdomain//http*:\/\//}
  echo "You accidentally included http with the domain. Using '$_arg_screenconnectdomain' instead."
fi

# If the destination folder doesn't exist create it.
if [[ ! -d $_arg_destfolder ]]; then
  mkdir "$_arg_destfolder"
fi

# If a file already exists with that name remove it.
if [[ -f "$_arg_destfolder/$_arg_filename" ]]; then
  rm "$_arg_destfolder/$_arg_filename"
fi

# Start the build process
echo "Building URL..."
# For anything we put in the url we'll need to escape it as curl won't do this conversion for us.
companyName=$(echo "$NINJA_COMPANY_NAME" | perl -MURI::Escape -ne 'chomp;print uri_escape($_),"\n"')
baseURL="https://$_arg_screenconnectdomain/Bin/$companyName.ClientSetup.pkg?e=Access&y=Guest"

# If the technician specified --useOrgName (or any other switch/flag) we set it to "on" when we parse the parameters
if [[ $_arg_useOrgName == "on" ]]; then
  orgName=$(echo "$NINJA_ORGANIZATION_NAME" | perl -MURI::Escape -ne 'chomp;print uri_escape($_),"\n"')
  baseURL="$baseURL&c=$orgName"
else
  # If they decided to not use that field we just leave it blank so ScreenConnect will skip over it.
  baseURL="$baseURL&c="
fi

if [[ $_arg_useLocation == "on" ]]; then
  location=$(echo "$NINJA_LOCATION_NAME" | perl -MURI::Escape -ne 'chomp;print uri_escape($_),"\n"')
  baseURL="$baseURL&c=$location"
else
  baseURL="$baseURL&c="
fi

if [[ -n $_arg_department ]]; then
  _arg_department=$(echo "$_arg_department" | perl -MURI::Escape -ne 'chomp;print uri_escape($_),"\n"')
  baseURL="$baseURL&c=$_arg_department"
else
  baseURL="$baseURL&c="
fi

# Getting whether or not the device is a laptop is a bit tricky. Fortunately only MacBooks are laptops (everything else is too old to worry about e.g. PowerBooks).
if [[ $_arg_useDeviceType == "on" ]]; then
  modelName=$(system_profiler SPHardwareDataType -detaillevel mini | grep "Model Name" | sed 's/Model Name://' | xargs)
  modelIdentifier=$(system_profiler SPHardwareDataType -detaillevel mini | grep "Model Identifier" | sed 's/Model Identifier://' | xargs)

  if [[ $modelName == *"MacBook"* || $modelIdentifier == *"MacBook"* ]]; then
    deviceType="Laptop"
  else
    deviceType="Workstation"
  fi

  baseURL="$baseURL&c=$deviceType&c=&c=&c=&c="
else
  baseURL="$baseURL&c=&c=&c=&c=&c="
fi

url="$baseURL"
echo "URL Built: $url"

# At this point we should have everything setup for us to be able to download the file.
downloadFile

# Lets check if the download was a success
file="$_arg_destfolder/$_arg_filename"
if [[ ! -f $file ]]; then
  _PRINT_HELP=no die "FATAL ERROR: The Installation File has failed to download please try again." 1
fi

# Analyze .pkg file and grab application name
pkgutil --expand $file "$_arg_destfolder/ScreenConnect"
pkgname=$(grep -Eo "connectwisecontrol-.*" "$_arg_destfolder/ScreenConnect/PackageInfo" | sed 's/".*//')

# Grabs a list of all installed packages and then filters it by connectwisecontrol-yourinstanceid
if [[ -z $pkgname ]]; then
  echo "WARNING: Failed to get package name from .Pkg file. Checking if ANY ScreenConnect instance is installed."
  installedPkg=$(pkgutil --pkgs | grep "connectwisecontrol-")
else
  installedPkg=$(pkgutil --pkgs | grep "$pkgname")
fi

if [[ -n $installedPkg ]]; then
  echo "Connectwise ScreenConnect is already installed!"
  exit 0
else
  echo "ConnectWise ScreenConnect is not installed. Installing..."
fi

# Start installing
echo "Installing application..."
if installer -pkg "$file" -target /; then
  echo "Exit Code: $?"
  echo "Connectwise ScreenConnect Installed Successfully!"
  rm "$file"
  exit 0
else
  echo "Exit Code: $?"
  rm "$file"
  _PRINT_HELP=no die "FATAL ERROR: The Installation has failed!" 1
fi

 

Description détaillée

Le script commence par définir une série de paramètres prédéfinis. Ces paramètres comprennent le domaine ConnectWise, des options permettant d’inclure le nom de l’organisation, l’emplacement et le type de l’appareil, ainsi qu’un identifiant de département. Une caractéristique notable est le paramètre “–skipSleep”, conçu pour contourner un intervalle de sommeil aléatoire avant de lancer le téléchargement, un ajout astucieux pour accélérer le processus d’installation lorsque cela est nécessaire.

Lors de l’exécution, le script analyse d’abord les arguments de la ligne de commande fournis, en définissant les variables appropriées en fonction de l’entrée de l’utilisateur. Il convient de noter sa souplesse d’adaptation à différents formats de paramètres (comme –useOrgName et –useorgname), ce qui le rend facile à utiliser.

Le script crée ensuite l’URL de téléchargement du programme d’installation de ConnectWise Control. Cette étape consiste à ajouter dynamiquement à l’URL des paramètres tels que le nom de l’organisation, la localisation et le type d’appareil. Il s’agit d’une partie essentielle du script, car elle permet d’adapter le paquet d’installation aux besoins spécifiques de l’organisation ou de l’appareil.

Le processus de téléchargement, géré par la fonction downloadFile, comprend une logique de gestion des erreurs et de réessai, garantissant un téléchargement fiable même dans des conditions de réseau moins qu’idéales. Le script tente de télécharger le fichier jusqu’à trois fois si nécessaire, ce qui constitue une approche solide pour gérer les problèmes de téléchargement potentiels.

Après le téléchargement, le script vérifie si ConnectWise Control est déjà installé, évitant ainsi une réinstallation inutile. S’il n’est pas déjà installé, il procède à l’installation du logiciel.

Cas d’utilisation potentiels

Prenons l’exemple d’un MSP qui gère l’infrastructure informatique de plusieurs petites entreprises. Chaque entreprise peut avoir des configurations différentes, comme des départements ou des types d’appareils distincts. Grâce à ce script, le MSP peut rapidement déployer ConnectWise Control sur tous les appareils clients, en fonction de la configuration spécifique de chaque entreprise, ce qui améliore l’efficacité et réduit les erreurs manuelles.

Comparaisons

Traditionnellement, de telles installations nécessitaient un téléchargement et une configuration manuels sur chaque appareil ou l’utilisation d’outils de déploiement en masse qui n’offraient pas toujours le même niveau de personnalisation. Ce script offre une approche plus rationalisée et personnalisable, particulièrement utile pour les environnements ayant des besoins de configuration variés et spécifiques.

FAQ

Q : Ce script peut-il être utilisé pour d’autres systèmes d’exploitation que macOS ?
R : Non, ce script est spécifiquement conçu pour macOS.

Q : Est-il possible de modifier le script pour différents logiciels de téléassistance ?
R : Oui, moyennant des modifications appropriées de la logique de construction et d’installation des URL, il pourrait être adapté à d’autres logiciels.

Implications

Bien que ce script améliore considérablement l’efficacité, il est essentiel de prendre en compte les implications en matière de sécurité. Les scripts automatisés peuvent être un vecteur de failles de sécurité s’ils ne sont pas gérés correctement. S’assurer que le script provient d’une URL sécurisée et vérifier l’intégrité du paquet téléchargé sont des étapes cruciales.

Recommandations

Les meilleures pratiques prévoient des révisions et des mises à jour régulières du script pour tenir compte de tout changement dans le processus d’installation de ConnectWise Control ou des mises à jour de macOS. Il est également essentiel de veiller à ce que le script soit exécuté dans un environnement sécurisé afin d’éviter toute faille de sécurité.

Conclusion :

Dans le contexte de NinjaOne, une plateforme de gestion informatique unifiée, ce script illustre le type d’ efficacité et d’automatisation qui peut être intégré dans des stratégies de gestion informatique plus larges. Ces scripts d’automatisation, combinés à un outil complet comme NinjaOne, peuvent améliorer de manière significative l’efficacité de la gestion informatique, en particulier dans des environnements divers et dynamiques.