Utilisation des services Web pour la création de clients hébergés à l'aide d'un programme

npc offre un ensemble d'API qui permettent d'automatiser les tâches de provisionnement et de configuration. Les services Web incluent les tâches les plus répétitives et celles dont l'exécution est particulièrement longue. Certaines de ces API consistent en des services Web conformes au modèle Representational State Transfer (REST).
capm300
NetOps Portal
offre un ensemble d'API qui permettent d'automatiser les tâches de provisionnement et de configuration. Les services Web incluent les tâches les plus répétitives et celles dont l'exécution est particulièrement longue. Certaines de ces API consistent en des services Web conformes au modèle Representational State Transfer (REST).
Ce scénario d'utilisation illustre une procédure qu'un administrateur peut déployer pour créer plusieurs définitions de client hébergé à l'aide des services Web RESTful de CA
NetOps Portal
. Chaque client hébergé dispose de ses propres comptes d'utilisateurs pour permettre l'accès à CA
NetOps Portal
. Il est donc nécessaire de décrire la création de compte d'utilisateur dans les clients hébergés. Ce scénario d'utilisation indique les étapes à effectuer lors de l'utilisation d'un client REST, d'une application d'interface utilisateur de services Web générique. Les exemples de ce scénario d'utilisation contiennent des URI qui sont construits à l'aide du port de serveur par défaut (port 8181).
Création de clients hébergés à l'aide d'un programme
L'administrateur d'hôtes peut utiliser les services Web RESTful de CA
NetOps Portal
pour créer des clients hébergés avec des paramètres spécifiques. La définition de client hébergé de base contient des paramètres qui permettent d'identifier le client MSP et qui permettent à d'autres opérateurs d'accéder à des éléments gérés et à la configuration pour le client. Un compte d'administrateur est un composant obligatoire de la définition de client hébergé permettant au client d'effectuer certaines opérations de configuration de client hébergé.
Vous pouvez associer les unités surveillées et les paramètres de produit à la définition de client hébergé en plusieurs étapes. Chaque client hébergé doit être associé à au moins un domaine IP. Vous et l'administrateur de clients hébergés pouvez alors configurer d'autres paramètres de produit obligatoires pour la gestion de l'infrastructure et des applications d'entreprise pour ce client.
Création des clients hébergés à l'aide de services Web
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>
    Pour plus d'informations sur les paramètres de client hébergé, consultez la section Exemple de syntaxe du service Clients hébergés.
  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.
Création des utilisateurs à l'aide de services Web
Utilisez un client REST pour créer et configurer un compte d'utilisateur à l'aide du service Web Utilisateurs.
Tous les comptes d'utilisateurs sont automatiquement associés à un client hébergé. Si vous déployez l'hébergement multiclient, le nouvel utilisateur est affecté au client hébergé du compte d'utilisateur authentifié utilisé pour émettre l'appel du service REST. Si vous ne déployez pas l'hébergement multiclient, cette association est transparente : les nouveaux comptes d'utilisateurs sont associés au client hébergé par défaut.
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/users/role/
    {roleIdName}
    /
    roleIdValue
    /
    • {roleIdName}
      Utilisez les valeurs spécifiées dans
      http://
      hôte_PC
      :8181/pc/center/webservice/roles/idNames
      .
      Exemples :
      roleName
      et
      roleId
      .
    • roleIdValue
      Cette valeur dépend de la valeur
      roleIdName
      sélectionnée. Par exemple, si vous utilisez le paramètre
      roleName
      , remplacez
      roleIdValue
      par un nom de rôle valide.
      Ce rôle doit être disponible dans le client hébergé.
  3. Sélectionnez
    POST
    comme
    méthode HTTP
    .
  4. Entrez un nom d'utilisateur et un mot de passe valides pour un compte d'utilisateur disposant d'un accès en tant qu'hôte ou qu'administrateur de clients hébergés à CA
    NetOps Portal
    .
  5. Dans les paramètres de corps, sélectionnez
    application/xml
    comme
    Body Content-type
    .
  6. Ajoutez les paramètres suivants dans la section de texte Body :
    <user> <name>{UserName}</name> <description>{UserDescription}</description> <enabled>{UserEnabled}</enabled> <removable>{UserRemovable}</removable> <timezone>{UserTimeZone}</timezone> <culture>{UserCulture}</culture> <administeredGroups> <group ID="{GroupID}"/> <group ID="{GroupID}"/> </administeredGroups> </user>
  7. Remplacez toute valeur par les valeurs que vous souhaitez utiliser pour le nouveau compte d'utilisateur.
    Fournissez, par exemple, les paramètres suivants :
    <user> <name>Jane Doe</name> <description>User associated with the John Doe Corporation tenant.</description> <enabled>true</enabled> <removable>true</removable> <timezone>CST6CDT</timezone> <culture>en-US</culture> <administeredGroups> <group ID="105"/> <group ID="367"/> </administeredGroups> </user>
    Pour plus d'informations sur les paramètres d'utilisateur, consultez la rubrique Service Web d'utilisateurs.
    La balise
    administeredGroups
    est facultative. Pour créer un utilisateur sans groupes administrés, excluez la balise.
  8. Exécutez la méthode.
  9. Répétez les étapes précédentes jusqu'à ce que vous ayez créé tous les utilisateurs de votre choix.
Paramètres de base de compte d'utilisateur
Les valeurs actuelles pour les paramètres de compte d'utilisateur suivants sont disponibles à l'aide d'une opération GET :
http://
PC_host
:8181/pc /center/webservice/users/
cultureId
.
Cette URL renvoie des informations sur les utilisateurs associés au même client hébergé que le compte qui est utilisé pour exécuter cette commande
.
Pour
cultureId
, indiquez le code de la langue dans laquelle vous souhaitez afficher le résultat, en-US par exemple.
  • userID
    Valeur affectée en interne pour le compte d'utilisateur.
  • name
    Nom de connexion pour le compte d'utilisateur. Le nom ne peut pas contenir plus de 50 caractères.
  • description
    (Facultatif) Décrit le compte d'utilisateur pour vous aider à l'identifier.
  • enabled
    Détermine si le compte est activé pour l'utilisation.
  • removable
    Indique que l'élément peut être supprimé (de la base de données).
    Valeurs
    : true ou false.
Vous ne pouvez pas supprimer les deux comptes d'utilisateurs prédéfinis (
admin
et
user
).
  • timezone (tz)
    Correspond au fuseau horaire dans lequel l'utilisateur affichera les données de rapport.
    Valeur par défaut
    : UTC (Temps universel coordonné).
  • userLevel
    Identifie les droits sur le produit affectés à ce compte d'utilisateur.
  • Rôle
    Spécifie le rôle affecté au compte d'utilisateur.
  • tenantId
    Est-ce un identificateur interne (base de données) pour le client hébergé auquel le compte d'utilisateur est associé.
  • culture
    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)
La méthode GET ne renvoie pas les informations de mot de passe. Lorsque vous créez un compte d'utilisateur, le mot de passe est automatiquement défini pour être identique au nom d'utilisateur.
Une méthode PUT distincte permet de mettre à jour le mot de passe d'un compte d'utilisateur spécifié. Le mot de passe est envoyé en texte clair pour éviter de communiquer la clé de chiffrement pour le service Web à utiliser. En conséquence, la méthode de modification du mot de passe doit être utilisée uniquement sur le serveur où CA
NetOps Portal
est installé afin de protéger la confidentialité du mot de passe.
Paramètres des droits sur le produit du compte d'utilisateur
Utilisez l'interface utilisateur de CA
NetOps Portal
pour déterminer les droits d'accès au produit pour le compte d'utilisateur spécifié. Le
droit d'accès au produit
est un type d'ensemble d'autorisations associé à un compte d'utilisateur. Le droit d'accès au produit accorde à l'utilisateur un accès aux fonctionnalités des sources de données sélectionnées et ne s'applique pas à la fonctionnalité CA
NetOps Portal
.
Les comptes d'utilisateurs possèdent l'une des affectations de droits sur le produit suivantes :
  • NONE
    Indique que cet utilisateur n'a pas accès à une source de données spécifiée.
  • ADMINISTRATOR
    Indique que cet utilisateur possède des droits d'administrateur sur le produit pour la source de données indiquée et peut effectuer des tâches administratives.
  • POWER_USER
    Indique que cet utilisateur possède des droits d'utilisateur avancé sur produit pour la source de données indiquée et peut effectuer certaines tâches administratives associées aux comptes d'utilisateurs et aux tableaux de bord.
  • USER
    Indique que cet utilisateur possède des droits d'utilisateur sur le produit pour la source de données indiquée et n'a pas accès aux fonctionnalités administratives.