Configuration API - Mettre à jour les Détails Généraux du Site

Nous recommandons fortement de réviser la Politique de Support pour l'API Cato avant de commencer à utiliser l'API Cato.

Vue d'ensemble de Mettre à jour les Détails Généraux du Site

Utilisez l'API de mutation updateSiteGeneralDetails pour mettre à jour les paramètres suivants dans la section Général pour un site dans l'application de gestion Cato (Réseau > Sites > {site name} > Configuration du Site > Général)

Nom
Description
Type
Fuseau horaire
Pays
État
Adresse

Localisation de l'accountId pour Votre Compte

Cet identifiant de compte n'est pas affiché dans l'Application de Gestion Cato, à la place c'est le chiffre dans l'URL pour l'Application de Gestion Cato. Par exemple, l'identifiant de compte est 26 pour l'URL suivante : https://cc.catonetworks.com/#!/26/topology.

Entrez cet ID dans l'argument accountId pour l'API de création de site, par exemple :

site(accountId: 26) {
    addSocketSite(input: $addSocketSite) { 
        siteId 
    } 
}

Localisation du siteID pour un Site

L'ID du site n'est pas affiché dans l'application de gestion Cato, vous pouvez localiser l'ID du site :

En utilisant la requête API entityLookup (voir Cato API - EntityLookup), utilisez le type avec la valeur site

Vous pouvez aussi utiliser le paramètre search avec la valeur comme le nom du site, et la requête retourne l'ID du site
Numéro dans l'URL pour l'application de gestion Cato, lorsque vous sélectionnez un site (Réseau > Sites > {site name}). Par exemple, l'ID du site est 12345 pour l'URL suivante : https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

Détails des Arguments de Mettre à jour les Détails Généraux du Site

Ce sont les arguments pour mettre à jour les paramètres généraux suivants pour un site en utilisant l'API de configuration Cato. Les arguments sont obligatoires sauf s'ils sont marqués comme optionnels :

nom - Nom du site
siteType - Type de site dans votre organisation, par exemple Centre de Données Cloud
description - (optionnel) Description du site
siteLocation - Données sur l'emplacement physique du site

updateSiteGeneralDetails Nom

Mettre à jour le nom du site.

updateSiteGeneralDetails siteType

Le siteType est un argument enum qui définit le type de site qui détermine quelle icône est utilisée pour le site dans l'écran Surveillance > Topologie dans l'Application de Gestion Cato.

Ce sont les options :

updateSiteGeneralDetails description (Optionnel)

Le description est un champ de texte libre optionnel pour décrire le site.

updateSiteGeneralDetails siteLocation

Les arguments siteLocation définissent les détails physiques suivants pour le site. Le countryCode est pertinent pour le nombre de licences de site qui sont disponibles pour une Région spécifique dans votre compte.

Vous pouvez utiliser la requête API entityLookup pour récupérer les valeurs de ces arguments, voir Cato API - EntityLookup.

Ce sont les arguments siteLocation :

countryCode - Code à deux lettres (ISO 3166-1 alpha-2) pour le pays où le site est situé

Pour entityLookup, utilisez le type avec la valeur country
stateCode - (Optionnel) Pour les pays applicables, l'état où le site est situé

Pour entityLookup, utilisez le type avec la valeur countryState
timezone - Fuseau horaire pour le site, utilisé pour définir la période de la fenêtre de maintenance pour les mises à jour des Socket et vSocket

Pour entityLookup, utilisez le type avec la valeur timezone
adresse - (Optionnel) Adresse de rue pour le site physique

Script Postman Exemple

mutation updateSiteGeneralDetails ($accountId: ID!, $siteID: ID!, $input: UpdateSiteGeneralDetailsInput!) {
    site(accountId: $accountId) {
        updateSiteGeneralDetails (siteId: $siteID, input: $input) {
            siteId
        }
    }
}

Variables GraphQL

{
    "accountId": "",
    "siteID": "",
    "input": {
        "name": "MySite",
        "description": "Mon premier DC utilisant l'API",
        "siteType": "DATACENTER",
        "siteLocation": {
            "countryCode": "FR",
            "timezone": "Europe/Paris"
        }
    }
}

Ressources Associées