Commandes de l'interface de ligne de commandes pour Omnissa Access

Après un déploiement réussi d'Omnissa Access, utilisez la CLI pour gérer et maintenir votre environnement.

La CLI prend en charge les tâches administratives quotidiennes, notamment la validation de la configuration, l'initialisation et la mise à jour des paramètres de locataire, la rotation des certificats, la vérification de la disponibilité des services, l'exécution de contrôles de santé, la collecte de journaux, la restauration de sauvegardes, la mise à jour des modules du système d'exploitation et la gestion des services sur Omnissa Access Control Plane.

Les commandes sont organisées en groupes par zone administrative :

wso access : gérez le locataire d'Omnissa Access et la configuration SMTP.
wso control-plane : déployez, validez, mettez à jour, restaurez et maintenez les composants d'Omnissa Access Control Plane.
wso services : déployez, restaurez, effectuez un snapshot et gérez les opérations au niveau du service.
wso healthcheck, wso validate-log-config et les commandes associées vérifient la santé et la configuration du déploiement.

Le tableau suivant répertorie les commandes de CLI disponibles avec une brève description de chacune d'elles.

Commandes wso

Remarque : exécutez les commandes wso à partir du dossier du cluster (/opt/wss/<cluster_name>), sauf si le texte d'aide d'une commande indique le contraire.

wso

Commande racine pour la CLI Omnissa Access. Exécutez wso --help pour afficher toutes les commandes disponibles et leur utilisation.
source <(wso completion bash)

Active la saisie automatique dans la session de terminal actuelle. Vous devez exécuter la commande source <(wso completion bash) chaque fois que vous lancez une nouvelle session de terminal.
wso access

Gère l'installation et la configuration d'Omnissa Access.

wso access add-tenant-admin-users : ajoute un utilisateur Admin à un locataire Access.

wso access bootstrap : charge le profil d'accès, valide les certificats, génère des variables d'environnement et synchronise les données clé-valeur et les secrets.

wso access check-service-readiness : vérifie la disponibilité des services Access.

wso access configure-cert-proxy : configure cert-proxy pour le cluster Access

wso access create-admin-client : crée un client OAuth2 admin dans un locataire

wso access create-tenant : crée le premier locataire Access. Il s'agit d'une commande à usage unique, déjà exécutée lors de l'installation.

wso access init : initialise le répertoire de travail pour l'installation d'Omnissa Access. Cette commande a déjà été exécutée lors de l'installation.

wso access push-notifications : commande pour gérer les notifications Push dans Hub Services.

wso access rate-limit set : définit des limites de débit pour Omnissa Access, avec les indicateurs suivants :
- --login_rpm : limite de débit pour les demandes de connexion
- --launch_rpm : limite de débit pour les demandes de lancement
- --wsfed_rpm : limite de débit pour les demandes WS-Fed
wso access rate-limit get : obtient les paramètres de limite de débit actuels pour Omnissa Access.

wso access reset-admin-password : réinitialise le mot de passe d'un utilisateur Admin de locataire.

wso access rotate-certificate : effectue une rotation des certificats d'accès (nom de domaine complet ou cert-proxy).

wso access smtp : initialise, met à jour, extrait et valide la configuration SMTP.

wso access smtp init : initialise SMTP pour l'envoi d'e-mails.
wso access smtp update : met à jour les paramètres SMTP pour l'envoi d'e-mails à l'aide d'un serveur SMTP.
wso access smtp get : obtient les paramètres SMTP pour l'envoi d'e-mails à l'aide d'un serveur SMTP.
wso access smtp validate : valide les paramètres SMTP pour l'envoi d'e-mails à l'aide d'un serveur SMTP.

wso access update-config : rapprochez la plate-forme Access Consul KV et la configuration de Vault lors de la mise à niveau.

wso access validate : valide le fichier d'inventaire du cluster Access et les conditions préalables.
wso configure

Configure la CLI pour utiliser une version spécifique des composants d'Omnissa Access.
swo control-plane

Déploie et gère les composants d'Omnissa Access Control Plane. Utilisez wso cp comme alias raccourci pour cette commande.

wso control-plane ansible : exécute des commandes Ansible arbitraires sur le cluster de plan de contrôle.

wso control-plane collect-log-bundle : collecte des journaux hors ligne des nœuds de cluster dans un bundle.

wso control-plane deploy : déploie les composants d'Omnissa Access Control Plane.

wso control-plane diagnostics : exécute des diagnostics sur les nœuds d'Omnissa Access Control Plane.

wso control-plane hydrate-assets : ajoute les dernières ressources.

wso control-plane plan-restore-backup : planifie la restauration des données de configuration et de valeur clé à partir de la sauvegarde dans Omnissa Control Plane.

wso control-plane precheck : vérifie si la configuration du cluster répond aux exigences de déploiement.

wso control-plane reset-assets : nettoie les anciennes ressources et réinitialise les dernières ressources.

wso control-plane restart-schedulers : redémarre les agents planificateurs de service dans le cluster Omnissa Access.

wso control-plane restore-backup : restaure les données de configuration et de valeur clé à partir de la sauvegarde dans Omnissa Access Control Plane.

wso control-plane sync-time : synchronise l'heure sur les machines virtuelles d'Omnissa Access Control Plane.

wso control-plane unseal : annule le scellement des nœuds Vault dans Omnissa Access Control Plane.

wso control-plane update-agents : met à niveau les versions de l'agent ou met à jour la configuration des composants d'Omnissa Access Control Plane sur les machines virtuelles d'agent.

wso control-plane update-certificate : met à jour les certificats pour les services d'Omnissa Access Control Plane.

wso control-plane update-os : met à jour les modules sur chaque nœud Linux d'Omnissa Access Control Plane.

wso control-plane update-telemetry : met à jour la télémétrie sur chaque nœud d'Omnissa Access Control Plane.
wso cp

Alias de la commande wso control-plane. Accepte toutes les mêmes sous-commandes.
wso eula

Affiche le CLUF et autorise l'acceptation ou le refus.
wso healthcheck

Exécute un contrôle de santé de base sur le plan de contrôle, y compris les composants de plate-forme principaux et les services s'exécutant sur celui-ci.
wso services

Déploie et gère les services sur Omnissa Control Plane.

wso services config-report : signale les configurations et les remplacements en cours d'utilisation.

wso services deploy : déploie les services sur Omnissa Control Plane.

wso services list : affiche les paramètres d'un service donné.

wso services restore : restaure les services sur Omnissa Control Plane.

wso services restore-complete : vérifie les données restaurées et active les opérations de sauvegarde sur le cluster principal récemment promu.

wso services set-log-level : définit le niveau de journal pour un service donné.

wso services snapshot : services de snapshot sur Omnissa Access Control Plane.

wso services sync-kv : se synchronise avec le magasin clé-valeur à partir d'un répertoire du système de fichiers local.

wso services sync-secrets : se synchronise avec le magasin de secrets à partir d'un répertoire du système de fichiers local.

wso services temp-creds-generate : génère des informations d'identification temporaires pour un service.

wso services temp-creds-revoke : révoque des informations d'identification temporaires pour un service.
wso validate-log-config

Valide la configuration de la journalisation (Syslog, Loki, OpenSearch) et vérifie l'accessibilité.
wso version

Affiche la version de la CLI.

Commandes access-wizard

Le déploiement initial (configuration du nœud de démarrage via la création de locataire) peut être effectué avec la commande guidée access-wizard au lieu d'exécuter directement les commandes wso. Reportez-vous à la section Phase 3, Option 1 : déployer Omnissa Access à l'aide d'Access Wizard pour consulter la procédure de déploiement guidée complète ou Phase 3, Option 2 : déployer Omnissa Access manuellement pour exécuter directement les commandes wso documentées ci-dessus. Après un déploiement de access-wizard, utilisez ces commandes access-wizard pour les tâches de jour 2 courantes. Les commandes access-wizard deploy, resume et support-bundle sont documentées dans la section Phase 3, Option 1 : déployer Omnissa Access à la place à l'aide d'Access Wizard, car elles sont utilisées dans le contexte du déploiement guidé lui-même. Pour tout ce qui n'est pas abordé ici, utilisez les commandes wso documentées ci-dessus.

Remarque : les commandes access-wizard fonctionnent uniquement si le déploiement a été effectué à l'aide d'Access Wizard.

access-wizard --help : affiche la liste des commandes access_wizard disponibles.
access-wizard status : affiche l'état de chaque étape de déploiement.
access-wizard configure : rouvre les questions de la section 6 (Services facultatifs), SMTP, NTP, stockage partagé NFS et Cert-Proxy, pour les configurer ou les modifier après le déploiement.
access-wizard show-tokens : affiche les URL Nomad, Consul et Vault, ainsi que les jetons d'accès. Nécessite un terminal interactif et une confirmation.
access-wizard credentials : valide le mot de passe configuser partagé pour chaque nœud du cluster.
access-wizard verify-control-plane : valide la santé des services de plate-forme du plan de contrôle.
access-wizard docs : affiche une liste des URL de la documentation d'Omnissa Access.

Tâches administratives courantes

Les exemples suivants montrent comment utiliser les commandes de CLI souvent nécessaires après le déploiement.

Générer un bundle de journaux

Utilisez wso control-plane collect-log-bundle pour collecter des journaux hors ligne de tous les nœuds de cluster dans un bundle unique à des fins de dépannage. Par défaut, le répertoire actuel recherche le fichier d'inventaire du cluster ; transmettez un répertoire de travail en tant qu'argument pour l'exécuter à partir d'un autre emplacement.

wso cp collect-log-bundle

Les journaux sont enregistrés sous /tmp/.

Réinitialiser le mot de passe de l'administrateur du locataire

Envoie un e-mail de réinitialisation du mot de passe à l'utilisateur par défaut ; utilisez --send_mail=false pour l'ignorer. Le domaine est défini par défaut sur System Domain, sauf si --domain est spécifié.

wso access reset-admin-password

Créez le premier locataire Access

wso access create-tenant

Annuler le scellement des nœuds de Vault

Utilisez wso control-plane unseal si Vault est scellé après une opération de maintenance, telle qu'un redémarrage du nœud. Par défaut, le répertoire actuel recherche le fichier d'inventaire du plan de contrôle ; transmettez un répertoire de travail en tant qu'argument pour l'exécuter à partir d'un autre emplacement.

wso cp unseal

Exécuter des diagnostics

Utilisez wso control-plane diagnostics pour exécuter des diagnostics sur les nœuds du plan de contrôle.

wso cp diagnostics

Restaurer la configuration à partir d'une sauvegarde

Utilisez wso control-plane restore-backup pour restaurer les données de configuration et clé-valeur dans le plan de contrôle. Cela nécessite un plan de restauration qui a déjà été créé et vérifié à l'aide de plan-restore-backup. Par défaut, le répertoire actuel recherche le fichier d'inventaire du plan de contrôle ; transmettez un répertoire de travail en tant qu'argument pour l'exécuter à partir d'un autre emplacement.

wso cp restore-backup

Vérifier la disponibilité du service

Utilisez wso access check-service-readiness pour vérifier que les services Access sont prêts. Vérifiez tous les services, ou un service spécifique par nom.

wso access check-service-readiness
wso access check-service-readiness --service_name saas

Créer un client OAuth2 Admin

Utilisez wso access create-admin-client pour créer un client OAuth2 d'étendue administrateur dans un locataire, pour l'authentification auprès de l'API ACS. Exécutez cela après la création du locataire. Le secret du client ne s'affiche qu'une seule fois, donc stockez-le en toute sécurité.

wso access create-admin-client --client_id my-admin-client

Exécuter un contrôle de santé

Utilisez wso healthcheck pour exécuter un contrôle de santé de base sur le plan de contrôle, y compris les composants de plate-forme principaux et les services s'exécutant sur celui-ci. La sortie est définie par défaut sur le format table ; utilisez -f json pour la sortie lisible par machine.

wso healthcheck

Ajoutez -n/--include_node_stats pour inclure les statistiques du nœud dans la sortie (cela augmente le temps d'exécution).

Ajouter un utilisateur Admin de locataire

Utilisez wso access add-tenant-admin-users pour ajouter un utilisateur Admin à un locataire existant.

wso access add-tenant-admin-users --admin_username admin --admin_email admin@example.com

Configurer SMTP

Utilisez les commandes wso access smtp pour initialiser, mettre à jour, extraire et valider les paramètres SMTP des e-mails sortants.

wso access smtp init
wso access smtp update --SMTP_HOST smtp.example.com --SMTP_PORT 587 --SMTP_USER user --SMTP_PASSWORD ****** --SMTP_SECURITY_TYPE TLS
wso access smtp get
wso access smtp validate

Définir des limites de débit

Utilisez wso access rate-limit set pour définir le nombre maximal de demandes de connexion, de lancement et de WS-Fed autorisées par minute. Utilisez wso access rate-limit get pour afficher les limites actuelles.

wso access rate-limit set --login_rpm 100 --launch_rpm 100 --wsfed_rpm 100
wso access rate-limit get

Effectuer une rotation de certificat

Utilisez wso access rotate-certificate pour effectuer une rotation du nom de domaine complet ou du certificat de proxy de certificat. Fournissez uniquement les noms de certificat et de fichier de clé (pas un chemin d'accès), comme indiqué dans /opt/wss/<cluster_name>/access/certs.

wso access rotate-certificate --cert_type fqdn --cert_file cert.pem --key_file key.pem

Configurer le proxy de certificat

Utilisez wso access configure-cert-proxy pour configurer le proxy de certificat en tant qu'opération de jour 2 sur un déploiement d'Access existant. --ssl_certificate_path et --ssl_certificate_key sont requis uniquement lorsque --ssl_certificate_type est CUSTOM_CERT ; ils ne sont pas nécessaires pour FQDN_CERT.

wso access configure-cert-proxy --ssl_certificate_type CUSTOM_CERT --ssl_certificate_path cert.pem --ssl_certificate_key key.pem

Définir un niveau de journal de service

Utilisez wso services set-log-level pour modifier le niveau de journal d'un service donné. Par défaut, le répertoire actuel recherche la configuration ; transmettez un répertoire de travail en tant qu'argument pour l'exécuter à partir d'un autre emplacement. Si --log-level n'est pas spécifié, le propre niveau de journal par défaut du service est utilisé.

wso services set-log-level --service <service-name> --log-level debug

Valider la configuration de journalisation

Utilisez wso validate-log-config pour valider la configuration de la journalisation (Syslog, Loki, OpenSearch) et vérifier l'accessibilité.

wso validate-log-config

Cette page vous a-t-elle été utile ?