drupal-state -Befehle verwenden

Mit den drupal-state -Befehlen können Informationen zum Status Ihres Developer Portal -Systems gespeichert und abgerufen werden.

Informationen zum Status Ihres Developer Portal -Systems werden in der Developer Portal -Datenbank gespeichert. Daher gehen diese Informationen verloren, wenn die Datenbank gelöscht oder die Developer Portal -Site erneut aus der Konfiguration installiert wird.

Mit den drupal-state -Befehlen kann ein Statusschlüsselwert festgelegt, aktualisiert, abgerufen oder gelöscht werden. Sie können beispielsweise die drupal-state -Befehle verwenden, um den Wartungsmodus für Ihr Developer Portal zu aktivieren und zu inaktivieren. Weitere Informationen finden Sie im Szenario How to enable and disable maintenance mode on your Developer Portal.

Warnung: Verwenden Sie den Befehl drupal-state mit Vorsicht. Mit diesem Befehl können Sie Schlüssel für den Status Ihrer Developer Portal -Site ändern. Bei falscher Verwendung dieses Befehls kann Ihr Developer Portalheruntergefahren werden und muss anschließend aus einer Sicherung wiederhergestellt werden.

Melden Sie sich als Provider-Organisation an:
```
apic login --server management_server --realm provider/identity_provider --username provider_username --password provider_password
```
Sie können bestimmen, welche Identitätsprovider im Parameter --realm verwendet werden sollen, indem Sie den folgenden Befehl eingeben, um eine Liste aller verfügbaren Identitätsprovider anzuzeigen (Sie müssen nicht angemeldet sein, um diesen Befehl zu verwenden):
```
apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm
```
Beispiel:
```
apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm 
total_results: 2
results:
  - title: API Manager User Registry
    realm: provider/default-idp-2
  - title: Corporate LDAP user registry
    realm: provider/corporate-ldap
```
Anhand des title-Werts können Sie bestimmen, welchen Identitätsprovider Sie verwenden müssen. Sie können dann den entsprechenden --realm-Parameter direkt aus dem angezeigten realm-Wert kopieren. Für alle Identitätsprovider, die Ihr Administrator nach der Installation von API Connect erstellt hat, werden die Namen bei der Erstellung bestimmt. Die standardmäßige lokale Benutzerregistry für API Manager für die Anmeldung als Mitglied einer Providerorganisation ist default-idp-2.
Ausführliche Informationen zum Befehl apic login finden Sie unter Bei einem Management-Server anmelden.
Erstellen Sie einen neuen Drupal -Statusschlüssel oder aktualisieren Sie einen vorhandenen Schlüssel und legen Sie den Wert fest.
```
apic --mode portaladmin drupal-state:set -server management_server --catalog catalogid/name --org orgid/name  --input_format input_format_type --state_key state_key_name --state_value state_value
```
Dabei gilt:
- management_server ist die URL des Verwaltungsservers (erforderlich).
- catalogid/name ist die ID oder der Name des Katalogs, zu dem die Site gehört (erforderlich)
- orgid/name ist die ID oder der Name der Providerorganisation, zu der der Katalog gehört (erforderlich).
- input_format_type ist das Eingabeformat des Werts für den Statusschlüssel. Kann string, integer, float, boolean, jsonoder yamlsein. Der Standardwert ist auto, d. h., Sie können diesen Parameter weglassen und die Toolkit-CLI entscheidet, welches Format verwendet werden soll.
- state_key_name ist der Name des Statusschlüssels, z. B. system.cron_last (erforderlich)
- state_value ist der Wert, der dem Statusschlüssel zugeordnet werden soll (erforderlich).
- --format ist das Ausgabeformat. Kann json, yaml, go-template=..., go-template-file=...sein. Der Standardwert ist yaml.
Geben Sie beispielsweise Folgendes ein, um einen neuen Schlüssel namens testKeyzu erstellen und den Wert auf 123zu setzen:
```
apic --mode portaladmin drupal-state:set -s my.management.server.com -o myorg -c dev-catalog --input_format yaml --state_key testKey --state_value 123
Successfully set state testKey to the value of 123
```

Ruft den Wert für einen bestimmten Drupal -Statusschlüssel ab.

apic --mode portaladmin drupal-state:get --server management_server --catalog catalogid/name --org orgid/name  --format format_type --state_key state_key_name

Geben Sie beispielsweise Folgendes ein, um den Wert des Statusschlüssels testKeyabzurufen:

apic --mode portaladmin drupal-state:get -s my.management.server.com -c dev-catalog -o myorg --format yaml --state_key testKey
testKey: 123

Löscht einen bestimmten Drupal -Statusschlüssel und dessen Wert.

apic --mode portaladmin drupal-state:delete --server management_server --catalog catalogid/name --org orgid/name --state_key state_key_name

Geben Sie beispielsweise Folgendes ein, um den Statusschlüssel testKey und seinen Wert zu löschen:

apic --mode portaladmin drupal-state:delete -s my.management.server.com -c dev-catalog -o myorg --state_key testKey
The key/value was successfully deleted.