Rubrique précédente: Service Web de groupesRubrique suivante: Syntaxe pour la gestion de groupes de sites

Administration à l'aide de services Web › Service Web de groupes › Syntaxe d'exemple du service Web des groupes

Syntaxe d'exemple du service Web des groupes

Emettez l'appel suivant pour afficher les paramètres du service Web de groupes :

http://adresse_IP_serveur_CA_Performance_Center:8181/pc/center/webservice/groups

Envoyez l'appel suivant pour afficher une liste des opérations prises en charge :

http://adresse_IP_serveur_CA_Performance_Center:8181/pc/center/rest/groups/documentation

Pour obtenir la liste de tous les groupes inclus dans le groupe au niveau le plus élevé dans l'arborescence Groupes (par défaut, Tous les groupes), vous pouvez utiliser les paramètres groupPath ou groupItemId.

Envoyez l'appel suivant pour utiliser le paramètre groupPath afin d'identifier le groupe par défaut : 

http://adresse_IP_serveur_CA_Performance_Center:8181/pc/center/webservice/groups/
groupPath/All%20Groups

Remarque : Lorsque vous utilisez certains clients REST, la syntaxe All Groups est requise au lieu de la syntaxe All%20Groups. Mais en général, les espaces ne sont pas valides dans les URL.

Envoyez l'appel suivant pour utiliser le paramètre groupItemId afin d'identifier le groupe par défaut (dont la valeur groupItemId est 1) : 

http://adresse_IP_serveur_CA_Performance_Center:8181/pc/center/webservice/
groups/groupItemId/1

Syntaxe de sous-groupe

Vous pouvez obtenir la liste de tous les sous-groupes inclus dans un groupe que vous spécifiez de deux façons :

Envoyez l'appel suivant pour utiliser le paramètre groupPath afin d'identifier le groupe dont les sous-groupes sont répertoriés dans le contenu XML renvoyé : 

http://adresse_IP_serveur_CA_Performance_Center:8181/pc/center/webservice/
groups/groupPath/All%20Groups%2FInventory

Envoyez l'appel suivant pour utiliser le paramètre groupItemId afin d'identifier le groupe dont les sous-groupes sont répertoriés dans le contenu XML renvoyé :

Remarque : La valeur groupItemId du groupe Inventory (Inventaire) par défaut est 5.

http://adresse_IP_serveur_CA_Performance_Center:8181/pc/center/webservice/
groups/groupItemId/5

Le contenu XML qui est renvoyé inclut la syntaxe des règles de groupe appliquées à ce groupe. Par conséquent, nous vous recommandons de tester plusieurs règles que vous créez dans l'interface utilisateur et de réviser la syntaxe qui est générée.

Syntaxe de groupe de sites

Le code XML suivant inclus dans une commande POST crée un groupe de sites (remplacez les exemples de valeurs par les valeurs souhaitées pour le nouveau groupe de sites) :

<GroupTree path="/All Groups">
   <Group name="East Coast USA" desc="This is a site group"
   inherit="true" type="site group" location="North America"
   bHourID="99990" timeZone="EST"/>
</GroupTree>
inherit (Hériter)

Indique si le groupe inclut les éléments enfants des membres du groupe. Par exemple, si l'attribut inherit est défini sur true, les interfaces d'unité sont des membres du groupe si l'unité a été ajoutée au groupe.

type

Indique le type de groupe. Les valeurs suivantes sont acceptées :

bHourID

(Facultatif) ID interne affecté à la définition d'heures ouvrées à associer à ce groupe de sites.

timeZone

(Facultatif) Fuseau horaire à associer à ce groupe de sites. Vous pouvez uniquement associer des fuseaux horaires à des groupes de sites, et non à des groupes personnalisés.

Règles de groupe

Les règles de groupe prennent en charge plusieurs comparaisons, en plus des expressions régulières. Par exemple, utilisez la syntaxe suivante dans le contenu XML pour publier une règle de groupe ajoutant des unités dont le nom commence par le mot Cisco :

<Match>
   <Compare readOnly="true" using="MEMBER_OF">
       <Property name="ItemID" type="device"/>
           <Value reference="/All Groups">1</Value>
   </Compare>
   <Compare readOnly="false" using="STARTS_WITH">
      <Property name="DisplayName" type="device"/>
           <Value>Cisco*</Value>
   </Compare>
</Match>

AllowDeletes

Pour la suppression de groupe, le paramètre allowDeletes doit être défini sur true. Appliquez ce paramètre à un groupe de conteneurs lorsque vous voulez supprimer un sous-groupe. Par exemple, ce code XML permet de supprimer le sous-groupe suivant : All Groups\Texas\Austin :

<GroupTree path="/All Groups/Texas">
   Group name="USA" desc="Group to represent the entire
   United States" allowDeletes="true" type="custom group"/> 
</GroupTree>

Pour la syntaxe du chemin de groupe, les caractères de barre oblique sont adaptés aux documents XML que vous publiez. Cet exemple s'applique à une structure de groupe All Groups\Texas\Austin :

<GroupTree inheritDefault="true" path="/All Groups/Texas/Austin">
    <Group desc="" inherit="true" location="" name="CA Office" type="custom group">
        <Group desc="" inherit="true" location="" name="Austin Lab" type="custom group"/>
    </Group>
    <Group desc="" inherit="true" location="" name="Austin Data Center" type="custom group"/>
</GroupTree>

Dans l'URL pour la demande de service Web, toutefois, utilisez une barre oblique inversée pour le chemin de groupe. Les barres obliques ne sont pas correctement interprétées par le navigateur.