Service Web de clients hébergés

L'API fournit le service Web de clients hébergés permettant d'afficher, de créer et de modifier des définitions de client hébergé.
capm250
L'API fournit le service Web de clients hébergés permettant d'afficher, de créer et de modifier des définitions de client hébergé.
La définition du client hébergé de base contient des paramètres permettant d'identifier le client. L'ensemble de l'infrastructure (unités, réseaux, serveurs) et tous les paramètres de surveillance pour les systèmes surveillés d'un client doivent être associés à la définition du client hébergé. Chaque client hébergé doit inclure au moins un domaine IP et autant de définitions (voir ci-dessous) que nécessaire pour gérer les applications et l'infrastructure de l'entreprise :
  • Comptes d'utilisateurs
  • Rôles
  • Groupes personnalisés et groupes système
  • Rapports personnalisés
  • Menus personnalisés
Pour associer des paramètres de définitions et de surveillance à une définition de client hébergé existante, connectez-vous en tant qu'administrateur de clients hébergés et utilisez les services Web requis pour créer les définitions requises. Les définitions sont alors associées à la définition de client hébergé et disponibles pour les utilisateurs connectés avec les comptes d'utilisateurs de ce client hébergé.
Pour en savoir plus sur l'utilisation des services Web de clients hébergés et d'utilisateurs, consultez le scénario d'utilisation correspondant disponible dans la bibliothèque de documentation de CA
NetOps Portal
.
Paramètres du service Web tenants
Envoyez l'appel suivant pour afficher les paramètres et les opérations disponibles pour le service Web tenants :
http://
PC_host
:8181/pc/center/rest/tenants/documentation
Paramètres
  • tenantDescription
    (Facultatif) Décrit le client hébergé.
  • idName
    Nom du client hébergé.
  • statut
    Statut de ce client hébergé. Sélectionnez l'une des valeurs suivantes :
    • Activated : active les comptes d'utilisateurs du client hébergé.
    • Désactivé : empêche toute action par les comptes d'utilisateurs associés à ce client hébergé.
  • removable
    Indique que l'élément peut être supprimé (de la base de données).
    Valeurs
    : true ou false.
  • theme
    Spécifie le format (le thème qui contrôle l'apparence de la page dans la fenêtre du navigateur) à utiliser pour ce client hébergé. Tous les opérateurs dont le compte d'utilisateur est associé à ce client hébergé voient ce même thème. Deux thèmes sont disponibles : CA-Blue et CA-Gray.
    Valeur par défaut
    : CA-Blue
  • defaultCulture
    Spécifie une langue (environnement linguistique). Entrez un identificateur de langue à partir de la liste suivante :
    • en-US (anglais, Etats-Unis)
    • ja-JP (japonais)
    • zh-CN (chinois simplifié)
    • fr-FR (français,France)
  • accountId
    Identifie ce client hébergé ; correspond habituellement au numéro de compte MSP. Si une valeur est fournie en entrée, elle doit être unique dans tous les clients hébergés définis.
  • tenantID
    Identificateur interne (de base de données) pour la définition d'un client hébergé.
Exemple de syntaxe du service Web de clients hébergés
Le service Web de clients hébergés vous permet d'obtenir la liste actuelle des définitions de clients hébergés, de créer des définitions de clients hébergés et de modifier ces définitions en modifiant leurs paramètres.
Pour en savoir plus sur l'utilisation du service Web de clients hébergés, consultez le scénario d'utilisation correspondant disponible dans la bibliothèque de documentation de CA
NetOps Portal
.
Opérations
Les opérations de base suivantes sont prises en charge par le service Web tenants :
  • GET
    Renvoie la liste des définitions de clients hébergés triés par nom. Disponible sur le terminal /tenantID. Utilisez la syntaxe suivante :
    http://
    PC_host
    :8181/pc/center/webservice/tenants/
  • POST
    Crée un client hébergé personnalisé. Utilisez la syntaxe suivante :
    http://
    PC_host
    :8181/pc /center/webservice/tenants/
  • PUT
    Met à jour une définition de client hébergé existante. Utilisez la syntaxe suivante :
    http://
    PC_host
    :8181/pc/center/webservice/tenants/
Création d'un client hébergé
Utilisez un client REST pour créer et configurer un client hébergé à l'aide du service Web de clients hébergés.
Procédez comme suit :
  1. Configurez un client REST avec une connexion au serveur
    NetOps Portal
    .
  2. Dans le client REST, entrez l'URL correspondant à l'API des services Web RESTful de CA
    NetOps Portal
    . Utilisez le format suivant :
    http://
    PC_host
    :8181/pc/center/webservice/tenants/
  3. Sélectionnez
    POST
    comme
    méthode HTTP
    .
  4. Fournissez un nom d'utilisateur et un mot de passe valides pour un compte d'utilisateur global disposant d'un accès d'administrateur global à
    NetOps Portal
    .
  5. Dans les paramètres de corps, sélectionnez
    application/xml
    comme
    Body Content-type
    .
  6. Ajoutez le code XML suivant dans la section de texte Body (Corps) :
    <tenant> <tenantName>Name of tenant</tenantName> <tenantDesc>Description of the tenant</tenantDesc> <accountIdentifier>unique string for this tenant</accountIdentifier> <status>{activated or disabled}</status> <removable>{true or false}</removable> <theme>{CA-Blue or CA-Gray}</theme> <defaultCulture>culture</defaultCulture> </tenant>
  7. Remplacez toute valeur par les valeurs que vous souhaitez utiliser pour le nouveau client hébergé.
    Fournissez, par exemple, les paramètres suivants :
    <tenant> <tenantName>John Doe</tenantName> <tenantDesc>John Doe Corporation tenant</tenantDesc> <accountIdentifier>JD1234</accountIdentifier> <status>Enabled</status> <removable>false</removable> <theme>CA-Blue</theme> <defaultCulture>en-US</defaultCulture> </tenant>
  8. Exécutez la méthode.
  9. Répétez les étapes précédentes jusqu'à ce que vous ayez créé tous les clients hébergés de votre choix.