Automatisch importeren en exporteren van Alias-configuratie

Inleiding

In dit document worden de stappen beschreven voor het automatiseren van de taken voor het configureren van aliassen voor importeren en exporteren binnen Email Security Appliance.

Voorwaarden

Vereisten

Cisco raadt kennis van deze onderwerpen aan:

• Cisco Secure Email Gateway (SEG / ESA) AsyncOS 16.0.2
• Opdrachtregelinterface toegang tot Cloud Appliance
• Linux-CLI
• Shell-scripting

Gebruikte componenten

De informatie in dit document is gebaseerd op deze software:

• Cloud Email Security Appliance (CESA)
• opdonder

De informatie in dit document is gebaseerd op de apparaten in een specifieke laboratoriumomgeving. Alle apparaten die in dit document worden beschreven, hadden een opgeschoonde (standaard)configuratie. Als uw netwerk live is, moet u zorgen dat u de potentiële impact van elke opdracht begrijpt.

Achtergrondinformatie

Het doel is om bepaalde taken te automatiseren, maar sommige processen vereisen meestal handmatige interventie. In het geval van het importeren en exporteren van de huidige aliasconfiguratie kunnen deze taken echter volledig worden geautomatiseerd, waardoor handmatige invoer overbodig wordt.

Exporteren en importeren van Alias Tabel

Om een aliastabel te importeren, begint u met het verifiëren van SSH- en SCP-toegang om ervoor te zorgen dat u verbinding kunt maken met de e-mailgateway.

Alvorens verder te gaan, moet er een aliastabel in het toestel aanwezig zijn:

(Machine esa1.xyz.iphmx.com) (SERVICE)> clustermode cluster; aliasconfig print

test: test@example.com, test@example2.com, test@example3.com
test2: test@domain.com, test@domain2.com, test@domain3.com
(Cluster Hosted_Cluster) (SERVICE)>

Wanneer u de subopdracht export van de opdracht aliasconfig gebruikt om een back-up te maken van een bestaande aliastabel, wordt een bestand (met een door u opgegeven naam) gegenereerd en opgeslagen in de map /configuration voor de listener.

Aliastabel exporteren met Bash-script

In dit geval maakt een bash-script verbinding met uw CES-toestel en gaat het verder met het exporteren van het aliasbestand

Het bash script is gestructureerd zoals getoond:

#!/bin/bash

# Configuration of SSH keys and paths
PROXY_KEY="/full/path/folder/.ssh/id_rsa"
SECOND_KEY="/full/path/folder/.ssh/id_rsa"
LOCAL_PORT="2200"
PROXY_USER="dh-user"
PROXY_HOST="f4-ssh.iphmx.com"
TARGET_HOST="esa1.xyz.iphmx.com"
REMOTE_USER="local_server_user"
REMOTE_FILE="/configuration/filename.csv"
LOCAL_DIR="/full/path/folder/Downloads"
LOCAL_FILE_PATH="${LOCAL_DIR}/aliasconfig-file.csv"

# 1. Connect to the proxy and set up the SSH tunnel
echo "Establishing connection to the proxy..."
ssh -i "$PROXY_KEY" -l "$PROXY_USER" -N -f "$PROXY_HOST" -L "$LOCAL_PORT:${TARGET_HOST}:22"
if [ $? -ne 0 ]; then
    echo "Error: Failed to establish connection to the proxy."
    exit 1
fi
echo "Proxy connection established."

# Pause for 5 seconds before proceeding
sleep 5

# 2. Export the aliasconfig file from the remote system
echo "Exporting aliasconfig file from the remote system..."
ssh -i "$SECOND_KEY" "$REMOTE_USER"@127.0.0.1 -p "$LOCAL_PORT" 'clustermode cluster; aliasconfig export aliasconfig-file.csv' 2>/dev/null
if [ $? -ne 0 ]; then
    echo "Error: Failed to export the aliasconfig file."
    exit 1
fi
echo "Aliasconfig file successfully exported."

# Pause for 5 seconds before proceeding
sleep 5

# 3. Download the file to the local directory
echo "Downloading file to the local directory..."
scp -i "$SECOND_KEY" -P "$LOCAL_PORT" -O "$REMOTE_USER"@127.0.0.1:"$REMOTE_FILE" "$LOCAL_DIR" 2>/dev/null
if [ $? -ne 0 ]; then
    echo "Error: Failed to download the file to the local directory."
    exit 1
fi
echo "File successfully downloaded to: $LOCAL_FILE_PATH"

# Pause for 5 seconds before finalizing
sleep 5

# Finalizing the script
echo "Process completed successfully."
exit 0

verklaring

1.- Configuratie van SSH-sleutels en -paden

• PROXY_KEY en SECOND_KEY: Het volledige pad naar het SSH-bestand met privésleutels dat wordt gebruikt voor verificatie. Beide toetsen zijn in dit geval op hetzelfde pad ingesteld.
• Voorbeeld: /full/path/folder/.ssh/id_rsa
• LOCAL_PORT: Specificeert de lokale poort (2200) voor de SSH-tunnel.
• PROXY_USER: De gebruikersnaam die wordt gebruikt voor de verbinding met de proxyserver.
• PROXY_HOST: De hostnaam van de proxyserver.
• TARGET_HOST: De volledig gekwalificeerde domeinnaam (FQDN) van de doelhost, bijgewerkt naar esa1.xyz.iphmx.com.
• REMOTE_USER: De gebruikersnaam die wordt gebruikt voor de verbinding met het externe toestel via de SSH-tunnel.
• REMOTE_FILE: Het pad op het externe systeem waar het geëxporteerde bestand is opgeslagen (/configuration/filename.csv).
• LOCAL_DIR: De lokale map voor het opslaan van het bestand is ingesteld op /full/path/folder/Downloads.
• LOCAL_FILE_PATH: Het volledige lokale pad voor het gedownloade bestand, bijgewerkt naar ${LOCAL_DIR}/aliasconfig-file.csv.

2.- Verbinding maken met de proxy en de SSH-tunnel instellen

echo "Establishing connection to the proxy..."
ssh -i "$PROXY_KEY" -l "$PROXY_USER" -N -f "$PROXY_HOST" -L "$LOCAL_PORT:${TARGET_HOST}:22"

• Doel:
  - Hiermee wordt een SSH-tunnel naar de proxyserver ingesteld voor veilige communicatie met de doelhost.
• Updates:
  - De SSH private key bevindt zich nu op /full/path/folder/.ssh/id_rsa.
  - De doelhostnaam is bijgewerkt naar esa1.xyz.iphmx.com.
• Foutafhandeling:
  - Als de verbinding mislukt, wordt een foutbericht weergegeven en wordt het script afgesloten met een foutcode (exit 1).

3.- Pauzeer gedurende 5 seconden voordat u verdergaat

• Doel:
  - introduceert een vertraging om ervoor te zorgen dat de SSH-tunnel volledig is aangelegd voordat wordt overgegaan tot de volgende stap.

4.- Exporteer het aliasconfig-bestand vanaf het externe systeem

echo "Exporting aliasconfig file from the remote system..."
ssh -i "$SECOND_KEY" "$REMOTE_USER"@127.0.0.1 -p "$LOCAL_PORT" 'clustermode cluster; aliasconfig export aliasconfig-file.csv' 2>/dev/null

• Doel:
  - Maakt verbinding met de doelhost via de SSH-tunnel en exporteert de aliasconfiguratie naar een bestand met de naam aliasconfig-file.csv.
• Updates:
  - De bestandsnaam voor het geëxporteerde bestand is bijgewerkt naar aliasconfig-file.csv.
• Uitvoeromleiding:
  - 2>/dev/null onderdrukt foutmeldingen van de SSH-opdracht.
• Foutafhandeling:
  - Als het exporteren mislukt, wordt een foutmelding weergegeven en wordt het script afgesloten.

5.- Download het bestand naar de lokale map

echo "Downloading file to the local directory..."
scp -i "$SECOND_KEY" -P "$LOCAL_PORT" -O "$REMOTE_USER"@127.0.0.1:"$REMOTE_FILE" "$LOCAL_DIR" 2>/dev/null

• Doel:
  - Gebruikt scp om het geëxporteerde bestand veilig van het externe systeem naar de lokale directory te kopiëren.
• Updates:
  - Het lokale bestand wordt opgeslagen als aliasconfig-file.csv in de map /full/path/folder/Downloads.
• Foutafhandeling:
  - Als het downloaden van het bestand mislukt, wordt een foutbericht weergegeven en wordt het script afgesloten.

Het script voltooien

echo "Process completed successfully."
exit 0

• Doel:
  - Voert een succesbericht uit en verlaat het script met een succescode (exit 0), wat aangeeft dat alle bewerkingen succesvol zijn voltooid.

SSH-toetsen

U kunt in het script twee variabelen PROXY_KEY en HOST_KEY noteren. Deze sleutels kunnen hetzelfde of anders zijn.

De PROXY_KEY wordt gebruikt om verbinding te maken met de proxycloud die verplicht is om naar uw CESA-servers te springen.

De HOST_KEY is de sleutel die wordt gebruikt om in te loggen als een lokale gebruiker, waardoor er geen wachtwoord nodig is.

Opmerking: Raadpleeg de configuratiegids voor het configureren van SSH-toegang tot de CES-proxy en het instellen van een SSH-sleutel voor een lokale gebruiker op het toestel.

Het geëxporteerde bestand controleren

Nadat het exportscript is uitgevoerd, kunt u de inhoud ervan controleren en kunt u zien dat het dezelfde informatie bevat als het origineel dat wordt weergegeven in de CLI-opdracht aliasconfig.

$ pwd
/full/path/folder/Downloads
$ ls
filename.csv
$ cat filename.csv
# File exported by the CLI at 20250702T125347
test: test@example.com, test@example2.com, test@example3.com
test2: test@domain.com, test@domain2.com, test@domain3.com⏎

Aliastabel importeren met Bash-script

Nadat u het huidige aliasbestand hebt geëxporteerd, kunt u het wijzigen, de benodigde items toevoegen en vervolgens importeren in de configuratie van ESA alia.

Het import bash script is gestructureerd zoals getoond:

#!/bin/bash

# Configuration of SSH keys and paths
SSH_KEY="/full/path/folder/.ssh/id_rsa"
LOCAL_PORT="2200"
REMOTE_USER="local_server_user"
LOCAL_FILE="/full/path/folder/Downloads/new-filename.csv"
OUTPUT_DIR="/full/path/folder/Downloads"

# Get the current local date in the desired format
CURRENT_DATE=$(date +"%Y-%m-%d_%H-%M-%S")

# 1. Upload the new aliasconfig file
echo "Uploading new aliasconfig file to the remote system..."
scp -i "$SSH_KEY" -P "$LOCAL_PORT" -O "$LOCAL_FILE" "$REMOTE_USER"@127.0.0.1:/configuration 2>/dev/null
if [ $? -ne 0 ]; then
    echo "Error: Failed to upload the aliasconfig file."
    exit 1
fi
echo "Aliasconfig file successfully uploaded."

# Pause for 5 seconds before proceeding
sleep 5

# 2. Import the new aliasconfig file and commit with a comment
COMMIT_COMMENT="Importing new entries to aliasconfig - $CURRENT_DATE"
echo "Importing the new aliasconfig file and committing changes..."
ssh -i "$SSH_KEY" "$REMOTE_USER"@127.0.0.1 -p "$LOCAL_PORT" "clustermode cluster; aliasconfig import new-filename.csv; commit \"$COMMIT_COMMENT\"" 2>/dev/null
if [ $? -ne 0 ]; then
    echo "Error: Failed to import the aliasconfig file or commit changes."
    exit 1
fi
echo "Aliasconfig file successfully imported and committed with comment: '$COMMIT_COMMENT'."

# Pause for 5 seconds before proceeding
sleep 5

# 3. Print the current aliasconfig and save it to a new file
OUTPUT_FILE="${OUTPUT_DIR}/current-aliasconfig-${CURRENT_DATE}.txt"
echo "Printing current aliasconfig and saving it to: $OUTPUT_FILE..."
ssh -i "$SSH_KEY" "$REMOTE_USER"@127.0.0.1 -p "$LOCAL_PORT" 'clustermode cluster; aliasconfig print' > "$OUTPUT_FILE" 2>/dev/null
if [ $? -ne 0 ]; then
    echo "Error: Failed to print the current aliasconfig."
    exit 1
fi
echo "Current aliasconfig successfully saved to: $OUTPUT_FILE"

# Finalizing the script
echo "Process completed successfully."
exit 0

verklaring

1.- Configuratie van SSH-pad en -sleutel

• SSH_KEY: pad naar het SSH-bestand met privésleutels, dat wordt gebruikt voor een veilige verificatie tegen de externe server.
• LOCAL_PORT: Lokale poort die is aangewezen voor de SSH-tunnel.
• REMOTE_USER: gebruikersaccount voor verificatie op de externe server.
• LOCAL_FILE: Lokaal pad naar het aliasconfig CSV-bestand dat moet worden geïmporteerd.
• OUTPUT_DIR: Lokale map waarin een kopie van de huidige configuratie wordt opgeslagen na het importproces.

2.- Huidige datum en tijd ophalen

CURRENT_DATE=$(date +"%Y-%m-%d_%H-%M-%S")

• Doel:
  - Bewaar de huidige datum en tijd in een specifieke indeling voor gebruik in bestandsnamen en opmerkingen.
• Updates:
  - Maakt eenvoudig bijhouden en organiseren van logs en back-ups door tijdstempel.

3.- Upload het nieuwe aliasconfig-bestand naar de externe ESA-server

Dit is de nieuwe inhoud van het aliasconfig-bestand:

# File exported by the CLI at 20250709T112719
test: new-data@example.com, new-date@example2.com, new-date@example3.com
test2: new-date@domain.com, new-data@domain2.com, new-data@domain3.com⏎

Ga verder met de instructie om het bestand te uploaden:

echo "Uploading new aliasconfig file to the remote system..."
scp -i "$SSH_KEY" -P "$LOCAL_PORT" -O "$LOCAL_FILE" "$REMOTE_USER"@127.0.0.1:/configuration 2>/dev/null
if [ $? -ne 0 ]; then
    echo "Error: Failed to upload the aliasconfig file."
    exit 1
fi
echo "Aliasconfig file successfully uploaded."

• Doel:
  - Breng het CSV-bestand met de aliasconfig over van het lokale systeem naar de map /configuration op de externe server met SCP via SSH.
• Updates:
  - Als het uploaden mislukt, geeft het script een fout weer en stopt het om onvolledige import te voorkomen.

4.- Importeer het bestand New aliasconfig en Commit with a Comment

COMMIT_COMMENT="Importing new entries to aliasconfig - $CURRENT_DATE"
echo "Importing the new aliasconfig file and committing changes..."
ssh -i "$SSH_KEY" "$REMOTE_USER"@127.0.0.1 -p "$LOCAL_PORT" "clustermode cluster; aliasconfig import new-filename.csv; commit \"$COMMIT_COMMENT\"" 2>/dev/null
if [ $? -ne 0 ]; then
    echo "Error: Failed to import the aliasconfig file or commit changes."
    exit 1
fi
echo "Aliasconfig file successfully imported and committed with comment: '$COMMIT_COMMENT'."

• Doel:
  - Verbinding maken via SSH, het geüploade CSV-bestand importeren in de aliasconfiguratie en de wijzigingen vastleggen met een opmerking met tijdstempel voor het bijhouden.
• Updates:
  - Als het importeren of vastleggen mislukt, wordt een foutmelding weergegeven en wordt het script afgesloten om de configuratie consistent te houden.

5.- Druk de huidige aliasconfig af en sla deze op in een nieuw lokaal bestand

OUTPUT_FILE="${OUTPUT_DIR}/current-aliasconfig-${CURRENT_DATE}.txt"
echo "Printing current aliasconfig and saving it to: $OUTPUT_FILE..."
ssh -i "$SSH_KEY" "$REMOTE_USER"@127.0.0.1 -p "$LOCAL_PORT" 'clustermode cluster; aliasconfig print' > "$OUTPUT_FILE" 2>/dev/null
if [ $? -ne 0 ]; then
    echo "Error: Failed to print the current aliasconfig."
    exit 1
fi
echo "Current aliasconfig successfully saved to: $OUTPUT_FILE"

• •Doel:
  - Maak verbinding via SSH, druk de huidige aliasconfiguratie af en sla de uitvoer op in een lokaal bestand met een tijdstempel voor back-up en controle.
• Updates:
  - Als de bewerking mislukt, geeft het script een fout weer en stopt het om te voorkomen dat onvolledige resultaten worden gegeven.

Wijzigingen controleren

Nadat het script is uitgevoerd, kunt u de wijzigingen in de tabel met aliasconfiguratie controleren en de toewijzingen in de systeemlogboeken controleren.

Nieuwe items in de AliasConfig-tabel controleren

Er zijn nieuwe wijzigingen aangebracht in de tabel.

(Machine esa1.xyz.iphmx.com) (SERVICE)> clustermode cluster; aliasconfig print

test: new-data@example.com, new-data@example2.com, new-data@example3.com
test2: new-data@domain.com, new-data@domain2.com, new-data@domain3.com

Wijzigingen vastleggen controleren

Met deze opdracht kunt u de aan het ESA toegezegde wijzigingen bijhouden en controleren, inclusief de gebruiker die de wijziging heeft aangebracht en de datum waarop deze heeft plaatsgevonden.

(Machine esa1.xyz-66.iphmx.com) (SERVICE)> grep "commit" system_logs
Wed Jul  9 11:29:42 2025 Info: PID 95790: User local_server_user commit changes: Importing new entries to aliasconfig - 2025-07-09_11-29-15

Scriptflexibiliteit

Hoewel dit script momenteel in Bash is geschreven, kan het eenvoudig worden aangepast of herschreven in andere scripts of programmeertalen, zoals Python, PowerShell of Perl-om beter af te stemmen op de voorkeuren of vereisten van verschillende beheerders en omgevingen. Deze flexibiliteit zorgt ervoor dat de kernlogica en -workflow behouden kunnen blijven en maakt gebruik van de taal of tools die het meest aansluiten bij uw operationele vereisten.

Laatste gedachten

Dit import/export script biedt een praktische en efficiënte oplossing voor het beheer van aliasconfiguraties direct op het toestel. Door het uploaden, importeren en back-uppen van configuratiebestanden te automatiseren, kunnen beheerders veilig en betrouwbaar wijzigingen invoeren zonder handmatige tussenkomst. Het script stroomlijnt niet alleen het proces, maar zorgt ook voor traceerbaarheid door back-ups met tijdstempels te maken en opmerkingen te maken.

Bovendien helpt het hebben van een dergelijk script de consistentie en naleving in uw omgeving te behouden, vooral wanneer meerdere wijzigingen of bulkupdates nodig zijn. Regelmatige back-ups van de huidige configuratie bieden een extra beveiligingslaag, waardoor snel herstel of terugdraaien mogelijk is indien nodig.

Over het algemeen stelt deze aanpak teams in staat om configuratie-updates met meer vertrouwen, controle en efficiëntie te beheren. Voor toekomstige aanpassingen kan het script eenvoudig worden aangepast om andere typen configuratiebestanden te verwerken of extra onderhoudstaken verder te automatiseren.

Referentielinks

• Toegang tot de Command Line Interface (CLI) van uw Cloud Email Security (CES)-oplossing
• CLI-instructies: PuTTY [Windows/pc-gebruikers]
• SSH Public Key Authentication configureren voor aanmelding bij de ESA zonder wachtwoord