Einführung in die Micetro-REST-API (v25.1+)
Automatisieren und integrieren Sie alle Aspekte Ihrer DNS-, DHCP- und IP-Adressverwaltung
Die wichtigsten ErkenntnisseDiese Kernaussage wurde dadurch generiert, dass große Sprachmodelle die Seite durchsuchten und einen Überblick über den Inhalt erstellten.Das Whitepaper stellt die Micetro-REST-API (v25.1+) vor, eine API-first-Schnittstelle zur Automatisierung und Orchestrierung von DNS-, DHCP- und IP-Adressverwaltung (DDI) über hybride, Multi-Cloud- und herstellerübergreifende Umgebungen. Es beschreibt die technischen Grundlagen wie Authentifizierung per Bearer-Token, unterstützte HTTP-Methoden, Ressourcenstruktur, Abfrageparameter (Filter, Sortierung, Paginierung) sowie Best Practices für Sicherheit, rollenbasierte Zugriffskontrolle, Massenoperationen und Fehlerbehandlung. Praxisorientierte Beispiele, Postman-Import via OpenAPI/Swagger sowie Skriptmuster in PowerShell und Python zeigen, wie Teams Automatisierung, Fehlerbehebung und Integrationen sicher und skalierbar implementieren können.
Wie authentifiziere ich mich sicher gegen die Micetro-REST-API und welche Alternativen werden beschrieben?
Die empfohlene Methode zur Authentifizierung gegen die Micetro-REST-API ist die Verwendung eines sitzungsbasierten Bearer-Tokens, das nach einer POST-Anfrage an /sessions im zurückgegebenen JSON enthalten ist und anschliessend im Authorization-Header (Authorization: Bearer ) für alle nachfolgenden Anfragen verwendet wird. Sicherheitsbestimmungen betonen, Passwörter niemals in Code einzubetten und Tokens in Umgebungsvariablen oder Geheimnisspeichern zu halten; Token sollten kurzlebig sein und regelmäßig rotiert werden. Als weitere unterstützte Methoden werden NTLM oder Kerberos für Windows-AD-Umgebungen genannt; Basisauthentifizierung wird zwar unterstützt, ist jedoch veraltet und für Automatisierung nicht empfohlen.
Welche Mechanismen bietet die API, um große Datensätze effizient zu verarbeiten und welche Parameter sollte ich dafür einsetzen?
Die Micetro-REST-API unterstützt Paginierung und zielgerichtete Abfragen über die Parameter limit und offset, wodurch grosse Ergebnislisten in handhabbare Blöcke aufgeteilt werden können (Beispiel: limit=100 und offset zur Verarbeitung in Chargen). Ergänzend ermöglichen filter, sortBy und sortOrder präzise Einschränkungen, Sortierung und geordnete Ergebnismengen; targetRef kann verwendet werden, um eine Seite zu verankern. Für Massenänderungen bieten spezialisierte Endpunkte (z. B. dnsrecords, ranges, ipamrecords) Batch-POSTs zur Übermittlung mehrerer Objekte in einem Request, woraufhin strukturierte Antworten mit Erfolgs- und Fehlerdetails pro Objekt zurückgegeben werden. Bewährte Praxis ist das Kombinieren von limit/offset mit Filtern und das robuste Handling teilweiser Fehler bei Massenoperationen.
Welche Sicherheits- und Governance-Empfehlungen gibt das Whitepaper für Automatisierungen mit Micetro?
Das Whitepaper empfiehlt das Prinzip der geringsten Berechtigungen: API-Konten und Automatisierungen sollten nur die minimal erforderlichen Rollen/Scopes erhalten, wobei Rollen über /roles verwaltet werden. Sitzungstoken sollten kurzlebig sein, in sicheren Speichern oder Umgebungsvariablen verwaltet und regelmässig rotiert werden; Tokens niemals im Code oder in Logs hinterlegen. Nutzt die /access- und /history-Endpunkte, um Berechtigungen zu prüfen und Änderungen zu auditieren. HTTPS-Absicherung, Zertifikatsprüfung, Validierung aller Daten clientseitig vor Senden und detailliertes Protokollieren von Anfrage-/Antwortdaten zur Fehleranalyse sind weitere zentrale Empfehlungen.
Zusammenfassung
Da Netzwerke zunehmend hybrider, verteilter und automatisierter werden, ist die Fähigkeit, DNS-, DHCP- und IP-Adressverwaltungssysteme (zusammen als DDI bezeichnet) programmgesteuert zu verwalten, unerlässlich, um unternehmensweit Agilität und Konsistenz zu gewährleisten. Die BlueCat Micetro REST-API bietet eine einheitliche, standardbasierte Schnittstelle zur Automatisierung und Orchestrierung aller Komponenten der DDI-Infrastruktur – darunter Microsoft, BIND, Kea, Cisco, Cloud-Plattformen und BlueCat-Appliances – über eine einzige, einheitliche Steuerungsebene.
Als API-first-Plattform konzipiert, stellt Micetro nahezu alle DDI-Funktionen über REST-Endpunkte bereit und ermöglicht Netzwerkadministratoren und DevOps-Teams damit:
- Wiederkehrende Aufgaben und Arbeitsabläufe automatisieren
- Integration in Automatisierungsframeworks für Unternehmen, CI/CD-Pipelines und IT-Servicemanagementsysteme
- Änderungen prüfen und Compliance durchsetzen
- Koordinieren Sie Dienste über Cloud- und Hybridumgebungen hinweg
Indem jedes verwaltete DDI-Objekt als eine über Standard-HTTP-Methoden zugängliche Ressource behandelt wird, vereinfacht die API komplexe Verwaltungsaufgaben, beschleunigt Änderungsworkflows und gewährleistet die Konsistenz der Konfiguration über alle Umgebungen hinweg.
Dieses Whitepaper bietet eine praktische Einführung in die Struktur, die Nutzungsmuster und die bewährten Verfahren für den Einsatz der Micetro-REST-API. Die API von Micetro richtet sich an Netzwerkingenieure, DevOps-Teams und Systemintegratoren und ermöglicht die Automatisierung, Orchestrierung und Integration von DDI-Vorgängen in Microsoft-, BIND-, Kea-, Cisco- und Cloud-Umgebungen. In diesem Whitepaper wird erläutert, wie Teams die Automatisierungsfunktionen von Micetro durch Skriptsprachen wie PowerShell und Python oder durch die Integration in Unternehmens-Automatisierungsframeworks erweitern können.
Dieses Dokument enthält praktische Beispiele, die veranschaulichen, wie die API für Automatisierung, Fehlerbehebung und Workflow-Entwicklung genutzt werden kann. Es bietet eine Schritt-für-Schritt-Anleitung zum Importieren der OpenAPI-Spezifikation in Postman zur Erkundung und zum Testen sowie Beispielskripte in PowerShell und Python. Ein abschließender Abschnitt listet wichtige zusätzliche Ressourcen auf, mit denen Sie Ihr Verständnis vertiefen und Ihre Automatisierungsinitiativen mit Micetro beschleunigen können.
Einführung
Micetro bietet eine robuste und moderne REST-API zur Automatisierung und Integration aller Aspekte von DDI. Die REST-API ermöglicht einen umfassenden, sicheren und skalierbaren Zugriff auf Ihre DDI-Umgebung. Sie ist die bevorzugte Schnittstelle für alle Automatisierungs- und Integrationsaufgaben und unterstützt sowohl alltägliche Arbeitsabläufe als auch komplexe benutzerdefinierte Automatisierungsszenarien für Netzwerkteams jeder Größe. Ganz gleich, ob Sie Integrationen entwickeln, Skripte für Routinevorgänge erstellen oder den gesamten Lebenszyklus von Netzwerkressourcen verwalten – die Micetro-REST-API bietet die Flexibilität und Leistungsfähigkeit, die heutige hybride, Multi-Cloud- und Compliance-orientierte Unternehmen benötigen.
API-Endpunkte:
- Basis-URL: https://<micetro.yourdomain.tld>/mmws/api/v2/
- Interaktive Swagger-Dokumentation:https://<micetro.yourdomain.tld>/mmws/api/doc/
- OpenAPI (Swagger) herunterladen:https://<micetro.yourdomain.tld>/mmws/api/swagger.json
Die API-Dokumentation und das Schema sind unter diesen URLs stets auf dem neuesten Stand. Sie können sie auch in Postman oder andere API-Tools importieren, um sie zu erkunden oder Ihre Workflows zu testen.
Umwelthinweis:
Alle Beispiele im POSIX-Stil in diesem Dokument wurden unter Ubuntu 24.04 LTS mit dem systemeigenen `curl` und den Standard-OpenSSL-Bibliotheken validiert. Ihre Umgebung kann davon abweichen. Variablen wie Betriebssystem, Micetro-Version, API-URLs, TLS-Konfiguration, Zertifikatsvertrauen und Authentifizierungseinstellungen können Anpassungen der Beispielbefehle erforderlich machen.
Beispielsweise kann es in Umgebungen mit selbstsignierten Zertifikaten erforderlich sein, „curl -k“ (unsicherer Modus) zu verwenden, um die strenge TLS-Überprüfung während des Testens zu umgehen. Verwenden Sie dieses Flag nur in kontrollierten, nicht produktiven Umgebungen.
Authentifizierung
Die empfohlene Authentifizierung für die REST-API erfolgt über ein Bearer-Token (sitzungsbasiert). Ein Bearer-Token ist sowohl für die interaktive Nutzung als auch für die Automatisierung der sicherste und flexibelste Ansatz. Es vermeidet die Einbettung von Anmeldedaten in jeden API-Aufruf und ermöglicht Sitzungszeitüberschreitungen sowie eine detaillierte Zugriffskontrolle.
So erhalten Sie ein Sitzungstoken:
Das zurückgegebene JSON enthält ein Sitzungstoken. Verwenden Sie dieses Token als Bearer-Token im Autorisierungsheader bei allen nachfolgenden API-Anfragen:
Sicherheitshinweis: Betten Sie niemals Passwörter in Code ein und geben Sie keine Sitzungstoken in Protokollen weiter. Verwenden Sie bei echter Automatisierung stets Umgebungsvariablen oder sichere Speicherstellen.
Weitere unterstützte Authentifizierungsmethoden:
- NTLM oder Kerberos – für lokale Umgebungen oder Windows Active Directory (AD)-Umgebungen, in denen Micetro Central auf einem Server installiert ist, der Mitglied einer Windows-Domäne ist.
- Veraltet – Die Basisauthentifizierung wird unterstützt, wird jedoch für die Automatisierung oder Skripterstellung nicht empfohlen.
Unterstützte HTTP-Methoden
Bei REST liegt der Schwerpunkt auf Ressourcen. Sie geben eine Ressource über ihre URL an und wenden dann mithilfe einer HTTP-Methode eine Operation darauf an.
Die vier gängigsten HTTP-Methoden sind GET, PUT, POST und DELETE, wie in der folgenden Tabelle beschrieben
| Method | Description |
| GET | Retrieve resources and object details (read-only operations) |
| POST | Create resources or trigger specific server-side operations |
| PUT | Update resources (entire object or specific properties) |
| DELETE | Remove resources from the system |
Viele Endpunkte unterstützen erweiterte Funktionen wie das Erstellen in großen Mengen, die Aktualisierung im Stapelverfahren und spezielle Aktionen (z. B. Abfragen des Audit-Protokolls, Hinzufügen von DNS-Einträgen in großen Mengen usw.). Weitere Informationen finden Sie in der API-Dokumentation der jeweiligen Ressource.
API-Ressourcen oder Objekte der obersten Ebene
Die folgende Tabelle listet alle primären REST-API-Ressourcen-Endpunkte auf, wobei die Bezeichnungen in Kleinbuchstaben und im Plural angegeben sind. Jeder Endpunkt bietet Zugriff auf einen wichtigen Objekttyp oder eine Systemfunktion in Micetro.
| Resource | Description |
| adForests | AD forests |
| adSiteLinks | AD site link |
| adSites | AD sites |
| addressSpaces | Organizations |
| appliances | Appliances |
| changeRequests | Change requests |
| cloudNetworks | Cloud networks |
| Resource | Description |
| cloudServiceAccounts | Cloud integration |
| devices | Connectable devices |
| dhcpAddressPools | DHCP address pools |
| dhcpExclusions | DHCP exclusions |
| dhcpGroups | DHCP groups |
| dhcpReservations | DHCP reservations |
| dhcpScopes | DHCP scopes |
| dhcpServers | DHCP servers |
| dhcpSuperscopes | DHCP superscopes |
| dnsRecords | DNS records |
| dnsServers | DNS servers |
| dnsViews | DNS views |
| dnsZones | DNS zones |
| folders | Folders for objects and custom filters |
| groups | User groups |
| interfaces | Device interfaces |
| ipamRecords | IP address management (IPAM) records |
| micetro | General Micetro system information |
| ranges | IP address ranges |
| reportDefinitions | Report definitions |
| reportSources | Report sources |
| reports | Reports |
| roles | User and group roles |
| users | User administration |
Eine vollständige Übersicht über die verfügbaren Methoden, Datenmodelle und Parameter für jede Ressource finden Sie in der interaktiven API-Dokumentation unter /mmws/api/doc/ oder unter https://api.menandmice.com/.
Arbeiten mit Ressourcen
Im Kontext der Micetro-REST-API stellt eine Ressource jedes verwaltbare Objekt oder jede Entität innerhalb des Micetro-Systems dar – beispielsweise eine DNS-Zone, einen DHCP-Bereich, eine IP-Adresse, einen Benutzer oder einen Server. Jede Ressource entspricht einer konkreten Komponente Ihrer DDI-Infrastruktur, auf die programmgesteuert über die API zugegriffen und die über diese API bearbeitet werden kann.
Ressourcen bilden die Grundlage des Designs der Micetro-API. Jeder REST-Endpunkt ist auf eine Ressource ausgerichtet, die durch eine eindeutige URL identifiziert wird und über Standard-HTTP-Methoden aufgerufen wird. Jeder Ressourcentyp ist in einem Pfad zusammengefasst, und jede Ressource verfügt über eine eindeutige Referenzkennung.
Ressourcenpfade und Bezeichner
- API-Ressourcenpfade folgen dem Muster /mmws/api/v2/<resource> (z. B. /mmws/api/v2/dnszones).
- Jedes Objekt verfügt über eine eindeutige Referenzzeichenfolge (z. B. dnsZones/12345). Die meisten Endpunkte unterstützen die Referenzierung von Objekten entweder über diese Referenz, einen eindeutigen Namen oder eine numerische ID. Im Zweifelsfall sollten Sie immer die Referenz verwenden.
- Viele Endpunkte sind hierarchisch aufgebaut (z. B. gehören DNS-Einträge zu einer Zone: /dnszones/<zone-ref>/dnsrecords).
Gängige Abfrageparameter
Die Micetro-REST-API bietet umfangreiche Abfrageparameter zum Suchen, Filtern, Sortieren und Paginieren von Ergebnissen, was einen effizienten Datenabruf ermöglicht und die Bandbreitennutzung minimiert.
| Parameter | Type | Purpose and example |
| filter | string | Filter results on properties. Flexible, supports logical/comparison/set operators. Example: filter=name~^corp AND type=A |
| sortBy | string | Sort results by a property. Most often name, created, lastModified, or a custom property. Example: sortBy=name |
| sortOrder | string | Sort direction, either ascending (default) or descending. Example: sortOrder=Descending |
| offset | integer | Skip a certain number of records for pagination. Example: offset=50 |
| limit | integer | Return a maximum number of records. Example: limit=100 |
| pretty | bool | Pretty-print (indented) JSON for human reading. Not needed in automation. Example: pretty=true |
| targetRef | string | Get a page of results where the specified object appears first (useful for UI-driven automation). |
Wann und wie man Abfrageparameter verwendet
filter
- Zweck: Die Ergebnisse auf eine Ihren Kriterien entsprechende Teilmenge beschränken – ideal für Berichte, Dashboards oder Automatisierungen, die nur relevante Daten verarbeiten sollen.
- Syntax-Hervorhebungen: Einfach: name=corp.com.
- Regulärer Ausdruck: name~prod-
- Logik: UND, ODER, NICHT (z. B. type=A ODER type=CNAME)
- Sets: Geben Sie {A,CNAME} ein
- Negation: type!=A ODER NOT type=A
- Verschachtelt: (name~“dev- UND type=A) ODER (name~“prod- UND type=CNAME)
sortBy und sortOrder
- Zweck: Steuerung der Sortierreihenfolge für vorhersehbare Ergebnisse, benutzerfreundliche Benutzeroberflächen und effiziente Paginierung.
- Verwendung: Es kann nach beliebigen einfachen Eigenschaften, benutzerdefinierten Eigenschaften oder sogar berechneten oder abgeleiteten Feldern sortiert werden (siehe Dokumentation).
- Standard: Wenn nicht festgelegt, variiert die Standardsortierung je nach Endpunkt (häufig nach Name oder Erstellungsdatum).
- Beispiel: Zuletzt aktualisierte DNS-Zonen abrufen:
Offset und Limit
- Zweck: Paginierung großer Ergebnismengen. Verwenden Sie bei unbegrenzten Ergebnislisten stets die Begrenzung.
- Bewährte Vorgehensweise: Verarbeiten Sie bei der Skripterstellung und Automatisierung die Ergebnisse stets in kleinen Einheiten (z. B. jeweils 100), um Speicher- oder Timeout-Probleme zu vermeiden.
- Beispiel: Abrufen der Einträge 201–300 aus einem großen Datensatz:
targetRef
- Zweck: Verankern der Seitenumschaltung an einem bestimmten Objekt, was für eine konsistente Navigation in UI-basierten Workflows oder Abgleich-Tools hilfreich ist.
- Beispiel: Eine Ergebnisseite abrufen, auf der ein bestimmter Eintrag an erster Stelle steht (siehe Dokumentation zur Verwendung).
pretty
- Zweck: Für eine für Menschen lesbare Ausgabe bei der Erkundung. Wird in der Produktionsautomatisierung selten verwendet.
- Beispiel:
Tipps, Muster und fortgeschrittene Anwendungen
- Verwenden Sie Filter für benutzerdefinierte Eigenschaften genau wie für integrierte Felder: filter=CustomTag=Finance
- Abfrageparameter kombinieren: z. B. ?filter=name=corp&sortBy=lastModified&limit=25
- Massen-Ressourcen-APIs (wie DNS-Einträge, Bereiche usw.) lassen sich für die Automatisierung mehrerer Objekte filtern.
- Bei vielen Ressourcenabfragen wird zwischen Groß- und Kleinschreibung unterschieden – Einzelheiten zu den jeweiligen Ressourcen finden Sie in der API-Dokumentation.
- Ressourcenspezifische Filter (z. B. unterstützt „dnsrecords“ Typ, Daten, Time-to-Live usw.) ermöglichen sehr gezielte Suchvorgänge.
- Verwenden Sie beim Schreiben von Skripten zur Batch-Automatisierung und beim Abrufen großer Datensätze stets „limit“ und „offset“.
- Für fortgeschrittene Anwendungen werden verschachtelte und komplexe boolesche Filterausdrücke unterstützt – siehe Swagger- und OpenAPI-Beispiele.
Beispiele für Automatisierung und Fehlerbehebung
Die folgenden Beispiele veranschaulichen eine Vielzahl von praktischen Automatisierungs- und Fehlerbehebungsszenarien unter Verwendung von Curl und der API. Weitere Beispiele finden Sie in den nachstehenden Abschnitten zum Thema Skripting.
Alle DNS-Server auflisten
XML-Ausgabe anfordern (anstelle von JSON)
A-Einträge auflisten, die in einer Zone mit „vm“ beginnen
Einen DNS-Eintrag hinzufügen
Erweiterte Filterung nach mehreren Typen
DNS-Einträge in großer Anzahl erstellen
Ereignisverlauf für eine DNS-Zone abrufen
Eine benutzerdefinierte Eigenschaft erstellen (Eigenschaftsdefinition)
Alle DHCP-Bereiche abrufen, sortiert nach DHCP-Server
Alle DHCP-Leases für einen Bereich abrufen
Nach einer benutzerdefinierten Eigenschaft filtern
Abfrageparameter kombinieren
Bewährte Verfahren
In diesem Abschnitt werden bewährte Verfahren für die Konzeption, Automatisierung und Absicherung von Integrationen empfohlen, die auf der Micetro-REST-API basieren. Da die API vollständigen programmatischen Zugriff auf Ressourcen für die Verwaltung von DNS, DHCP und IP-Adressen bietet, ist es unerlässlich, einheitliche Standards zu befolgen, die Zuverlässigkeit, Sicherheit und Wartbarkeit fördern. Die folgenden Richtlinien konzentrieren sich auf wichtige Betriebsbereiche – darunter benutzerdefinierte Eigenschaften, rollenbasierte Zugriffskontrolle, Massenoperationen, Änderungshistorie, Fehlerbehandlung und Sicherheit –, um sicherzustellen, dass Ihre Skripte und Integrationen bewährte Muster für eine sichere und effiziente Interaktion mit Micetro befolgen.
Benutzerdefinierte Eigenschaften
- Verwenden Sie die Endpunkte /propertydefinitions, um benutzerdefinierte Felder für Objekte zu definieren und zu verwalten, die geschäftliche oder technische Metadaten enthalten (z. B. Anlageninhaber, Umgebung, Standort oder Kostenstelle).
- Speichern Sie den Automatisierungsstatus, den Änderungsverlauf und die Zuordnungstags als benutzerdefinierte Eigenschaften für Rückverfolgbarkeit und Berichterstellung.
- Benutzerdefinierte Eigenschaftsfilter für Berichte und Skripte verwenden: filter=owner=devops
- Dokumentieren Sie die Namen und Typen benutzerdefinierter Eigenschaften in Ihrem internen API-Styleguide.
Rollenbasierte Zugriffskontrolle
- Jede Ressource unterstützt detaillierte Berechtigungen – gewähren Sie Zugriff auf Zonen, Bereiche, Gruppen und mehr.
- Verwenden Sie /access-Endpunkte, um Berechtigungen für beliebige Benutzer oder Gruppen zu überprüfen und zu verwalten.
- Wenden Sie für alle API-Benutzer stets das Prinzip der geringsten Berechtigungen an (verwenden Sie in der Automatisierung niemals Admin-Token, es sei denn, dies ist erforderlich).
- Verwenden Sie Rollen (erstellt über /roles), um den tatsächlichen team- oder funktionsbasierten Zugriff abzubilden.
- Wechseln Sie die Rollenzuweisungen und überprüfen Sie regelmäßig die Audit-Protokolle auf sensible Änderungen.
Massenoperationen
- Endpunkte wie „dnsrecords“, „ranges“ und „ipamrecords“ unterstützen die Erstellung oder Aktualisierung im Stapelverfahren – übermitteln Sie mehrere Objekte in einem einzigen POST-Request, um Zeit zu sparen und die Effizienz zu steigern.
- Massenoperationen liefern strukturierte Antworten, einschließlich Erfolg oder Fehlschlag pro Objekt; analysieren und melden Sie Fehler in der Automatisierung stets.
- Verwenden Sie „Limit“ und „Filter“, um große Aufgaben in kleinere, zuverlässigere Teile aufzuteilen.
- Massenaktualisierungen eignen sich ideal für Onboarding, Migrationen und Compliance-Korrekturen.
Verlauf
- Verwenden Sie Endpunkte für den Ereignisverlauf (z. B. /history), um alle an einer Ressource vorgenommenen Änderungen abzufragen oder Benutzeraktionen im Zeitverlauf zu überprüfen.
Fehlerbehandlung
- Alle Fehlerantworten sind strukturierte JSON-Daten mit Codes und Meldungen (siehe API-Dokumentation für die Liste).
- Die Automatisierung sollte stets die HTTP-Statuscodes überprüfen und Fehler-JSON-Daten analysieren, um eine robuste Verarbeitung zu gewährleisten.
- Alle Daten vor dem Absenden von Anfragen lokal validieren (z. B. IP-Adressformate, Eigenschaftstypen).
- Protokollieren Sie Fehler mit vollständigen Anfrage- und Antwortdetails für Audits und die Fehlerbehebung.
- Bei Massenoperationen sollten sowohl teilweise als auch vollständige Fehler elegant behandelt werden.
Sicherheit
- Verwenden Sie kurzlebige Sitzungstoken und speichern Sie diese in Umgebungsvariablen oder Geheimnisspeichern – niemals fest im Code.
- Wechseln Sie die Passwörter oder Tokens von Dienstkonten regelmäßig; verwenden Sie Tokens niemals in verschiedenen Umgebungen (z. B. Entwicklung und Produktion) wieder.
- Beschränken Sie API-Benutzerkonten auf die minimal erforderlichen Berechtigungen und den erforderlichen Geltungsbereich.
- Überprüfen Sie regelmäßig die API-Zugriffsprotokolle und fehlgeschlagene Authentifizierungsversuche (siehe /history und Admin-Konsole).
- Bevorzugen Sie HTTPS-Endpunkte für alle API-Aufrufe und überprüfen Sie die Zertifikate.
- Automatisieren Sie Überprüfungen des Ablaufs von Sitzungen oder Tokens in allen persistenten Automatisierungen.
Verwendung von Postman und Workflows
Die Micetro-REST-API ist vollständig über eine OpenAPI-Spezifikation (Swagger) dokumentiert, die Sie direkt in Tools wie Postman importieren können, um sie interaktiv zu erkunden und Workflows zu automatisieren. In diesem Abschnitt wird erläutert, wie Sie die API-Definition laden, eine Postman-Umgebung konfigurieren und Authentifizierungs-Workflows mithilfe von Sitzungstoken einrichten. Wenn Sie diese Schritte befolgen, erhalten Sie einen vollständigen, einsatzbereiten Arbeitsbereich zum Testen von Endpunkten, zum Verketten authentifizierter Anfragen und zum Verwalten gängiger Automatisierungsszenarien wie Massenaktualisierungen oder Änderungsanfragen. Indem Sie Ihre Postman-Sammlungen mit der neuesten Micetro-OpenAPI-Spezifikation synchronisieren, stellen Sie sicher, dass Ihre Integrationen korrekt, effizient und auf das aktuelle API-Schema abgestimmt bleiben.
Importieren der API
- OpenAPI/Swagger-Spezifikation herunterladen: https://<micetro>/mmws/api/swagger.json
- Importieren Sie die Daten in Postman als Sammlung, um vollständige und aktuelle Endpunkt- und Schema-Referenzen zu erhalten.
- Erstellen oder konfigurieren Sie eine Umgebung mit diesen Variablen:
Verwendung von Postman für Workflows
- Anmeldeablauf: Erstellen Sie eine POST-Anfrage an /sessions und setzen Sie {{token}} aus der Antwort mithilfe eines Testskripts oder einer Umgebungsvariablen.
- Anfragen verketten: Verwenden Sie Postman-Umgebungen, um „Authorization: Bearer {{token}}“ automatisch in den Headern aller Anfragen festzulegen.
- Sammlungen und Automatisierung: Verwenden Sie Ordner für gruppierte Workflows (z. B. „DNS-Einträge“, „Massenvorgänge“, „Änderungsanfragen“). Speichern Sie häufig verwendete Filter oder Massenaktualisierungen als wiederverwendbare Anfragen.
- Massenimport und -tests: Importieren Sie Swagger oder OpenAPI direkt für jede neue Micetro-Version, um
Beispiel: Automatisierte Token-Bezugsabfrage bei Postman (Testskript)
Verwenden Sie dann in nachfolgenden Anfragen die Variable: Authorization: Bearer {{bearerToken}}
Skriptbeispiele für PowerShell
Die Verwendung einer Skriptsprache wie PowerShell bietet eine leistungsstarke und flexible Möglichkeit, Interaktionen mit der Micetro-REST-API zu automatisieren. Mit PowerShell können Administratoren und DevOps-Teams wiederholbare Workflows skripten, Micetro-Daten in umfassendere IT-Automatisierungsframeworks integrieren und komplexe Vorgänge über DNS-, DHCP- und IP-Adressverwaltungsressourcen hinweg mit minimalem manuellem Aufwand ausführen. Da PowerShell RESTful-Anfragen, JSON-Parsing und den sicheren Umgang mit Anmeldedaten nativ unterstützt, eignet es sich ideal für die Erstellung zuverlässiger, produktionsreifer Automatisierungen – sei es für Massenaktualisierungen, geplante Berichterstellung oder die Integration von Micetro in andere Systeme und Service-Pipelines. Im Folgenden finden Sie grundlegende Beispiele dafür, wie Sie die Micetro-API in PowerShell nutzen können, um sich zu authentifizieren, Einträge hinzuzufügen und Fehler zu behandeln.
Authentifizierung und Auflistung von DNS-Zonen
Einen DNS-Eintrag hinzufügen
DNS-Einträge in großer Anzahl erstellen
Beispiel für die Fehlerbehandlung
Skriptbeispiele für Python
Python bietet einen vielseitigen, plattformübergreifenden Ansatz zur Automatisierung von Interaktionen mit der Micetro-REST-API. Dank seines umfangreichen Ökosystems an Bibliotheken für HTTP-Anfragen, JSON-Verarbeitung und Datenverarbeitung lassen sich auf einfache Weise portable Automatisierungen erstellen, die unter Windows, Linux und macOS konsistent laufen. Ob zur Integration von Micetro in bestehende IT-Workflows, zur Analyse von Daten zur DNS- und IP-Adressverwaltung oder zur Koordination umfangreicher Konfigurationsänderungen – Python bietet eine flexible Grundlage, um die Funktionen von Micetro über die Benutzeroberfläche hinaus zu erweitern.
Der folgende Abschnitt enthält kurze Beispiele für den Einstieg in die Nutzung der Micetro-API in Python.
Authentifizierung und Auflistung von DNS-Zonen
Einen DNS-Eintrag hinzufügen
DNS-Einträge in großer Anzahl erstellen
Verdächtige Einträge in Reverse-Zonen finden
Beispiel für die Fehlerbehandlung
Wichtige zusätzliche Ressourcen
Um Sie bei der weiteren Entwicklung, Automatisierung und Integration mit Micetro zu unterstützen, bieten die folgenden Ressourcen detaillierte technische Anleitungen, API-Referenzen und Community-Support. Diese Materialien stellen sicher, dass Ihre Integrationen auch bei der Weiterentwicklung von Micetro stets mit den aktuellen Versionen und Best Practices im Einklang bleiben.
Micetro REST-API-Dokumentation
- Interaktive API-Dokumentation: https://<micetro>/mmws/api/doc/Entdecken Sie Endpunkte, Parameter und Live-Beispiele direkt in Ihrem Browser.
- OpenAPI/Swagger-Spezifikation: https://<micetro>/mmws/api/swagger.jsonLaden Sie das vollständige Schema zum Import in Postman oder andere API-Tools herunter.
Ressourcen für Entwickler und Automatisierung
- Micetro-Dokumentationsportal: https://docs.bluecatnetworks.comGet – umfassende Anleitungen zur API-Nutzung, zu Automatisierungsmodulen, zur Skripterstellung und zur Systemkonfiguration.
- Automatisierungsbeispiele: https://github.com/menandmiceVisit dem Micetro-GitHub finden Sie Beispielskripte in PowerShell und Python sowie fortgeschrittene Anwendungsfälle mit Ansible und Terraform.
- Postman-Sammlungen: Importieren Sie die neueste Swagger-Definition, um Ihre Workflows mit jeder Micetro-Version auf dem neuesten Stand zu halten.
Community und Support
- BlueCat Care-Portal: https://care.bluecatnetworks.comAccess – Knowledge-Base-Artikel, Produkt-Updates und technischer Support.
- BlueCat-Community: https://community.bluecatnetworks.comJoin – diskutieren Sie mit Kollegen, tauschen Sie Automatisierungsbeispiele aus und bleiben Sie über neue Funktionen und Releases von Micetro auf dem Laufenden.
- Für fortgeschrittene Fehlerbehebung oder benutzerdefinierte Automatisierung sollten Sie stets zuerst die interaktive API-Dokumentation und das Swagger-Schema konsultieren. Diese spiegeln die aktuellste API-Struktur und die unterstützten Parameter über alle Micetro-Versionen hinweg wider.