Guide complet de script : Changer le nom d’hôte d’une machine Linux

Points à retenir

• Automatise les changements de nom d’hôte: Ce script rationalise le processus de modification des noms d’hôtes sur les systèmes Linux, améliorant ainsi l’efficacité.
• Prise en charge de fonctions multiples: Offre des options pour mettre à jour le nom d’hôte, le fichier d’hôte, le joli nom et redémarrer le système.
• Validation et contrôle des erreurs: Incorpore des contrôles pour les commandes existantes et valide les changements afin d’éviter les mauvaises configurations.
• Analyse conviviale des arguments: Simplifie l’utilisation grâce à des arguments clairs pour les différentes fonctionnalités.
• Réduit l’erreur humaine: L’automatisation réduit le risque d’erreurs manuelles dans le processus de changement de nom d’hôte.
• Améliore la gestion des technologies de l’information: Un outil précieux pour les professionnels de l’informatique et les MSP pour la gestion de plusieurs appareils Linux.
• Méthodes script et méthodes traditionnelles: Offre une approche plus efficace que l’édition manuelle des fichiers système.
• Sûreté et sécurité: Recommande des sauvegardes et des tests d’environnement contrôlé pour assurer la stabilité du réseau.
• Intégration avec les outils de gestion: Souligne les avantages de l’intégration de ces scripts dans des plateformes telles que NinjaOne pour rationaliser les opérations.
• Essentiel pour la gestion du réseau: Met l’accent sur le rôle du script dans le maintien de l’uniformité et de la sécurité dans la gestion des réseaux.

La gestion d’un réseau de machines Linux implique diverses tâches, dont l’une consiste à modifier le nom d’hôte d’un périphérique. Cette opération, apparemment simple, joue un rôle crucial dans la gestion du réseau et l’identification des appareils.

Contexte

Le script en question est conçu pour modifier le nom d’hôte d’un périphérique Linux. Il est particulièrement important pour les professionnels de l’informatique et les fournisseurs de services gérés (MSP) qui gèrent plusieurs appareils Linux. Un tel script garantit l’uniformité, facilite la gestion et contribue à de meilleures pratiques en matière de sécurité.

Le script :

#!/bin/bash

# Description: Change the hostname for a linux device (require's hostnamectl/systemd). Host file update expects the hostname to not be fully qualified.
#
# Release Notes: Initial Release
# 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/terms-of-use.
#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).
#
# Below are all the (case sensitive) valid parameters for this script.
# Only the new computer name / pretty name is required!
# Preset Parameter: "ReplaceWithNewComputerName"
# Preset Parameter: "ReplaceWithNewComputerName" --update-hostfile
#   --update-hostfile: Will replace the non-fqdn in /etc/hosts with the name given in the script (will not un-fullyqualify it)
# Preset Parameter: "ReplaceWithNewPrettyName" --prettyname-only
#   --prettyname-only: Set's the 'Pretty' name used by some applications.
# Preset Parameter: "ReplaceWithNewComputerName" --restart
#   --restart: Restart's the machine after updating the hostname. This is required for the new name to take immediate effect.

print_help() {
  printf '\n### Below are all the (case sensitive) valid parameters for this script. ###\n'
  printf '### Only the new computer name / pretty name is required! ###\n'
  printf 'Preset Parameter: "ReplaceWithNewComputerName" \n'
  printf 'Preset Parameter: "ReplaceWithNewComputerName" --update-hostfile \n'
  printf '\t%s\n' "--update-hostfile: Will replace the non-fqdn in /etc/hosts with the name given in the script (will not un-fullyqualify it)"
  printf 'Preset Parameter: "ReplaceWithNewPrettyName" --prettyname-only \n'
  printf '\t%s\n' "--prettyname-only: Set's the 'Pretty' name used by some applications."
  printf 'Preset Parameter: "ReplaceWithNewComputerName" --restart \n'
  printf '\t%s\n' "--restart: Restart's the machine after updating the hostname. This is required for the new name to take immediate effect."
}

# 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}"
}

# Commands required for this script
required_cmds="hostnamectl sed sleep echo"
for i in $required_cmds; do
  check=$(type -P "$i" 2>/dev/null)
  if [[ -z $check ]]; then
    _PRINT_HELP=yes die "FATAL ERROR: The command $i was not found and is required!" 1
  fi
done

# THE DEFAULTS INITIALIZATION - OPTIONALS
_arg_prettyname_only="off"
_arg_update_hostfile="off"
_arg_restart="off"
typical="on"

# Grabbing the parameters and parsing through them.
parse_commandline() {
  while test $# -gt 0; do
    _key="$1"
    case "$_key" in
    --prettyname-only)
      typical="off"
      _arg_prettyname_only="on"
      ;;
    --update-hostfile)
      _arg_update_hostfile="on"
      ;;
    --restart)
      _arg_restart="on"
      ;;
    --*)
      _PRINT_HELP=yes die "FATAL ERROR: Got an unexpected argument '$1'" 1
      ;;
    *)
      if [[ -z $_arg_name ]]; then
        _arg_name=$1
      else
        _PRINT_HELP=yes die "FATAL ERROR: Got an unexpected argument '$1' but the new computername '$_arg_name' was already specified" 1
      fi
      ;;
    esac
    shift
  done
}

# Initializes parameter processing
parse_commandline "$@"

if [[ -n $setHostnameTo ]]; then
  _arg_name=$setHostnameTo
fi

if [[ -n $forceRestart && $forceRestart == "true" ]]; then
  _arg_restart="on"
fi

if [[ -n $action ]]; then
  if [[ $action == "Set Pretty Name" ]]; then
    _arg_prettyname_only="on"
    typical="off"
  fi

  if [[ $action == "Set Hostname and Update Host File" ]]; then
    _arg_update_hostfile="on"
  fi
fi

# Old hostname to use when updating the hosts file or checking success
old_name=$(hostname)

# Error out on invalid combo
if [[ $typical == "off" && $_arg_update_hostfile == "on" ]]; then
  _PRINT_HELP=yes die 'FATAL ERROR: --update-hostfile and --prettyname-only cannot be used together.' 1
fi

# If the new computer name isn't given error out
if [[ -z $_arg_name ]]; then
  _PRINT_HELP=yes die 'FATAL ERROR: No Computer Name was given! Please enter in the new name in the "Preset Parameter" box in Ninja! For Example "MyNewName".' 1
fi

# If the typical use case is given proceed with changing the hostname
if [[ $typical == "on" ]]; then

  pattern='^[a-zA-Z0-9]([a-zA-Z0-9-]{0,253}[a-zA-Z0-9])?$'
  if [[ $_arg_name =~ [^a-zA-Z0-9-] ]] || [[ ! $_arg_name =~ $pattern ]]; then
    _PRINT_HELP=yes die 'FATAL ERROR: Hostname has invalid characters or spaces. Hostname can only contain A-Z characters, Digits or Hyphens.' 1
  fi

  # Converts the variables to lowercase prior to comparing them
  if [[ "${old_name,,}" == "${_arg_name,,}" ]]; then
    _PRINT_HELP=yes die "FATAL ERROR: The name $old_name is already set. Please enter a new name in the 'Preset Parameter' box in Ninja! For Example 'MyNewName'." 1
  fi

  # Sets the hostname
  hostnamectl set-hostname "$_arg_name"

  # Sleep for a few seconds prior to checking that the change worked
  sleep 7

  current_hostname=$(hostnamectl --static)

  # Checking if the hostname got set correctly
  if ! [[ "${current_hostname,,}" == "${_arg_name,,}" ]]; then
    _PRINT_HELP=no die "FATAL ERROR: Failed to set the hostname from $current_hostname to $_arg_name using hostnamectl is this a systemd system?" 1
  else
    echo "Successfully updated the hostname to '$current_hostname'!"
    printf "\nWARNING: The displayname in Ninja will need to be manually updated however the 'Device Name' section will update itself.\n\n"
  fi

  # If requested to update the hosts file update it
  if [[ $_arg_update_hostfile == "on" ]]; then
    echo "Replacing $old_name in /etc/hosts with $_arg_name (if $old_name is in /etc/hosts at all)"
    sed -i "s/$old_name/$_arg_name/" /etc/hosts
  fi
fi

# If requested to update the pretty name update it
if [[ $_arg_prettyname_only == "on" ]]; then
  current_hostname=$(hostnamectl --pretty)

  if [[ "${current_hostname,,}" == "${_arg_name,,}" ]]; then
    _PRINT_HELP=no die "FATAL ERROR: The pretty name $current_hostname is already set. Please enter a new name in the 'Preset Parameter' box in Ninja! For Example 'MyNewName'." 1
  fi

  hostnamectl set-hostname --pretty "$_arg_name"

  sleep 7

  current_hostname=$(hostnamectl --pretty)
  if ! [[ "${current_hostname,,}" == "${_arg_name,,}" ]]; then
    _PRINT_HELP=no die "FATAL ERROR: Failed to set the pretty name from $current_hostname to $_arg_name using hostnamectl is this a systemd system?" 1
  else
    echo "Successfully updated the pretty name to '$current_hostname'!"
  fi
fi

if [[ $_arg_restart == "on"  ]]; then
  echo "A restart was requested, restarting..."
  shutdown -r
else
  echo "Please restart this computer at your earliest convenience."
fi

 

Description détaillée

Le script fonctionne de la manière suivante :

• Contrôles initiaux et paramètres: Il commence par vérifier la présence des commandes nécessaires comme hostnamectl, sed, sleep et echo. Si l’un d’entre eux est manquant, le script génère une erreur.
• Analyse des arguments: Le script accepte divers arguments pour définir le nouveau nom d’hôte, mettre à jour le fichier d’hôte, définir le joli nom ou redémarrer la machine. Chaque argument déclenche des actions spécifiques dans le script.
• Définition et validation du nom d’hôte: Si le scénario classique est choisi, le script définit le nouveau nom d’hôte à l’aide de hostnamectl et vérifie la modification.
• Mise à jour du fichier des hôtes: Si cela est demandé, le script met à jour le fichier /etc/hosts avec le nouveau nom d’hôte.
• Jolie mise à jour du nom: Pour mettre à jour le « joli » nom, le script utilise à nouveau hostnamectl et valide le changement.
• Option de redémarrage: Enfin, le script propose de redémarrer la machine pour appliquer immédiatement les modifications.

Cas d’utilisation potentiels

Prenons l’exemple d’un administrateur informatique d’une grande entreprise chargé de renommer plusieurs serveurs basés sur Linux à la suite d’une initiative de rebranding. Grâce à ce script, l’administrateur peut automatiser le processus, ce qui garantit la cohérence et permet de gagner beaucoup de temps.

Comparaisons

Traditionnellement, la modification d’un nom d’hôte implique la modification manuelle de fichiers tels que /etc/hostname et /etc/hosts, suivie d’un redémarrage du système. Ce script automatise ces étapes, réduisant ainsi le risque d’erreur humaine et rationalisant le processus.

FAQ

• Le script est-il compatible avec toutes les distributions Linux ?
  • Il est conçu pour les systèmes utilisant hostnamectl, que l’on trouve couramment dans les distributions modernes comme Ubuntu, Fedora et CentOS.

• Que se passe-t-il si je ne dois changer que le « joli » nom ?
  • Utilisez l’argument –prettyname-only. Il ignore les autres actions et ne met à jour que le joli nom.

• Un redémarrage du système est-il toujours nécessaire ?
  • Ce n’est pas toujours le cas, mais un redémarrage permet de s’assurer que les modifications ont bien été appliquées.

Implications

Bien que le script facilite les changements de noms d’hôtes, une utilisation incorrecte peut entraîner des erreurs de configuration du réseau. Il est essentiel de disposer d’un mécanisme de sauvegarde et de validation adéquat pour éviter de perturber les services du réseau.

Recommandations

• Testez d’abord le script dans un environnement contrôlé.
• Assurez-vous que vous disposez des autorisations nécessaires avant d’exécuter le script.
• Sauvegardez les fichiers système essentiels tels que /etc/hosts avant d’effectuer des modifications.

Conclusion :

Dans le domaine de la gestion des appareils, des outils comme NinjaOne fournissent une plateforme complète pour gérer efficacement ces opérations. L’intégration de scripts dans ces systèmes permet de rationaliser davantage les processus de gestion informatique, en facilitant les tâches telles que le changement de nom d’hôte, tout en garantissant la cohérence et en réduisant les erreurs humaines.