Global settings Archives | XOAP

Connections

Stella — Tue, 30 Apr 2024 11:59:20 +0000

Schnellübersicht

XOAP Verbindungen Speichern Sie die Anmeldeinformationen und Endpunkte, die XOAP zur Integration mit externen Systemen (z. B. Cloud-Anbietern und On-Prem-Virtualisierungsplattformen) benötigt. Diese Verbindungen werden dann von anderen XOAP-Funktionen abgerufen.

Erstellen Sie eine neue Verbindung

Gehen Sie zu Verbindungen und klicken Sie + Neue Verbindung.
Unter Wählen Sie den Verbindungstyp aus, wählen Sie: Cloud-Anbieter, On-Premises, oder API-Schlüssel.
Füllen Sie die erforderlichen Felder für die ausgewählte Art aus (siehe Beispiele unten).
(Optional) Hinzufügen Beschreibung und Tags.
Klicken Sie auf Verbindung testen (falls verfügbar) zur Validierung der Anmeldeinformationen und der Verbindungsqualität.
Klicken Sie auf Bestätigen Sie (oder „Speichern“) um die Verbindung zu erstellen.

Eine Verbindung bearbeiten

Klicken Sie in der Tabelle „Verbindungen“ auf Aktionsmenü (⋮) für die Verbindung.
Wählen Sie bearbeiten.
Aktualisieren Sie die Felder nach Bedarf.
Klicken Sie auf Verbindung testen (empfohlen) und Speichern/Bestätigen.

Eine Verbindung löschen

Klicken Sie in der Tabelle „Verbindungen“ auf Aktionsmenü (⋮) für die Verbindung.
Wählen Sie Löschen.
Bestätigen Sie die Löschung.

Weitere nützliche Informationen

Verwenden Sie Kennwörter mit geringer Privilegieregelung

Erstellen Sie pro Verbindung separate Identitäten bzw. Zugangsdaten und gewähren Sie nur die für die verwendete XOAP-Funktion erforderlichen Berechtigungen (z. B. nur für das Image Management vs-Inventory).

Zertifikatlebenszyklus

Gehe regelmäßig Änderungen an den Passwörtern vor (insbesondere bei Cloud-App-Passwörtern) und aktualisiere die XOAP-Verbindung entsprechend. Wähle lieber nicht ablaufende/verwaltete Ansätze, sofern deine Umgebung dies zulässt.

Tags helfen in großem Maßstab

Verknüpfen Sie Tags nach Zweck (z. B. ImageManagement, Inventory, Prod, PoC), um sie einfacher zu finden und zu verwalten.

Testen Sie die Verbindungen frühzeitig

Wenn Verbindung testen Verifizieren Sie die Netzwerkverfügbarkeit (Proxy/Firewall/DNS), die Identitätsberechtigungen und den richtigen Mietvertrag-/Abonnements-Kontext, bevor Sie Probleme mit XOAP-Funktionen beheben, die von der Verbindung abhängen.

Technische Dokumentation

Verbindungen definieren, wie XOAP sich mit externen Plattformen und APIs authentifiziert. Sie werden von XOAP-Funktionen verwendet, die Zugriff auf Ihre Infrastruktur (in der Cloud oder lokal) benötigen, oder von dem XOAP-Connector während der Registrierung.

In XOAP können Sie drei Verbindungskategorien erstellen:

Cloud-Anbieter (Azure, AWS, Google Cloud)
On-Premises (vSphere, Nutanix) (Vorschau)
API-Schlüssel (Vorschau)

Geltungsbereich der Aufgabe: Eine Verbindung kann zugewiesen werden nur zu Bilder / Image Management und Geskriptete Aktionen (es wird nirgendwo anders verwendet).

Berechtigungen: Die Mindestberechtigungen pro Anbieter sind in Vorraussetzungen für XOAP.

Verbindungstypen und Felder

1) Verbindungen zu Cloud-Anbietern

Azure: Managed Identity

Datenfelder, die Sie angeben:

Verbindungstitel – Freundlicher Name, der in XOAP verwendet wird, um diese Verbindung zu beschreiben.
Verbinder – Geräte, die über einen XOAP-Anschluss ausgestattet sind (Weitere Informationen unter „Inventar“).
Abonnement-ID – Der Azure-Abonnements-ID, über die XOAP Ressourcen verwalten und lesen kann.
Beschreibung (optional) – Freitextnotiz zum Dokumentzweck/dem Eigentümer der Verbindung.
Schlagwörter (optional) – Etiketten, die Ihnen helfen, Verbindungen zu finden, zu filtern und zu verwalten (maximal 5 pro Objekt).

Verbindung testen: Verfügbar (wird die Berechtigungen/Authentifizierungsinformationen mit Azure überprüft).

Hinweise:

Verwenden Sie ein dediziertes verwaltetes Identitätssystem mit Berechtigungen auf minimaler Zugriffsebene und mit installierten XOAP-Connector-Funktionen.
Geheime Informationen regelmäßig rotieren lassen; behandle sie wie vertrauliche Daten.

Azure – Anwendungsregistrierung

Datenfelder, die Sie angeben:

Verbindungstitel – Freundlicher Name, der in XOAP verwendet wird, um diese Verbindung zu beschreiben.
Verbinder – Geräte, an denen der XOAP-Anschluss installiert ist (Weitere Informationen unter „Inventar“). Nicht zwingend erforderlich.
Vermieternummer – Der Entra ID-Verzeichnis- (Tenant-)Identifikator, in dem die Anwendung existiert.
Beschreibung (optional) – Freitextnotiz zum Dokumentzweck/dem Eigentümer der Verbindung.
Schlagwörter (optional) – Etiketten, die Ihnen helfen, Verbindungen zu finden, zu filtern und zu verwalten (maximal 5 pro Objekt).

Verbindung testen: Verfügbar (wird die Berechtigungen/Authentifizierungsinformationen mit Azure überprüft).

Hinweise:

Verwenden Sie die Option „Anwendungregistrierung“, wenn Sie skriptbasierte Aktionen ausführen möchten Platform Management, aber Sie keine Azure-Abonnement haben.
Unterstützung für MS Graph RestAPI.

AWS – Zugriffsschlüssel

Datenfelder, die Sie angeben:

Verbindungstitel – Freundlicher Name, der in XOAP verwendet wird, um diese Verbindung zu beschreiben.
AWS-Kontonummer – Der 12-stellige AWS-Kontonummer, der die Zielressourcen besitzt.
Zugriffsschlüssel-ID – Der öffentliche Identifikationsteil einer IAM-Zugriffs-Schlüssel.
Zugangs-Schlüssel-Geheimnis – Der private Teil des IAM-Zugangskeys (als Passwort behandelt).
Beschreibung (optional) – Freitextnotiz zum Dokumentzweck/dem Eigentümer der Verbindung.
Schlagwörter (optional) – Etiketten, die Ihnen helfen, Verbindungen zu finden, zu filtern und zu verwalten (maximal 5 pro Objekt).

Verbindung testen: Verfügbar (wird die Berechtigungen/Authentifizierungsinformationen gegenüber AWS überprüft).

Hinweis: Verwenden Sie eine spezielle IAM-Benutzer-/Rollenscheine und eine Richtlinie mit geringerem Zugriffsberechtigungsparametern gemäß den Voraussetzungen von XOAP.

AWS – Rolle übernehmen

Datenfelder, die Sie angeben:

Verbindungstitel – Freundlicher Name, der in XOAP verwendet wird, um diese Verbindung zu beschreiben.
Rolle ARN – Die vollständige Amazon Resource Name (ARN) der IAM-Rolle XOAP wird für die Berechtigungen gelten.
Beschreibung (optional) – Freitextnotiz zum Dokumentzweck/dem Eigentümer der Verbindung.
Schlagwörter (optional) – Etiketten, die Ihnen helfen, Verbindungen zu finden, zu filtern und zu verwalten (maximal 5 pro Objekt).

Verbindung testen: Verfügbar. (Überprüft die Berechtigungen/Authentifizierungsdaten gegen AWS).

AWS – Rolle übernehmen (über mehrere Konten)

Datenfelder, die Sie angeben:

Verbindungstitel – Freundlicher Name, der in XOAP verwendet wird, um diese Verbindung zu beschreiben.
Rolle ARN – Die IAM-Rollen-ARN im Zielkonto, die XOAP übernehmen wird.
Externe ID – Eine gemeinsam genutzte “Geheimnis”-Zeichenfolge, die in der Rolle-Vertrauensrichtlinie erforderlich ist, um einen unklaren Zugriff durch Stellvertreter zu verhindern.
Beschreibung (optional) – Freitextnotiz zum Dokumentzweck/dem Eigentümer der Verbindung.
Schlagwörter (optional) – Etiketten, die Ihnen helfen, Verbindungen zu finden, zu filtern und zu verwalten (maximal 5 pro Objekt).

Verbindung testen: Verfügbar (wird die Berechtigungen/Authentifizierungsinformationen gegenüber AWS überprüft).

Hinweis: Die Einrichtung mehrerer Konten erfordert in der Regel eine Rolle-Vertrauensrichtlinie und ein externes ID-Pattern. Die Vorraussetzungen für XOAP werden auf der Seite aufgelistet.

Google Cloud

Datenfelder, die Sie angeben:

Verbindungstitel – Freundlicher Name, der in XOAP verwendet wird, um diese Verbindung zu beschreiben.
Projekt-ID – Der Google Cloud Projekt-Identifikator, über den XOAP Ressourcen verwalten/lesen kann.
Datei (JSON-Datei mit Schlüssel für den Service-Account) – Die hochgeladene JSON-Keydatei wird verwendet, um sich als Service-Account zu authentifizieren.
Beschreibung (optional) – Freitextnotiz zum Dokumentzweck/dem Eigentümer der Verbindung.
Schlagwörter (optional) – Etiketten, die Ihnen helfen, Verbindungen zu finden, zu filtern und zu verwalten (maximal 5 pro Objekt).

Verbindung testen: Verfügbar. (Überprüft die Anmeldeinformationen/Berechtigungen anhand von Google Cloud).

Hinweis: Die hochgeladene JSON-Schlüsselart muss einem Service-Account zugeordnet sein, der Rollen mit geringen Berechtigungen für Ihren Anwendungsfall (Bilder vs. skriptbasierte Aktionen) benötigt.

2) On-Premises-Verbindungen (Vorschau)

vSphere

Datenfelder, die Sie angeben:

Verbindungstitel – Freundlicher Name, der in XOAP verwendet wird, um diese Verbindung zu beschreiben.
vCenter Server – Der vCenter-Hostname oder die IP-Adresse XOAP, mit der eine Verbindung hergestellt wird.
Benutzername – Der vCenter-Benutzer (oder die SSO-Identität), der zur Authentifizierung verwendet wird.
Passwort – Das Passwort für den angegebenen vCenter-Benutzer.
Rechenzentrum – Das vSphere Rechenzentrum Ein Inventarobjekt, das die Cluster/Hosts/Datenspeicher enthält, die Sie ausrichten möchten.
Cluster – Der vSphere-Cluster im ausgewählten Datencenter, in dem Hostgruppen erstellt und die gemeinsame Ressourcenverwaltung (DRS/HA, sofern aktiviert) bereitgestellt wird.
Veranstalter – Ein spezifischer ESXi-Host zum Ziel (oft verwendet, wenn stattdessen ein exakter Host ausgewählt werden soll, anstatt über Cluster-/Regel-Verfahren).
Ressourcenpool – Der Ressourcenzug innerhalb des Clusters/des Hosts, der die CPU-/RAM-Teilungs- bzw. -begrenzungsmöglichkeiten sowie Reservierungen für bereitgestellte VMs definiert.
Datenspeicher – Der Speicherort, in dem die VM-Dateien (VMDKs/config) gespeichert werden.
Ordner – Die vCenter-VM-Ordnerstruktur dient dazu, festzulegen, wo das VM-Objekt im Inventar erscheint.
Unsicher (Umschalten) – ermöglicht die Verbindung ohne strenge TLS-Validierung (nur bei Bedarf in Labortests oder Proof-of-Concept-Demonstrationen verwenden).
Beschreibung (optional) – Freitextnotiz zum Dokumentzweck/dem Eigentümer der Verbindung.
Schlagwörter (optional) – Etiketten, die Ihnen helfen, Verbindungen zu finden, zu filtern und zu verwalten (maximal 5 pro Objekt).

Verbindung testen: Aktuell nicht verfügbar für die lokale Nutzung.

Wichtiges Verhalten:

Felder, die bei der Eingabe von Buchstaben und Zahlen unterschieden werden: Die Namen der vCenter-Inventarobjekte (Datacenter/Cluster/Host/Resource Pool/Datastore/Folder) lauten wie folgt: keine Sonderzeichen. Geben Sie sie genau so ein, wie sie in vCenter definiert sind.

Nutanix

Datenfelder, die Sie angeben:

Verbindungstitel – Freundlicher Name, der in XOAP verwendet wird, um diese Verbindung zu beschreiben.
Nutanix-Benutzername – Das Konto, das XOAP verwendet, um sich bei Nutanix zu authentifizieren (typischerweise Prism).
Nutanix Passwort – Das Passwort für das Nutanix-Konto.
Endpunkt – Das Endpunkt „Prism“ (Hostname/IP-Adresse + ggf. Port), mit dem XOAP verbunden ist.
Clustername – Der Nutanix-Cluster-Kennung/Name in Prism, in dem die Operationen durchgeführt werden.
Unsicher (Umschalten) – ermöglicht die Verbindung ohne strenge TLS-Validierung (nur bei Bedarf in Labortests oder Proof-of-Concept-Demonstrationen verwenden).
Beschreibung (optional) – Freitextnotiz zum Dokumentzweck/dem Eigentümer der Verbindung.
Schlagwörter (optional) – Etiketten, die Ihnen helfen, Verbindungen zu finden, zu filtern und zu verwalten (maximal 5 pro Objekt).

Verbindung testen: Aktuell nicht verfügbar für die lokale Nutzung.

3) API-Key-Verknüpfungen (Vorschau)

Verwendet zur Authentifizierung der Installation und Registrierung des XOAP-Connectors Fließverhalten (Wahl einer API-Schlüssel bei der Generierung von Installationsbefehlen).

Datenfelder, die Sie angeben:

Verbindungstitel
API-Token-Typ (Momentan haben “Admin” und “XOAP Connector” die gleichen Berechtigungen – ignorieren Sie den Unterschied für den Moment)
Optional: Beschreibung, Tags

Sicherheitshinweise

API-Schlüssel als Geheimnisse behandeln: den Zugriff einschränken, sie bei Bedarf rotieren und sie nicht in der Standarddokumentation als Text enthalten lassen.
Wenn eine API-Schlüsselrotation erfolgt, müssen Endpunkte, die auf diese angewiesen sind (z. B. Konnektorenbereitungsabläufe), entsprechend aktualisiert werden.

Operational Notes und Best Practices

Mindeste Privilegien zuerst: Starten Sie von den minimalen Berechtigungen ab, die in den XOAP-Voraussetzungen beschrieben sind, und erweitern Sie die Berechtigungen erst dann, wenn eine bestimmte Funktion weitere Berechtigungen erfordert.
Abgedeckt nach Zweck: Verwenden Sie für verschiedene Verbindungen Image Management vs Geskriptete Aktionen Wenn Sie eine strikte Trennung der Rechte wünschen.
Namenskonvention: In den Namen sollten der Provider, der Zweck und die Umgebung angegeben werden (z. B. azure-im-prod, aws-sa-dev, vsphere-im-lab).
Kennzeichnung: Fügen Sie Tags für Eigentum, Umgebung, Kunde/Projekt und Zweck hinzu (z. B. prod, lab, im, sa).
Rotation und Lebenszyklus: Planen Sie einen Rotationsprozess (insbesondere für Azure Client Secret, AWS Access Keys, Google JSON Keys und API Keys).
Aufgabenbewusstsein: Bevor Sie eine Verbindung löschen, vergewissern Sie sich, dass sie keiner anderen Verbindung zugeordnet ist. Bilder oder Geskriptete Aktionen.

The post Connections appeared first on XOAP.

Parameters

Stella — Mon, 29 Apr 2024 12:57:52 +0000

Schnellübersicht

Die XOAP-Parameter bieten eine zentralisierte Möglichkeit, wiederverwendbare Werte (z. B. Benutzernamen, Passwörter, IDs, Listen und Karten) zu speichern, sodass diese in allen XOAP-Funktionen abgerufen werden können. Parameter werden hauptsächlich über Wählen Sie „Existierendes“ Felder in der gesamten Benutzeroberfläche – wenn Sie auf einen Button klicken Wählen Sie „Existierendes“, Bei XOAP werden Parameter angezeigt, die den Wichtiges Format von diesem Feld.

Erstellen Sie einen neuen Parameter

Gehen Sie zu Parameter und klicken Sie + Neuer Parameter.
Unter Art wählen, Wählen Sie den Parametertyp: Text, Passwort, Qualifikationen, Nummer, Bool, Liste, oder Karte.
Geben Sie einen Name und die Wert für die ausgewählte Art.
(Optional) Hinzufügen einer Beschreibung und Tags.
Klicken Sie auf Bestätigen Sie (oder Speichern Sie) um den Parameter zu erstellen.

Parameter bearbeiten

In der Parameter Tabelle, klicken Sie auf Aktionsmenü (⋮) für den Parameter.
Wählen Sie Details (oder den Parameter öffnen).
Aktualisieren Sie den Wert und/oder die Metadaten (Beschreibung, Tags) nach Bedarf.
Klicken Sie auf Speichern Sie Um die Änderungen anzuwenden.

Parameter löschen

In der Parameter Tabelle, klicken Sie auf Aktionsmenü (⋮) für den Parameter.
Wählen Sie Löschen.
Bestätigen Sie die Löschung.

Weitere nützliche Informationen

Wie “Existierendes auswählen” funktioniert

Wenn ein Feld unterstützt Wählen Sie „Existierendes“, Das XOAP-Filter filtriert die Liste so, dass nur die Parameter der der gleiche Typ da diese Felder (z. B. Passwortfelder werden nur angezeigt) Passwort Parameter).

Verwenden Sie Parameter, um Umgebungen zu standardisieren

Geben Sie gemeinsame Werte einmal (Leasing-IDs, Abonnement-IDs, Endpunkte, Standardbenutzernamen usw.) an und verwenden Sie diese wieder in Verbindung mit anderen Funktionen, Skripten und anderen Elementen.

Verarbeitung von Geheimnissen

Verwenden Sie Passwort oder Qualifikationen Typen für sensible Daten statt Text und beschränken den Zugriff unter Verwendung von RBAC, falls erforderlich.

Benennungskonventionen helfen

Verwenden Sie klare Präfixe, um Parameter zu gruppieren (z. B. AZ_, AWS_, VMW_, IM_, SA_, PROD_, POC_), damit sie leicht zu finden sind. Wählen Sie „Existierendes“ Dialoge.

Verweise

Hinweise werden nicht überall automatisch aktualisiert: Die Änderung eines Parameters aktualisiert nicht automatisch den effektiven Wert an allen Stellen, an denen er zuvor verwendet wurde. Falls eine Funktion einen Snapshot des Wertes speichert, müssen Sie möglicherweise die Konfiguration erneut speichern/anwenden (oder die entsprechende Aktion erneut ausführen), um den aktualisierten Parameter zu übernehmen.

Technische Dokumentation

Parameter Es handelt sich um zentral verwaltete Werte, die in XOAP wiederverwendet werden können. Sie sind darauf ausgelegt, die Hardcoding sensibler Daten (Passwörter, Anmeldeinformationen) und häufig wiederverwendeter Identifikatoren (Abonnentennummern, Tenant-IDs) sowie um umweltspezifische Einstellungen (Pfadnamen, Flags, Listen, Zuordnungen) zu vermeiden.

Parameter werden hauptsächlich über Wählen Sie „Existierendes“ Felder in der gesamten Benutzeroberfläche. Wenn Sie auf Wählen Sie „Existierendes“ Neben einem Feld werden von XOAP Filterungen durchgeführt und nur Parameter angezeigt, die den angegebenen Kriterien entsprechen. Wichtiges Format von diesem Feld.

Wo Parameter verwendet werden

Parameter können aus mehreren XOAP-Funktionen abgerufen werden, typischerweise dort, wo Sie sie sehen:

Ein Feld mit Wählen Sie „Existierendes“
Ein Feld, das empfindliche Werte (Passwörter, Geheimnisse) unterstützt
Ein Feld, das in mehreren Konfigurationen wiederverwendet wird (IDs, Namen, Listen)

Typische Anwendungsbeispiele:

Verbindungen: Speicherung von Geheimnissen/Authentifizierungsdaten (Cloud-Geheimnisse, vCenter-Passwort, Nutanix-Passwort usw.)
Skriptierte Aktionen / Automatisierung: Speichern von API-Tokens, Benutzernamen/Passwörtern und Umgebungsvariablen
Image Management: Speichern von Cloud-Kennungen, Ressourcennamen oder Zugangsdaten, die von Entwicklern verwendet werden

Parametertypen

XOAP unterstützt mehrere Parametertypen. Jede Art bestimmt die Validierung, die Maskierung und die Verwendungsmöglichkeiten.

1) Text

Generischer String-Wert.
Verwenden Sie es für Identitäten, Namen, Hostnamen, URLs und nicht-sensible Werte.
Beispiele: tenant-id, subscription-id, resource-group, endpoint-url.

2) Passwort

Geheime Zeichenkette (in der Benutzeroberfläche maskiert).
Verwenden Sie es für alle sensiblen Einzelwert-Passwörter (Passwörter, App-Passwörter, Token).
Beispiele: vcenter-password, aws-secret-access-key, client-secret.

3) Bescheinigungen

Strukturiertes Objekt zur Authentifizierung.
In der Regel enthalten diese Felder den Benutzernamen und das Passwort (oder ähnliche Felder).
Am geeignetsten für Orte, in denen ein Benutzername und ein Passwort zusammen verwendet werden.
Beispielwertformat (konzeptionell): { “username”: “xoap-admin”, “password”: “****” }.

4) Zahl

Numerische Größe.
Verwenden Sie sie für Zähler, Schwellenwerte, Größenangaben, Timeout-Einstellungen usw.
Beispiele: vm-count = 3, timeout-seconds = 600.

5) Bool

Werte mit dem Wert „True/False“.
Verwenden Sie es für Feature-Schaltflächen und -Flaggen.
Beispiele: enable-tpm = true, dry-run = false.

6) Liste

Liste/Array mit Werten.
Verwenden Sie sie für Sammlungen wie Hostnamen, VM-Namen, Subnetze usw.
Beispiel: [“XOAPDEMO0001″,”XOAPDEMO0002”].

7) Karte

Key/value-Struktur (ähnlich einem Wörterbuch).
Verwenden Sie es für strukturierte Konfigurationen und Zuordnungen.
Beispiel: (Das [{“name”:”key1″,”value”:”value1″},{“name”:”key2″,”value”:”value2″}] Format kann je nach Benutzeroberfläche variieren).

In der Parameterinformationen Auf der Seite zeigt XOAP an, wo der Parameter derzeit verweist (zugeordnet).

Dies hilft bei der Identifizierung von:

Welche skriptbasierten Aktionen/ Platform Management Elemente davon abhängen
Was wird betroffen sein, wenn Sie die Anmeldeinformationen ändern oder die Identitäten ändern?

Verwenden Sie diese Ansicht zuvor:

Drehende Geheimnisse
Parameter umbenennen oder löschen
Änderung der umweltbezogenen Werte

Sicherheits- und betriebswirtschaftliche Best Practices

Geheime Informationen im Speicher als Passwort/Authentifizierungsinformationen speichern, nicht Text.
Authentifizierungseinstellungen rotieren Regelmäßig ein kurzes Handlungsablaufverfahren für “Update + Neuaufbau/Neuverwendung” festlegen.
Verwenden Sie Tags Parametergruppen nach:
- Umgebung (prod, poc, lab)
- Zweck (Bildverwaltung, Inventarisierung, skriptbasierte Aktionen)
- Kunde/Projekt
Vorzugsweise Prinzip der geringsten Privilegien: Verwenden Sie nicht überall denselben Secret, wenn die Scope-Variablen unterschiedlich sind.
Bei den Typen „Credentials/List/Map“ sollten die Strukturen konsistent und dokumentiert bleiben, damit die Teams wissen, worauf sie sich einstellen können.

The post Parameters appeared first on XOAP.

Resources

Stella — Mon, 29 Apr 2024 14:22:50 +0000

Schnellübersicht

XOAP Ressourcen ist ein zentraler Dateispeicher, der in XOAP verwendet wird. Sie können Dateien hochladen jeder Dateityp (Skripts, Konfigurationsdateien, Vorlagen, Archive, Binärdateien usw.). Ressourcen werden häufig durch andere XOAP-Funktionen verlinkt (z. B. die Auswahl von Skripten in “Skript ausführen”).

Erstellen Sie eine neue Ressource

Gehen Sie zu Ressourcen und klicken Sie + Neue Ressource.
Laden Sie Ihre Datei(en) mithilfe von Klicken Sie, um zu laden oder Ziehen und Ablegen.
(Optional) In dem Details zu den Ressourcen Schritt, hinzufügen:
- Beschreibung
- Tags
- (Optional) Versionenmeldung
Klicken Sie auf Weiter/Bestätigen Um die Ressource fertigzustellen und zu erstellen.

Eine Ressource bearbeiten

In der Ressourcen Tabelle, klicken Sie auf Aktionsmenü (⋮) für die Ressource.
Wählen Sie Details.
Wenn die Ressource eine editierbare Art ist (PowerShell, Shell-Skript, JSON, YAML, Textdatei), aktualisieren Sie den Inhalt und/oder die Metadaten nach Bedarf.
Speichern Sie die Änderungen (eine neue Version kann je nach Update-Workflow erstellt werden).

Eine Ressource löschen

In der Ressourcen Tabelle, klicken Sie auf Aktionsmenü (⋮) für die Ressource.
Wählen Sie Löschen.
Bestätigen Sie die Löschung.

Weitere nützliche Informationen

Alles hochladen

XOAP Resources unterstützt das Hochladen jeder Dateityp (nicht auf Skripten beschränkt).

Bearbeitbare Formate

Sie können diese Ressourcetypen direkt bearbeiten und verwalten: PowerShell, Shell-Skripts, JSON, YAML, Textdateien.

Verwenden Sie Tags für die Organisation

Taggen von Ressourcen nach Zweck/Umgebung (z. B. ImageManagement, ScriptedAction, PoC, Prod), um die Suchbarkeit und das Verwalten der Bibliothek zu gewährleisten.

Die Ressourcen werden in XOAP wiederverwendet.

Viele UI-Workflows, die eine Datei oder ein Skript erfordern (z. B. Ablaufregeln für die Skriptausführung), beziehen sich auf Inhalte, die in Ressourcen.

Technische Dokumentation

XOAP Ressourcen ist ein zentraler Speicher für Dateien, die auf der gesamten Plattform verwendet werden. Sie können Dateien hochladen jeder Dateityp (Skripts, Konfigurationsdateien, Vorlagen, Binärdateien, Archive usw.). Ressourcen werden verknüpft und können von anderen XOAP-Funktionen (üblicherweise „Scripted Actions“ und „Actions with Parameters Image Management“) abgerufen werden.

Ressourcenkategorien und Filterung

Die Seite „Ressourcen“ bietet Filter/Tabs für häufig verwendete Dateikategorien wie:

Alle Ressourcen
PowerShell
Shell-Skripts
JSON
YAML
ZIP
Textdateien
Aktivitätsprotokoll

Diese Funktionen dienen hauptsächlich der Organisation und schnelleren Erkennung; XOAP ermöglicht weiterhin das Hochladen beliebiger Formate.

Kernressourcen-Eigenschaften

Jede Ressource verfügt typischerweise über:

Namen des Ressourcenobjekts
Art des Ressourcen (MIME-/Typklassifizierung)
Beschreibung
Tags
Version und Versionenmeldung
Auditinformationen (Erstellt von / Aktualisiert von + Zeitstempel)

Upload- und Überschreibevorgang

Bei der Zuweisung von Ressourcen:

Sie können Dateien über Drag & Drop oder den Dateiwähler hochladen.
Erlauben Sie Überschreibungen, falls sie bereits vorhanden sind Steuert, ob ein Upload eine vorhandene Ressource mit derselben Identität/Namen ersetzen kann (abhängig von Ihrem XOAP-Verhalten und den Einschränkungen). Wenn Sie eine bereits existierende Datei überschreiben, wird eine neue Version mit der hochgeladenen Ressource erstellt.

Verzeichnis der Ressourcen und Aktionen

Aus der Ressourcenliste (⋮-Menü) können Sie typischerweise Folgendes tun:

Details ansehen
Herunterladen
Löschen

Seite mit Details zu Ressourcen

Die Seite „Ressourzeninformationen“ ist die Hauptbedienoberfläche für einen Ressource.

Neueste Version des Bedienfelds

Ausstellungen:

Neueste Versionsnummer
Versionenmeldung
Erstellung/Aktualisierung von Metadaten

Bearbeiten von Ressourceninhalten

Inhaltsveränderung von Ressourcen Öffnet einen Editor für unterstützte textbasierte Ressourstypen (z. B.: PowerShell, Shell, JSON, YAML, Text).
Dadurch ist die Bearbeitung direkt am Ort möglich, ohne dass eine Datei erneut hochgeladen werden muss.

Speichern / Bestätigen und Versionierung

Wenn Sie Änderungen an Ressourceninhalten speichern, werden von XOAP Anweisungen zur Erstellung einer Neue Ressourcenversion:

Sie können die Neue Version (einschließlich Eigene Version Abschnitte).
Sie können eine Versionenmeldung die Veränderung darzustellen.
Confirming veröffentlicht die aktualisierte Version als die neueste Version.

Die Versionierung ist entscheidend, da andere XOAP-Komponenten auf einer bestimmten Ressourcenversion für Reproduzierbarkeit angewiesen sein können.

Alle Versionen ansehen und vergleichen

Aus den Ressourceninformationen, Alle anzeigen öffnet Versionsverlauf Wo Sie es tun können:

Alle historischen Versionen ansehen
Nachrichten, Datumsangaben und Autoren der Überprüfungsvorlage überprüfen
Vergleichen Sie die Versionen (Vergleichsansicht), um genau zu verstehen, welche Änderungen zwischen den einzelnen Versionen entstanden sind.

Download der Ressource

Download-Quelle erhält die aktuell ausgewählte/neueste Ressourcendatei zurück.

Zugeordnet an

Die Zugeordnet an In den Abschnitten werden aufgelistet, wo die Ressource derzeit verweist (in der Regel unter „Scripted Actions Platform Management“). Dies hilft bei der Analyse von Auswirkungen vor Änderungen:

“Wer nutzt diese Ressource?”
“Welche Version wird derzeit verwendet?”

Praktische Hinweise und Best Practices

Verwenden Sie Versionen von Nachrichten konsequent (was sich verändert hat + warum).
Ich bevorzuge die Bearbeitung über Inhaltsveränderung von Ressourcen für kleine kontrollierte Änderungen in Skripten/Konfigurationsdateien; für große strukturelle Änderungen oder binäre Artefakte empfiehlt es sich, das Update erneut zu starten.
Behandle gemeinsam genutzte Ressourcen als “Interfaces”: Ändern des Verhaltens kann die weitere Ausführung beeinflussen – verwenden Sie Versionierung, um Rollbacks einfach zu verwalten.
Verwenden Sie Tags, um Umgebungen und Zwecke voneinander zu trennen (z. B. Prod, Test, CustomerX, AVD, Build, Deploy).

The post Resources appeared first on XOAP.

Schedules

Dora — Mon, 12 Aug 2024 13:49:43 +0000

Schnellübersicht

XOAP Zeitpläne Lassen Sie Sie laufen Bilddefinitionen und Geskriptete Aktionen automatisch anhand eines definierten Zeitintervalls (Minuten, Stunden, Tage, Wochen oder Monate). Jede Schedule kann einem oder mehreren Bildern und/oder skriptierten Aktionen zugeordnet werden, und XOAP zeigt die Nächste geplante Runde in der Liste der Zeitpläne.

Erstellen Sie einen neuen Zeitplan

Gehen Sie zu Zeitpläne und klicken Sie + Neues Zeitplan.
Unter Details zum Zeitplan, geben Sie:
- Name (erforderlich)
- Beschreibung (optional)
- Tags (optional)
Wählen Sie das Wiederholungsmuster über die Tabulatoren aus:
- Minuten, Stündlich, Tageszeitung, Wöchentlich, oder Monatlich
- Konfigurieren Sie die für die ausgewählte Registerkarte angegebenen Timing-Optionen (z. B. “Jeden X-minütigen Zeitraum”, “Jeden X-stündigen Zeitraum ab Minute Y” usw.).
Klicken Sie auf Weiter zu öffnen Zeitplan festlegen.
Den Zeitplan den Zielen zuweisen:
- Verwenden Sie die Bilder Tasten zum Auswählen einer oder mehrerer Bilder
- Verwenden Sie die Geskriptete Aktionen Tastenkombination zum Auswählen einer oder mehrerer skriptierter Aktionen
Klicken Sie auf Oberfläche Um den Zeitplan zu erstellen.

Eine Schedule bearbeiten

In der Zeitpläne Tabelle, klicken Sie auf Aktionsmenü (⋮) für den Zeitplan.
Wählen Sie Details.
Aktualisierung Name, Beschreibung, Tags, und/oder das Wiederauftrittsmuster (Minuten/Stunden/Tage/Wochen/Monate).
Überprüfen oder die zugeordneten Einstellungen anpassen Bilder / Geskriptete Aktionen (falls in Ihrem Workflow relevant).
Klicken Sie auf Speichern Sie.

Eine Schedule löschen

In der Zeitpläne Tabelle, klicken Sie auf Aktionsmenü (⋮) für den Zeitplan.
Wählen Sie Löschen.
Bestätigen Sie die Löschung.

Weitere nützliche Informationen

Was ein Zeitplan anstreben kann

Eine Zeitpläne können zugeordnet werden Bilder und/oder Geskriptete Aktionen (Sie können für beide ein Schema verwenden).

Visibilität der bevorstehenden Läufe

Die Liste der Zeitpläne zeigt Nächste geplante Runde Damit können Sie die Zeitgenauigkeit schnell überprüfen.

Tags für die Governance

Verwenden Sie Tags wie Prod, PoC, AWS, Hardening und WeeklyAudit, um Pläne in großem Umfang zu filtern und zu verwalten.

Fehlerbehebung

Wenn die geplanten Hinrichtungen nicht wie erwartet stattfinden, überprüfen Sie das Zeitplanmuster, die Zuordnungen (Bilddateien/skriptbasierte Aktionen) und prüfen Sie die entsprechenden Aktivitätsprotokoll zur Beweisführung bei der Verurteilung.

Technische Dokumentation

Zeitpläne In XOAP definieren Sie wiederkehrende Ausführungstermine für Bilder und Geskriptete Aktionen. Ein Zeitplan ist ein wiederverwendbares Objekt, das folgende Elemente enthält:

Metadaten (Name, Beschreibung, Tags, Audit-Informationen)
Zurückfallmuster (Minuten/Stunden/Tage/Wochen/Monate)
Aufgaben (welche Bilder und/oder skriptierte Aktionen mit dem Zeitplan verknüpft sind)

Zeitpläne helfen, die Automatisierung zu standardisieren und wiederkehrende Vorgänge so zu gestalten, dass sie vorhersehbar und verifizierbar sind.

Wo Zeitpläne verwendet werden

Zeitpläne können an folgende Personen zugeordnet werden:

Bilder (Image Management)
Geskriptete Aktionen

Eine einzige Schedule kann mehreren Zielen und gleichzeitig beiden Kategorien zugeordnet werden.

Seitenansicht der Zeitpläne

Die Zeitpläne Die Liste zeigt auf einen Blick die wichtigsten Zeitplan-Metadaten.

Spalten (typisch)

Name – Name des Zeitplans
Beschreibung – Optionale kurze Beschreibung
Nächste geplante Runde – Berechneter Zeitstempel des nächsten Durchlaufs basierend auf dem ausgewählten Wiederholungsmuster
Tags – Optionale Kennzeichnungen für Filterung und Governance

Symbolleiste und Listensteuerung

Suche – Filteren Sie die Termine nach Namen/Beschreibung (und kennzeichnen Sie sie üblicherweise anhand der UI-Implementierung)
Spaltenauswähler – Wählen Sie sichtbare Spalten aus
Checkboxen für die Zeilenauswahl – Elemente auswählen (falls in Ihrer Umgebung Gruppenaktionen verfügbar sind)
Seitenumbrüche – Navigieren Sie durch die Ergebnisseiten

Zeilenaktionen (Aktionsmenü ⋮)

Details – Öffnet die Detailinformationen des Zeitplans
Löschen – Entfernt den Zeitplan (nach Bestätigung)

Seite mit Details zum Zeitplan

Die Details zum Zeitplan view ist der autoritative Ort, um einen Zeitplan zu überprüfen und zu verwalten. Er umfasst Folgendes:

1) Metadatenbereich

Name (erforderlich)Einzigartiger, für den Zeitplan benutzerfreundlicher Identifikator.
Beschreibung (optional): Freitextdokumentation für die Intention/den Zweck.
Schlagwörter (optional)Verwendet für Filterung, Governance und Gruppierung (z. B. aws, prod, weekly-audit).

2) Auditinformationen (nur zum Lesen)

Erstellt von / Aktualisiert von – Benutzer-ID, die den Zeitplan erstellt oder zuletzt geändert hat
Erstellungszeit & Datum / Aktualisierungszeit & Datum – Zeitstempel für die Lebenszyklus-Verfolgung

3) Konfiguration des Wiederauftrittsmodells

Die Zeitpläne unterstützen die folgenden Wiederholungsmethoden:

Minuten
Stündlich
Tageszeitung
Wöchentlich
Monatlich

Nur eine Wiederholungskonfiguration ist gleichzeitig aktiv. Die Benutzeroberfläche zeigt die relevanten Bedienelemente für die ausgewählte Registerkarte an. Der Zeitplan-Modul verwendet diese Einstellungen, um die Zeit zu berechnen. Nächste geplante Runde ist in der Listenansicht dargestellt.

Hinweis: Die Benutzeroberfläche gibt diese Muster typischerweise auf “humanen Cron-ähnliche” Weise an (z. B. “Jeden X Minuten”, “Jeden Tag um Y Uhr”). Die genauen verfügbaren Felder hängen vom ausgewählten Modus ab.

4) Abschnitt „Zuweisung“ (Ziele)

Zeitpläne können über Tab-Schaltflächen an zwei Zieltypen zugeordnet werden:

Bilder Tab
Zeigt die Liste der Bilddefinitionen, die derzeit dem Zeitplan zugewiesen sind.
Geskriptete Aktionen Tab
Zeigt die Liste der skriptbasierten Aktionen an, die derzeit dem Zeitplan zugeordnet sind.

Diese Registerkarten bieten eine Übersicht über Was ausgelöst wird nach diesem Zeitplan.

In der Tabelle werden in der Regel Spalten wie folgt angezeigt:

Name
Status (Letzte Runde) (sofern zutreffend)
Ausgang (Letzter Lauf) (sofern zutreffend)
OS / Rolle / Builder (für Bilder, abhängig von Ihrem Arbeitsbereich)

Dieser Abschnitt ist hauptsächlich für Verbandsmanagement und Sichtbarkeit (was dem Zeitplan zugeordnet ist).

Erstellen Sie einen Zeitplanfluss (Wizard)

Beim Erstellen eines Zeitplans verwendet XOAP einen zweistufigen Ablauf:

Schritt 1 – Details der Terminplanung

Bereitstellung von Name, Optional Beschreibung und Tags
Wählen Sie das Wiederholungsmuster aus (Minuten/Stündlich/Täglich/Wöchentlich/Monatlich) und konfigurieren Sie es.
A Zusammenfassung In der Bar wird normalerweise der ausgewählte Name und die Wiederholungstiefe angezeigt.

Schritt 2 – Zeitplan festlegen

Wählen Sie Zielobjekte unter:
- Bilder
- Geskriptete Aktionen
Die Zusammenfassung In der Tabelle wird üblicherweise angezeigt, wie viele Ziele je nach Typ ausgewählt werden können.
Abschließend mit Oberfläche

Dieser Assistent sorgt dafür, dass die Definitionen der Zeitpläne und die Zuordnungen zusammen erfasst werden.

Taten und Verhalten

Speichern Sie

Verändert die Planungskonfiguration (Metadaten + Wiederholung)
Die Nächste geplante Runde Rechnet neu anhand neuer Einstellungen

Löschen

Entfernt die Zeitplandefinition aus XOAP
Jede Automatisierung, die auf diesem Zeitplan basiert, stoppt (da das Zeitplanobjekt nicht mehr existiert).

Details

Öffnet die Planungs- und Zuordnungsansicht zur Überprüfung und Bearbeitung

Operational Notes und Best Practices

Fügen Sie Tags hinzu, die helfen Zukunftige Governance und Filterung (z. B. prod, poc, aws, audit, weekly).
Vorzugsweise Namen, die Absicht und Rhythmus ausdrücken (z. B. Weekly-CIS-Hardening, Daily-AVD-Image-Refresh).
Ein Stundenplan ohne Aufgaben Es wird existieren, wird aber nichts Nützliches auslösen. Bestätigen Sie immer die zugeordneten Bilder bzw. skriptierten Aktionen.
Sehr häufige Zeitpläne (minuten-/stündige Abfolge) können erhebliche Auswirkungen haben. Berechnungs- und Betriebslast abhängig davon, was Ihre Bilder bzw. skriptgestützte Aktionen tun.
Bei Zielen, die in den Aufgabenlisten angegeben sind, sind die Indikatoren “Letzter Lauf” die Die schnellste Art, Probleme zu erkennen; Bei einer eingehenderen Untersuchung sollten die entsprechenden Aktivitäten-/Log-Ansichten in XOAP verwendet werden.

Grenzen und Umfang

Die Fahrpläne gelten nur für Bild Definitionen und Geskriptete Aktionen.
Die Benutzeroberfläche bietet Nächste geplante Runde als Hauptindikator dafür, dass die Wiederauftrittsdefinition gültig und aktiv ist.

The post Schedules appeared first on XOAP.